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
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
28 (eval-when-compile (require 'cl))
30 (defvar gnus-server-mode-hook nil
31 "Hook run in `gnus-server-mode' buffers.")
33 (defconst gnus-server-line-format " {%(%h:%w%)} %s\n"
34 "Format of server lines.
35 It works along the same lines as a normal formatting string,
36 with some simple extensions.")
38 (defvar gnus-server-mode-line-format "Gnus List of servers"
39 "The format specification for the server mode line.")
41 ;;; Internal variables.
43 (defconst gnus-server-line-format-alist
49 (defconst gnus-server-mode-line-format-alist
50 (` ((?S news-server ?s)
52 (?u user-defined ?s))))
54 (defvar gnus-server-line-format-spec nil)
55 (defvar gnus-server-mode-line-format-spec nil)
56 (defvar gnus-server-killed-servers nil)
58 (defvar gnus-server-mode-map)
60 (defvar gnus-server-menu-hook nil
61 "*Hook run after the creation of the server mode menu.")
63 (defun gnus-server-make-menu-bar ()
64 (gnus-visual-turn-off-edit-menu 'server)
66 (boundp 'gnus-server-menu)
69 gnus-server-menu gnus-server-mode-map ""
71 ["Add" gnus-server-add-server t]
72 ["Browse" gnus-server-read-server t]
73 ["List" gnus-server-list-servers t]
74 ["Kill" gnus-server-kill-server t]
75 ["Yank" gnus-server-yank-server t]
76 ["Copy" gnus-server-copy-server t]
77 ["Edit" gnus-server-edit-server t]
78 ["Exit" gnus-server-exit t]
82 gnus-server-menu gnus-server-mode-map ""
84 ["Open" gnus-server-open-server t]
85 ["Close" gnus-server-close-server t]
86 ["Deny" gnus-server-deny-servers t]
87 ["Reset" gnus-server-remove-denials t]
90 (run-hooks 'gnus-server-menu-hook))))
92 (defvar gnus-server-mode-map nil)
93 (put 'gnus-server-mode 'mode-class 'special)
95 (unless gnus-server-mode-map
96 (setq gnus-server-mode-map (make-sparse-keymap))
97 (suppress-keymap gnus-server-mode-map)
101 " " gnus-server-read-server
102 "\r" gnus-server-read-server
103 gnus-mouse-2 gnus-server-pick-server
105 "l" gnus-server-list-servers
106 "k" gnus-server-kill-server
107 "y" gnus-server-yank-server
108 "c" gnus-server-copy-server
109 "a" gnus-server-add-server
110 "e" gnus-server-edit-server
112 "O" gnus-server-open-server
113 "C" gnus-server-close-server
114 "D" gnus-server-deny-server
115 "R" gnus-server-remove-denials))
117 (defun gnus-server-mode ()
118 "Major mode for listing and editing servers.
120 All normal editing commands are switched off.
121 \\<gnus-server-mode-map>
123 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
125 The following commands are available:
127 \\{gnus-server-mode-map}"
129 (when (and menu-bar-mode
130 (gnus-visual-p 'server-menu 'menu))
131 (gnus-server-make-menu-bar))
132 (kill-all-local-variables)
133 (gnus-simplify-mode-line)
134 (setq major-mode 'gnus-server-mode)
135 (setq mode-name "Server")
136 ; (gnus-group-set-mode-line)
137 (setq mode-line-process nil)
138 (use-local-map gnus-server-mode-map)
139 (buffer-disable-undo (current-buffer))
140 (setq truncate-lines t)
141 (setq buffer-read-only t)
142 (run-hooks 'gnus-server-mode-hook))
144 (defun gnus-server-insert-server-line (name method)
145 (let* ((how (car method))
146 (where (nth 1 method))
147 (elem (assoc method gnus-opened-servers))
148 (status (cond ((eq (nth 1 elem) 'denied)
150 ((or (gnus-server-opened method)
151 (eq (nth 1 elem) 'ok))
160 (eval gnus-server-line-format-spec))
161 (list 'gnus-server (intern name)))))
163 (defun gnus-enter-server-buffer ()
164 "Set up the server buffer."
165 (gnus-server-setup-buffer)
166 (gnus-configure-windows 'server)
167 (gnus-server-prepare))
169 (defun gnus-server-setup-buffer ()
170 "Initialize the server buffer."
171 (unless (get-buffer gnus-server-buffer)
173 (set-buffer (get-buffer-create gnus-server-buffer))
176 (gnus-carpal-setup-buffer 'server)))))
178 (defun gnus-server-prepare ()
179 (setq gnus-server-mode-line-format-spec
180 (gnus-parse-format gnus-server-mode-line-format
181 gnus-server-mode-line-format-alist))
182 (setq gnus-server-line-format-spec
183 (gnus-parse-format gnus-server-line-format
184 gnus-server-line-format-alist t))
185 (let ((alist gnus-server-alist)
186 (buffer-read-only nil)
187 (opened gnus-opened-servers)
190 ;; First we do the real list of servers.
192 (push (cdr (setq server (pop alist))) done)
194 (gnus-server-insert-server-line (car server) (cdr server))))
195 ;; Then we insert the list of servers that have been opened in
198 (unless (member (car (car opened)) done)
199 (gnus-server-insert-server-line
200 (format "%s:%s" (car (car (car opened))) (nth 1 (car (car opened))))
202 (setq opened (cdr opened))))
203 (goto-char (point-min))
204 (gnus-server-position-point))
206 (defun gnus-server-server-name ()
207 (let ((server (get-text-property (gnus-point-at-bol) 'gnus-server)))
208 (and server (symbol-name server))))
210 (defalias 'gnus-server-position-point 'gnus-goto-colon)
212 (defconst gnus-server-edit-buffer "*Gnus edit server*")
214 (defun gnus-server-update-server (server)
216 (set-buffer gnus-server-buffer)
217 (let ((buffer-read-only nil)
218 (info (cdr (assoc server gnus-server-alist))))
220 (concat "(gnus-server-set-info \"" server "\" '"
221 (prin1-to-string info) ")"))
222 ;; Buffer may be narrowed.
225 (if (gnus-server-goto-server server)
226 (delete-region (progn (beginning-of-line) (point))
227 (progn (forward-line 1) (point))))
228 (let ((entry (assoc server gnus-server-alist)))
229 (gnus-server-insert-server-line (car entry) (cdr entry))
230 (gnus-server-position-point))))))
232 (defun gnus-server-set-info (server info)
233 ;; Enter a select method into the virtual server alist.
235 (concat "(gnus-server-set-info \"" server "\" '"
236 (prin1-to-string info) ")"))
237 (let* ((server (nth 1 info))
238 (entry (assoc server gnus-server-alist)))
239 (if entry (setcdr entry info)
240 (setq gnus-server-alist
241 (nconc gnus-server-alist (list (cons server info)))))))
243 ;;; Interactive server functions.
245 (defun gnus-server-kill-server (server)
246 "Kill the server on the current line."
247 (interactive (list (gnus-server-server-name)))
248 (or (gnus-server-goto-server server)
249 (if server (error "No such server: %s" server)
250 (error "No server on the current line")))
251 (gnus-dribble-enter "")
252 (let ((buffer-read-only nil))
253 (delete-region (progn (beginning-of-line) (point))
254 (progn (forward-line 1) (point))))
255 (setq gnus-server-killed-servers
256 (cons (assoc server gnus-server-alist) gnus-server-killed-servers))
257 (setq gnus-server-alist (delq (car gnus-server-killed-servers)
259 (gnus-server-position-point))
261 (defun gnus-server-yank-server ()
262 "Yank the previously killed server."
264 (or gnus-server-killed-servers
265 (error "No killed servers to be yanked"))
266 (let ((alist gnus-server-alist)
267 (server (gnus-server-server-name))
268 (killed (car gnus-server-killed-servers)))
270 (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
271 (if (string= server (car (car gnus-server-alist)))
272 (setq gnus-server-alist (cons killed gnus-server-alist))
273 (while (and (cdr alist)
274 (not (string= server (car (car (cdr alist))))))
275 (setq alist (cdr alist)))
276 (setcdr alist (cons killed (cdr alist)))
278 (setcdr alist (cons killed (cdr alist)))
279 (setq gnus-server-alist (list killed)))))
280 (gnus-server-update-server (car killed))
281 (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
282 (gnus-server-position-point)))
284 (defun gnus-server-exit ()
285 "Return to the group buffer."
287 (kill-buffer (current-buffer))
288 (switch-to-buffer gnus-group-buffer))
290 (defun gnus-server-list-servers ()
291 "List all available servers."
293 (let ((cur (gnus-server-server-name)))
294 (gnus-server-prepare)
295 (if cur (gnus-server-goto-server cur)
296 (goto-char (point-max))
298 (gnus-server-position-point)))
300 (defun gnus-opened-servers-remove (method)
301 "Remove METHOD from the list of opened servers."
302 (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
303 gnus-opened-servers)))
305 (defun gnus-server-open-server (server)
306 "Force an open of SERVER."
307 (interactive (list (gnus-server-server-name)))
308 (let ((method (gnus-server-to-method server)))
309 (or method (error "No such server: %s" server))
310 (gnus-opened-servers-remove method)
312 (or (gnus-open-server method)
313 (progn (message "Couldn't open %s" server) nil))
314 (gnus-server-update-server server)
315 (gnus-server-position-point))))
317 (defun gnus-server-close-server (server)
319 (interactive (list (gnus-server-server-name)))
320 (let ((method (gnus-server-to-method server)))
321 (or method (error "No such server: %s" server))
322 (gnus-opened-servers-remove method)
324 (gnus-close-server method)
325 (gnus-server-update-server server)
326 (gnus-server-position-point))))
328 (defun gnus-server-deny-server (server)
329 "Make sure SERVER will never be attempted opened."
330 (interactive (list (gnus-server-server-name)))
331 (let ((method (gnus-server-to-method server)))
332 (or method (error "No such server: %s" server))
333 (gnus-opened-servers-remove method)
334 (setq gnus-opened-servers
335 (cons (list method 'denied) gnus-opened-servers)))
336 (gnus-server-update-server server)
337 (gnus-server-position-point))
339 (defun gnus-server-remove-denials ()
340 "Make all denied servers into closed servers."
342 (let ((servers gnus-opened-servers))
344 (when (eq (nth 1 (car servers)) 'denied)
345 (setcar (nthcdr 1 (car servers)) 'closed))
346 (setq servers (cdr servers))))
347 (gnus-server-list-servers))
349 (defun gnus-server-copy-server (from to)
352 (or (gnus-server-server-name)
353 (error "No server on the current line"))
354 (read-string "Copy to: ")))
355 (or from (error "No server on current line"))
356 (or (and to (not (string= to ""))) (error "No name to copy to"))
357 (and (assoc to gnus-server-alist) (error "%s already exists" to))
358 (or (assoc from gnus-server-alist)
359 (error "%s: no such server" from))
360 (let ((to-entry (gnus-copy-sequence (assoc from gnus-server-alist))))
362 (setcar (nthcdr 2 to-entry) to)
363 (setq gnus-server-killed-servers
364 (cons to-entry gnus-server-killed-servers))
365 (gnus-server-yank-server)))
367 (defun gnus-server-add-server (how where)
369 (list (intern (completing-read "Server method: "
370 gnus-valid-select-methods nil t))
371 (read-string "Server name: ")))
372 (setq gnus-server-killed-servers
373 (cons (list where how where) gnus-server-killed-servers))
374 (gnus-server-yank-server))
376 (defun gnus-server-goto-server (server)
377 "Jump to a server line."
379 (list (completing-read "Goto server: " gnus-server-alist nil t)))
380 (let ((to (text-property-any (point-min) (point-max)
381 'gnus-server (intern server))))
385 (gnus-server-position-point)))))
387 (defun gnus-server-edit-server (server)
388 "Edit the server on the current line."
389 (interactive (list (gnus-server-server-name)))
391 (error "No server on current line"))
392 (let ((winconf (current-window-configuration)))
393 (get-buffer-create gnus-server-edit-buffer)
394 (gnus-configure-windows 'edit-server)
395 (gnus-add-current-to-buffer-list)
397 (make-local-variable 'gnus-prev-winconf)
398 (setq gnus-prev-winconf winconf)
399 (use-local-map (copy-keymap (current-local-map)))
400 (let ((done-func '(lambda ()
401 "Exit editing mode and update the information."
403 (gnus-server-edit-server-done 'group))))
404 (setcar (cdr (nth 4 done-func)) server)
405 (local-set-key "\C-c\C-c" done-func))
407 (insert ";; Type `C-c C-c' after you have edited the server.\n\n")
408 (insert (pp-to-string (cdr (assoc server gnus-server-alist))))))
410 (defun gnus-server-edit-server-done (server)
412 (set-buffer (get-buffer-create gnus-server-edit-buffer))
413 (goto-char (point-min))
414 (let ((form (read (current-buffer)))
415 (winconf gnus-prev-winconf))
416 (gnus-server-set-info server form)
417 (kill-buffer (current-buffer))
418 (and winconf (set-window-configuration winconf))
419 (set-buffer gnus-server-buffer)
420 (gnus-server-update-server (gnus-server-server-name))
421 (gnus-server-list-servers)
422 (gnus-server-position-point)))
424 (defun gnus-server-read-server (server)
426 (interactive (list (gnus-server-server-name)))
427 (let ((buf (current-buffer)))
429 (gnus-browse-foreign-server (gnus-server-to-method server) buf)
432 (gnus-server-update-server (gnus-server-server-name))
433 (gnus-server-position-point)))))
435 (defun gnus-server-pick-server (e)
438 (gnus-server-read-server (gnus-server-server-name)))
442 ;;; Browse Server Mode
445 (defvar gnus-browse-menu-hook nil
446 "*Hook run after the creation of the browse mode menu.")
448 (defvar gnus-browse-mode-hook nil)
449 (defvar gnus-browse-mode-map nil)
450 (put 'gnus-browse-mode 'mode-class 'special)
452 (unless gnus-browse-mode-map
453 (setq gnus-browse-mode-map (make-keymap))
454 (suppress-keymap gnus-browse-mode-map)
458 " " gnus-browse-read-group
459 "=" gnus-browse-select-group
460 "n" gnus-browse-next-group
461 "p" gnus-browse-prev-group
462 "\177" gnus-browse-prev-group
463 "N" gnus-browse-next-group
464 "P" gnus-browse-prev-group
465 "\M-n" gnus-browse-next-group
466 "\M-p" gnus-browse-prev-group
467 "\r" gnus-browse-select-group
468 "u" gnus-browse-unsubscribe-current-group
473 "\C-c\C-c" gnus-browse-exit
474 "?" gnus-browse-describe-briefly
475 "\C-c\C-i" gnus-info-find-node))
477 (defun gnus-browse-make-menu-bar ()
478 (gnus-visual-turn-off-edit-menu 'browse)
480 (boundp 'gnus-browse-menu)
483 gnus-browse-menu gnus-browse-mode-map ""
485 ["Subscribe" gnus-browse-unsubscribe-current-group t]
486 ["Read" gnus-browse-read-group t]
487 ["Select" gnus-browse-read-group t]
488 ["Next" gnus-browse-next-group t]
489 ["Prev" gnus-browse-next-group t]
490 ["Exit" gnus-browse-exit t]
492 (run-hooks 'gnus-browse-menu-hook))))
494 (defvar gnus-browse-current-method nil)
495 (defvar gnus-browse-return-buffer nil)
497 (defvar gnus-browse-buffer "*Gnus Browse Server*")
499 (defun gnus-browse-foreign-server (method &optional return-buffer)
500 "Browse the server METHOD."
501 (setq gnus-browse-current-method method)
502 (setq gnus-browse-return-buffer return-buffer)
503 (let ((gnus-select-method method)
505 (gnus-message 5 "Connecting to %s..." (nth 1 method))
507 ((not (gnus-check-server method))
509 1 "Unable to contact server: %s" (gnus-status-message method))
511 ((not (gnus-request-list method))
513 1 "Couldn't request list: %s" (gnus-status-message method))
516 (get-buffer-create gnus-browse-buffer)
517 (gnus-add-current-to-buffer-list)
518 (and gnus-carpal (gnus-carpal-setup-buffer 'browse))
519 (gnus-configure-windows 'browse)
520 (buffer-disable-undo (current-buffer))
521 (let ((buffer-read-only nil))
524 (setq mode-line-buffer-identification
527 "Gnus: %%b {%s:%s}" (car method) (car (cdr method)))))
529 (set-buffer nntp-server-buffer)
530 (let ((cur (current-buffer)))
531 (goto-char (point-min))
532 (or (string= gnus-ignored-newsgroups "")
533 (delete-matching-lines gnus-ignored-newsgroups))
534 (while (re-search-forward
535 "\\(^[^ \t]+\\)[ \t]+[0-9]+[ \t]+[0-9]+" nil t)
536 (goto-char (match-end 1))
537 (setq groups (cons (cons (match-string 1)
538 (max 0 (- (1+ (read cur)) (read cur))))
540 (setq groups (sort groups
542 (string< (car l1) (car l2)))))
543 (let ((buffer-read-only nil))
545 (setq group (car groups))
547 (format "K%7d: %s\n" (cdr group) (car group)))
548 (setq groups (cdr groups))))
549 (switch-to-buffer (current-buffer))
550 (goto-char (point-min))
551 (gnus-group-position-point)
554 (defun gnus-browse-mode ()
555 "Major mode for browsing a foreign server.
557 All normal editing commands are switched off.
559 \\<gnus-browse-mode-map>
560 The only things you can do in this buffer is
562 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
563 The group will be inserted into the group buffer upon exit from this
566 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
568 3) `\\[gnus-browse-exit]' to return to the group buffer."
570 (kill-all-local-variables)
571 (when (and menu-bar-mode
572 (gnus-visual-p 'browse-menu 'menu))
573 (gnus-browse-make-menu-bar))
574 (gnus-simplify-mode-line)
575 (setq major-mode 'gnus-browse-mode)
576 (setq mode-name "Browse Server")
577 (setq mode-line-process nil)
578 (use-local-map gnus-browse-mode-map)
579 (buffer-disable-undo (current-buffer))
580 (setq truncate-lines t)
581 (setq buffer-read-only t)
582 (run-hooks 'gnus-browse-mode-hook))
584 (defun gnus-browse-read-group (&optional no-article)
585 "Enter the group at the current line."
587 (let ((group (gnus-browse-group-name)))
588 (or (gnus-group-read-ephemeral-group
589 group gnus-browse-current-method nil
590 (cons (current-buffer) 'browse))
591 (error "Couldn't enter %s" group))))
593 (defun gnus-browse-select-group ()
594 "Select the current group."
596 (gnus-browse-read-group 'no))
598 (defun gnus-browse-next-group (n)
599 "Go to the next group."
603 (gnus-group-position-point)))
605 (defun gnus-browse-prev-group (n)
606 "Go to the next group."
608 (gnus-browse-next-group (- n)))
610 (defun gnus-browse-unsubscribe-current-group (arg)
611 "(Un)subscribe to the next ARG groups."
614 (error "No group at current line."))
615 (let ((ward (if (< arg 0) -1 1))
617 (while (and (> arg 0)
619 (gnus-browse-unsubscribe-group)
620 (zerop (gnus-browse-next-group ward)))
622 (gnus-group-position-point)
623 (if (/= 0 arg) (gnus-message 7 "No more newsgroups"))
626 (defun gnus-browse-group-name ()
629 (when (re-search-forward ": \\(.*\\)$" (gnus-point-at-eol) t)
630 (gnus-group-prefixed-name (match-string 1) gnus-browse-current-method))))
632 (defun gnus-browse-unsubscribe-group ()
633 "Toggle subscription of the current group in the browse buffer."
635 (buffer-read-only nil)
639 ;; If this group it killed, then we want to subscribe it.
640 (if (= (following-char) ?K) (setq sub t))
641 (setq group (gnus-browse-group-name))
645 (gnus-group-change-level
646 (list t group gnus-level-default-subscribed
647 nil nil gnus-browse-current-method)
648 gnus-level-default-subscribed gnus-level-killed
649 (and (car (nth 1 gnus-newsrc-alist))
650 (gnus-gethash (car (nth 1 gnus-newsrc-alist))
654 (gnus-group-change-level
655 group gnus-level-killed gnus-level-default-subscribed)
659 (defun gnus-browse-exit ()
660 "Quit browsing and return to the group buffer."
662 (if (eq major-mode 'gnus-browse-mode)
663 (kill-buffer (current-buffer)))
664 (if gnus-browse-return-buffer
665 (gnus-configure-windows 'server 'force)
666 (gnus-configure-windows 'group 'force)
667 (gnus-group-list-groups nil)))
669 (defun gnus-browse-describe-briefly ()
670 "Give a one line description of the group mode commands."
673 (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")))
676 ;;; gnus-srvr.el ends here.