1 ;;; gnus-srvr.el --- virtual server support for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 (eval-when-compile (require 'cl
))
37 (autoload 'gnus-group-make-nnir-group
"nnir")
39 (defcustom gnus-server-mode-hook nil
40 "Hook run in `gnus-server-mode' buffers."
44 (defcustom gnus-server-exit-hook nil
45 "Hook run when exiting the server buffer."
49 (defcustom gnus-server-line-format
" {%(%h:%w%)} %s%a\n"
50 "Format of server lines.
51 It works along the same lines as a normal formatting string,
52 with some simple extensions.
54 The following specs are understood:
62 General format specifiers can also be used.
63 See Info node `(gnus)Formatting Variables'."
64 :link
'(custom-manual "(gnus)Formatting Variables")
65 :group
'gnus-server-visual
68 (defcustom gnus-server-mode-line-format
"Gnus: %%b"
69 "The format specification for the server mode line."
70 :group
'gnus-server-visual
73 (defcustom gnus-server-browse-in-group-buffer nil
74 "Whether server browsing should take place in the group buffer.
75 If nil, a faster, but more primitive, buffer is used instead."
77 :group
'gnus-server-visual
80 ;;; Internal variables.
82 (defvar gnus-inserted-opened-servers nil
)
84 (defvar gnus-server-line-format-alist
85 `((?h gnus-tmp-how ?s
)
87 (?w gnus-tmp-where ?s
)
88 (?s gnus-tmp-status ?s
)
89 (?a gnus-tmp-agent ?s
)))
91 (defvar gnus-server-mode-line-format-alist
92 `((?S gnus-tmp-news-server ?s
)
93 (?M gnus-tmp-news-method ?s
)
94 (?u gnus-tmp-user-defined ?s
)))
96 (defvar gnus-server-line-format-spec nil
)
97 (defvar gnus-server-mode-line-format-spec nil
)
98 (defvar gnus-server-killed-servers nil
)
100 (defvar gnus-server-mode-map
)
102 (defvar gnus-server-menu-hook nil
103 "*Hook run after the creation of the server mode menu.")
105 (defun gnus-server-make-menu-bar ()
106 (gnus-turn-off-edit-menu 'server
)
107 (unless (boundp 'gnus-server-server-menu
)
109 gnus-server-server-menu gnus-server-mode-map
""
111 ["Add..." gnus-server-add-server t
]
112 ["Browse" gnus-server-read-server t
]
113 ["Scan" gnus-server-scan-server t
]
114 ["List" gnus-server-list-servers t
]
115 ["Kill" gnus-server-kill-server t
]
116 ["Yank" gnus-server-yank-server t
]
117 ["Copy" gnus-server-copy-server t
]
118 ["Show" gnus-server-show-server t
]
119 ["Edit" gnus-server-edit-server t
]
120 ["Regenerate" gnus-server-regenerate-server t
]
121 ["Compact" gnus-server-compact-server t
]
122 ["Exit" gnus-server-exit t
]))
125 gnus-server-connections-menu gnus-server-mode-map
""
127 ["Open" gnus-server-open-server t
]
128 ["Close" gnus-server-close-server t
]
129 ["Offline" gnus-server-offline-server t
]
130 ["Deny" gnus-server-deny-server t
]
132 ["Open All" gnus-server-open-all-servers t
]
133 ["Close All" gnus-server-close-all-servers t
]
134 ["Reset All" gnus-server-remove-denials t
]))
136 (gnus-run-hooks 'gnus-server-menu-hook
)))
138 (defvar gnus-server-mode-map nil
)
139 (put 'gnus-server-mode
'mode-class
'special
)
141 (unless gnus-server-mode-map
142 (setq gnus-server-mode-map
(make-sparse-keymap))
143 (suppress-keymap gnus-server-mode-map
)
145 (gnus-define-keys gnus-server-mode-map
146 " " gnus-server-read-server-in-server-buffer
147 "\r" gnus-server-read-server
148 gnus-mouse-2 gnus-server-pick-server
150 "l" gnus-server-list-servers
151 "k" gnus-server-kill-server
152 "y" gnus-server-yank-server
153 "c" gnus-server-copy-server
154 "a" gnus-server-add-server
155 "e" gnus-server-edit-server
156 "S" gnus-server-show-server
157 "s" gnus-server-scan-server
159 "O" gnus-server-open-server
160 "\M-o" gnus-server-open-all-servers
161 "C" gnus-server-close-server
162 "\M-c" gnus-server-close-all-servers
163 "D" gnus-server-deny-server
164 "L" gnus-server-offline-server
165 "R" gnus-server-remove-denials
170 "g" gnus-server-regenerate-server
172 "G" gnus-group-make-nnir-group
174 "z" gnus-server-compact-server
176 "\C-c\C-i" gnus-info-find-node
177 "\C-c\C-b" gnus-bug
))
179 (defface gnus-server-agent
180 '((((class color
) (background light
)) (:foreground
"PaleTurquoise" :bold t
))
181 (((class color
) (background dark
)) (:foreground
"PaleTurquoise" :bold t
))
183 "Face used for displaying AGENTIZED servers"
184 :group
'gnus-server-visual
)
185 ;; backward-compatibility alias
186 (put 'gnus-server-agent-face
'face-alias
'gnus-server-agent
)
187 (put 'gnus-server-agent-face
'obsolete-face
"22.1")
189 (defface gnus-server-opened
190 '((((class color
) (background light
)) (:foreground
"Green3" :bold t
))
191 (((class color
) (background dark
)) (:foreground
"Green1" :bold t
))
193 "Face used for displaying OPENED servers"
194 :group
'gnus-server-visual
)
195 ;; backward-compatibility alias
196 (put 'gnus-server-opened-face
'face-alias
'gnus-server-opened
)
197 (put 'gnus-server-opened-face
'obsolete-face
"22.1")
199 (defface gnus-server-closed
200 '((((class color
) (background light
)) (:foreground
"Steel Blue" :italic t
))
201 (((class color
) (background dark
))
202 (:foreground
"LightBlue" :italic t
))
204 "Face used for displaying CLOSED servers"
205 :group
'gnus-server-visual
)
206 ;; backward-compatibility alias
207 (put 'gnus-server-closed-face
'face-alias
'gnus-server-closed
)
208 (put 'gnus-server-closed-face
'obsolete-face
"22.1")
210 (defface gnus-server-denied
211 '((((class color
) (background light
)) (:foreground
"Red" :bold t
))
212 (((class color
) (background dark
)) (:foreground
"Pink" :bold t
))
213 (t (:inverse-video t
:bold t
)))
214 "Face used for displaying DENIED servers"
215 :group
'gnus-server-visual
)
216 ;; backward-compatibility alias
217 (put 'gnus-server-denied-face
'face-alias
'gnus-server-denied
)
218 (put 'gnus-server-denied-face
'obsolete-face
"22.1")
220 (defface gnus-server-offline
221 '((((class color
) (background light
)) (:foreground
"Orange" :bold t
))
222 (((class color
) (background dark
)) (:foreground
"Yellow" :bold t
))
223 (t (:inverse-video t
:bold t
)))
224 "Face used for displaying OFFLINE servers"
225 :group
'gnus-server-visual
)
226 ;; backward-compatibility alias
227 (put 'gnus-server-offline-face
'face-alias
'gnus-server-offline
)
228 (put 'gnus-server-offline-face
'obsolete-face
"22.1")
230 (defvar gnus-server-font-lock-keywords
231 '(("(\\(agent\\))" 1 'gnus-server-agent
)
232 ("(\\(opened\\))" 1 'gnus-server-opened
)
233 ("(\\(closed\\))" 1 'gnus-server-closed
)
234 ("(\\(offline\\))" 1 'gnus-server-offline
)
235 ("(\\(denied\\))" 1 'gnus-server-denied
)))
237 (defun gnus-server-mode ()
238 "Major mode for listing and editing servers.
240 All normal editing commands are switched off.
241 \\<gnus-server-mode-map>
242 For more in-depth information on this mode, read the manual
243 \(`\\[gnus-info-find-node]').
245 The following commands are available:
247 \\{gnus-server-mode-map}"
249 (when (gnus-visual-p 'server-menu
'menu
)
250 (gnus-server-make-menu-bar))
251 (kill-all-local-variables)
252 (gnus-simplify-mode-line)
253 (setq major-mode
'gnus-server-mode
)
254 (setq mode-name
"Server")
255 (gnus-set-default-directory)
256 (setq mode-line-process nil
)
257 (use-local-map gnus-server-mode-map
)
258 (buffer-disable-undo)
259 (setq truncate-lines t
)
260 (setq buffer-read-only t
)
261 (if (featurep 'xemacs
)
262 (put 'gnus-server-mode
'font-lock-defaults
'(gnus-server-font-lock-keywords t
))
263 (set (make-local-variable 'font-lock-defaults
)
264 '(gnus-server-font-lock-keywords t
)))
265 (gnus-run-mode-hooks 'gnus-server-mode-hook
))
267 (defun gnus-server-insert-server-line (gnus-tmp-name method
)
268 (let* ((gnus-tmp-how (car method
))
269 (gnus-tmp-where (nth 1 method
))
270 (elem (assoc method gnus-opened-servers
))
273 ((eq (nth 1 elem
) 'denied
) "(denied)")
274 ((eq (nth 1 elem
) 'offline
) "(offline)")
277 (if (or (gnus-server-opened method
)
278 (eq (nth 1 elem
) 'ok
))
281 ((error) "(error)")))))
282 (gnus-tmp-agent (if (and gnus-agent
283 (gnus-agent-method-p method
))
287 (gnus-add-text-properties
291 (eval gnus-server-line-format-spec
))
292 (list 'gnus-server
(intern gnus-tmp-name
)
293 'gnus-named-server
(intern (gnus-method-to-server method t
))))))
295 (defun gnus-enter-server-buffer ()
296 "Set up the server buffer."
297 (gnus-server-setup-buffer)
298 (gnus-configure-windows 'server
)
299 ;; Usually `gnus-configure-windows' will finish with the
300 ;; `gnus-server-buffer' selected as the current buffer, but not always (I
301 ;; bumped into it when starting from a dedicated *Group* frame, and
302 ;; gnus-configure-windows opened *Server* into its own dedicated frame).
303 (with-current-buffer (get-buffer gnus-server-buffer
)
304 (gnus-server-prepare)))
306 (defun gnus-server-setup-buffer ()
307 "Initialize the server buffer."
308 (unless (get-buffer gnus-server-buffer
)
309 (with-current-buffer (gnus-get-buffer-create gnus-server-buffer
)
310 (gnus-server-mode))))
312 (defun gnus-server-prepare ()
313 (gnus-set-format 'server-mode
)
314 (gnus-set-format 'server t
)
315 (let ((alist gnus-server-alist
)
316 (buffer-read-only nil
)
319 (setq gnus-inserted-opened-servers nil
)
320 ;; First we do the real list of servers.
322 (unless (member (cdar alist
) done
)
323 (push (cdar alist
) done
)
324 (setq server
(pop alist
))
325 (when (and server
(car server
) (cdr server
))
326 (gnus-server-insert-server-line (car server
) (cdr server
))))
327 (when (member (cdar alist
) done
)
329 ;; Then we insert the list of servers that have been opened in
331 (dolist (open gnus-opened-servers
)
332 (when (and (not (member (car open
) done
))
333 ;; Just ignore ephemeral servers.
334 (not (member (car open
) gnus-ephemeral-servers
)))
335 (push (car open
) done
)
336 (gnus-server-insert-server-line
337 (setq op-ser
(format "%s:%s" (caar open
) (nth 1 (car open
))))
339 (push (list op-ser
(car open
)) gnus-inserted-opened-servers
))))
340 (goto-char (point-min))
341 (gnus-server-position-point))
343 (defun gnus-server-server-name ()
344 (let ((server (get-text-property (point-at-bol) 'gnus-server
)))
345 (and server
(symbol-name server
))))
347 (defun gnus-server-named-server ()
348 "Return a server name that matches one of the names returned by
349 `gnus-method-to-server'."
350 (let ((server (get-text-property (point-at-bol) 'gnus-named-server
)))
351 (and server
(symbol-name server
))))
353 (defalias 'gnus-server-position-point
'gnus-goto-colon
)
355 (defconst gnus-server-edit-buffer
"*Gnus edit server*")
357 (defun gnus-server-update-server (server)
358 (with-current-buffer gnus-server-buffer
359 (let* ((buffer-read-only nil
)
360 (entry (assoc server gnus-server-alist
))
361 (oentry (assoc (gnus-server-to-method server
)
362 gnus-opened-servers
)))
365 (concat "(gnus-server-set-info \"" server
"\" '"
366 (gnus-prin1-to-string (cdr entry
)) ")\n")))
367 (when (or entry oentry
)
368 ;; Buffer may be narrowed.
371 (when (gnus-server-goto-server server
)
374 (gnus-server-insert-server-line (car entry
) (cdr entry
))
375 (gnus-server-insert-server-line
376 (format "%s:%s" (caar oentry
) (nth 1 (car oentry
)))
378 (gnus-server-position-point))))))
380 (defun gnus-server-set-info (server info
)
381 ;; Enter a select method into the virtual server alist.
382 (when (and server info
)
384 (concat "(gnus-server-set-info \"" server
"\" '"
385 (gnus-prin1-to-string info
) ")"))
386 (let* ((server (nth 1 info
))
387 (entry (assoc server gnus-server-alist
))
388 (cached (assoc server gnus-server-method-cache
)))
390 (setq gnus-server-method-cache
391 (delq cached gnus-server-method-cache
)))
394 ;; Remove the server from `gnus-opened-servers' since
395 ;; it has never been opened with the new `info' yet.
396 (gnus-opened-servers-remove (cdr entry
))
397 ;; Don't make a new Lisp object.
398 (setcar (cdr entry
) (car info
))
399 (setcdr (cdr entry
) (cdr info
)))
400 (setq gnus-server-alist
401 (nconc gnus-server-alist
(list (cons server info
))))))))
403 ;;; Interactive server functions.
405 (defun gnus-server-kill-server (server)
406 "Kill the server on the current line."
407 (interactive (list (gnus-server-server-name)))
408 (unless (gnus-server-goto-server server
)
409 (if server
(error "No such server: %s" server
)
410 (error "No server on the current line")))
411 (unless (assoc server gnus-server-alist
)
412 (error "Read-only server %s" server
))
414 (let ((buffer-read-only nil
))
416 (push (assoc server gnus-server-alist
) gnus-server-killed-servers
)
417 (setq gnus-server-alist
(delq (car gnus-server-killed-servers
)
419 (let ((groups (gnus-groups-from-server server
)))
422 (format "Kill all %s groups from this server? "
424 (dolist (group groups
)
425 (setq gnus-newsrc-alist
426 (delq (assoc group gnus-newsrc-alist
)
428 (when gnus-group-change-level-function
429 (funcall gnus-group-change-level-function
430 group gnus-level-killed
3)))))
431 (gnus-server-position-point))
433 (defun gnus-server-yank-server ()
434 "Yank the previously killed server."
436 (unless gnus-server-killed-servers
437 (error "No killed servers to be yanked"))
438 (let ((alist gnus-server-alist
)
439 (server (gnus-server-server-name))
440 (killed (car gnus-server-killed-servers
)))
442 (setq gnus-server-alist
(nconc gnus-server-alist
(list killed
)))
443 (if (string= server
(caar gnus-server-alist
))
444 (push killed gnus-server-alist
)
445 (while (and (cdr alist
)
446 (not (string= server
(caadr alist
))))
447 (setq alist
(cdr alist
)))
449 (setcdr alist
(cons killed
(cdr alist
)))
450 (setq gnus-server-alist
(list killed
)))))
451 (gnus-server-update-server (car killed
))
452 (setq gnus-server-killed-servers
(cdr gnus-server-killed-servers
))
453 (gnus-server-position-point)))
455 (defun gnus-server-exit ()
456 "Return to the group buffer."
458 (gnus-run-hooks 'gnus-server-exit-hook
)
459 (gnus-kill-buffer (current-buffer))
460 (gnus-configure-windows 'group t
))
462 (defun gnus-server-list-servers ()
463 "List all available servers."
465 (let ((cur (gnus-server-server-name)))
466 (gnus-server-prepare)
467 (if cur
(gnus-server-goto-server cur
)
468 (goto-char (point-max))
470 (gnus-server-position-point)))
472 (defun gnus-server-set-status (method status
)
473 "Make METHOD have STATUS."
474 (let ((entry (assoc method gnus-opened-servers
)))
476 (setcar (cdr entry
) status
)
477 (push (list method status
) gnus-opened-servers
))))
479 (defun gnus-opened-servers-remove (method)
480 "Remove METHOD from the list of opened servers."
481 (setq gnus-opened-servers
(delq (assoc method gnus-opened-servers
)
482 gnus-opened-servers
)))
484 (defun gnus-server-open-server (server)
485 "Force an open of SERVER."
486 (interactive (list (gnus-server-server-name)))
487 (let ((method (gnus-server-to-method server
)))
489 (error "No such server: %s" server
))
490 (gnus-server-set-status method
'ok
)
492 (or (gnus-open-server method
)
493 (progn (message "Couldn't open %s" server
) nil
))
494 (gnus-server-update-server server
)
495 (gnus-server-position-point))))
497 (defun gnus-server-open-all-servers ()
500 (dolist (server gnus-inserted-opened-servers
)
501 (gnus-server-open-server (car server
))))
503 (defun gnus-server-close-server (server)
505 (interactive (list (gnus-server-server-name)))
506 (let ((method (gnus-server-to-method server
)))
508 (error "No such server: %s" server
))
509 (gnus-server-set-status method
'closed
)
511 (gnus-close-server method
)
512 (gnus-server-update-server server
)
513 (gnus-server-position-point))))
515 (defun gnus-server-offline-server (server)
516 "Set SERVER to offline."
517 (interactive (list (gnus-server-server-name)))
518 (let ((method (gnus-server-to-method server
)))
520 (error "No such server: %s" server
))
522 (gnus-close-server method
)
523 (gnus-server-set-status method
'offline
)
524 (gnus-server-update-server server
)
525 (gnus-server-position-point))))
527 (defun gnus-server-close-all-servers ()
530 (dolist (server gnus-inserted-opened-servers
)
531 (gnus-server-close-server (car server
)))
532 (dolist (server gnus-server-alist
)
533 (gnus-server-close-server (car server
))))
535 (defun gnus-server-deny-server (server)
536 "Make sure SERVER will never be attempted opened."
537 (interactive (list (gnus-server-server-name)))
538 (let ((method (gnus-server-to-method server
)))
540 (error "No such server: %s" server
))
541 (gnus-server-set-status method
'denied
))
542 (gnus-server-update-server server
)
543 (gnus-server-position-point)
546 (defun gnus-server-remove-denials ()
547 "Make all denied servers into closed servers."
549 (dolist (server gnus-opened-servers
)
550 (when (eq (nth 1 server
) 'denied
)
551 (setcar (nthcdr 1 server
) 'closed
)))
552 (gnus-server-list-servers))
554 (defun gnus-server-copy-server (from to
)
555 "Copy a server definiton to a new name."
558 (or (gnus-server-server-name)
559 (error "No server on the current line"))
560 (read-string "Copy to: ")))
562 (error "No server on current line"))
563 (unless (and to
(not (string= to
"")))
564 (error "No name to copy to"))
565 (when (assoc to gnus-server-alist
)
566 (error "%s already exists" to
))
567 (unless (gnus-server-to-method from
)
568 (error "%s: no such server" from
))
569 (let ((to-entry (cons from
(gnus-copy-sequence
570 (gnus-server-to-method from
)))))
572 (setcar (nthcdr 2 to-entry
) to
)
573 (push to-entry gnus-server-killed-servers
)
574 (gnus-server-yank-server)))
576 (defun gnus-server-add-server (how where
)
578 (list (intern (gnus-completing-read "Server method"
579 (mapcar 'car gnus-valid-select-methods
)
581 (read-string "Server name: ")))
582 (when (assq where gnus-server-alist
)
583 (error "Server with that name already defined"))
584 (push (list where how where
) gnus-server-killed-servers
)
585 (gnus-server-yank-server))
587 (defun gnus-server-goto-server (server)
588 "Jump to a server line."
590 (list (gnus-completing-read "Goto server" (mapcar 'car gnus-server-alist
) t
)))
591 (let ((to (text-property-any (point-min) (point-max)
592 'gnus-server
(intern server
))))
595 (gnus-server-position-point))))
597 (defun gnus-server-edit-server (server)
598 "Edit the server on the current line."
599 (interactive (list (gnus-server-server-name)))
601 (error "No server on current line"))
602 (unless (assoc server gnus-server-alist
)
603 (error "This server can't be edited"))
604 (let ((info (cdr (assoc server gnus-server-alist
))))
605 (gnus-close-server info
)
607 info
"Editing the server."
609 (gnus-server-set-info ,server form
)
610 (gnus-server-list-servers)
611 (gnus-server-position-point))
614 (defun gnus-server-show-server (server)
615 "Show the definition of the server on the current line."
616 (interactive (list (gnus-server-server-name)))
618 (error "No server on current line"))
619 (let ((info (gnus-server-to-method server
)))
621 info
"Showing the server."
623 (gnus-server-position-point))
626 (defun gnus-server-scan-server (server)
627 "Request a scan from the current server."
628 (interactive (list (gnus-server-server-name)))
629 (let ((method (gnus-server-to-method server
)))
630 (if (not (gnus-get-function method
'request-scan
))
631 (error "Server %s can't scan" (car method
))
632 (gnus-message 3 "Scanning %s..." server
)
633 (gnus-request-scan nil method
)
634 (gnus-message 3 "Scanning %s...done" server
))))
636 (defun gnus-server-read-server-in-server-buffer (server)
637 "Browse a server in server buffer."
638 (interactive (list (gnus-server-server-name)))
639 (let (gnus-server-browse-in-group-buffer)
640 (gnus-server-read-server server
)))
642 (defun gnus-server-read-server (server)
644 (interactive (list (gnus-server-server-name)))
645 (let ((buf (current-buffer)))
647 (gnus-browse-foreign-server server buf
)
648 (with-current-buffer buf
649 (gnus-server-update-server (gnus-server-server-name))
650 (gnus-server-position-point)))))
652 (defun gnus-server-pick-server (e)
655 (gnus-server-read-server (gnus-server-server-name)))
659 ;;; Browse Server Mode
662 (defvar gnus-browse-menu-hook nil
663 "*Hook run after the creation of the browse mode menu.")
665 (defcustom gnus-browse-subscribe-newsgroup-method
666 'gnus-subscribe-alphabetically
667 "Function(s) called when subscribing groups in the Browse Server Buffer
668 A few pre-made functions are supplied: `gnus-subscribe-randomly'
669 inserts new groups at the beginning of the list of groups;
670 `gnus-subscribe-alphabetically' inserts new groups in strict
671 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
672 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
673 for your decision; `gnus-subscribe-killed' kills all new groups;
674 `gnus-subscribe-zombies' will make all new groups into zombies;
675 `gnus-subscribe-topics' will enter groups into the topics that
679 :type
'(radio (function-item gnus-subscribe-randomly
)
680 (function-item gnus-subscribe-alphabetically
)
681 (function-item gnus-subscribe-hierarchically
)
682 (function-item gnus-subscribe-interactively
)
683 (function-item gnus-subscribe-killed
)
684 (function-item gnus-subscribe-zombies
)
685 (function-item gnus-subscribe-topics
)
689 (defvar gnus-browse-mode-hook nil
)
690 (defvar gnus-browse-mode-map nil
)
691 (put 'gnus-browse-mode
'mode-class
'special
)
693 (unless gnus-browse-mode-map
694 (setq gnus-browse-mode-map
(make-keymap))
695 (suppress-keymap gnus-browse-mode-map
)
699 " " gnus-browse-read-group
700 "=" gnus-browse-select-group
701 "n" gnus-browse-next-group
702 "p" gnus-browse-prev-group
703 "\177" gnus-browse-prev-group
704 [delete] gnus-browse-prev-group
705 "N" gnus-browse-next-group
706 "P" gnus-browse-prev-group
707 "\M-n" gnus-browse-next-group
708 "\M-p" gnus-browse-prev-group
709 "\r" gnus-browse-select-group
710 "u" gnus-browse-unsubscribe-current-group
715 "d" gnus-browse-describe-group
716 "\C-c\C-c" gnus-browse-exit
717 "?" gnus-browse-describe-briefly
719 "\C-c\C-i" gnus-info-find-node
720 "\C-c\C-b" gnus-bug))
722 (defun gnus-browse-make-menu-bar ()
723 (gnus-turn-off-edit-menu 'browse)
724 (unless (boundp 'gnus-browse-menu)
726 gnus-browse-menu gnus-browse-mode-map ""
728 ["Subscribe" gnus-browse-unsubscribe-current-group t]
729 ["Read" gnus-browse-read-group t]
730 ["Select" gnus-browse-select-group t]
731 ["Describe" gnus-browse-describe-group t]
732 ["Next" gnus-browse-next-group t]
733 ["Prev" gnus-browse-prev-group t]
734 ["Exit" gnus-browse-exit t]))
735 (gnus-run-hooks 'gnus-browse-menu-hook)))
737 (defvar gnus-browse-current-method nil)
738 (defvar gnus-browse-return-buffer nil)
740 (defvar gnus-browse-buffer "*Gnus Browse Server*")
742 (defun gnus-browse-foreign-server (server &optional return-buffer)
743 "Browse the server SERVER."
744 (setq gnus-browse-current-method (gnus-server-to-method server))
745 (setq gnus-browse-return-buffer return-buffer)
746 (let* ((method gnus-browse-current-method)
747 (orig-select-method gnus-select-method)
748 (gnus-select-method method)
750 (gnus-message 5 "Connecting to %s..." (nth 1 method))
752 ((not (gnus-check-server method))
754 1 "Unable to contact server %s: %s" (nth 1 method)
755 (gnus-status-message method))
759 (gnus-message 6 "Reading active file...")
760 (gnus-request-list method)
761 (gnus-message 6 "Reading active file...done")))
763 1 "Couldn't request list: %s" (gnus-status-message method))
766 (with-current-buffer nntp-server-buffer
767 (let ((cur (current-buffer)))
768 (goto-char (point-min))
769 (unless (or (null gnus-ignored-newsgroups)
770 (string= gnus-ignored-newsgroups ""))
771 (delete-matching-lines gnus-ignored-newsgroups))
772 ;; We treat NNTP as a special case to avoid problems with
773 ;; garbage group names like `"foo' that appear in some badly
774 ;; managed active files. -jh.
775 (if (eq (car method) 'nntp)
779 (mm-string-as-unibyte
783 (skip-chars-forward "^ \t")
785 (let ((last (read cur)))
786 (cons (read cur) last)))
792 (mm-string-as-unibyte
793 (if (eq (char-after) ?\")
795 (let ((p (point)) (name ""))
796 (skip-chars-forward "^ \t\\\\")
797 (setq name (buffer-substring p (point)))
798 (while (eq (char-after) ?\\)
799 (setq p (1+ (point)))
801 (skip-chars-forward "^ \t\\\\")
802 (setq name (concat name (buffer-substring
805 (let ((last (read cur)))
806 (cons (read cur) last)))
809 (setq groups (sort groups
811 (string< (car l1) (car l2)))))
812 (if gnus-server-browse-in-group-buffer
813 (let* ((gnus-select-method orig-select-method)
814 (gnus-group-listed-groups
815 (mapcar (lambda (group)
817 (gnus-group-prefixed-name
818 (car group) method)))
819 (gnus-set-active name (cdr group))
822 (gnus-configure-windows 'group)
823 (funcall gnus-group-prepare-function
824 gnus-level-killed 'ignore 1 'ignore))
825 (gnus-get-buffer-create gnus-browse-buffer)
826 (gnus-configure-windows 'browse)
827 (buffer-disable-undo)
828 (let ((buffer-read-only nil))
831 (setq mode-line-buffer-identification
834 "Gnus: %%b {%s:%s}" (car method) (cadr method))))
835 (let ((buffer-read-only nil)
837 (prefix (let ((gnus-select-method orig-select-method))
838 (gnus-group-prefixed-name "" method))))
839 (while (setq group (pop groups))
840 (gnus-add-text-properties
844 (format "%c%7d: %s\n"
846 (if (string= prefix "")
847 (gnus-group-level (setq name (car group)))
849 (concat prefix (setq name (car group)))))))
851 ((<= level gnus-level-subscribed) ? )
852 ((<= level gnus-level-unsubscribed) ?U)
853 ((= level gnus-level-zombie) ?Z)
855 (max 0 (- (1+ (cddr group)) (cadr group)))
856 ;; Don't decode if name is ASCII
857 (if (and (fboundp 'detect-coding-string)
858 (eq (detect-coding-string name t) 'undecided))
860 (mm-decode-coding-string
862 (inline (gnus-group-name-charset method name)))))))
863 (list 'gnus-group name)
865 (switch-to-buffer (current-buffer)))
866 (goto-char (point-min))
867 (gnus-group-position-point)
868 (gnus-message 5 "Connecting to %s...done" (nth 1 method))
871 (defun gnus-browse-mode ()
872 "Major mode for browsing a foreign server.
874 All normal editing commands are switched off.
876 \\<gnus-browse-mode-map>
877 The only things you can do in this buffer is
879 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
880 The group will be inserted into the group buffer upon exit from this
883 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
885 3) `\\[gnus-browse-exit]' to return to the group buffer."
887 (kill-all-local-variables)
888 (when (gnus-visual-p 'browse-menu 'menu)
889 (gnus-browse-make-menu-bar))
890 (gnus-simplify-mode-line)
891 (setq major-mode 'gnus-browse-mode)
892 (setq mode-name "Browse Server")
893 (setq mode-line-process nil)
894 (use-local-map gnus-browse-mode-map)
895 (buffer-disable-undo)
896 (setq truncate-lines t)
897 (gnus-set-default-directory)
898 (setq buffer-read-only t)
899 (gnus-run-mode-hooks 'gnus-browse-mode-hook))
901 (defun gnus-browse-read-group (&optional no-article number)
902 "Enter the group at the current line.
903 If NUMBER, fetch this number of articles."
905 (let ((group (gnus-browse-group-name)))
906 (if (or (not (gnus-get-info group))
907 (gnus-ephemeral-group-p group))
908 (unless (gnus-group-read-ephemeral-group
909 group gnus-browse-current-method nil
910 (cons (current-buffer) 'browse)
912 (error "Couldn't enter %s" group))
913 (unless (gnus-group-read-group nil no-article group)
914 (error "Couldn't enter %s" group)))))
916 (defun gnus-browse-select-group (&optional number)
917 "Select the current group.
918 If NUMBER, fetch this number of articles."
920 (gnus-browse-read-group 'no number))
922 (defun gnus-browse-next-group (n)
923 "Go to the next group."
927 (gnus-group-position-point)))
929 (defun gnus-browse-prev-group (n)
930 "Go to the next group."
932 (gnus-browse-next-group (- n)))
934 (defun gnus-browse-unsubscribe-current-group (arg)
935 "(Un)subscribe to the next ARG groups.
936 The variable `gnus-browse-subscribe-newsgroup-method' determines
937 how new groups will be entered into the group buffer."
940 (error "No group at current line"))
941 (let ((ward (if (< arg 0) -1 1))
943 (while (and (> arg 0)
945 (gnus-browse-unsubscribe-group)
946 (zerop (gnus-browse-next-group ward)))
948 (gnus-group-position-point)
950 (gnus-message 7 "No more newsgroups"))
953 (defun gnus-browse-group-name ()
956 (let ((name (get-text-property (point) 'gnus-group)))
957 (when (re-search-forward ": \\(.*\\)$" (point-at-eol) t)
958 (concat (gnus-method-to-server-name gnus-browse-current-method) ":"
960 (match-string-no-properties 1)))))))
962 (defun gnus-browse-describe-group (group)
963 "Describe the current group."
964 (interactive (list (gnus-browse-group-name)))
965 (gnus-group-describe-group nil group))
967 (defun gnus-browse-unsubscribe-group ()
968 "Toggle subscription of the current group in the browse buffer."
970 (buffer-read-only nil)
974 ;; If this group it killed, then we want to subscribe it.
975 (unless (eq (char-after) ? )
977 (setq group (gnus-browse-group-name))
978 (when (gnus-server-equal gnus-browse-current-method "native")
979 (setq group (gnus-group-real-name group)))
982 ;; Make sure the group has been properly removed before we
984 (if (gnus-ephemeral-group-p group)
985 (gnus-kill-ephemeral-group group))
986 (let ((entry (gnus-group-entry group)))
988 ;; Just change the subscription level if it is an
989 ;; unsubscribed group.
990 (gnus-group-change-level entry
991 gnus-level-default-subscribed)
992 ;; If it is a killed group or a zombie, feed it to the
993 ;; mechanism for new group subscription.
994 (gnus-call-subscribe-functions
995 gnus-browse-subscribe-newsgroup-method
997 (gnus-request-update-group-status group 'subscribe)))
999 (insert (let ((lvl (gnus-group-level group)))
1001 ((< lvl gnus-level-unsubscribed) ? )
1002 ((< lvl gnus-level-zombie) ?U)
1003 ((< lvl gnus-level-killed) ?Z)
1005 (gnus-group-change-level
1006 group gnus-level-unsubscribed gnus-level-default-subscribed)
1011 (defun gnus-browse-exit ()
1012 "Quit browsing and return to the group buffer."
1014 (when (eq major-mode 'gnus-browse-mode)
1015 (gnus-kill-buffer (current-buffer)))
1016 ;; Insert the newly subscribed groups in the group buffer.
1017 (with-current-buffer gnus-group-buffer
1018 (gnus-group-list-groups nil))
1019 (if gnus-browse-return-buffer
1020 (gnus-configure-windows 'server 'force)
1021 (gnus-configure-windows 'group 'force)))
1023 (defun gnus-browse-describe-briefly ()
1024 "Give a one line description of the group mode commands."
1026 (gnus-message 6 "%s"
1027 (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")))
1029 (defun gnus-server-regenerate-server ()
1030 "Issue a command to the server to regenerate all its data structures."
1032 (let ((server (gnus-server-server-name)))
1034 (error "No server on the current line"))
1036 (gnus-get-function (gnus-server-to-method server)
1037 'request-regenerate)
1039 (error "This back end doesn't support regeneration")))
1040 (gnus-message 5 "Requesting regeneration of %s..." server)
1041 (unless (gnus-open-server server)
1042 (error "Couldn't open server"))
1043 (if (gnus-request-regenerate server)
1044 (gnus-message 5 "Requesting regeneration of %s...done" server)
1045 (gnus-message 5 "Couldn't regenerate %s" server))))
1049 ;;; Server compaction. -- dvl
1052 ;; #### FIXME: this function currently fails to update the Group buffer's
1054 (defun gnus-server-compact-server ()
1055 "Issue a command to the server to compact all its groups.
1057 Note: currently only implemented in nnml."
1059 (let ((server (gnus-server-server-name)))
1061 (error "No server on the current line"))
1063 (gnus-get-function (gnus-server-to-method server)
1066 (error "This back end doesn't support compaction")))
1068 Requesting compaction of %s... (this may take a long time)"
1070 (unless (gnus-open-server server)
1071 (error "Couldn't open server"))
1072 (if (not (gnus-request-compact server))
1073 (gnus-message 5 "Couldn't compact %s" server)
1074 (gnus-message 5 "Requesting compaction of %s...done" server)
1075 ;; Invalidate the original article buffer which might be out of date.
1076 ;; #### NOTE: Yes, this might be a bit rude, but since compaction
1077 ;; #### will not happen very often, I think this is acceptable.
1078 (let ((original (get-buffer gnus-original-article-buffer)))
1079 (and original (gnus-kill-buffer original))))))
1081 (provide 'gnus-srvr)
1083 ;;; gnus-srvr.el ends here