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 (defvar gnus-server-exit-hook nil
43 "*Hook run when exiting the server buffer.")
45 ;;; Internal variables.
47 (defvar gnus-inserted-opened-servers nil)
49 (defvar gnus-server-line-format-alist
55 (defvar gnus-server-mode-line-format-alist
58 (?u user-defined ?s)))
60 (defvar gnus-server-line-format-spec nil)
61 (defvar gnus-server-mode-line-format-spec nil)
62 (defvar gnus-server-killed-servers nil)
64 (defvar gnus-server-mode-map)
66 (defvar gnus-server-menu-hook nil
67 "*Hook run after the creation of the server mode menu.")
69 (defun gnus-server-make-menu-bar ()
70 (gnus-visual-turn-off-edit-menu 'server)
71 (unless (boundp 'gnus-server-menu)
73 gnus-server-menu gnus-server-mode-map ""
75 ["Add" gnus-server-add-server t]
76 ["Browse" gnus-server-read-server t]
77 ["List" gnus-server-list-servers t]
78 ["Kill" gnus-server-kill-server t]
79 ["Yank" gnus-server-yank-server t]
80 ["Copy" gnus-server-copy-server t]
81 ["Edit" gnus-server-edit-server t]
82 ["Exit" gnus-server-exit t]
86 gnus-server-menu gnus-server-mode-map ""
88 ["Open" gnus-server-open-server t]
89 ["Close" gnus-server-close-server t]
90 ["Deny" gnus-server-deny-server t]
91 ["Reset" gnus-server-remove-denials t]
94 (run-hooks 'gnus-server-menu-hook)))
96 (defvar gnus-server-mode-map nil)
97 (put 'gnus-server-mode 'mode-class 'special)
99 (unless gnus-server-mode-map
100 (setq gnus-server-mode-map (make-sparse-keymap))
101 (suppress-keymap gnus-server-mode-map)
105 " " gnus-server-read-server
106 "\r" gnus-server-read-server
107 gnus-mouse-2 gnus-server-pick-server
109 "l" gnus-server-list-servers
110 "k" gnus-server-kill-server
111 "y" gnus-server-yank-server
112 "c" gnus-server-copy-server
113 "a" gnus-server-add-server
114 "e" gnus-server-edit-server
116 "O" gnus-server-open-server
117 "C" gnus-server-close-server
118 "D" gnus-server-deny-server
119 "R" gnus-server-remove-denials))
121 (defun gnus-server-mode ()
122 "Major mode for listing and editing servers.
124 All normal editing commands are switched off.
125 \\<gnus-server-mode-map>
126 For more in-depth information on this mode, read the manual
127 (`\\[gnus-info-find-node]').
129 The following commands are available:
131 \\{gnus-server-mode-map}"
133 (when (and menu-bar-mode
134 (gnus-visual-p 'server-menu 'menu))
135 (gnus-server-make-menu-bar))
136 (kill-all-local-variables)
137 (gnus-simplify-mode-line)
138 (setq major-mode 'gnus-server-mode)
139 (setq mode-name "Server")
140 ; (gnus-group-set-mode-line)
141 (setq mode-line-process nil)
142 (use-local-map gnus-server-mode-map)
143 (buffer-disable-undo (current-buffer))
144 (setq truncate-lines t)
145 (setq buffer-read-only t)
146 (run-hooks 'gnus-server-mode-hook))
148 (defun gnus-server-insert-server-line (name method)
149 (let* ((how (car method))
150 (where (nth 1 method))
151 (elem (assoc method gnus-opened-servers))
152 (status (cond ((eq (nth 1 elem) 'denied)
154 ((or (gnus-server-opened method)
155 (eq (nth 1 elem) 'ok))
160 (gnus-add-text-properties
164 (eval gnus-server-line-format-spec))
165 (list 'gnus-server (intern name)))))
167 (defun gnus-enter-server-buffer ()
168 "Set up the server buffer."
169 (gnus-server-setup-buffer)
170 (gnus-configure-windows 'server)
171 (gnus-server-prepare))
173 (defun gnus-server-setup-buffer ()
174 "Initialize the server buffer."
175 (unless (get-buffer gnus-server-buffer)
177 (set-buffer (get-buffer-create gnus-server-buffer))
180 (gnus-carpal-setup-buffer 'server)))))
182 (defun gnus-server-prepare ()
183 (setq gnus-server-mode-line-format-spec
184 (gnus-parse-format gnus-server-mode-line-format
185 gnus-server-mode-line-format-alist))
186 (setq gnus-server-line-format-spec
187 (gnus-parse-format gnus-server-line-format
188 gnus-server-line-format-alist t))
189 (let ((alist gnus-server-alist)
190 (buffer-read-only nil)
191 (opened gnus-opened-servers)
194 (setq gnus-inserted-opened-servers nil)
195 ;; First we do the real list of servers.
197 (push (cdr (setq server (pop alist))) done)
198 (when (and server (car server) (cdr server))
199 (gnus-server-insert-server-line (car server) (cdr server))))
200 ;; Then we insert the list of servers that have been opened in
203 (unless (member (caar opened) done)
204 (gnus-server-insert-server-line
205 (setq op-ser (format "%s:%s" (caaar opened) (nth 1 (caar opened))))
207 (push (list op-ser (caar opened)) gnus-inserted-opened-servers))
208 (setq opened (cdr opened))))
209 (goto-char (point-min))
210 (gnus-server-position-point))
212 (defun gnus-server-server-name ()
213 (let ((server (get-text-property (gnus-point-at-bol) 'gnus-server)))
214 (and server (symbol-name server))))
216 (defalias 'gnus-server-position-point 'gnus-goto-colon)
218 (defconst gnus-server-edit-buffer "*Gnus edit server*")
220 (defun gnus-server-update-server (server)
222 (set-buffer gnus-server-buffer)
223 (let* ((buffer-read-only nil)
224 (entry (assoc server gnus-server-alist)))
227 (concat "(gnus-server-set-info \"" server "\" '"
228 (prin1-to-string (cdr entry)) ")"))
229 ;; Buffer may be narrowed.
232 (when (gnus-server-goto-server server)
234 (gnus-server-insert-server-line (car entry) (cdr entry))
235 (gnus-server-position-point))))))
237 (defun gnus-server-set-info (server info)
238 ;; Enter a select method into the virtual server alist.
239 (when (and server info)
241 (concat "(gnus-server-set-info \"" server "\" '"
242 (prin1-to-string info) ")"))
243 (let* ((server (nth 1 info))
244 (entry (assoc server gnus-server-alist)))
245 (if entry (setcdr entry info)
246 (setq gnus-server-alist
247 (nconc gnus-server-alist (list (cons server info))))))))
249 ;;; Interactive server functions.
251 (defun gnus-server-kill-server (server)
252 "Kill the server on the current line."
253 (interactive (list (gnus-server-server-name)))
254 (unless (gnus-server-goto-server server)
255 (if server (error "No such server: %s" server)
256 (error "No server on the current line")))
257 (unless (assoc server gnus-server-alist)
258 (error "Read-only server %s" server))
259 (gnus-dribble-enter "")
260 (let ((buffer-read-only nil))
262 (setq gnus-server-killed-servers
263 (cons (assoc server gnus-server-alist) gnus-server-killed-servers))
264 (setq gnus-server-alist (delq (car gnus-server-killed-servers)
266 (gnus-server-position-point))
268 (defun gnus-server-yank-server ()
269 "Yank the previously killed server."
271 (or gnus-server-killed-servers
272 (error "No killed servers to be yanked"))
273 (let ((alist gnus-server-alist)
274 (server (gnus-server-server-name))
275 (killed (car gnus-server-killed-servers)))
277 (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
278 (if (string= server (caar gnus-server-alist))
279 (setq gnus-server-alist (cons killed gnus-server-alist))
280 (while (and (cdr alist)
281 (not (string= server (caadr alist))))
282 (setq alist (cdr alist)))
284 (setcdr alist (cons killed (cdr alist)))
285 (setq gnus-server-alist (list killed)))))
286 (gnus-server-update-server (car killed))
287 (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
288 (gnus-server-position-point)))
290 (defun gnus-server-exit ()
291 "Return to the group buffer."
293 (kill-buffer (current-buffer))
294 (switch-to-buffer gnus-group-buffer)
295 (run-hooks 'gnus-server-exit-hook))
297 (defun gnus-server-list-servers ()
298 "List all available servers."
300 (let ((cur (gnus-server-server-name)))
301 (gnus-server-prepare)
302 (if cur (gnus-server-goto-server cur)
303 (goto-char (point-max))
305 (gnus-server-position-point)))
307 (defun gnus-opened-servers-remove (method)
308 "Remove METHOD from the list of opened servers."
309 (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
310 gnus-opened-servers)))
312 (defun gnus-server-open-server (server)
313 "Force an open of SERVER."
314 (interactive (list (gnus-server-server-name)))
315 (let ((method (gnus-server-to-method server)))
316 (or method (error "No such server: %s" server))
317 (gnus-opened-servers-remove method)
319 (or (gnus-open-server method)
320 (progn (message "Couldn't open %s" server) nil))
321 (gnus-server-update-server server)
322 (gnus-server-position-point))))
324 (defun gnus-server-close-server (server)
326 (interactive (list (gnus-server-server-name)))
327 (let ((method (gnus-server-to-method server)))
328 (or method (error "No such server: %s" server))
329 (gnus-opened-servers-remove method)
331 (gnus-close-server method)
332 (gnus-server-update-server server)
333 (gnus-server-position-point))))
335 (defun gnus-server-deny-server (server)
336 "Make sure SERVER will never be attempted opened."
337 (interactive (list (gnus-server-server-name)))
338 (let ((method (gnus-server-to-method server)))
339 (or method (error "No such server: %s" server))
340 (gnus-opened-servers-remove method)
341 (setq gnus-opened-servers
342 (cons (list method 'denied) gnus-opened-servers)))
343 (gnus-server-update-server server)
344 (gnus-server-position-point))
346 (defun gnus-server-remove-denials ()
347 "Make all denied servers into closed servers."
349 (let ((servers gnus-opened-servers))
351 (when (eq (nth 1 (car servers)) 'denied)
352 (setcar (nthcdr 1 (car servers)) 'closed))
353 (setq servers (cdr servers))))
354 (gnus-server-list-servers))
356 (defun gnus-server-copy-server (from to)
359 (or (gnus-server-server-name)
360 (error "No server on the current line"))
361 (read-string "Copy to: ")))
362 (or from (error "No server on current line"))
363 (or (and to (not (string= to ""))) (error "No name to copy to"))
364 (and (assoc to gnus-server-alist) (error "%s already exists" to))
365 (or (assoc from gnus-server-alist)
366 (error "%s: no such server" from))
367 (let ((to-entry (gnus-copy-sequence (assoc from gnus-server-alist))))
369 (setcar (nthcdr 2 to-entry) to)
370 (setq gnus-server-killed-servers
371 (cons to-entry gnus-server-killed-servers))
372 (gnus-server-yank-server)))
374 (defun gnus-server-add-server (how where)
376 (list (intern (completing-read "Server method: "
377 gnus-valid-select-methods nil t))
378 (read-string "Server name: ")))
379 (setq gnus-server-killed-servers
380 (cons (list where how where) gnus-server-killed-servers))
381 (gnus-server-yank-server))
383 (defun gnus-server-goto-server (server)
384 "Jump to a server line."
386 (list (completing-read "Goto server: " gnus-server-alist nil t)))
387 (let ((to (text-property-any (point-min) (point-max)
388 'gnus-server (intern server))))
392 (gnus-server-position-point)))))
394 (defun gnus-server-edit-server (server)
395 "Edit the server on the current line."
396 (interactive (list (gnus-server-server-name)))
398 (error "No server on current line"))
399 (unless (assoc server gnus-server-alist)
400 (error "This server can't be edited"))
401 (let ((winconf (current-window-configuration))
402 (info (cdr (assoc server gnus-server-alist))))
403 (gnus-close-server info)
404 (get-buffer-create gnus-server-edit-buffer)
405 (gnus-configure-windows 'edit-server)
406 (gnus-add-current-to-buffer-list)
408 (make-local-variable 'gnus-prev-winconf)
409 (setq gnus-prev-winconf winconf)
410 (use-local-map (copy-keymap (current-local-map)))
411 (let ((done-func '(lambda ()
412 "Exit editing mode and update the information."
414 (gnus-server-edit-server-done 'group))))
415 (setcar (cdr (nth 4 done-func)) server)
416 (local-set-key "\C-c\C-c" done-func))
418 (insert ";; Type `C-c C-c' after you have edited the server.\n\n")
419 (insert (pp-to-string info))))
421 (defun gnus-server-edit-server-done (server)
423 (set-buffer (get-buffer-create gnus-server-edit-buffer))
424 (goto-char (point-min))
425 (let ((form (read (current-buffer)))
426 (winconf gnus-prev-winconf))
427 (gnus-server-set-info server form)
428 (kill-buffer (current-buffer))
429 (and winconf (set-window-configuration winconf))
430 (set-buffer gnus-server-buffer)
431 (gnus-server-update-server server)
432 (gnus-server-list-servers)
433 (gnus-server-position-point)))
435 (defun gnus-server-read-server (server)
437 (interactive (list (gnus-server-server-name)))
438 (let ((buf (current-buffer)))
440 (gnus-browse-foreign-server (gnus-server-to-method server) buf)
443 (gnus-server-update-server (gnus-server-server-name))
444 (gnus-server-position-point)))))
446 (defun gnus-server-pick-server (e)
449 (gnus-server-read-server (gnus-server-server-name)))
453 ;;; Browse Server Mode
456 (defvar gnus-browse-menu-hook nil
457 "*Hook run after the creation of the browse mode menu.")
459 (defvar gnus-browse-mode-hook nil)
460 (defvar gnus-browse-mode-map nil)
461 (put 'gnus-browse-mode 'mode-class 'special)
463 (unless gnus-browse-mode-map
464 (setq gnus-browse-mode-map (make-keymap))
465 (suppress-keymap gnus-browse-mode-map)
469 " " gnus-browse-read-group
470 "=" gnus-browse-select-group
471 "n" gnus-browse-next-group
472 "p" gnus-browse-prev-group
473 "\177" gnus-browse-prev-group
474 "N" gnus-browse-next-group
475 "P" gnus-browse-prev-group
476 "\M-n" gnus-browse-next-group
477 "\M-p" gnus-browse-prev-group
478 "\r" gnus-browse-select-group
479 "u" gnus-browse-unsubscribe-current-group
484 "\C-c\C-c" gnus-browse-exit
485 "?" gnus-browse-describe-briefly
486 "\C-c\C-i" gnus-info-find-node))
488 (defun gnus-browse-make-menu-bar ()
489 (gnus-visual-turn-off-edit-menu 'browse)
491 (boundp 'gnus-browse-menu)
494 gnus-browse-menu gnus-browse-mode-map ""
496 ["Subscribe" gnus-browse-unsubscribe-current-group t]
497 ["Read" gnus-browse-read-group t]
498 ["Select" gnus-browse-read-group t]
499 ["Next" gnus-browse-next-group t]
500 ["Prev" gnus-browse-next-group t]
501 ["Exit" gnus-browse-exit t]
503 (run-hooks 'gnus-browse-menu-hook))))
505 (defvar gnus-browse-current-method nil)
506 (defvar gnus-browse-return-buffer nil)
508 (defvar gnus-browse-buffer "*Gnus Browse Server*")
510 (defun gnus-browse-foreign-server (method &optional return-buffer)
511 "Browse the server METHOD."
512 (setq gnus-browse-current-method method)
513 (setq gnus-browse-return-buffer return-buffer)
514 (let ((gnus-select-method method)
516 (gnus-message 5 "Connecting to %s..." (nth 1 method))
518 ((not (gnus-check-server method))
520 1 "Unable to contact server: %s" (gnus-status-message method))
522 ((not (gnus-request-list method))
524 1 "Couldn't request list: %s" (gnus-status-message method))
527 (get-buffer-create gnus-browse-buffer)
528 (gnus-add-current-to-buffer-list)
529 (and gnus-carpal (gnus-carpal-setup-buffer 'browse))
530 (gnus-configure-windows 'browse)
531 (buffer-disable-undo (current-buffer))
532 (let ((buffer-read-only nil))
535 (setq mode-line-buffer-identification
538 "Gnus: %%b {%s:%s}" (car method) (cadr method))))
540 (set-buffer nntp-server-buffer)
541 (let ((cur (current-buffer)))
542 (goto-char (point-min))
543 (or (string= gnus-ignored-newsgroups "")
544 (delete-matching-lines gnus-ignored-newsgroups))
545 (while (re-search-forward
546 "\\(^[^ \t]+\\)[ \t]+[0-9]+[ \t]+[0-9]+" nil t)
547 (goto-char (match-end 1))
548 (setq groups (cons (cons (match-string 1)
549 (max 0 (- (1+ (read cur)) (read cur))))
551 (setq groups (sort groups
553 (string< (car l1) (car l2)))))
554 (let ((buffer-read-only nil))
556 (setq group (car groups))
558 (format "K%7d: %s\n" (cdr group) (car group)))
559 (setq groups (cdr groups))))
560 (switch-to-buffer (current-buffer))
561 (goto-char (point-min))
562 (gnus-group-position-point)
563 (gnus-message 5 "Connecting to %s...done" (nth 1 method))
566 (defun gnus-browse-mode ()
567 "Major mode for browsing a foreign server.
569 All normal editing commands are switched off.
571 \\<gnus-browse-mode-map>
572 The only things you can do in this buffer is
574 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
575 The group will be inserted into the group buffer upon exit from this
578 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
580 3) `\\[gnus-browse-exit]' to return to the group buffer."
582 (kill-all-local-variables)
583 (when (and menu-bar-mode
584 (gnus-visual-p 'browse-menu 'menu))
585 (gnus-browse-make-menu-bar))
586 (gnus-simplify-mode-line)
587 (setq major-mode 'gnus-browse-mode)
588 (setq mode-name "Browse Server")
589 (setq mode-line-process nil)
590 (use-local-map gnus-browse-mode-map)
591 (buffer-disable-undo (current-buffer))
592 (setq truncate-lines t)
593 (setq buffer-read-only t)
594 (run-hooks 'gnus-browse-mode-hook))
596 (defun gnus-browse-read-group (&optional no-article)
597 "Enter the group at the current line."
599 (let ((group (gnus-browse-group-name)))
600 (or (gnus-group-read-ephemeral-group
601 group gnus-browse-current-method nil
602 (cons (current-buffer) 'browse))
603 (error "Couldn't enter %s" group))))
605 (defun gnus-browse-select-group ()
606 "Select the current group."
608 (gnus-browse-read-group 'no))
610 (defun gnus-browse-next-group (n)
611 "Go to the next group."
615 (gnus-group-position-point)))
617 (defun gnus-browse-prev-group (n)
618 "Go to the next group."
620 (gnus-browse-next-group (- n)))
622 (defun gnus-browse-unsubscribe-current-group (arg)
623 "(Un)subscribe to the next ARG groups."
626 (error "No group at current line."))
627 (let ((ward (if (< arg 0) -1 1))
629 (while (and (> arg 0)
631 (gnus-browse-unsubscribe-group)
632 (zerop (gnus-browse-next-group ward)))
634 (gnus-group-position-point)
635 (if (/= 0 arg) (gnus-message 7 "No more newsgroups"))
638 (defun gnus-browse-group-name ()
641 (when (re-search-forward ": \\(.*\\)$" (gnus-point-at-eol) t)
642 (gnus-group-prefixed-name (match-string 1) gnus-browse-current-method))))
644 (defun gnus-browse-unsubscribe-group ()
645 "Toggle subscription of the current group in the browse buffer."
647 (buffer-read-only nil)
651 ;; If this group it killed, then we want to subscribe it.
652 (if (= (following-char) ?K) (setq sub t))
653 (setq group (gnus-browse-group-name))
657 (gnus-group-change-level
658 (list t group gnus-level-default-subscribed
659 nil nil gnus-browse-current-method)
660 gnus-level-default-subscribed gnus-level-killed
661 (and (car (nth 1 gnus-newsrc-alist))
662 (gnus-gethash (car (nth 1 gnus-newsrc-alist))
666 (gnus-group-change-level
667 group gnus-level-killed gnus-level-default-subscribed)
671 (defun gnus-browse-exit ()
672 "Quit browsing and return to the group buffer."
674 (when (eq major-mode 'gnus-browse-mode)
675 (kill-buffer (current-buffer)))
676 ;; Insert the newly subscribed groups in the group buffer.
678 (set-buffer gnus-group-buffer)
679 (gnus-group-list-groups nil))
680 (if gnus-browse-return-buffer
681 (gnus-configure-windows 'server 'force)
682 (gnus-configure-windows 'group 'force)))
684 (defun gnus-browse-describe-briefly ()
685 "Give a one line description of the group mode commands."
688 (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")))
692 ;;; gnus-srvr.el ends here.