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

   1 ;;; gnus-srvr.el --- virtual server support for Gnus
   2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000
   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 (defvar gnus-server-mode-hook nil
  38   "Hook run in `gnus-server-mode' buffers.")
  39
  40 (defconst gnus-server-line-format "     {%(%h:%w%)} %s\n"
  41   "Format of server lines.
  42 It works along the same lines as a normal formatting string,
  43 with some simple extensions.
  44
  45 The following specs are understood:
  46
  47 %h backend
  48 %n name
  49 %w address
  50 %s status")
  51
  52 (defvar gnus-server-mode-line-format "Gnus: %%b"
  53   "The format specification for the server mode line.")
  54
  55 (defvar gnus-server-exit-hook nil
  56   "*Hook run when exiting the server buffer.")
  57
  58 (defvar gnus-server-browse-in-group-buffer t
  59   "Whether browse server in group buffer.")
  60
  61 ;;; Internal variables.
  62
  63 (defvar gnus-inserted-opened-servers nil)
  64
  65 (defvar gnus-server-line-format-alist
  66   `((?h gnus-tmp-how ?s)
  67     (?n gnus-tmp-name ?s)
  68     (?w gnus-tmp-where ?s)
  69     (?s gnus-tmp-status ?s)))
  70
  71 (defvar gnus-server-mode-line-format-alist
  72   `((?S gnus-tmp-news-server ?s)
  73     (?M gnus-tmp-news-method ?s)
  74     (?u gnus-tmp-user-defined ?s)))
  75
  76 (defvar gnus-server-line-format-spec nil)
  77 (defvar gnus-server-mode-line-format-spec nil)
  78 (defvar gnus-server-killed-servers nil)
  79
  80 (defvar gnus-server-mode-map)
  81
  82 (defvar gnus-server-menu-hook nil
  83   "*Hook run after the creation of the server mode menu.")
  84
  85 (defun gnus-server-make-menu-bar ()
  86   (gnus-turn-off-edit-menu 'server)
  87   (unless (boundp 'gnus-server-server-menu)
  88     (easy-menu-define
  89      gnus-server-server-menu gnus-server-mode-map ""
  90      '("Server"
  91        ["Add" gnus-server-add-server t]
  92        ["Browse" gnus-server-read-server t]
  93        ["Scan" gnus-server-scan-server t]
  94        ["List" gnus-server-list-servers t]
  95        ["Kill" gnus-server-kill-server t]
  96        ["Yank" gnus-server-yank-server t]
  97        ["Copy" gnus-server-copy-server t]
  98        ["Edit" gnus-server-edit-server t]
  99        ["Regenerate" gnus-server-regenerate-server t]
 100        ["Exit" gnus-server-exit t]))
 101
 102     (easy-menu-define
 103      gnus-server-connections-menu gnus-server-mode-map ""
 104      '("Connections"
 105        ["Open" gnus-server-open-server t]
 106        ["Close" gnus-server-close-server t]
 107        ["Deny" gnus-server-deny-server t]
 108        "---"
 109        ["Open All" gnus-server-open-all-servers t]
 110        ["Close All" gnus-server-close-all-servers t]
 111        ["Reset All" gnus-server-remove-denials t]))
 112
 113     (gnus-run-hooks 'gnus-server-menu-hook)))
 114
 115 (defvar gnus-server-mode-map nil)
 116 (put 'gnus-server-mode 'mode-class 'special)
 117
 118 (unless gnus-server-mode-map
 119   (setq gnus-server-mode-map (make-sparse-keymap))
 120   (suppress-keymap gnus-server-mode-map)
 121
 122   (gnus-define-keys gnus-server-mode-map
 123     " " gnus-server-read-server-in-server-buffer
 124     "\r" gnus-server-read-server
 125     gnus-mouse-2 gnus-server-pick-server
 126     "q" gnus-server-exit
 127     "l" gnus-server-list-servers
 128     "k" gnus-server-kill-server
 129     "y" gnus-server-yank-server
 130     "c" gnus-server-copy-server
 131     "a" gnus-server-add-server
 132     "e" gnus-server-edit-server
 133     "s" gnus-server-scan-server
 134
 135     "O" gnus-server-open-server
 136     "\M-o" gnus-server-open-all-servers
 137     "C" gnus-server-close-server
 138     "\M-c" gnus-server-close-all-servers
 139     "D" gnus-server-deny-server
 140     "R" gnus-server-remove-denials
 141
 142     "n" next-line
 143     "p" previous-line
 144
 145     "g" gnus-server-regenerate-server
 146
 147     "\C-c\C-i" gnus-info-find-node
 148     "\C-c\C-b" gnus-bug))
 149
 150 (defun gnus-server-mode ()
 151   "Major mode for listing and editing servers.
 152
 153 All normal editing commands are switched off.
 154 \\<gnus-server-mode-map>
 155 For more in-depth information on this mode, read the manual
 156 (`\\[gnus-info-find-node]').
 157
 158 The following commands are available:
 159
 160 \\{gnus-server-mode-map}"
 161   (interactive)
 162   (when (gnus-visual-p 'server-menu 'menu)
 163     (gnus-server-make-menu-bar))
 164   (kill-all-local-variables)
 165   (gnus-simplify-mode-line)
 166   (setq major-mode 'gnus-server-mode)
 167   (setq mode-name "Server")
 168   (gnus-set-default-directory)
 169   (setq mode-line-process nil)
 170   (use-local-map gnus-server-mode-map)
 171   (buffer-disable-undo)
 172   (setq truncate-lines t)
 173   (setq buffer-read-only t)
 174   (gnus-run-hooks 'gnus-server-mode-hook))
 175
 176 (defun gnus-server-insert-server-line (gnus-tmp-name method)
 177   (let* ((gnus-tmp-how (car method))
 178          (gnus-tmp-where (nth 1 method))
 179          (elem (assoc method gnus-opened-servers))
 180          (gnus-tmp-status (cond ((eq (nth 1 elem) 'denied)
 181                                  "(denied)")
 182                                 ((or (gnus-server-opened method)
 183                                      (eq (nth 1 elem) 'ok))
 184                                  "(opened)")
 185                                 (t
 186                                  "(closed)"))))
 187     (beginning-of-line)
 188     (gnus-add-text-properties
 189      (point)
 190      (prog1 (1+ (point))
 191        ;; Insert the text.
 192        (eval gnus-server-line-format-spec))
 193      (list 'gnus-server (intern gnus-tmp-name)))))
 194
 195 (defun gnus-enter-server-buffer ()
 196   "Set up the server buffer."
 197   (gnus-server-setup-buffer)
 198   (gnus-configure-windows 'server)
 199   (gnus-server-prepare))
 200
 201 (defun gnus-server-setup-buffer ()
 202   "Initialize the server buffer."
 203   (unless (get-buffer gnus-server-buffer)
 204     (save-excursion
 205       (set-buffer (gnus-get-buffer-create gnus-server-buffer))
 206       (gnus-server-mode)
 207       (when gnus-carpal
 208         (gnus-carpal-setup-buffer 'server)))))
 209
 210 (defun gnus-server-prepare ()
 211   (gnus-set-format 'server-mode)
 212   (gnus-set-format 'server t)
 213   (let ((alist gnus-server-alist)
 214         (buffer-read-only nil)
 215         (opened gnus-opened-servers)
 216         done server op-ser)
 217     (erase-buffer)
 218     (setq gnus-inserted-opened-servers nil)
 219     ;; First we do the real list of servers.
 220     (while alist
 221       (unless (member (cdar alist) done)
 222         (push (cdar alist) done)
 223         (cdr (setq server (pop alist)))
 224         (when (and server (car server) (cdr server))
 225           (gnus-server-insert-server-line (car server) (cdr server))))
 226       (when (member (cdar alist) done)
 227         (pop alist)))
 228     ;; Then we insert the list of servers that have been opened in
 229     ;; this session.
 230     (while opened
 231       (when (and (not (member (caar opened) done))
 232                  ;; Just ignore ephemeral servers.
 233                  (not (member (caar opened) gnus-ephemeral-servers)))
 234         (push (caar opened) done)
 235         (gnus-server-insert-server-line
 236          (setq op-ser (format "%s:%s" (caaar opened) (nth 1 (caar opened))))
 237          (caar opened))
 238         (push (list op-ser (caar opened)) gnus-inserted-opened-servers))
 239       (setq opened (cdr opened))))
 240   (goto-char (point-min))
 241   (gnus-server-position-point))
 242
 243 (defun gnus-server-server-name ()
 244   (let ((server (get-text-property (gnus-point-at-bol) 'gnus-server)))
 245     (and server (symbol-name server))))
 246
 247 (defalias 'gnus-server-position-point 'gnus-goto-colon)
 248
 249 (defconst gnus-server-edit-buffer "*Gnus edit server*")
 250
 251 (defun gnus-server-update-server (server)
 252   (save-excursion
 253     (set-buffer gnus-server-buffer)
 254     (let* ((buffer-read-only nil)
 255            (entry (assoc server gnus-server-alist))
 256            (oentry (assoc (gnus-server-to-method server)
 257                           gnus-opened-servers)))
 258       (when entry
 259         (gnus-dribble-enter
 260          (concat "(gnus-server-set-info \"" server "\" '"
 261                  (prin1-to-string (cdr entry)) ")\n")))
 262       (when (or entry oentry)
 263         ;; Buffer may be narrowed.
 264         (save-restriction
 265           (widen)
 266           (when (gnus-server-goto-server server)
 267             (gnus-delete-line))
 268           (if entry
 269               (gnus-server-insert-server-line (car entry) (cdr entry))
 270             (gnus-server-insert-server-line
 271              (format "%s:%s" (caar oentry) (nth 1 (car oentry)))
 272              (car oentry)))
 273           (gnus-server-position-point))))))
 274
 275 (defun gnus-server-set-info (server info)
 276   ;; Enter a select method into the virtual server alist.
 277   (when (and server info)
 278     (gnus-dribble-enter
 279      (concat "(gnus-server-set-info \"" server "\" '"
 280              (prin1-to-string info) ")"))
 281     (let* ((server (nth 1 info))
 282            (entry (assoc server gnus-server-alist)))
 283       (if entry (setcdr entry info)
 284         (setq gnus-server-alist
 285               (nconc gnus-server-alist (list (cons server info))))))))
 286
 287 ;;; Interactive server functions.
 288
 289 (defun gnus-server-kill-server (server)
 290   "Kill the server on the current line."
 291   (interactive (list (gnus-server-server-name)))
 292   (unless (gnus-server-goto-server server)
 293     (if server (error "No such server: %s" server)
 294       (error "No server on the current line")))
 295   (unless (assoc server gnus-server-alist)
 296     (error "Read-only server %s" server))
 297   (gnus-dribble-touch)
 298   (let ((buffer-read-only nil))
 299     (gnus-delete-line))
 300   (push (assoc server gnus-server-alist) gnus-server-killed-servers)
 301   (setq gnus-server-alist (delq (car gnus-server-killed-servers)
 302                                 gnus-server-alist))
 303   (let ((groups (gnus-groups-from-server server)))
 304     (when (and groups
 305                (gnus-yes-or-no-p
 306                 (format "Kill all %s groups from this server? "
 307                         (length groups))))
 308       (dolist (group groups)
 309         (setq gnus-newsrc-alist
 310               (delq (assoc group gnus-newsrc-alist)
 311                     gnus-newsrc-alist))
 312         (when gnus-group-change-level-function
 313           (funcall gnus-group-change-level-function
 314                    group gnus-level-killed 3)))))
 315   (gnus-server-position-point))
 316
 317 (defun gnus-server-yank-server ()
 318   "Yank the previously killed server."
 319   (interactive)
 320   (unless gnus-server-killed-servers
 321     (error "No killed servers to be yanked"))
 322   (let ((alist gnus-server-alist)
 323         (server (gnus-server-server-name))
 324         (killed (car gnus-server-killed-servers)))
 325     (if (not server)
 326         (setq gnus-server-alist (nconc gnus-server-alist (list killed)))
 327       (if (string= server (caar gnus-server-alist))
 328           (push killed gnus-server-alist)
 329         (while (and (cdr alist)
 330                     (not (string= server (caadr alist))))
 331           (setq alist (cdr alist)))
 332         (if alist
 333             (setcdr alist (cons killed (cdr alist)))
 334           (setq gnus-server-alist (list killed)))))
 335     (gnus-server-update-server (car killed))
 336     (setq gnus-server-killed-servers (cdr gnus-server-killed-servers))
 337     (gnus-server-position-point)))
 338
 339 (defun gnus-server-exit ()
 340   "Return to the group buffer."
 341   (interactive)
 342   (gnus-run-hooks 'gnus-server-exit-hook)
 343   (kill-buffer (current-buffer))
 344   (gnus-configure-windows 'group t))
 345
 346 (defun gnus-server-list-servers ()
 347   "List all available servers."
 348   (interactive)
 349   (let ((cur (gnus-server-server-name)))
 350     (gnus-server-prepare)
 351     (if cur (gnus-server-goto-server cur)
 352       (goto-char (point-max))
 353       (forward-line -1))
 354     (gnus-server-position-point)))
 355
 356 (defun gnus-server-set-status (method status)
 357   "Make METHOD have STATUS."
 358   (let ((entry (assoc method gnus-opened-servers)))
 359     (if entry
 360         (setcar (cdr entry) status)
 361       (push (list method status) gnus-opened-servers))))
 362
 363 (defun gnus-opened-servers-remove (method)
 364   "Remove METHOD from the list of opened servers."
 365   (setq gnus-opened-servers (delq (assoc method gnus-opened-servers)
 366                                   gnus-opened-servers)))
 367
 368 (defun gnus-server-open-server (server)
 369   "Force an open of SERVER."
 370   (interactive (list (gnus-server-server-name)))
 371   (let ((method (gnus-server-to-method server)))
 372     (unless method
 373       (error "No such server: %s" server))
 374     (gnus-server-set-status method 'ok)
 375     (prog1
 376         (or (gnus-open-server method)
 377             (progn (message "Couldn't open %s" server) nil))
 378       (gnus-server-update-server server)
 379       (gnus-server-position-point))))
 380
 381 (defun gnus-server-open-all-servers ()
 382   "Open all servers."
 383   (interactive)
 384   (let ((servers gnus-inserted-opened-servers))
 385     (while servers
 386       (gnus-server-open-server (car (pop servers))))))
 387
 388 (defun gnus-server-close-server (server)
 389   "Close SERVER."
 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 'closed)
 395     (prog1
 396         (gnus-close-server method)
 397       (gnus-server-update-server server)
 398       (gnus-server-position-point))))
 399
 400 (defun gnus-server-close-all-servers ()
 401   "Close all servers."
 402   (interactive)
 403   (let ((servers gnus-inserted-opened-servers))
 404     (while servers
 405       (gnus-server-close-server (car (pop servers))))))
 406
 407 (defun gnus-server-deny-server (server)
 408   "Make sure SERVER will never be attempted opened."
 409   (interactive (list (gnus-server-server-name)))
 410   (let ((method (gnus-server-to-method server)))
 411     (unless method
 412       (error "No such server: %s" server))
 413     (gnus-server-set-status method 'denied))
 414   (gnus-server-update-server server)
 415   (gnus-server-position-point)
 416   t)
 417
 418 (defun gnus-server-remove-denials ()
 419   "Make all denied servers into closed servers."
 420   (interactive)
 421   (let ((servers gnus-opened-servers))
 422     (while servers
 423       (when (eq (nth 1 (car servers)) 'denied)
 424         (setcar (nthcdr 1 (car servers)) 'closed))
 425       (setq servers (cdr servers))))
 426   (gnus-server-list-servers))
 427
 428 (defun gnus-server-copy-server (from to)
 429   (interactive
 430    (list
 431     (or (gnus-server-server-name)
 432         (error "No server on the current line"))
 433     (read-string "Copy to: ")))
 434   (unless from
 435     (error "No server on current line"))
 436   (unless (and to (not (string= to "")))
 437     (error "No name to copy to"))
 438   (when (assoc to gnus-server-alist)
 439     (error "%s already exists" to))
 440   (unless (gnus-server-to-method from)
 441     (error "%s: no such server" from))
 442   (let ((to-entry (cons from (gnus-copy-sequence
 443                               (gnus-server-to-method from)))))
 444     (setcar to-entry to)
 445     (setcar (nthcdr 2 to-entry) to)
 446     (push to-entry gnus-server-killed-servers)
 447     (gnus-server-yank-server)))
 448
 449 (defun gnus-server-add-server (how where)
 450   (interactive
 451    (list (intern (completing-read "Server method: "
 452                                   gnus-valid-select-methods nil t))
 453          (read-string "Server name: ")))
 454   (when (assq where gnus-server-alist)
 455     (error "Server with that name already defined"))
 456   (push (list where how where) gnus-server-killed-servers)
 457   (gnus-server-yank-server))
 458
 459 (defun gnus-server-goto-server (server)
 460   "Jump to a server line."
 461   (interactive
 462    (list (completing-read "Goto server: " gnus-server-alist nil t)))
 463   (let ((to (text-property-any (point-min) (point-max)
 464                                'gnus-server (intern server))))
 465     (when to
 466       (goto-char to)
 467       (gnus-server-position-point))))
 468
 469 (defun gnus-server-edit-server (server)
 470   "Edit the server on the current line."
 471   (interactive (list (gnus-server-server-name)))
 472   (unless server
 473     (error "No server on current line"))
 474   (unless (assoc server gnus-server-alist)
 475     (error "This server can't be edited"))
 476   (let ((info (cdr (assoc server gnus-server-alist))))
 477     (gnus-close-server info)
 478     (gnus-edit-form
 479      info "Editing the server."
 480      `(lambda (form)
 481         (gnus-server-set-info ,server form)
 482         (gnus-server-list-servers)
 483         (gnus-server-position-point)))))
 484
 485 (defun gnus-server-scan-server (server)
 486   "Request a scan from the current server."
 487   (interactive (list (gnus-server-server-name)))
 488   (let ((method (gnus-server-to-method server)))
 489     (if (not (gnus-get-function method 'request-scan))
 490         (error "Server %s can't scan" (car method))
 491       (gnus-message 3 "Scanning %s..." server)
 492       (gnus-request-scan nil method)
 493       (gnus-message 3 "Scanning %s...done" server))))
 494
 495 (defun gnus-server-read-server-in-server-buffer (server)
 496   "Browse a server in server buffer."
 497   (interactive (list (gnus-server-server-name)))
 498   (let (gnus-server-browse-in-group-buffer)
 499     (gnus-server-read-server server)))
 500
 501 (defun gnus-server-read-server (server)
 502   "Browse a server."
 503   (interactive (list (gnus-server-server-name)))
 504   (let ((buf (current-buffer)))
 505     (prog1
 506         (gnus-browse-foreign-server server buf)
 507       (save-excursion
 508         (set-buffer buf)
 509         (gnus-server-update-server (gnus-server-server-name))
 510         (gnus-server-position-point)))))
 511
 512 (defun gnus-server-pick-server (e)
 513   (interactive "e")
 514   (mouse-set-point e)
 515   (gnus-server-read-server (gnus-server-server-name)))
 516
 517 \f
 518 ;;;
 519 ;;; Browse Server Mode
 520 ;;;
 521
 522 (defvar gnus-browse-menu-hook nil
 523   "*Hook run after the creation of the browse mode menu.")
 524
 525 (defvar gnus-browse-mode-hook nil)
 526 (defvar gnus-browse-mode-map nil)