git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-srvr.el

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