1 ;;; gnus-srvr.el --- virtual server support for Gnus
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
29 (eval-when-compile (require 'cl))
31 (defvar gnus-server-mode-hook nil
32 "Hook run in `gnus-server-mode' buffers.")
34 (defconst gnus-server-line-format " {%(%h:%w%)} %s\n"
35 "Format of server lines.
36 It works along the same lines as a normal formatting string,
37 with some simple extensions.")
39 (defvar gnus-server-mode-line-format "Gnus List of servers"
40 "The format specification for the server mode line.")
42 ;;; Internal variables.
44 (defconst gnus-server-line-format-alist
50 (defconst gnus-server-mode-line-format-alist
51 (` ((?S news-server ?s)
53 (?u user-defined ?s))))
55 (defvar gnus-server-line-format-spec nil)
56 (defvar gnus-server-mode-line-format-spec nil)
57 (defvar gnus-server-killed-servers nil)
59 (defvar gnus-server-mode-map)
61 (defvar gnus-server-menu-hook nil
62 "*Hook run after the creation of the server mode menu.")
64 (defun gnus-server-make-menu-bar ()
65 (gnus-visual-turn-off-edit-menu 'server)
67 (boundp 'gnus-server-menu)
70 gnus-server-menu gnus-server-mode-map ""
72 ["Add" gnus-server-add-server t]
73 ["Browse" gnus-server-read-server t]
74 ["List" gnus-server-list-servers t]
75 ["Kill" gnus-server-kill-server t]
76 ["Yank" gnus-server-yank-server t]
77 ["Copy" gnus-server-copy-server t]
78 ["Edit" gnus-server-edit-server t]
79 ["Exit" gnus-server-exit t]
83 gnus-server-menu gnus-server-mode-map ""
85 ["Open" gnus-server-open-server t]
86 ["Close" gnus-server-close-server t]
87 ["Deny" gnus-server-deny-servers t]
88 ["Reset" gnus-server-remove-denials t]
91 (run-hooks 'gnus-server-menu-hook))))
93 (defvar gnus-server-mode-map nil)
94 (put 'gnus-server-mode 'mode-class 'special)
96 (unless gnus-server-mode-map
97 (setq gnus-server-mode-map (make-sparse-keymap))
98 (suppress-keymap gnus-server-mode-map)
102 " " gnus-server-read-server
103 "\r" gnus-server-read-server
104 gnus-mouse-2 gnus-server-pick-server
106 "l" gnus-server-list-servers
107 "k" gnus-server-kill-server
108 "y" gnus-server-yank-server
109 "c" gnus-server-copy-server
110 "a" gnus-server-add-server
111 "e" gnus-server-edit-server
113 "O" gnus-server-open-server
114 "C" gnus-server-close-server
115 "D" gnus-server-deny-server
116 "R" gnus-server-remove-denials))
118 (defun gnus-server-mode ()
119 "Major mode for listing and editing servers.
121 All normal editing commands are switched off.
122 \\<gnus-server-mode-map>
124 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
126 The following commands are available:
128 \\{gnus-server-mode-map}"
130 (when (and menu-bar-mode
131 (gnus-visual-p 'server-menu 'menu))
132 (gnus-server-make-menu-bar))
133 (kill-all-local-variables)
134 (gnus-simplify-mode-line)
135 (setq major-mode 'gnus-server-mode)
136 (setq mode-name "Server")
137 ; (gnus-group-set-mode-line)
138 (setq mode-line-process nil)
139 (use-local-map gnus-server-mode-map)
140 (buffer-disable-undo (current-buffer))
141 (setq truncate-lines t)
142 (setq buffer-read-only t)
143 (run-hooks 'gnus-server-mode-hook))
145 (defun gnus-server-insert-server-line (name method)
146 (let* ((how (car method))
147 (where (nth 1 method))
148 (elem (assoc method gnus-opened-servers))
149 (status (cond ((eq (nth 1 elem) 'denied)
151 ((or (gnus-server-opened method)
152 (eq (nth 1 elem) 'ok))
161 (eval gnus-server-line-format-spec))
162 (list 'gnus-server (intern name)))))
164 (defun gnus-enter-server-buffer ()
165 "Set up the server buffer."
166 (gnus-server-setup-buffer)
167 (gnus-configure-windows 'server)
168 (gnus-server-prepare))
170 (defun gnus-server-setup-buffer ()
171 "Initialize the server buffer."
172 (unless (get-buffer gnus-server-buffer)
174 (set-buffer (get-buffer-create gnus-server-buffer))
177 (gnus-carpal-setup-buffer 'server)))))
179 (fset 'gnus-server-position-point 'gnus-goto-colon)
181 (defun gnus-server-prepare ()
182 (setq gnus-server-mode-line-format-spec
183 (gnus-parse-format gnus-server-mode-line-format
184 gnus-server-mode-line-format-alist))
185 (setq gnus-server-line-format-spec
186 (gnus-parse-format gnus-server-line-format
187 gnus-server-line-format-alist t))
188 (let ((alist gnus-server-alist)
189 (buffer-read-only nil)
190 (opened gnus-opened-servers)
193 ;; First we do the real list of servers.
195 (push (cdr (setq server (pop alist))) done)
196 (when (and server (car server))
197 (gnus-server-insert-server-line (car server) (cdr server))))
198 ;; Then we insert the list of servers that have been opened in
201 (unless (member (car (car opened)) done)
202 (gnus-server-insert-server-line
203 (format "%s:%s" (car (car (car opened))) (nth 1 (car (car opened))))
205 (setq opened (cdr opened))))
206 (goto-char (point-min))
207 (gnus-server-position-point))
209 (defun gnus-server-server-name ()
210 (let ((server (get-text-property (gnus-point-at-bol) 'gnus-server)))
211 (and server (symbol-name server))))
213 (defalias 'gnus-server-position-point 'gnus-goto-colon)
215 (defconst gnus-server-edit-buffer "*Gnus edit server*")
217 (defun gnus-server-update-server (server)
219 (set-buffer gnus-server-buffer)
220 (let ((buffer-read-only nil)
221 (info (cdr (assoc server gnus-server-alist))))
223 (concat "(gnus-server-set-info \"" server "\" '"
224 (prin1-to-string info) ")"))
225 ;; Buffer may be narrowed.
228 (if (gnus-server-goto-server server)
229 (delete-region (progn (beginning-of-line) (point))
230 (progn (forward-line 1) (point))))
231 (let ((entry (assoc server gnus-server-alist)))
232 (gnus-server-insert-server-line (car entry) (cdr entry))
233 (gnus-server-position-point))))))
235 (defun gnus-server-set-info (server info)
236 ;; Enter a select method into the virtual server alist.
238 (concat "(gnus-server-set-info \"" server "\" '"
239 (prin1-to-string info) ")"))
240 (let* ((server (nth 1 info))
241 (entry (assoc server gnus-server-alist)))
242 (if entry (setcdr entry info)
243 (setq gnus-server-alist
244 (nconc gnus-server-alist (list (cons server info)))))))
246 ;;; Interactive server functions.
248 (defun gnus-server-kill-server (server)
249 "Kill the server on the current line."
250 (interactive (list (gnus-server-server-name)))
251 (or (gnus-server-goto-server server)
252 (if server (error "No such server: %s" server)
253 (error "No server on the current line")))
254 (gnus-dribble-enter "")
255 (let ((buffer-read-only nil))
256 (delete-region (progn (beginning-of-line) (point))
257 (progn (forward-line 1) (point))))
258 (setq gnus-server-killed-servers
259 (cons (assoc server gnus-server-alist) gnus-server-killed-servers))
260 (setq gnus-server-alist (delq (car gnus-server-killed-servers)
262 (gnus-server-position-point))
264 (defun gnus-server-yank-server ()
265 "Yank the previously killed server."
267 (or gnus-server-killed-servers
268 (error "No killed servers to be yanked"))
269 (let ((alist gnus-server-alist)
270 (server (gnus-server-server-name))
271 (killed (car gnus-server-killed-servers)))
273 (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
274 (if (string= server (car (car gnus-server-alist)))
275 (setq gnus-server-alist (cons killed gnus-server-alist))
276 (while (and (cdr alist)
277 (not (string= server (car (car (cdr alist))))))
278 (setq alist (cdr alist)))
279 (setcdr alist (cons killed (cdr alist)))
281 (setcdr alist (cons killed (cdr alist)))
282 (setq gnus-server-alist (list killed)))))
283 (gnus-server-update-server (car killed))
284 (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
285 (gnus-server-position-point)))
287 (defun gnus-server-exit ()
288 "Return to the group buffer."
290 (kill-buffer (current-buffer))
291 (switch-to-buffer gnus-group-buffer))
293 (defun gnus-server-list-servers ()
294 "List all available servers."
296 (let ((cur (gnus-server-server-name)))
297 (gnus-server-prepare)
298 (if cur (gnus-server-goto-server cur)
299 (goto-char (point-max))
301 (gnus-server-position-point)))
303 (defun gnus-opened-servers-remove (method)
304 "Remove METHOD from the list of opened servers."
305 (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
306 gnus-opened-servers)))
308 (defun gnus-server-open-server (server)
309 "Force an open of SERVER."
310 (interactive (list (gnus-server-server-name)))
311 (let ((method (gnus-server-to-method server)))
312 (or method (error "No such server: %s" server))
313 (gnus-opened-servers-remove method)
315 (or (gnus-open-server method)
316 (progn (message "Couldn't open %s" server) nil))
317 (gnus-server-update-server server)
318 (gnus-server-position-point))))
320 (defun gnus-server-close-server (server)
322 (interactive (list (gnus-server-server-name)))
323 (let ((method (gnus-server-to-method server)))
324 (or method (error "No such server: %s" server))
325 (gnus-opened-servers-remove method)
327 (gnus-close-server method)
328 (gnus-server-update-server server)
329 (gnus-server-position-point))))
331 (defun gnus-server-deny-server (server)
332 "Make sure SERVER will never be attempted opened."
333 (interactive (list (gnus-server-server-name)))
334 (let ((method (gnus-server-to-method server)))
335 (or method (error "No such server: %s" server))
336 (gnus-opened-servers-remove method)
337 (setq gnus-opened-servers
338 (cons (list method 'denied) gnus-opened-servers)))
339 (gnus-server-update-server server)
340 (gnus-server-position-point))
342 (defun gnus-server-remove-denials ()
343 "Make all denied servers into closed servers."
345 (let ((servers gnus-opened-servers))
347 (when (eq (nth 1 (car servers)) 'denied)
348 (setcar (nthcdr 1 (car servers)) 'closed))
349 (setq servers (cdr servers))))
350 (gnus-server-list-servers))
352 (defun gnus-server-copy-server (from to)
355 (or (gnus-server-server-name)
356 (error "No server on the current line"))
357 (read-string "Copy to: ")))
358 (or from (error "No server on current line"))
359 (or (and to (not (string= to ""))) (error "No name to copy to"))
360 (and (assoc to gnus-server-alist) (error "%s already exists" to))
361 (or (assoc from gnus-server-alist)
362 (error "%s: no such server" from))
363 (let ((to-entry (gnus-copy-sequence (assoc from gnus-server-alist))))
365 (setcar (nthcdr 2 to-entry) to)
366 (setq gnus-server-killed-servers
367 (cons to-entry gnus-server-killed-servers))
368 (gnus-server-yank-server)))
370 (defun gnus-server-add-server (how where)
372 (list (intern (completing-read "Server method: "
373 gnus-valid-select-methods nil t))
374 (read-string "Server name: ")))
375 (setq gnus-server-killed-servers
376 (cons (list where how where) gnus-server-killed-servers))
377 (gnus-server-yank-server))
379 (defun gnus-server-goto-server (server)
380 "Jump to a server line."
382 (list (completing-read "Goto server: " gnus-server-alist nil t)))
383 (let ((to (text-property-any (point-min) (point-max)
384 'gnus-server (intern server))))
388 (gnus-server-position-point)))))
390 (defun gnus-server-edit-server (server)
391 "Edit the server on the current line."
392 (interactive (list (gnus-server-server-name)))
394 (error "No server on current line"))
395 (let ((winconf (current-window-configuration)))
396 (get-buffer-create gnus-server-edit-buffer)
397 (gnus-configure-windows 'edit-server)
398 (gnus-add-current-to-buffer-list)
400 (make-local-variable 'gnus-prev-winconf)
401 (setq gnus-prev-winconf winconf)
402 (use-local-map (copy-keymap (current-local-map)))
403 (let ((done-func '(lambda ()
404 "Exit editing mode and update the information."
406 (gnus-server-edit-server-done 'group))))
407 (setcar (cdr (nth 4 done-func)) server)
408 (local-set-key "\C-c\C-c" done-func))
410 (insert ";; Type `C-c C-c' after you have edited the server.\n\n")
411 (insert (pp-to-string (cdr (assoc server gnus-server-alist))))))
413 (defun gnus-server-edit-server-done (server)
415 (set-buffer (get-buffer-create gnus-server-edit-buffer))
416 (goto-char (point-min))
417 (let ((form (read (current-buffer)))
418 (winconf gnus-prev-winconf))
419 (gnus-server-set-info server form)
420 (kill-buffer (current-buffer))
421 (and winconf (set-window-configuration winconf))
422 (set-buffer gnus-server-buffer)
423 (gnus-server-update-server (gnus-server-server-name))
424 (gnus-server-list-servers)
425 (gnus-server-position-point)))
427 (defun gnus-server-read-server (server)
429 (interactive (list (gnus-server-server-name)))
430 (let ((buf (current-buffer)))
432 (gnus-browse-foreign-server (gnus-server-to-method server) buf)
435 (gnus-server-update-server (gnus-server-server-name))
436 (gnus-server-position-point)))))
438 (defun gnus-server-pick-server (e)
441 (gnus-server-read-server (gnus-server-server-name)))
445 ;;; Browse Server Mode
448 (defvar gnus-browse-menu-hook nil
449 "*Hook run after the creation of the browse mode menu.")
451 (defvar gnus-browse-mode-hook nil)
452 (defvar gnus-browse-mode-map nil)
453 (put 'gnus-browse-mode 'mode-class 'special)
455 (unless gnus-browse-mode-map
456 (setq gnus-browse-mode-map (make-keymap))
457 (suppress-keymap gnus-browse-mode-map)
461 " " gnus-browse-read-group
462 "=" gnus-browse-select-group
463 "n" gnus-browse-next-group
464 "p" gnus-browse-prev-group
465 "\177" gnus-browse-prev-group
466 "N" gnus-browse-next-group
467 "P" gnus-browse-prev-group
468 "\M-n" gnus-browse-next-group
469 "\M-p" gnus-browse-prev-group
470 "\r" gnus-browse-select-group
471 "u" gnus-browse-unsubscribe-current-group
476 "\C-c\C-c" gnus-browse-exit
477 "?" gnus-browse-describe-briefly
478 "\C-c\C-i" gnus-info-find-node))
480 (defun gnus-browse-make-menu-bar ()
481 (gnus-visual-turn-off-edit-menu 'browse)
483 (boundp 'gnus-browse-menu)
486 gnus-browse-menu gnus-browse-mode-map ""
488 ["Subscribe" gnus-browse-unsubscribe-current-group t]
489 ["Read" gnus-browse-read-group t]
490 ["Select" gnus-browse-read-group t]
491 ["Next" gnus-browse-next-group t]
492 ["Prev" gnus-browse-next-group t]
493 ["Exit" gnus-browse-exit t]
495 (run-hooks 'gnus-browse-menu-hook))))
497 (defvar gnus-browse-current-method nil)
498 (defvar gnus-browse-return-buffer nil)
500 (defvar gnus-browse-buffer "*Gnus Browse Server*")
502 (defun gnus-browse-foreign-server (method &optional return-buffer)
503 "Browse the server METHOD."
504 (setq gnus-browse-current-method method)
505 (setq gnus-browse-return-buffer return-buffer)
506 (let ((gnus-select-method method)
508 (gnus-message 5 "Connecting to %s..." (nth 1 method))
510 ((not (gnus-check-server method))
512 1 "Unable to contact server: %s" (gnus-status-message method))
514 ((not (gnus-request-list method))
516 1 "Couldn't request list: %s" (gnus-status-message method))
519 (get-buffer-create gnus-browse-buffer)
520 (gnus-add-current-to-buffer-list)
521 (and gnus-carpal (gnus-carpal-setup-buffer 'browse))
522 (gnus-configure-windows 'browse)
523 (buffer-disable-undo (current-buffer))
524 (let ((buffer-read-only nil))
527 (setq mode-line-buffer-identification
530 "Gnus: %%b {%s:%s}" (car method) (car (cdr method)))))
532 (set-buffer nntp-server-buffer)
533 (let ((cur (current-buffer)))
534 (goto-char (point-min))
535 (or (string= gnus-ignored-newsgroups "")
536 (delete-matching-lines gnus-ignored-newsgroups))
537 (while (re-search-forward
538 "\\(^[^ \t]+\\)[ \t]+[0-9]+[ \t]+[0-9]+" nil t)
539 (goto-char (match-end 1))
540 (setq groups (cons (cons (match-string 1)
541 (max 0 (- (1+ (read cur)) (read cur))))
543 (setq groups (sort groups
545 (string< (car l1) (car l2)))))
546 (let ((buffer-read-only nil))
548 (setq group (car groups))
550 (format "K%7d: %s\n" (cdr group) (car group)))
551 (setq groups (cdr groups))))
552 (switch-to-buffer (current-buffer))
553 (goto-char (point-min))
554 (gnus-group-position-point)
557 (defun gnus-browse-mode ()
558 "Major mode for browsing a foreign server.
560 All normal editing commands are switched off.
562 \\<gnus-browse-mode-map>
563 The only things you can do in this buffer is
565 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
566 The group will be inserted into the group buffer upon exit from this
569 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
571 3) `\\[gnus-browse-exit]' to return to the group buffer."
573 (kill-all-local-variables)
574 (when (and menu-bar-mode
575 (gnus-visual-p 'browse-menu 'menu))
576 (gnus-browse-make-menu-bar))
577 (gnus-simplify-mode-line)
578 (setq major-mode 'gnus-browse-mode)
579 (setq mode-name "Browse Server")
580 (setq mode-line-process nil)
581 (use-local-map gnus-browse-mode-map)
582 (buffer-disable-undo (current-buffer))
583 (setq truncate-lines t)
584 (setq buffer-read-only t)
585 (run-hooks 'gnus-browse-mode-hook))
587 (defun gnus-browse-read-group (&optional no-article)
588 "Enter the group at the current line."
590 (let ((group (gnus-browse-group-name)))
591 (or (gnus-group-read-ephemeral-group
592 group gnus-browse-current-method nil
593 (cons (current-buffer) 'browse))
594 (error "Couldn't enter %s" group))))
596 (defun gnus-browse-select-group ()
597 "Select the current group."
599 (gnus-browse-read-group 'no))
601 (defun gnus-browse-next-group (n)
602 "Go to the next group."
606 (gnus-group-position-point)))
608 (defun gnus-browse-prev-group (n)
609 "Go to the next group."
611 (gnus-browse-next-group (- n)))
613 (defun gnus-browse-unsubscribe-current-group (arg)
614 "(Un)subscribe to the next ARG groups."
617 (error "No group at current line."))
618 (let ((ward (if (< arg 0) -1 1))
620 (while (and (> arg 0)
622 (gnus-browse-unsubscribe-group)
623 (zerop (gnus-browse-next-group ward)))
625 (gnus-group-position-point)
626 (if (/= 0 arg) (gnus-message 7 "No more newsgroups"))
629 (defun gnus-browse-group-name ()
632 (when (re-search-forward ": \\(.*\\)$" (gnus-point-at-eol) t)
633 (gnus-group-prefixed-name (match-string 1) gnus-browse-current-method))))
635 (defun gnus-browse-unsubscribe-group ()
636 "Toggle subscription of the current group in the browse buffer."
638 (buffer-read-only nil)
642 ;; If this group it killed, then we want to subscribe it.
643 (if (= (following-char) ?K) (setq sub t))
644 (setq group (gnus-browse-group-name))
648 (gnus-group-change-level
649 (list t group gnus-level-default-subscribed
650 nil nil gnus-browse-current-method)
651 gnus-level-default-subscribed gnus-level-killed
652 (and (car (nth 1 gnus-newsrc-alist))
653 (gnus-gethash (car (nth 1 gnus-newsrc-alist))
657 (gnus-group-change-level
658 group gnus-level-killed gnus-level-default-subscribed)
662 (defun gnus-browse-exit ()
663 "Quit browsing and return to the group buffer."
665 (if (eq major-mode 'gnus-browse-mode)
666 (kill-buffer (current-buffer)))
667 (if gnus-browse-return-buffer
668 (gnus-configure-windows 'server 'force)
669 (gnus-configure-windows 'group 'force)
670 (gnus-group-list-groups nil)))
672 (defun gnus-browse-describe-briefly ()
673 "Give a one line description of the group mode commands."
676 (substitute-command-keys "\\<gnus-browse-mode-map>\\[gnus-group-next-group]:Forward \\[gnus-group-prev-group]:Backward \\[gnus-browse-exit]:Exit \\[gnus-info-find-node]:Run Info \\[gnus-browse-describe-briefly]:This help")))
679 ;;; gnus-srvr.el ends here.