cgit.sxemacs.org Git - gnus/blob - lisp/gnus-srvr.el

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