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.
34 (defvar gnus-server-mode-hook nil
35 "Hook run in `gnus-server-mode' buffers.")
37 (defconst gnus-server-line-format " {%(%h:%w%)} %s\n"
38 "Format of server lines.
39 It works along the same lines as a normal formatting string,
40 with some simple extensions.")
42 (defvar gnus-server-mode-line-format "Gnus List of servers"
43 "The format specification for the server mode line.")
45 (defvar gnus-server-exit-hook nil
46 "*Hook run when exiting the server buffer.")
48 ;;; Internal variables.
50 (defvar gnus-inserted-opened-servers nil)
52 (defvar gnus-server-line-format-alist
58 (defvar gnus-server-mode-line-format-alist
61 (?u user-defined ?s)))
63 (defvar gnus-server-line-format-spec nil)
64 (defvar gnus-server-mode-line-format-spec nil)
65 (defvar gnus-server-killed-servers nil)
67 (defvar gnus-server-mode-map)
69 (defvar gnus-server-menu-hook nil
70 "*Hook run after the creation of the server mode menu.")
72 (defun gnus-server-make-menu-bar ()
73 (gnus-turn-off-edit-menu 'server)
74 (unless (boundp 'gnus-server-server-menu)
76 gnus-server-server-menu gnus-server-mode-map ""
78 ["Add" gnus-server-add-server t]
79 ["Browse" gnus-server-read-server t]
80 ["Scan" gnus-server-scan-server t]
81 ["List" gnus-server-list-servers t]
82 ["Kill" gnus-server-kill-server t]
83 ["Yank" gnus-server-yank-server t]
84 ["Copy" gnus-server-copy-server t]
85 ["Edit" gnus-server-edit-server t]
86 ["Exit" gnus-server-exit t]
90 gnus-server-connections-menu gnus-server-mode-map ""
92 ["Open" gnus-server-open-server t]
93 ["Close" gnus-server-close-server t]
94 ["Deny" gnus-server-deny-server t]
96 ["Open All" gnus-server-open-all-servers t]
97 ["Close All" gnus-server-close-all-servers t]
98 ["Reset All" gnus-server-remove-denials t]
101 (run-hooks 'gnus-server-menu-hook)))
103 (defvar gnus-server-mode-map nil)
104 (put 'gnus-server-mode 'mode-class 'special)
106 (unless gnus-server-mode-map
107 (setq gnus-server-mode-map (make-sparse-keymap))
108 (suppress-keymap gnus-server-mode-map)
112 " " gnus-server-read-server
113 "\r" gnus-server-read-server
114 gnus-mouse-2 gnus-server-pick-server
116 "l" gnus-server-list-servers
117 "k" gnus-server-kill-server
118 "y" gnus-server-yank-server
119 "c" gnus-server-copy-server
120 "a" gnus-server-add-server
121 "e" gnus-server-edit-server
122 "s" gnus-server-scan-server
124 "O" gnus-server-open-server
125 "\M-o" gnus-server-open-all-servers
126 "C" gnus-server-close-server
127 "\M-c" gnus-server-close-all-servers
128 "D" gnus-server-deny-server
129 "R" gnus-server-remove-denials
131 "\C-c\C-i" gnus-info-find-node))
133 (defun gnus-server-mode ()
134 "Major mode for listing and editing servers.
136 All normal editing commands are switched off.
137 \\<gnus-server-mode-map>
138 For more in-depth information on this mode, read the manual
139 (`\\[gnus-info-find-node]').
141 The following commands are available:
143 \\{gnus-server-mode-map}"
145 (when (and menu-bar-mode
146 (gnus-visual-p 'server-menu 'menu))
147 (gnus-server-make-menu-bar))
148 (kill-all-local-variables)
149 (gnus-simplify-mode-line)
150 (setq major-mode 'gnus-server-mode)
151 (setq mode-name "Server")
152 (gnus-set-default-directory)
153 (setq mode-line-process nil)
154 (use-local-map gnus-server-mode-map)
155 (buffer-disable-undo (current-buffer))
156 (setq truncate-lines t)
157 (setq buffer-read-only t)
158 (run-hooks 'gnus-server-mode-hook))
160 (defun gnus-server-insert-server-line (name method)
161 (let* ((how (car method))
162 (where (nth 1 method))
163 (elem (assoc method gnus-opened-servers))
164 (status (cond ((eq (nth 1 elem) 'denied)
166 ((or (gnus-server-opened method)
167 (eq (nth 1 elem) 'ok))
172 (gnus-add-text-properties
176 (eval gnus-server-line-format-spec))
177 (list 'gnus-server (intern name)))))
179 (defun gnus-enter-server-buffer ()
180 "Set up the server buffer."
181 (gnus-server-setup-buffer)
182 (gnus-configure-windows 'server)
183 (gnus-server-prepare))
185 (defun gnus-server-setup-buffer ()
186 "Initialize the server buffer."
187 (unless (get-buffer gnus-server-buffer)
189 (set-buffer (get-buffer-create gnus-server-buffer))
192 (gnus-carpal-setup-buffer 'server)))))
194 (defun gnus-server-prepare ()
195 (setq gnus-server-mode-line-format-spec
196 (gnus-parse-format gnus-server-mode-line-format
197 gnus-server-mode-line-format-alist))
198 (setq gnus-server-line-format-spec
199 (gnus-parse-format gnus-server-line-format
200 gnus-server-line-format-alist t))
201 (let ((alist gnus-server-alist)
202 (buffer-read-only nil)
203 (opened gnus-opened-servers)
206 (setq gnus-inserted-opened-servers nil)
207 ;; First we do the real list of servers.
209 (push (cdr (setq server (pop alist))) done)
210 (when (and server (car server) (cdr server))
211 (gnus-server-insert-server-line (car server) (cdr server))))
212 ;; Then we insert the list of servers that have been opened in
215 (unless (member (caar opened) done)
216 (gnus-server-insert-server-line
217 (setq op-ser (format "%s:%s" (caaar opened) (nth 1 (caar opened))))
219 (push (list op-ser (caar opened)) gnus-inserted-opened-servers))
220 (setq opened (cdr opened))))
221 (goto-char (point-min))
222 (gnus-server-position-point))
224 (defun gnus-server-server-name ()
225 (let ((server (get-text-property (gnus-point-at-bol) 'gnus-server)))
226 (and server (symbol-name server))))
228 (defalias 'gnus-server-position-point 'gnus-goto-colon)
230 (defconst gnus-server-edit-buffer "*Gnus edit server*")
232 (defun gnus-server-update-server (server)
234 (set-buffer gnus-server-buffer)
235 (let* ((buffer-read-only nil)
236 (entry (assoc server gnus-server-alist))
237 (oentry (assoc (gnus-server-to-method server)
238 gnus-opened-servers)))
241 (concat "(gnus-server-set-info \"" server "\" '"
242 (prin1-to-string (cdr entry)) ")
244 (when (or entry oentry)
245 ;; Buffer may be narrowed.
248 (when (gnus-server-goto-server server)
251 (gnus-server-insert-server-line (car entry) (cdr entry))
252 (gnus-server-insert-server-line
253 (format "%s:%s" (caar oentry) (nth 1 (car oentry)))
255 (gnus-server-position-point))))))
257 (defun gnus-server-set-info (server info)
258 ;; Enter a select method into the virtual server alist.
259 (when (and server info)
261 (concat "(gnus-server-set-info \"" server "\" '"
262 (prin1-to-string info) ")"))
263 (let* ((server (nth 1 info))
264 (entry (assoc server gnus-server-alist)))
265 (if entry (setcdr entry info)
266 (setq gnus-server-alist
267 (nconc gnus-server-alist (list (cons server info))))))))
269 ;;; Interactive server functions.
271 (defun gnus-server-kill-server (server)
272 "Kill the server on the current line."
273 (interactive (list (gnus-server-server-name)))
274 (unless (gnus-server-goto-server server)
275 (if server (error "No such server: %s" server)
276 (error "No server on the current line")))
277 (unless (assoc server gnus-server-alist)
278 (error "Read-only server %s" server))
279 (gnus-dribble-enter "")
280 (let ((buffer-read-only nil))
282 (push (assoc server gnus-server-alist) gnus-server-killed-servers)
283 (setq gnus-server-alist (delq (car gnus-server-killed-servers)
285 (gnus-server-position-point))
287 (defun gnus-server-yank-server ()
288 "Yank the previously killed server."
290 (unless gnus-server-killed-servers
291 (error "No killed servers to be yanked"))
292 (let ((alist gnus-server-alist)
293 (server (gnus-server-server-name))
294 (killed (car gnus-server-killed-servers)))
296 (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
297 (if (string= server (caar gnus-server-alist))
298 (push killed gnus-server-alist)
299 (while (and (cdr alist)
300 (not (string= server (caadr alist))))
301 (setq alist (cdr alist)))
303 (setcdr alist (cons killed (cdr alist)))
304 (setq gnus-server-alist (list killed)))))
305 (gnus-server-update-server (car killed))
306 (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
307 (gnus-server-position-point)))
309 (defun gnus-server-exit ()
310 "Return to the group buffer."
312 (kill-buffer (current-buffer))
313 (switch-to-buffer gnus-group-buffer)
314 (run-hooks 'gnus-server-exit-hook))
316 (defun gnus-server-list-servers ()
317 "List all available servers."
319 (let ((cur (gnus-server-server-name)))
320 (gnus-server-prepare)
321 (if cur (gnus-server-goto-server cur)
322 (goto-char (point-max))
324 (gnus-server-position-point)))
326 (defun gnus-server-set-status (method status)
327 "Make METHOD have STATUS."
328 (let ((entry (assoc method gnus-opened-servers)))
330 (setcar (cdr entry) status)
331 (push (list method status) gnus-opened-servers))))
333 (defun gnus-opened-servers-remove (method)
334 "Remove METHOD from the list of opened servers."
335 (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
336 gnus-opened-servers)))
338 (defun gnus-server-open-server (server)
339 "Force an open of SERVER."
340 (interactive (list (gnus-server-server-name)))
341 (let ((method (gnus-server-to-method server)))
343 (error "No such server: %s" server))
344 (gnus-server-set-status method 'ok)
346 (or (gnus-open-server method)
347 (progn (message "Couldn't open %s" server) nil))
348 (gnus-server-update-server server)
349 (gnus-server-position-point))))
351 (defun gnus-server-open-all-servers ()
354 (let ((servers gnus-inserted-opened-servers))
356 (gnus-server-open-server (car (pop servers))))))
358 (defun gnus-server-close-server (server)
360 (interactive (list (gnus-server-server-name)))
361 (let ((method (gnus-server-to-method server)))
363 (error "No such server: %s" server))
364 (gnus-server-set-status method 'closed)
366 (gnus-close-server method)
367 (gnus-server-update-server server)
368 (gnus-server-position-point))))
370 (defun gnus-server-close-all-servers ()
373 (let ((servers gnus-inserted-opened-servers))
375 (gnus-server-close-server (car (pop servers))))))
377 (defun gnus-server-deny-server (server)
378 "Make sure SERVER will never be attempted opened."
379 (interactive (list (gnus-server-server-name)))
380 (let ((method (gnus-server-to-method server)))
382 (error "No such server: %s" server))
383 (gnus-server-set-status method 'denied))
384 (gnus-server-update-server server)
385 (gnus-server-position-point)
388 (defun gnus-server-remove-denials ()
389 "Make all denied servers into closed servers."
391 (let ((servers gnus-opened-servers))
393 (when (eq (nth 1 (car servers)) 'denied)
394 (setcar (nthcdr 1 (car servers)) 'closed))
395 (setq servers (cdr servers))))
396 (gnus-server-list-servers))
398 (defun gnus-server-copy-server (from to)
401 (unless (gnus-server-server-name)
402 (error "No server on the current line"))
403 (read-string "Copy to: ")))
405 (error "No server on current line"))
406 (unless (and to (not (string= to "")))
407 (error "No name to copy to"))
408 (when (assoc to gnus-server-alist)
409 (error "%s already exists" to))
410 (unless (assoc from gnus-server-alist)
411 (error "%s: no such server" from))
412 (let ((to-entry (gnus-copy-sequence (assoc from gnus-server-alist))))
414 (setcar (nthcdr 2 to-entry) to)
415 (push to-entry gnus-server-killed-servers)
416 (gnus-server-yank-server)))
418 (defun gnus-server-add-server (how where)
420 (list (intern (completing-read "Server method: "
421 gnus-valid-select-methods nil t))
422 (read-string "Server name: ")))
423 (push (list where how where) gnus-server-killed-servers)
424 (gnus-server-yank-server))
426 (defun gnus-server-goto-server (server)
427 "Jump to a server line."
429 (list (completing-read "Goto server: " gnus-server-alist nil t)))
430 (let ((to (text-property-any (point-min) (point-max)
431 'gnus-server (intern server))))
434 (gnus-server-position-point))))
436 (defun gnus-server-edit-server (server)
437 "Edit the server on the current line."
438 (interactive (list (gnus-server-server-name)))
440 (error "No server on current line"))
441 (unless (assoc server gnus-server-alist)
442 (error "This server can't be edited"))
443 (let ((info (cdr (assoc server gnus-server-alist))))
444 (gnus-close-server info)
446 info "Editing the server."
448 (gnus-server-set-info ,server form)
449 (gnus-server-list-servers)
450 (gnus-server-position-point)))))
452 (defun gnus-server-scan-server (server)
453 "Request a scan from the current server."
454 (interactive (list (gnus-server-server-name)))
455 (gnus-message 3 "Scanning %s...done" server)
456 (gnus-request-scan nil (gnus-server-to-method server))
457 (gnus-message 3 "Scanning %s...done" server))
459 (defun gnus-server-read-server (server)
461 (interactive (list (gnus-server-server-name)))
462 (let ((buf (current-buffer)))
464 (gnus-browse-foreign-server (gnus-server-to-method server) buf)
467 (gnus-server-update-server (gnus-server-server-name))
468 (gnus-server-position-point)))))
470 (defun gnus-server-pick-server (e)
473 (gnus-server-read-server (gnus-server-server-name)))
477 ;;; Browse Server Mode
480 (defvar gnus-browse-menu-hook nil
481 "*Hook run after the creation of the browse mode menu.")
483 (defvar gnus-browse-mode-hook nil)
484 (defvar gnus-browse-mode-map nil)
485 (put 'gnus-browse-mode 'mode-class 'special)
487 (unless gnus-browse-mode-map
488 (setq gnus-browse-mode-map (make-keymap))
489 (suppress-keymap gnus-browse-mode-map)
493 " " gnus-browse-read-group
494 "=" gnus-browse-select-group
495 "n" gnus-browse-next-group
496 "p" gnus-browse-prev-group
497 "\177" gnus-browse-prev-group
498 "N" gnus-browse-next-group
499 "P" gnus-browse-prev-group
500 "\M-n" gnus-browse-next-group
501 "\M-p" gnus-browse-prev-group
502 "\r" gnus-browse-select-group
503 "u" gnus-browse-unsubscribe-current-group
508 "\C-c\C-c" gnus-browse-exit
509 "?" gnus-browse-describe-briefly
511 "\C-c\C-i" gnus-info-find-node))
513 (defun gnus-browse-make-menu-bar ()
514 (gnus-turn-off-edit-menu 'browse)
515 (unless (boundp 'gnus-browse-menu)
517 gnus-browse-menu gnus-browse-mode-map ""
519 ["Subscribe" gnus-browse-unsubscribe-current-group t]
520 ["Read" gnus-browse-read-group t]
521 ["Select" gnus-browse-read-group t]
522 ["Next" gnus-browse-next-group t]
523 ["Prev" gnus-browse-next-group t]
524 ["Exit" gnus-browse-exit t]
526 (run-hooks 'gnus-browse-menu-hook)))
528 (defvar gnus-browse-current-method nil)
529 (defvar gnus-browse-return-buffer nil)
531 (defvar gnus-browse-buffer "*Gnus Browse Server*")
533 (defun gnus-browse-foreign-server (method &optional return-buffer)
534 "Browse the server METHOD."
535 (setq gnus-browse-current-method method)
536 (setq gnus-browse-return-buffer return-buffer)
537 (let ((gnus-select-method method)
539 (gnus-message 5 "Connecting to %s..." (nth 1 method))
541 ((not (gnus-check-server method))
543 1 "Unable to contact server: %s" (gnus-status-message method))
547 (gnus-message 6 "Reading active file...")
548 (gnus-request-list method)
549 (gnus-message 6 "Reading active file...done")))
551 1 "Couldn't request list: %s" (gnus-status-message method))
554 (get-buffer-create gnus-browse-buffer)
555 (gnus-add-current-to-buffer-list)
557 (gnus-carpal-setup-buffer 'browse))
558 (gnus-configure-windows 'browse)
559 (buffer-disable-undo (current-buffer))
560 (let ((buffer-read-only nil))
563 (setq mode-line-buffer-identification
566 "Gnus: %%b {%s:%s}" (car method) (cadr method))))
568 (set-buffer nntp-server-buffer)
569 (let ((cur (current-buffer)))
570 (goto-char (point-min))
571 (unless (string= gnus-ignored-newsgroups "")
572 (delete-matching-lines gnus-ignored-newsgroups))
573 (while (re-search-forward
574 "\\(^[^ \t]+\\)[ \t]+[0-9]+[ \t]+[0-9]+" nil t)
575 (goto-char (match-end 1))
576 (push (cons (match-string 1)
577 (max 0 (- (1+ (read cur)) (read cur))))
579 (setq groups (sort groups
581 (string< (car l1) (car l2)))))
582 (let ((buffer-read-only nil))
584 (setq group (car groups))
586 (format "K%7d: %s\n" (cdr group) (car group)))
587 (setq groups (cdr groups))))
588 (switch-to-buffer (current-buffer))
589 (goto-char (point-min))
590 (gnus-group-position-point)
591 (gnus-message 5 "Connecting to %s...done" (nth 1 method))
594 (defun gnus-browse-mode ()
595 "Major mode for browsing a foreign server.
597 All normal editing commands are switched off.
599 \\<gnus-browse-mode-map>
600 The only things you can do in this buffer is
602 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
603 The group will be inserted into the group buffer upon exit from this
606 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
608 3) `\\[gnus-browse-exit]' to return to the group buffer."
610 (kill-all-local-variables)
611 (when (and menu-bar-mode
612 (gnus-visual-p 'browse-menu 'menu))
613 (gnus-browse-make-menu-bar))
614 (gnus-simplify-mode-line)
615 (setq major-mode 'gnus-browse-mode)
616 (setq mode-name "Browse Server")
617 (setq mode-line-process nil)
618 (use-local-map gnus-browse-mode-map)
619 (buffer-disable-undo (current-buffer))
620 (setq truncate-lines t)
621 (gnus-set-default-directory)
622 (setq buffer-read-only t)
623 (run-hooks 'gnus-browse-mode-hook))
625 (defun gnus-browse-read-group (&optional no-article)
626 "Enter the group at the current line."
628 (let ((group (gnus-browse-group-name)))
629 (unless (gnus-group-read-ephemeral-group
630 group gnus-browse-current-method nil
631 (cons (current-buffer) 'browse))
632 (error "Couldn't enter %s" group))))
634 (defun gnus-browse-select-group ()
635 "Select the current group."
637 (gnus-browse-read-group 'no))
639 (defun gnus-browse-next-group (n)
640 "Go to the next group."
644 (gnus-group-position-point)))
646 (defun gnus-browse-prev-group (n)
647 "Go to the next group."
649 (gnus-browse-next-group (- n)))
651 (defun gnus-browse-unsubscribe-current-group (arg)
652 "(Un)subscribe to the next ARG groups."
655 (error "No group at current line."))
656 (let ((ward (if (< arg 0) -1 1))
658 (while (and (> arg 0)
660 (gnus-browse-unsubscribe-group)
661 (zerop (gnus-browse-next-group ward)))
663 (gnus-group-position-point)
665 (gnus-message 7 "No more newsgroups"))
668 (defun gnus-browse-group-name ()
671 (when (re-search-forward ": \\(.*\\)$" (gnus-point-at-eol) t)
672 (gnus-group-prefixed-name (match-string 1) gnus-browse-current-method))))
674 (defun gnus-browse-unsubscribe-group ()
675 "Toggle subscription of the current group in the browse buffer."
677 (buffer-read-only nil)
681 ;; If this group it killed, then we want to subscribe it.
682 (when (= (following-char) ?K)
684 (setq group (gnus-browse-group-name))
685 ;; Make sure the group has been properly removed before we
687 (gnus-kill-ephemeral-group group)
691 (gnus-group-change-level
692 (list t group gnus-level-default-subscribed
693 nil nil gnus-browse-current-method)
694 gnus-level-default-subscribed gnus-level-killed
695 (and (car (nth 1 gnus-newsrc-alist))
696 (gnus-gethash (car (nth 1 gnus-newsrc-alist))
700 (gnus-group-change-level
701 group gnus-level-killed gnus-level-default-subscribed)
705 (defun gnus-browse-exit ()
706 "Quit browsing and return to the group buffer."
708 (when (eq major-mode 'gnus-browse-mode)
709 (kill-buffer (current-buffer)))
710 ;; Insert the newly subscribed groups in the group buffer.
712 (set-buffer gnus-group-buffer)
713 (gnus-group-list-groups nil))
714 (if gnus-browse-return-buffer
715 (gnus-configure-windows 'server 'force)
716 (gnus-configure-windows 'group 'force)))
718 (defun gnus-browse-describe-briefly ()
719 "Give a one line description of the group mode commands."
722 (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")))
726 ;;; gnus-srvr.el ends here.