lisp/gnus/gnus-srvr.el

   1 ;;; gnus-srvr.el --- virtual server support for Gnus
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile (require 'cl))
  29
  30 (require 'gnus)
  31 (require 'gnus-start)
  32 (require 'gnus-spec)
  33 (require 'gnus-group)
  34 (require 'gnus-int)
  35 (require 'gnus-range)
  36
  37 (autoload 'gnus-group-make-nnir-group "nnir")
  38
  39 (defcustom gnus-server-mode-hook nil
  40   "Hook run in `gnus-server-mode' buffers."
  41   :group 'gnus-server
  42   :type 'hook)
  43
  44 (defcustom gnus-server-exit-hook nil
  45   "Hook run when exiting the server buffer."
  46   :group 'gnus-server
  47   :type 'hook)
  48
  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.
  53
  54 The following specs are understood:
  55
  56 %h back end
  57 %n name
  58 %w address
  59 %s status
  60 %a agent covered
  61
  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
  66   :type 'string)
  67
  68 (defcustom gnus-server-mode-line-format "Gnus: %%b"
  69   "The format specification for the server mode line."
  70   :group 'gnus-server-visual
  71   :type 'string)
  72
  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."
  76   :version "22.1"
  77   :group 'gnus-server-visual
  78   :type 'boolean)
  79
  80 ;;; Internal variables.
  81
  82 (defvar gnus-inserted-opened-servers nil)
  83
  84 (defvar gnus-server-line-format-alist
  85   `((?h gnus-tmp-how ?s)
  86     (?n gnus-tmp-name ?s)
  87     (?w gnus-tmp-where ?s)
  88     (?s gnus-tmp-status ?s)
  89     (?a gnus-tmp-agent ?s)))
  90
  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)))
  95
  96 (defvar gnus-server-line-format-spec nil)
  97 (defvar gnus-server-mode-line-format-spec nil)
  98 (defvar gnus-server-killed-servers nil)
  99
 100 (defvar gnus-server-mode-map)
 101
 102 (defvar gnus-server-menu-hook nil
 103   "*Hook run after the creation of the server mode menu.")
 104
 105 (defun gnus-server-make-menu-bar ()
 106   (gnus-turn-off-edit-menu 'server)
 107   (unless (boundp 'gnus-server-server-menu)
 108     (easy-menu-define
 109      gnus-server-server-menu gnus-server-mode-map ""
 110      '("Server"
 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        ["Edit" gnus-server-edit-server t]
 119        ["Regenerate" gnus-server-regenerate-server t]
 120        ["Compact" gnus-server-compact-server t]
 121        ["Exit" gnus-server-exit t]))
 122
 123     (easy-menu-define
 124      gnus-server-connections-menu gnus-server-mode-map ""
 125      '("Connections"
 126        ["Open" gnus-server-open-server t]
 127        ["Close" gnus-server-close-server t]
 128        ["Offline" gnus-server-offline-server t]
 129        ["Deny" gnus-server-deny-server t]
 130        "---"
 131        ["Open All" gnus-server-open-all-servers t]
 132        ["Close All" gnus-server-close-all-servers t]
 133        ["Reset All" gnus-server-remove-denials t]))
 134
 135     (gnus-run-hooks 'gnus-server-menu-hook)))
 136
 137 (defvar gnus-server-mode-map nil)
 138 (put 'gnus-server-mode 'mode-class 'special)
 139
 140 (unless gnus-server-mode-map
 141   (setq gnus-server-mode-map (make-sparse-keymap))
 142   (suppress-keymap gnus-server-mode-map)
 143
 144   (gnus-define-keys gnus-server-mode-map
 145     " " gnus-server-read-server-in-server-buffer
 146     "\r" gnus-server-read-server
 147     gnus-mouse-2 gnus-server-pick-server
 148     "q" gnus-server-exit
 149     "l" gnus-server-list-servers
 150     "k" gnus-server-kill-server
 151     "y" gnus-server-yank-server
 152     "c" gnus-server-copy-server
 153     "a" gnus-server-add-server
 154     "e" gnus-server-edit-server
 155     "s" gnus-server-scan-server
 156
 157     "O" gnus-server-open-server
 158     "\M-o" gnus-server-open-all-servers
 159     "C" gnus-server-close-server
 160     "\M-c" gnus-server-close-all-servers
 161     "D" gnus-server-deny-server
 162     "L" gnus-server-offline-server
 163     "R" gnus-server-remove-denials
 164
 165     "n" next-line
 166     "p" previous-line
 167
 168     "g" gnus-server-regenerate-server
 169
 170     "G" gnus-group-make-nnir-group
 171
 172     "z" gnus-server-compact-server
 173
 174     "\C-c\C-i" gnus-info-find-node
 175     "\C-c\C-b" gnus-bug))
 176
 177 (defface gnus-server-agent
 178   '((((class color) (background light)) (:foreground "PaleTurquoise" :bold t))
 179     (((class color) (background dark)) (:foreground "PaleTurquoise" :bold t))
 180     (t (:bold t)))
 181   "Face used for displaying AGENTIZED servers"
 182   :group 'gnus-server-visual)
 183 ;; backward-compatibility alias
 184 (put 'gnus-server-agent-face 'face-alias 'gnus-server-agent)
 185 (put 'gnus-server-agent-face 'obsolete-face "22.1")
 186
 187 (defface gnus-server-opened
 188   '((((class color) (background light)) (:foreground "Green3" :bold t))
 189     (((class color) (background dark)) (:foreground "Green1" :bold t))
 190     (t (:bold t)))
 191   "Face used for displaying OPENED servers"
 192   :group 'gnus-server-visual)
 193 ;; backward-compatibility alias
 194 (put 'gnus-server-opened-face 'face-alias 'gnus-server-opened)
 195 (put 'gnus-server-opened-face 'obsolete-face "22.1")
 196
 197 (defface gnus-server-closed
 198   '((((class color) (background light)) (:foreground "Steel Blue" :italic t))
 199     (((class color) (background dark))
 200      (:foreground "LightBlue" :italic t))
 201     (t (:italic t)))
 202   "Face used for displaying CLOSED servers"
 203   :group 'gnus-server-visual)
 204 ;; backward-compatibility alias
 205 (put 'gnus-server-closed-face 'face-alias 'gnus-server-closed)
 206 (put 'gnus-server-closed-face 'obsolete-face "22.1")
 207
 208 (defface gnus-server-denied
 209   '((((class color) (background light)) (:foreground "Red" :bold t))
 210     (((class color) (background dark)) (:foreground "Pink" :bold t))
 211     (t (:inverse-video t :bold t)))
 212   "Face used for displaying DENIED servers"
 213   :group 'gnus-server-visual)
 214 ;; backward-compatibility alias
 215 (put 'gnus-server-denied-face 'face-alias 'gnus-server-denied)
 216 (put 'gnus-server-denied-face 'obsolete-face "22.1")
 217
 218 (defface gnus-server-offline
 219   '((((class color) (background light)) (:foreground "Orange" :bold t))
 220     (((class color) (background dark)) (:foreground "Yellow" :bold t))
 221     (t (:inverse-video t :bold t)))
 222   "Face used for displaying OFFLINE servers"
 223   :group 'gnus-server-visual)
 224 ;; backward-compatibility alias
 225 (put 'gnus-server-offline-face 'face-alias 'gnus-server-offline)
 226 (put 'gnus-server-offline-face 'obsolete-face "22.1")
 227
 228 (defvar gnus-server-font-lock-keywords
 229   '(("(\\(agent\\))" 1 'gnus-server-agent)
 230     ("(\\(opened\\))" 1 'gnus-server-opened)
 231     ("(\\(closed\\))" 1 'gnus-server-closed)
 232     ("(\\(offline\\))" 1 'gnus-server-offline)
 233     ("(\\(denied\\))" 1 'gnus-server-denied)))
 234
 235 (defun gnus-server-mode ()
 236   "Major mode for listing and editing servers.
 237
 238 All normal editing commands are switched off.
 239 \\<gnus-server-mode-map>
 240 For more in-depth information on this mode, read the manual
 241 \(`\\[gnus-info-find-node]').
 242
 243 The following commands are available:
 244
 245 \\{gnus-server-mode-map}"
 246   (interactive)
 247   (when (gnus-visual-p 'server-menu 'menu)
 248     (gnus-server-make-menu-bar))
 249   (kill-all-local-variables)
 250   (gnus-simplify-mode-line)
 251   (setq major-mode 'gnus-server-mode)
 252   (setq mode-name "Server")
 253   (gnus-set-default-directory)
 254   (setq mode-line-process nil)
 255   (use-local-map gnus-server-mode-map)
 256   (buffer-disable-undo)
 257   (setq truncate-lines t)
 258   (setq buffer-read-only t)
 259   (if (featurep 'xemacs)
 260       (put 'gnus-server-mode 'font-lock-defaults '(gnus-server-font-lock-keywords t))
 261     (set (make-local-variable 'font-lock-defaults)
 262          '(gnus-server-font-lock-keywords t)))
 263   (gnus-run-mode-hooks 'gnus-server-mode-hook))
 264
 265 (defun gnus-server-insert-server-line (gnus-tmp-name method)
 266   (let* ((gnus-tmp-how (car method))
 267          (gnus-tmp-where (nth 1 method))
 268          (elem (assoc method gnus-opened-servers))
 269          (gnus-tmp-status
 270           (cond
 271            ((eq (nth 1 elem) 'denied) "(denied)")
 272            ((eq (nth 1 elem) 'offline) "(offline)")
 273            (t
 274             (condition-case nil
 275                 (if (or (gnus-server-opened method)
 276                         (eq (nth 1 elem) 'ok))
 277                     "(opened)"
 278                   "(closed)")
 279               ((error) "(error)")))))
 280          (gnus-tmp-agent (if (and gnus-agent
 281                                   (gnus-agent-method-p method))
 282                              " (agent)"
 283                            "")))
 284     (beginning-of-line)
 285     (gnus-add-text-properties
 286      (point)
 287      (prog1 (1+ (point))
 288        ;; Insert the text.
 289        (eval gnus-server-line-format-spec))
 290      (list 'gnus-server (intern gnus-tmp-name)
 291            'gnus-named-server (intern (gnus-method-to-server method t))))))
 292
 293 (defun gnus-enter-server-buffer ()
 294   "Set up the server buffer."
 295   (gnus-server-setup-buffer)
 296   (gnus-configure-windows 'server)
 297   ;; Usually `gnus-configure-windows' will finish with the
 298   ;; `gnus-server-buffer' selected as the current buffer, but not always (I
 299   ;; bumped into it when starting from a dedicated *Group* frame, and
 300   ;; gnus-configure-windows opened *Server* into its own dedicated frame).
 301   (with-current-buffer (get-buffer gnus-server-buffer)
 302     (gnus-server-prepare)))
 303
 304 (defun gnus-server-setup-buffer ()
 305   "Initialize the server buffer."
 306   (unless (get-buffer gnus-server-buffer)
 307     (with-current-buffer (gnus-get-buffer-create gnus-server-buffer)
 308       (gnus-server-mode))))
 309
 310 (defun gnus-server-prepare ()
 311   (gnus-set-format 'server-mode)
 312   (gnus-set-format 'server t)
 313   (let ((alist gnus-server-alist)
 314         (buffer-read-only nil)
 315         done server op-ser)
 316     (erase-buffer)
 317     (setq gnus-inserted-opened-servers nil)
 318     ;; First we do the real list of servers.
 319     (while alist
 320       (unless (member (cdar alist) done)
 321         (push (cdar alist) done)
 322         (setq server (pop alist))
 323         (when (and server (car server) (cdr server))
 324           (gnus-server-insert-server-line (car server) (cdr server))))
 325       (when (member (cdar alist) done)
 326         (pop alist)))
 327     ;; Then we insert the list of servers that have been opened in
 328     ;; this session.
 329     (dolist (open gnus-opened-servers)
 330       (when (and (not (member (car open) done))
 331                  ;; Just ignore ephemeral servers.
 332                  (not (member (car open) gnus-ephemeral-servers)))
 333         (push (car open) done)
 334         (gnus-server-insert-server-line
 335          (setq op-ser (format "%s:%s" (caar open) (nth 1 (car open))))
 336          (car open))
 337         (push (list op-ser (car open)) gnus-inserted-opened-servers))))
 338   (goto-char (point-min))
 339   (gnus-server-position-point))
 340
 341 (defun gnus-server-server-name ()
 342   (let ((server (get-text-property (point-at-bol) 'gnus-server)))
 343     (and server (symbol-name server))))
 344
 345 (defun gnus-server-named-server ()
 346   "Return a server name that matches one of the names returned by
 347 `gnus-method-to-server'."
 348   (let ((server (get-text-property (point-at-bol) 'gnus-named-server)))
 349     (and server (symbol-name server))))
 350
 351 (defalias 'gnus-server-position-point 'gnus-goto-colon)
 352
 353 (defconst gnus-server-edit-buffer "*Gnus edit server*")
 354
 355 (defun gnus-server-update-server (server)
 356   (with-current-buffer gnus-server-buffer
 357     (let* ((buffer-read-only nil)
 358            (entry (assoc server gnus-server-alist))
 359            (oentry (assoc (gnus-server-to-method server)
 360                           gnus-opened-servers)))
 361       (when entry
 362         (gnus-dribble-enter
 363          (concat "(gnus-server-set-info \"" server "\" '"
 364                  (gnus-prin1-to-string (cdr entry)) ")\n")))
 365       (when (or entry oentry)
 366         ;; Buffer may be narrowed.
 367         (save-restriction
 368           (widen)
 369           (when (gnus-server-goto-server server)
 370             (gnus-delete-line))
 371           (if entry
 372               (gnus-server-insert-server-line (car entry) (cdr entry))
 373             (gnus-server-insert-server-line
 374              (format "%s:%s" (caar oentry) (nth 1 (car oentry)))
 375              (car oentry)))
 376           (gnus-server-position-point))))))
 377
 378 (defun gnus-server-set-info (server info)
 379   ;; Enter a select method into the virtual server alist.
 380   (when (and server info)
 381     (gnus-dribble-enter
 382      (concat "(gnus-server-set-info \"" server "\" '"
 383              (gnus-prin1-to-string info) ")"))
 384     (let* ((server (nth 1 info))
 385            (entry (assoc server gnus-server-alist))
 386            (cached (assoc server gnus-server-method-cache)))
 387       (if cached
 388           (setq gnus-server-method-cache
 389                 (delq cached gnus-server-method-cache)))
 390       (if entry
 391           (progn
 392             ;; Remove the server from `gnus-opened-servers' since
 393             ;; it has never been opened with the new `info' yet.
 394             (gnus-opened-servers-remove (cdr entry))
 395             ;; Don't make a new Lisp object.
 396             (setcar (cdr entry) (car info))
 397             (setcdr (cdr entry) (cdr info)))
 398         (setq gnus-server-alist
 399               (nconc gnus-server-alist (list (cons server info))))))))
 400
 401 ;;; Interactive server functions.
 402
 403 (defun gnus-server-kill-server (server)
 404   "Kill the server on the current line."
 405   (interactive (list (gnus-server-server-name)))
 406   (unless (gnus-server-goto-server server)
 407     (if server (error "No such server: %s" server)
 408       (error "No server on the current line")))
 409   (unless (assoc server gnus-server-alist)
 410     (error "Read-only server %s" server))
 411   (gnus-dribble-touch)
 412   (let ((buffer-read-only nil))
 413     (gnus-delete-line))
 414   (push (assoc server gnus-server-alist) gnus-server-killed-servers)
 415   (setq gnus-server-alist (delq (car gnus-server-killed-servers)
 416                                 gnus-server-alist))
 417   (let ((groups (gnus-groups-from-server server)))
 418     (when (and groups
 419                (gnus-yes-or-no-p
 420                 (format "Kill all %s groups from this server? "
 421                         (length groups))))
 422       (dolist (group groups)
 423         (setq gnus-newsrc-alist
 424               (delq (assoc group gnus-newsrc-alist)
 425                     gnus-newsrc-alist))
 426         (when gnus-group-change-level-function
 427           (funcall gnus-group-change-level-function
 428                    group gnus-level-killed 3)))))
 429   (gnus-server-position-point))
 430
 431 (defun gnus-server-yank-server ()
 432   "Yank the previously killed server."
 433   (interactive)
 434   (unless gnus-server-killed-servers
 435     (error "No killed servers to be yanked"))
 436   (let ((alist gnus-server-alist)
 437         (server (gnus-server-server-name))
 438         (killed (car gnus-server-killed-servers)))
 439     (if (not server)
 440         (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
 441       (if (string= server (caar gnus-server-alist))
 442           (push killed gnus-server-alist)
 443         (while (and (cdr alist)
 444                     (not (string= server (caadr alist))))
 445           (setq alist (cdr alist)))
 446         (if alist
 447             (setcdr alist (cons killed (cdr alist)))
 448           (setq gnus-server-alist (list killed)))))
 449     (gnus-server-update-server (car killed))
 450     (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
 451     (gnus-server-position-point)))
 452
 453 (defun gnus-server-exit ()
 454   "Return to the group buffer."
 455   (interactive)
 456   (gnus-run-hooks 'gnus-server-exit-hook)
 457   (gnus-kill-buffer (current-buffer))
 458   (gnus-configure-windows 'group t))
 459
 460 (defun gnus-server-list-servers ()
 461   "List all available servers."
 462   (interactive)
 463   (let ((cur (gnus-server-server-name)))
 464     (gnus-server-prepare)
 465     (if cur (gnus-server-goto-server cur)
 466       (goto-char (point-max))
 467       (forward-line -1))
 468     (gnus-server-position-point)))
 469
 470 (defun gnus-server-set-status (method status)
 471   "Make METHOD have STATUS."
 472   (let ((entry (assoc method gnus-opened-servers)))
 473     (if entry
 474         (setcar (cdr entry) status)
 475       (push (list method status) gnus-opened-servers))))
 476
 477 (defun gnus-opened-servers-remove (method)
 478   "Remove METHOD from the list of opened servers."
 479   (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
 480                                   gnus-opened-servers)))
 481
 482 (defun gnus-server-open-server (server)
 483   "Force an open of SERVER."
 484   (interactive (list (gnus-server-server-name)))
 485   (let ((method (gnus-server-to-method server)))
 486     (unless method
 487       (error "No such server: %s" server))
 488     (gnus-server-set-status method 'ok)
 489     (prog1
 490         (or (gnus-open-server method)
 491             (progn (message "Couldn't open %s" server) nil))
 492       (gnus-server-update-server server)
 493       (gnus-server-position-point))))
 494
 495 (defun gnus-server-open-all-servers ()
 496   "Open all servers."
 497   (interactive)
 498   (dolist (server gnus-inserted-opened-servers)
 499     (gnus-server-open-server (car server))))
 500
 501 (defun gnus-server-close-server (server)
 502   "Close SERVER."
 503   (interactive (list (gnus-server-server-name)))
 504   (let ((method (gnus-server-to-method server)))
 505     (unless method
 506       (error "No such server: %s" server))
 507     (gnus-server-set-status method 'closed)
 508     (prog1
 509         (gnus-close-server method)
 510       (gnus-server-update-server server)
 511       (gnus-server-position-point))))
 512
 513 (defun gnus-server-offline-server (server)
 514   "Set SERVER to offline."
 515   (interactive (list (gnus-server-server-name)))
 516   (let ((method (gnus-server-to-method server)))
 517     (unless method
 518       (error "No such server: %s" server))
 519     (prog1
 520         (gnus-close-server method)
 521       (gnus-server-set-status method 'offline)
 522       (gnus-server-update-server server)
 523       (gnus-server-position-point))))
 524
 525 (defun gnus-server-close-all-servers ()
 526   "Close all servers."
 527   (interactive)
 528   (dolist (server gnus-inserted-opened-servers)
 529     (gnus-server-close-server (car server)))
 530   (dolist (server gnus-server-alist)
 531     (gnus-server-close-server (car server))))
 532
 533 (defun gnus-server-deny-server (server)
 534   "Make sure SERVER will never be attempted opened."
 535   (interactive (list (gnus-server-server-name)))
 536   (let ((method (gnus-server-to-method server)))
 537     (unless method
 538       (error "No such server: %s" server))
 539     (gnus-server-set-status method 'denied))
 540   (gnus-server-update-server server)
 541   (gnus-server-position-point)
 542   t)
 543
 544 (defun gnus-server-remove-denials ()
 545   "Make all denied servers into closed servers."
 546   (interactive)
 547   (dolist (server gnus-opened-servers)
 548     (when (eq (nth 1 server) 'denied)
 549       (setcar (nthcdr 1 server) 'closed)))
 550   (gnus-server-list-servers))
 551
 552 (defun gnus-server-copy-server (from to)
 553   "Copy a server definiton to a new name."
 554   (interactive
 555    (list
 556     (or (gnus-server-server-name)
 557         (error "No server on the current line"))
 558     (read-string "Copy to: ")))
 559   (unless from
 560     (error "No server on current line"))
 561   (unless (and to (not (string= to "")))
 562     (error "No name to copy to"))
 563   (when (assoc to gnus-server-alist)
 564     (error "%s already exists" to))
 565   (unless (gnus-server-to-method from)
 566     (error "%s: no such server" from))
 567   (let ((to-entry (cons from (gnus-copy-sequence
 568                               (gnus-server-to-method from)))))
 569     (setcar to-entry to)
 570     (setcar (nthcdr 2 to-entry) to)
 571     (push to-entry gnus-server-killed-servers)
 572     (gnus-server-yank-server)))
 573
 574 (defun gnus-server-add-server (how where)
 575   (interactive
 576    (list (intern (gnus-completing-read "Server method"
 577                                        (mapcar 'car gnus-valid-select-methods)
 578                                        t))
 579          (read-string "Server name: ")))
 580   (when (assq where gnus-server-alist)
 581     (error "Server with that name already defined"))
 582   (push (list where how where) gnus-server-killed-servers)
 583   (gnus-server-yank-server))
 584
 585 (defun gnus-server-goto-server (server)
 586   "Jump to a server line."
 587   (interactive
 588    (list (gnus-completing-read "Goto server" (mapcar 'car gnus-server-alist) t)))
 589   (let ((to (text-property-any (point-min) (point-max)
 590                                'gnus-server (intern server))))
 591     (when to
 592       (goto-char to)
 593       (gnus-server-position-point))))
 594
 595 (defun gnus-server-edit-server (server)
 596   "Edit the server on the current line."
 597   (interactive (list (gnus-server-server-name)))
 598   (unless server
 599     (error "No server on current line"))
 600   (unless (assoc server gnus-server-alist)
 601     (error "This server can't be edited"))
 602   (let ((info (cdr (assoc server gnus-server-alist))))
 603     (gnus-close-server info)
 604     (gnus-edit-form
 605      info "Editing the server."
 606      `(lambda (form)
 607         (gnus-server-set-info ,server form)
 608         (gnus-server-list-servers)
 609         (gnus-server-position-point))
 610      'edit-server)))
 611
 612 (defun gnus-server-scan-server (server)
 613   "Request a scan from the current server."
 614   (interactive (list (gnus-server-server-name)))
 615   (let ((method (gnus-server-to-method server)))
 616     (if (not (gnus-get-function method 'request-scan))
 617         (error "Server %s can't scan" (car method))
 618       (gnus-message 3 "Scanning %s..." server)
 619       (gnus-request-scan nil method)
 620       (gnus-message 3 "Scanning %s...done" server))))
 621
 622 (defun gnus-server-read-server-in-server-buffer (server)
 623   "Browse a server in server buffer."
 624   (interactive (list (gnus-server-server-name)))
 625   (let (gnus-server-browse-in-group-buffer)
 626     (gnus-server-read-server server)))
 627
 628 (defun gnus-server-read-server (server)
 629   "Browse a server."
 630   (interactive (list (gnus-server-server-name)))
 631   (let ((buf (current-buffer)))
 632     (prog1
 633         (gnus-browse-foreign-server server buf)
 634       (with-current-buffer buf
 635         (gnus-server-update-server (gnus-server-server-name))
 636         (gnus-server-position-point)))))
 637
 638 (defun gnus-server-pick-server (e)
 639   (interactive "e")
 640   (mouse-set-point e)
 641   (gnus-server-read-server (gnus-server-server-name)))
 642
 643 \f
 644 ;;;
 645 ;;; Browse Server Mode
 646 ;;;
 647
 648 (defvar gnus-browse-menu-hook nil
 649   "*Hook run after the creation of the browse mode menu.")
 650
 651 (defcustom gnus-browse-subscribe-newsgroup-method
 652   'gnus-subscribe-alphabetically
 653   "Function(s) called when subscribing groups in the Browse Server Buffer
 654 A few pre-made functions are supplied: `gnus-subscribe-randomly'
 655 inserts new groups at the beginning of the list of groups;
 656 `gnus-subscribe-alphabetically' inserts new groups in strict
 657 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
 658 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
 659 for your decision; `gnus-subscribe-killed' kills all new groups;
 660 `gnus-subscribe-zombies' will make all new groups into zombies;
 661 `gnus-subscribe-topics' will enter groups into the topics that
 662 claim them."
 663   :version "24.1"
 664   :group 'gnus-server
 665   :type '(radio (function-item gnus-subscribe-randomly)
 666                 (function-item gnus-subscribe-alphabetically)
 667                 (function-item gnus-subscribe-hierarchically)
 668                 (function-item gnus-subscribe-interactively)
 669                 (function-item gnus-subscribe-killed)
 670                 (function-item gnus-subscribe-zombies)
 671                 (function-item gnus-subscribe-topics)
 672                 function
 673                 (repeat function)))
 674
 675 (defvar gnus-browse-mode-hook nil)
 676 (defvar gnus-browse-mode-map nil)
 677 (put 'gnus-browse-mode 'mode-class 'special)
 678
 679 (unless gnus-browse-mode-map
 680   (setq gnus-browse-mode-map (make-keymap))
 681   (suppress-keymap gnus-browse-mode-map)
 682
 683   (gnus-define-keys
 684       gnus-browse-mode-map
 685     " " gnus-browse-read-group
 686     "=" gnus-browse-select-group
 687     "n" gnus-browse-next-group
 688     "p" gnus-browse-prev-group
 689     "\177" gnus-browse-prev-group
 690     [delete] gnus-browse-prev-group
 691     "N" gnus-browse-next-group
 692     "P" gnus-browse-prev-group
 693     "\M-n" gnus-browse-next-group
 694     "\M-p" gnus-browse-prev-group
 695     "\r" gnus-browse-select-group
 696     "u" gnus-browse-unsubscribe-current-group
 697     "l" gnus-browse-exit
 698     "L" gnus-browse-exit
 699     "q" gnus-browse-exit
 700     "Q" gnus-browse-exit
 701     "d" gnus-browse-describe-group
 702     "\C-c\C-c" gnus-browse-exit
 703     "?" gnus-browse-describe-briefly
 704
 705     "\C-c\C-i" gnus-info-find-node
 706     "\C-c\C-b" gnus-bug))
 707
 708 (defun gnus-browse-make-menu-bar ()
 709   (gnus-turn-off-edit-menu 'browse)
 710   (unless (boundp 'gnus-browse-menu)
 711     (easy-menu-define
 712      gnus-browse-menu gnus-browse-mode-map ""
 713      '("Browse"
 714        ["Subscribe" gnus-browse-unsubscribe-current-group t]
 715        ["Read" gnus-browse-read-group t]
 716        ["Select" gnus-browse-select-group t]
 717        ["Describe" gnus-browse-describe-group t]
 718        ["Next" gnus-browse-next-group t]
 719        ["Prev" gnus-browse-prev-group t]
 720        ["Exit" gnus-browse-exit t]))
 721     (gnus-run-hooks 'gnus-browse-menu-hook)))
 722
 723 (defvar gnus-browse-current-method nil)
 724 (defvar gnus-browse-return-buffer nil)
 725
 726 (defvar gnus-browse-buffer "*Gnus Browse Server*")
 727
 728 (defun gnus-browse-foreign-server (server &optional return-buffer)
 729   "Browse the server SERVER."
 730   (setq gnus-browse-current-method (gnus-server-to-method server))
 731   (setq gnus-browse-return-buffer return-buffer)
 732   (let* ((method gnus-browse-current-method)
 733          (orig-select-method gnus-select-method)
 734          (gnus-select-method method)
 735          groups group)
 736     (gnus-message 5 "Connecting to %s..." (nth 1 method))
 737     (cond
 738      ((not (gnus-check-server method))
 739       (gnus-message
 740        1 "Unable to contact server %s: %s" (nth 1 method)
 741        (gnus-status-message method))
 742       nil)
 743      ((not
 744        (prog2
 745            (gnus-message 6 "Reading active file...")
 746            (gnus-request-list method)
 747          (gnus-message 6 "Reading active file...done")))
 748       (gnus-message
 749        1 "Couldn't request list: %s" (gnus-status-message method))
 750       nil)
 751      (t
 752       (with-current-buffer nntp-server-buffer
 753         (let ((cur (current-buffer)))
 754           (goto-char (point-min))
 755           (unless (string= gnus-ignored-newsgroups "")
 756             (delete-matching-lines gnus-ignored-newsgroups))
 757           ;; We treat NNTP as a special case to avoid problems with
 758           ;; garbage group names like `"foo' that appear in some badly
 759           ;; managed active files. -jh.
 760           (if (eq (car method) 'nntp)
 761               (while (not (eobp))
 762                 (ignore-errors
 763                   (push (cons
 764                          (mm-string-as-unibyte
 765                           (buffer-substring
 766                            (point)
 767                            (progn
 768                              (skip-chars-forward "^ \t")
 769                              (point))))
 770                          (let ((last (read cur)))
 771                            (cons (read cur) last)))
 772                         groups))
 773                 (forward-line))
 774             (while (not (eobp))
 775               (ignore-errors
 776                 (push (cons
 777                        (mm-string-as-unibyte
 778                         (if (eq (char-after) ?\")
 779                             (read cur)
 780                           (let ((p (point)) (name ""))
 781                             (skip-chars-forward "^ \t\\\\")
 782                             (setq name (buffer-substring p (point)))
 783                             (while (eq (char-after) ?\\)
 784                               (setq p (1+ (point)))
 785                               (forward-char 2)
 786                               (skip-chars-forward "^ \t\\\\")
 787                               (setq name (concat name (buffer-substring
 788                                                        p (point)))))
 789                             name)))
 790                        (let ((last (read cur)))
 791                          (cons (read cur) last)))
 792                       groups))
 793               (forward-line)))))
 794       (setq groups (sort groups
 795                          (lambda (l1 l2)
 796                            (string< (car l1) (car l2)))))
 797       (if gnus-server-browse-in-group-buffer
 798           (let* ((gnus-select-method orig-select-method)
 799                  (gnus-group-listed-groups
 800                   (mapcar (lambda (group)
 801                             (let ((name
 802                                    (gnus-group-prefixed-name
 803                                     (car group) method)))
 804                               (gnus-set-active name (cdr group))
 805                               name))
 806                           groups)))
 807             (gnus-configure-windows 'group)
 808             (funcall gnus-group-prepare-function
 809                      gnus-level-killed 'ignore 1 'ignore))
 810         (gnus-get-buffer-create gnus-browse-buffer)
 811         (gnus-configure-windows 'browse)
 812         (buffer-disable-undo)
 813         (let ((buffer-read-only nil))
 814           (erase-buffer))
 815         (gnus-browse-mode)
 816         (setq mode-line-buffer-identification
 817               (list
 818                (format
 819                 "Gnus: %%b {%s:%s}" (car method) (cadr method))))
 820         (let ((buffer-read-only nil)
 821               name
 822               (prefix (let ((gnus-select-method orig-select-method))
 823                         (gnus-group-prefixed-name "" method))))
 824           (while (setq group (pop groups))
 825             (gnus-add-text-properties
 826              (point)
 827              (prog1 (1+ (point))
 828                (insert
 829                 (format "%c%7d: %s\n"
 830                         (let ((level
 831                                (if (string= prefix "")
 832                                    (gnus-group-level (setq name (car group)))
 833                                  (gnus-group-level
 834                                   (concat prefix (setq name (car group)))))))
 835                           (cond
 836                            ((<= level gnus-level-subscribed) ? )
 837                            ((<= level gnus-level-unsubscribed) ?U)
 838                            ((= level gnus-level-zombie) ?Z)
 839                            (t ?K)))
 840                         (max 0 (- (1+ (cddr group)) (cadr group)))
 841                         ;; Don't decode if name is ASCII
 842                         (if (and (fboundp 'detect-coding-string)
 843                                  (eq (detect-coding-string name t) 'undecided))
 844                             name
 845                           (mm-decode-coding-string
 846                            name
 847                            (inline (gnus-group-name-charset method name)))))))
 848              (list 'gnus-group name)
 849              )))
 850         (switch-to-buffer (current-buffer)))
 851       (goto-char (point-min))
 852       (gnus-group-position-point)
 853       (gnus-message 5 "Connecting to %s...done" (nth 1 method))
 854       t))))
 855
 856 (defun gnus-browse-mode ()
 857   "Major mode for browsing a foreign server.
 858
 859 All normal editing commands are switched off.
 860
 861 \\<gnus-browse-mode-map>
 862 The only things you can do in this buffer is
 863
 864 1) `\\[gnus-browse-unsubscribe-current-group]' to subscribe to a group.
 865 The group will be inserted into the group buffer upon exit from this
 866 buffer.
 867
 868 2) `\\[gnus-browse-read-group]' to read a group ephemerally.
 869
 870 3) `\\[gnus-browse-exit]' to return to the group buffer."
 871   (interactive)
 872   (kill-all-local-variables)
 873   (when (gnus-visual-p 'browse-menu 'menu)
 874     (gnus-browse-make-menu-bar))
 875   (gnus-simplify-mode-line)
 876   (setq major-mode 'gnus-browse-mode)
 877   (setq mode-name "Browse Server")
 878   (setq mode-line-process nil)
 879   (use-local-map gnus-browse-mode-map)
 880   (buffer-disable-undo)
 881   (setq truncate-lines t)
 882   (gnus-set-default-directory)
 883   (setq buffer-read-only t)
 884   (gnus-run-mode-hooks 'gnus-browse-mode-hook))
 885
 886 (defun gnus-browse-read-group (&optional no-article number)
 887   "Enter the group at the current line.
 888 If NUMBER, fetch this number of articles."
 889   (interactive "P")
 890   (let ((group (gnus-browse-group-name)))
 891     (if (or (not (gnus-get-info group))
 892             (gnus-ephemeral-group-p group))
 893         (unless (gnus-group-read-ephemeral-group
 894                  group gnus-browse-current-method nil
 895                  (cons (current-buffer) 'browse)
 896                  nil nil nil number)
 897           (error "Couldn't enter %s" group))
 898       (unless (gnus-group-read-group nil no-article group)
 899         (error "Couldn't enter %s" group)))))
 900
 901 (defun gnus-browse-select-group (&optional number)
 902   "Select the current group.
 903 If NUMBER, fetch this number of articles."
 904   (interactive "P")
 905   (gnus-browse-read-group 'no number))
 906
 907 (defun gnus-browse-next-group (n)
 908   "Go to the next group."
 909   (interactive "p")
 910   (prog1
 911       (forward-line n)
 912     (gnus-group-position-point)))
 913
 914 (defun gnus-browse-prev-group (n)
 915   "Go to the next group."
 916   (interactive "p")
 917   (gnus-browse-next-group (- n)))
 918
 919 (defun gnus-browse-unsubscribe-current-group (arg)
 920   "(Un)subscribe to the next ARG groups.
 921 The variable `gnus-browse-subscribe-newsgroup-method' determines
 922 how new groups will be entered into the group buffer."
 923   (interactive "p")
 924   (when (eobp)
 925     (error "No group at current line"))
 926   (let ((ward (if (< arg 0) -1 1))
 927         (arg (abs arg)))
 928     (while (and (> arg 0)
 929                 (not (eobp))
 930                 (gnus-browse-unsubscribe-group)
 931                 (zerop (gnus-browse-next-group ward)))
 932       (decf arg))
 933     (gnus-group-position-point)
 934     (when (/= 0 arg)
 935       (gnus-message 7 "No more newsgroups"))
 936     arg))
 937
 938 (defun gnus-browse-group-name ()
 939   (save-excursion
 940     (beginning-of-line)
 941     (let ((name (get-text-property (point) 'gnus-group)))
 942       (when (re-search-forward ": \\(.*\\)$" (point-at-eol) t)
 943         (concat (gnus-method-to-server-name gnus-browse-current-method) ":"
 944                 (or name
 945                     (match-string-no-properties 1)))))))
 946
 947 (defun gnus-browse-describe-group (group)
 948   "Describe the current group."
 949   (interactive (list (gnus-browse-group-name)))
 950   (gnus-group-describe-group nil group))
 951
 952 (defun gnus-browse-unsubscribe-group ()
 953   "Toggle subscription of the current group in the browse buffer."
 954   (let ((sub nil)
 955         (buffer-read-only nil)
 956         group)
 957     (save-excursion
 958       (beginning-of-line)
 959       ;; If this group it killed, then we want to subscribe it.
 960       (unless (eq (char-after) ? )
 961         (setq sub t))
 962       (setq group (gnus-browse-group-name))
 963       (when (gnus-server-equal gnus-browse-current-method "native")
 964         (setq group (gnus-group-real-name group)))
 965       (if sub
 966           (progn
 967             ;; Make sure the group has been properly removed before we
 968             ;; subscribe to it.
 969             (if (gnus-ephemeral-group-p group)
 970                 (gnus-kill-ephemeral-group group))
 971             (let ((entry (gnus-group-entry group)))
 972               (if entry
 973                   ;; Just change the subscription level if it is an
 974                   ;; unsubscribed group.
 975                   (gnus-group-change-level entry
 976                                            gnus-level-default-subscribed)
 977                 ;; If it is a killed group or a zombie, feed it to the
 978                 ;; mechanism for new group subscription.
 979                 (gnus-call-subscribe-functions
 980                  gnus-browse-subscribe-newsgroup-method
 981                  group)))
 982             (delete-char 1)
 983             (insert (let ((lvl (gnus-group-level group)))
 984                       (cond
 985                        ((< lvl gnus-level-unsubscribed) ? )
 986                        ((< lvl gnus-level-zombie) ?U)
 987                        ((< lvl gnus-level-killed) ?Z)
 988                        (t ?K)))))
 989         (gnus-group-change-level
 990          group gnus-level-unsubscribed gnus-level-default-subscribed)
 991         (delete-char 1)
 992         (insert ?U)))
 993     t))
 994
 995 (defun gnus-browse-exit ()
 996   "Quit browsing and return to the group buffer."
 997   (interactive)
 998   (when (eq major-mode 'gnus-browse-mode)
 999     (gnus-kill-buffer (current-buffer)))
1000   ;; Insert the newly subscribed groups in the group buffer.
1001   (with-current-buffer gnus-group-buffer
1002     (gnus-group-list-groups nil))
1003   (if gnus-browse-return-buffer
1004       (gnus-configure-windows 'server 'force)
1005     (gnus-configure-windows 'group 'force)))
1006
1007 (defun gnus-browse-describe-briefly ()
1008   "Give a one line description of the group mode commands."
1009   (interactive)
1010   (gnus-message 6 "%s"
1011                 (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")))
1012
1013 (defun gnus-server-regenerate-server ()
1014   "Issue a command to the server to regenerate all its data structures."
1015   (interactive)
1016   (let ((server (gnus-server-server-name)))
1017     (unless server
1018       (error "No server on the current line"))
1019     (condition-case ()
1020         (gnus-get-function (gnus-server-to-method server)
1021                            'request-regenerate)
1022       (error
1023         (error "This back end doesn't support regeneration")))
1024     (gnus-message 5 "Requesting regeneration of %s..." server)
1025     (unless (gnus-open-server server)
1026       (error "Couldn't open server"))
1027     (if (gnus-request-regenerate server)
1028         (gnus-message 5 "Requesting regeneration of %s...done" server)
1029       (gnus-message 5 "Couldn't regenerate %s" server))))
1030
1031
1032 ;;;
1033 ;;; Server compaction. -- dvl
1034 ;;;
1035
1036 ;; #### FIXME: this function currently fails to update the Group buffer's
1037 ;; #### appearance.
1038 (defun gnus-server-compact-server ()
1039   "Issue a command to the server to compact all its groups.
1040
1041 Note: currently only implemented in nnml."
1042   (interactive)
1043   (let ((server (gnus-server-server-name)))
1044     (unless server
1045       (error "No server on the current line"))
1046     (condition-case ()
1047         (gnus-get-function (gnus-server-to-method server)
1048                            'request-compact)
1049       (error
1050        (error "This back end doesn't support compaction")))
1051     (gnus-message 5 "\
1052 Requesting compaction of %s... (this may take a long time)"
1053                   server)
1054     (unless (gnus-open-server server)
1055       (error "Couldn't open server"))
1056     (if (not (gnus-request-compact server))
1057         (gnus-message 5 "Couldn't compact %s" server)
1058       (gnus-message 5 "Requesting compaction of %s...done" server)
1059       ;; Invalidate the original article buffer which might be out of date.
1060       ;; #### NOTE: Yes, this might be a bit rude, but since compaction
1061       ;; #### will not happen very often, I think this is acceptable.
1062       (let ((original (get-buffer gnus-original-article-buffer)))
1063         (and original (gnus-kill-buffer original))))))
1064
1065 (provide 'gnus-srvr)
1066
1067 ;;; gnus-srvr.el ends here