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 ["Regenerate" gnus-server-regenerate-server t]
87 ["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]))
100 (run-hooks 'gnus-server-menu-hook)))
102 (defvar gnus-server-mode-map nil)
103 (put 'gnus-server-mode 'mode-class 'special)
105 (unless gnus-server-mode-map
106 (setq gnus-server-mode-map (make-sparse-keymap))
107 (suppress-keymap gnus-server-mode-map)
111 " " gnus-server-read-server
112 "\r" gnus-server-read-server
113 gnus-mouse-2 gnus-server-pick-server
115 "l" gnus-server-list-servers
116 "k" gnus-server-kill-server
117 "y" gnus-server-yank-server
118 "c" gnus-server-copy-server
119 "a" gnus-server-add-server
120 "e" gnus-server-edit-server
121 "s" gnus-server-scan-server
123 "O" gnus-server-open-server
124 "\M-o" gnus-server-open-all-servers
125 "C" gnus-server-close-server
126 "\M-c" gnus-server-close-all-servers
127 "D" gnus-server-deny-server
128 "R" gnus-server-remove-denials
130 "g" gnus-server-regenerate-server
132 "\C-c\C-i" gnus-info-find-node))
134 (defun gnus-server-mode ()
135 "Major mode for listing and editing servers.
137 All normal editing commands are switched off.
138 \\<gnus-server-mode-map>
139 For more in-depth information on this mode, read the manual
140 (`\\[gnus-info-find-node]').
142 The following commands are available:
144 \\{gnus-server-mode-map}"
146 (when (and menu-bar-mode
147 (gnus-visual-p 'server-menu 'menu))
148 (gnus-server-make-menu-bar))
149 (kill-all-local-variables)
150 (gnus-simplify-mode-line)
151 (setq major-mode 'gnus-server-mode)
152 (setq mode-name "Server")
153 (gnus-set-default-directory)
154 (setq mode-line-process nil)
155 (use-local-map gnus-server-mode-map)
156 (buffer-disable-undo (current-buffer))
157 (setq truncate-lines t)
158 (setq buffer-read-only t)
159 (run-hooks 'gnus-server-mode-hook))
161 (defun gnus-server-insert-server-line (name method)
162 (let* ((how (car method))
163 (where (nth 1 method))
164 (elem (assoc method gnus-opened-servers))
165 (status (cond ((eq (nth 1 elem) 'denied)
167 ((or (gnus-server-opened method)
168 (eq (nth 1 elem) 'ok))
173 (gnus-add-text-properties
177 (eval gnus-server-line-format-spec))
178 (list 'gnus-server (intern name)))))
180 (defun gnus-enter-server-buffer ()
181 "Set up the server buffer."
182 (gnus-server-setup-buffer)
183 (gnus-configure-windows 'server)
184 (gnus-server-prepare))
186 (defun gnus-server-setup-buffer ()
187 "Initialize the server buffer."
188 (unless (get-buffer gnus-server-buffer)
190 (set-buffer (get-buffer-create gnus-server-buffer))
193 (gnus-carpal-setup-buffer 'server)))))
195 (defun gnus-server-prepare ()
196 (setq gnus-server-mode-line-format-spec
197 (gnus-parse-format gnus-server-mode-line-format
198 gnus-server-mode-line-format-alist))
199 (setq gnus-server-line-format-spec
200 (gnus-parse-format gnus-server-line-format
201 gnus-server-line-format-alist t))
202 (let ((alist gnus-server-alist)
203 (buffer-read-only nil)
204 (opened gnus-opened-servers)
207 (setq gnus-inserted-opened-servers nil)
208 ;; First we do the real list of servers.
210 (push (cdr (setq server (pop alist))) done)
211 (when (and server (car server) (cdr server))
212 (gnus-server-insert-server-line (car server) (cdr server))))
213 ;; Then we insert the list of servers that have been opened in
216 (unless (member (caar opened) done)
217 (push (caar opened) done)
218 (gnus-server-insert-server-line
219 (setq op-ser (format "%s:%s" (caaar opened) (nth 1 (caar opened))))
221 (push (list op-ser (caar opened)) gnus-inserted-opened-servers))
222 (setq opened (cdr opened))))
223 (goto-char (point-min))
224 (gnus-server-position-point))
226 (defun gnus-server-server-name ()
227 (let ((server (get-text-property (gnus-point-at-bol) 'gnus-server)))
228 (and server (symbol-name server))))
230 (defalias 'gnus-server-position-point 'gnus-goto-colon)
232 (defconst gnus-server-edit-buffer "*Gnus edit server*")
234 (defun gnus-server-update-server (server)
236 (set-buffer gnus-server-buffer)
237 (let* ((buffer-read-only nil)
238 (entry (assoc server gnus-server-alist))
239 (oentry (assoc (gnus-server-to-method server)
240 gnus-opened-servers)))
243 (concat "(gnus-server-set-info \"" server "\" '"
244 (prin1-to-string (cdr entry)) ")
246 (when (or entry oentry)
247 ;; Buffer may be narrowed.
250 (when (gnus-server-goto-server server)
253 (gnus-server-insert-server-line (car entry) (cdr entry))
254 (gnus-server-insert-server-line
255 (format "%s:%s" (caar oentry) (nth 1 (car oentry)))
257 (gnus-server-position-point))))))
259 (defun gnus-server-set-info (server info)
260 ;; Enter a select method into the virtual server alist.
261 (when (and server info)
263 (concat "(gnus-server-set-info \"" server "\" '"
264 (prin1-to-string info) ")"))
265 (let* ((server (nth 1 info))
266 (entry (assoc server gnus-server-alist)))
267 (if entry (setcdr entry info)
268 (setq gnus-server-alist
269 (nconc gnus-server-alist (list (cons server info))))))))
271 ;;; Interactive server functions.
273 (defun gnus-server-kill-server (server)
274 "Kill the server on the current line."
275 (interactive (list (gnus-server-server-name)))
276 (unless (gnus-server-goto-server server)
277 (if server (error "No such server: %s" server)
278 (error "No server on the current line")))
279 (unless (assoc server gnus-server-alist)
280 (error "Read-only server %s" server))
281 (gnus-dribble-enter "")
282 (let ((buffer-read-only nil))
284 (push (assoc server gnus-server-alist) gnus-server-killed-servers)
285 (setq gnus-server-alist (delq (car gnus-server-killed-servers)
287 (gnus-server-position-point))
289 (defun gnus-server-yank-server ()
290 "Yank the previously killed server."
292 (unless gnus-server-killed-servers
293 (error "No killed servers to be yanked"))
294 (let ((alist gnus-server-alist)
295 (server (gnus-server-server-name))
296 (killed (car gnus-server-killed-servers)))
298 (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
299 (if (string= server (caar gnus-server-alist))
300 (push killed gnus-server-alist)
301 (while (and (cdr alist)
302 (not (string= server (caadr alist))))
303 (setq alist (cdr alist)))
305 (setcdr alist (cons killed (cdr alist)))
306 (setq gnus-server-alist (list killed)))))
307 (gnus-server-update-server (car killed))
308 (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
309 (gnus-server-position-point)))
311 (defun gnus-server-exit ()
312 "Return to the group buffer."
314 (kill-buffer (current-buffer))
315 (switch-to-buffer gnus-group-buffer)
316 (run-hooks 'gnus-server-exit-hook))
318 (defun gnus-server-list-servers ()
319 "List all available servers."
321 (let ((cur (gnus-server-server-name)))
322 (gnus-server-prepare)
323 (if cur (gnus-server-goto-server cur)
324 (goto-char (point-max))
326 (gnus-server-position-point)))
328 (defun gnus-server-set-status (method status)
329 "Make METHOD have STATUS."
330 (let ((entry (assoc method gnus-opened-servers)))
332 (setcar (cdr entry) status)
333 (push (list method status) gnus-opened-servers))))
335 (defun gnus-opened-servers-remove (method)
336 "Remove METHOD from the list of opened servers."
337 (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
338 gnus-opened-servers)))
340 (defun gnus-server-open-server (server)
341 "Force an open of SERVER."
342 (interactive (list (gnus-server-server-name)))
343 (let ((method (gnus-server-to-method server)))
345 (error "No such server: %s" server))
346 (gnus-server-set-status method 'ok)
348 (or (gnus-open-server method)
349 (progn (message "Couldn't open %s" server) nil))
350 (gnus-server-update-server server)
351 (gnus-server-position-point))))
353 (defun gnus-server-open-all-servers ()
356 (let ((servers gnus-inserted-opened-servers))
358 (gnus-server-open-server (car (pop servers))))))
360 (defun gnus-server-close-server (server)
362 (interactive (list (gnus-server-server-name)))
363 (let ((method (gnus-server-to-method server)))
365 (error "No such server: %s" server))
366 (gnus-server-set-status method 'closed)
368 (gnus-close-server method)
369 (gnus-server-update-server server)
370 (gnus-server-position-point))))
372 (defun gnus-server-close-all-servers ()
375 (let ((servers gnus-inserted-opened-servers))
377 (gnus-server-close-server (car (pop servers))))))
379 (defun gnus-server-deny-server (server)
380 "Make sure SERVER will never be attempted opened."
381 (interactive (list (gnus-server-server-name)))
382 (let ((method (gnus-server-to-method server)))
384 (error "No such server: %s" server))
385 (gnus-server-set-status method 'denied))
386 (gnus-server-update-server server)
387 (gnus-server-position-point)
390 (defun gnus-server-remove-denials ()
391 "Make all denied servers into closed servers."
393 (let ((servers gnus-opened-servers))
395 (when (eq (nth 1 (car servers)) 'denied)
396 (setcar (nthcdr 1 (car servers)) 'closed))
397 (setq servers (cdr servers))))
398 (gnus-server-list-servers))
400 (defun gnus-server-copy-server (from to)
403 (unless (gnus-server-server-name)
404 (error "No server on the current line"))
405 (read-string "Copy to: ")))
407 (error "No server on current line"))
408 (unless (and to (not (string= to "")))
409 (error "No name to copy to"))
410 (when (assoc to gnus-server-alist)
411 (error "%s already exists" to))
412 (unless (assoc from gnus-server-alist)
413 (error "%s: no such server" from))
414 (let ((to-entry (gnus-copy-sequence (assoc from gnus-server-alist))))
416 (setcar (nthcdr 2 to-entry) to)
417 (push to-entry gnus-server-killed-servers)
418 (gnus-server-yank-server)))
420 (defun gnus-server-add-server (how where)
422 (list (intern (completing-read "Server method: "
423 gnus-valid-select-methods nil t))
424 (read-string "Server name: ")))
425 (push (list where how where) gnus-server-killed-servers)
426 (gnus-server-yank-server))
428 (defun gnus-server-goto-server (server)
429 "Jump to a server line."
431 (list (completing-read "Goto server: " gnus-server-alist nil t)))
432 (let ((to (text-property-any (point-min) (point-max)
433 'gnus-server (intern server))))
436 (gnus-server-position-point))))
438 (defun gnus-server-edit-server (server)
439 "Edit the server on the current line."
440 (interactive (list (gnus-server-server-name)))
442 (error "No server on current line"))
443 (unless (assoc server gnus-server-alist)
444 (error "This server can't be edited"))
445 (let ((info (cdr (assoc server gnus-server-alist))))
446 (gnus-close-server info)
448 info "Editing the server."
450 (gnus-server-set-info ,server form)
451 (gnus-server-list-servers)
452 (gnus-server-position-point)))))
454 (defun gnus-server-scan-server (server)
455 "Request a scan from the current server."
456 (interactive (list (gnus-server-server-name)))
457 (gnus-message 3 "Scanning %s...done" server)
458 (gnus-request-scan nil (gnus-server-to-method server))
459 (gnus-message 3 "Scanning %s...done" server))
461 (defun gnus-server-read-server (server)
463 (interactive (list (gnus-server-server-name)))
464 (let ((buf (current-buffer)))
466 (gnus-browse-foreign-server (gnus-server-to-method server) buf)
469 (gnus-server-update-server (gnus-server-server-name))
470 (gnus-server-position-point)))))
472 (defun gnus-server-pick-server (e)
475 (gnus-server-read-server (gnus-server-server-name)))
479 ;;; Browse Server Mode
482 (defvar gnus-browse-menu-hook nil
483 "*Hook run after the creation of the browse mode menu.")
485 (defvar gnus-browse-mode-hook nil)
486 (defvar gnus-browse-mode-map nil)
487 (put 'gnus-browse-mode 'mode-class 'special)
489 (unless gnus-browse-mode-map
490 (setq gnus-browse-mode-map (make-keymap))
491 (suppress-keymap gnus-browse-mode-map)
495 " " gnus-browse-read-group
496 "=" gnus-browse-select-group
497 "n" gnus-browse-next-group
498 "p" gnus-browse-prev-group
499 "\177" gnus-browse-prev-group
500 "N" gnus-browse-next-group
501 "P" gnus-browse-prev-group
502 "\M-n" gnus-browse-next-group
503 "\M-p" gnus-browse-prev-group
504 "\r" gnus-browse-select-group
505 "u" gnus-browse-unsubscribe-current-group
510 "\C-c\C-c" gnus-browse-exit
511 "?" gnus-browse-describe-briefly
513 "\C-c\C-i" gnus-info-find-node))
515 (defun gnus-browse-make-menu-bar ()
516 (gnus-turn-off-edit-menu 'browse)
517 (unless (boundp 'gnus-browse-menu)
519 gnus-browse-menu gnus-browse-mode-map ""
521 ["Subscribe" gnus-browse-unsubscribe-current-group t]
522 ["Read" gnus-browse-read-group t]
523 ["Select" gnus-browse-read-group t]
524 ["Next" gnus-browse-next-group t]
525 ["Prev" gnus-browse-next-group t]
526 ["Exit" gnus-browse-exit t]
528 (run-hooks 'gnus-browse-menu-hook)))
530 (defvar gnus-browse-current-method nil)
531 (defvar gnus-browse-return-buffer nil)
533 (defvar gnus-browse-buffer "*Gnus Browse Server*")
535 (defun gnus-browse-foreign-server (method &optional return-buffer)
536 "Browse the server METHOD."
537 (setq gnus-browse-current-method method)
538 (setq gnus-browse-return-buffer return-buffer)
539 (let ((gnus-select-method method)
541 (gnus-message 5 "Connecting to %s..." (nth 1 method))
543 ((not (gnus-check-server method))
545 1 "Unable to contact server: %s" (gnus-status-message method))
549 (gnus-message 6 "Reading active file...")
550 (gnus-request-list method)
551 (gnus-message 6 "Reading active file...done")))
553 1 "Couldn't request list: %s" (gnus-status-message method))
556 (get-buffer-create gnus-browse-buffer)
557 (gnus-add-current-to-buffer-list)
559 (gnus-carpal-setup-buffer 'browse))
560 (gnus-configure-windows 'browse)
561 (buffer-disable-undo (current-buffer))
562 (let ((buffer-read-only nil))
565 (setq mode-line-buffer-identification
568 "Gnus: %%b {%s:%s}" (car method) (cadr method))))
570 (set-buffer nntp-server-buffer)
571 (let ((cur (current-buffer)))
572 (goto-char (point-min))
573 (unless (string= gnus-ignored-newsgroups "")
574 (delete-matching-lines gnus-ignored-newsgroups))
575 (while (re-search-forward
576 "\\(^[^ \t]+\\)[ \t]+[0-9]+[ \t]+[0-9]+" nil t)
577 (goto-char (match-end 1))
578 (push (cons (match-string 1)
579 (max 0 (- (1+ (read cur)) (read cur))))
581 (setq groups (sort groups
583 (string< (car l1) (car l2)))))
584 (let ((buffer-read-only nil))
586 (setq group (car groups))
588 (format "K%7d: %s\n" (cdr group) (car group)))
589 (setq groups (cdr groups))))
590 (switch-to-buffer (current-buffer))
591 (goto-char (point-min))
592 (gnus-group-position-point)
593 (gnus-message 5 "Connecting to %s...done" (nth 1 method))
596 (defun gnus-browse-mode ()
597 "Major mode for browsing a foreign server.
599 All normal editing commands are switched off.
601 \\<gnus-browse-mode-map>
602 The only things you can do in this buffer is
604 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
605 The group will be inserted into the group buffer upon exit from this
608 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
610 3) `\\[gnus-browse-exit]' to return to the group buffer."
612 (kill-all-local-variables)
613 (when (and menu-bar-mode
614 (gnus-visual-p 'browse-menu 'menu))
615 (gnus-browse-make-menu-bar))
616 (gnus-simplify-mode-line)
617 (setq major-mode 'gnus-browse-mode)
618 (setq mode-name "Browse Server")
619 (setq mode-line-process nil)
620 (use-local-map gnus-browse-mode-map)
621 (buffer-disable-undo (current-buffer))
622 (setq truncate-lines t)
623 (gnus-set-default-directory)
624 (setq buffer-read-only t)
625 (run-hooks 'gnus-browse-mode-hook))
627 (defun gnus-browse-read-group (&optional no-article)
628 "Enter the group at the current line."
630 (let ((group (gnus-group-real-name (gnus-browse-group-name))))
631 (unless (gnus-group-read-ephemeral-group
632 group gnus-browse-current-method nil
633 (cons (current-buffer) 'browse))
634 (error "Couldn't enter %s" group))))
636 (defun gnus-browse-select-group ()
637 "Select the current group."
639 (gnus-browse-read-group 'no))
641 (defun gnus-browse-next-group (n)
642 "Go to the next group."
646 (gnus-group-position-point)))
648 (defun gnus-browse-prev-group (n)
649 "Go to the next group."
651 (gnus-browse-next-group (- n)))
653 (defun gnus-browse-unsubscribe-current-group (arg)
654 "(Un)subscribe to the next ARG groups."
657 (error "No group at current line."))
658 (let ((ward (if (< arg 0) -1 1))
660 (while (and (> arg 0)
662 (gnus-browse-unsubscribe-group)
663 (zerop (gnus-browse-next-group ward)))
665 (gnus-group-position-point)
667 (gnus-message 7 "No more newsgroups"))
670 (defun gnus-browse-group-name ()
673 (when (re-search-forward ": \\(.*\\)$" (gnus-point-at-eol) t)
674 (gnus-group-prefixed-name (match-string 1) gnus-browse-current-method))))
676 (defun gnus-browse-unsubscribe-group ()
677 "Toggle subscription of the current group in the browse buffer."
679 (buffer-read-only nil)
683 ;; If this group it killed, then we want to subscribe it.
684 (when (= (following-char) ?K)
686 (setq group (gnus-browse-group-name))
687 ;; Make sure the group has been properly removed before we
689 (gnus-kill-ephemeral-group group)
693 (gnus-group-change-level
694 (list t group gnus-level-default-subscribed
695 nil nil gnus-browse-current-method)
696 gnus-level-default-subscribed gnus-level-killed
697 (and (car (nth 1 gnus-newsrc-alist))
698 (gnus-gethash (car (nth 1 gnus-newsrc-alist))
702 (gnus-group-change-level
703 group gnus-level-killed gnus-level-default-subscribed)
707 (defun gnus-browse-exit ()
708 "Quit browsing and return to the group buffer."
710 (when (eq major-mode 'gnus-browse-mode)
711 (kill-buffer (current-buffer)))
712 ;; Insert the newly subscribed groups in the group buffer.
714 (set-buffer gnus-group-buffer)
715 (gnus-group-list-groups nil))
716 (if gnus-browse-return-buffer
717 (gnus-configure-windows 'server 'force)
718 (gnus-configure-windows 'group 'force)))
720 (defun gnus-browse-describe-briefly ()
721 "Give a one line description of the group mode commands."
724 (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 (defun gnus-server-regenerate-server ()
727 "Issue a command to the server to regenerate all its data structures."
729 (let ((server (gnus-server-server-name)))
731 (error "No server on the current line"))
732 (if (not (gnus-check-backend-function
733 'request-regenerate (car (gnus-server-to-method server))))
734 (error "This backend doesn't support regeneration")
735 (gnus-message 5 "Requesing regeneration of %s..." server)
736 (when (gnus-request-regenerate server)
737 (gnus-message 5 "Requesing regeneration of %s...done" server)))))
741 ;;; gnus-srvr.el ends here.