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

   1 ;;; gnus-agent.el --- unplugged support for Gnus
   2 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; This file is part of GNU Emacs.
   7
   8 ;; GNU Emacs is free software; you can redistribute it and/or modify
   9 ;; it under the terms of the GNU General Public License as published by
  10 ;; the Free Software Foundation; either version 2, or (at your option)
  11 ;; any later version.
  12
  13 ;; GNU Emacs is distributed in the hope that it will be useful,
  14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 ;; GNU General Public License for more details.
  17
  18 ;; You should have received a copy of the GNU General Public License
  19 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21 ;; Boston, MA 02111-1307, USA.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (require 'gnus)
  28 (require 'gnus-cache)
  29 (require 'nnvirtual)
  30 (require 'gnus-sum)
  31 (require 'gnus-score)
  32 (require 'gnus-srvr)
  33 (eval-when-compile
  34   (if (featurep 'xemacs)
  35       (require 'itimer)
  36     (require 'timer))
  37   (require 'cl))
  38
  39 (eval-and-compile
  40   (autoload 'gnus-server-update-server "gnus-srvr")
  41   (autoload 'gnus-agent-customize-category "gnus-cus")
  42 )
  43
  44 (defcustom gnus-agent-directory (nnheader-concat gnus-directory "agent/")
  45   "Where the Gnus agent will store its files."
  46   :group 'gnus-agent
  47   :type 'directory)
  48
  49 (defcustom gnus-agent-plugged-hook nil
  50   "Hook run when plugging into the network."
  51   :group 'gnus-agent
  52   :type 'hook)
  53
  54 (defcustom gnus-agent-unplugged-hook nil
  55   "Hook run when unplugging from the network."
  56   :group 'gnus-agent
  57   :type 'hook)
  58
  59 (defcustom gnus-agent-handle-level gnus-level-subscribed
  60   "Groups on levels higher than this variable will be ignored by the Agent."
  61   :group 'gnus-agent
  62   :type 'integer)
  63
  64 (defcustom gnus-agent-expire-days 7
  65   "Read articles older than this will be expired.
  66 This can also be a list of regexp/day pairs.  The regexps will be
  67 matched against group names."
  68   :group 'gnus-agent
  69   :type '(choice (number :tag "days")
  70                  (sexp :tag "List" nil)))
  71
  72 (defcustom gnus-agent-expire-all nil
  73   "If non-nil, also expire unread, ticked and dormant articles.
  74 If nil, only read articles will be expired."
  75   :group 'gnus-agent
  76   :type 'boolean)
  77
  78 (defcustom gnus-agent-group-mode-hook nil
  79   "Hook run in Agent group minor modes."
  80   :group 'gnus-agent
  81   :type 'hook)
  82
  83 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
  84 (when (featurep 'xemacs)
  85   (add-hook 'gnus-agent-group-mode-hook 'gnus-xmas-agent-group-menu-add))
  86
  87 (defcustom gnus-agent-summary-mode-hook nil
  88   "Hook run in Agent summary minor modes."
  89   :group 'gnus-agent
  90   :type 'hook)
  91
  92 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
  93 (when (featurep 'xemacs)
  94   (add-hook 'gnus-agent-summary-mode-hook 'gnus-xmas-agent-summary-menu-add))
  95
  96 (defcustom gnus-agent-server-mode-hook nil
  97   "Hook run in Agent summary minor modes."
  98   :group 'gnus-agent
  99   :type 'hook)
 100
 101 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 102 (when (featurep 'xemacs)
 103   (add-hook 'gnus-agent-server-mode-hook 'gnus-xmas-agent-server-menu-add))
 104
 105 (defcustom gnus-agent-confirmation-function 'y-or-n-p
 106   "Function to confirm when error happens."
 107   :version "21.1"
 108   :group 'gnus-agent
 109   :type 'function)
 110
 111 (defcustom gnus-agent-synchronize-flags 'ask
 112   "Indicate if flags are synchronized when you plug in.
 113 If this is `ask' the hook will query the user."
 114   :version "21.1"
 115   :type '(choice (const :tag "Always" t)
 116                  (const :tag "Never" nil)
 117                  (const :tag "Ask" ask))
 118   :group 'gnus-agent)
 119
 120 (defcustom gnus-agent-go-online 'ask
 121   "Indicate if offline servers go online when you plug in.
 122 If this is `ask' the hook will query the user."
 123   :version "21.1"
 124   :type '(choice (const :tag "Always" t)
 125                  (const :tag "Never" nil)
 126                  (const :tag "Ask" ask))
 127   :group 'gnus-agent)
 128
 129 (defcustom gnus-agent-mark-unread-after-downloaded t
 130   "Indicate whether to mark articles unread after downloaded."
 131   :version "21.1"
 132   :type 'boolean
 133   :group 'gnus-agent)
 134
 135 (defcustom gnus-agent-download-marks '(download)
 136   "Marks for downloading."
 137   :version "21.1"
 138   :type '(repeat (symbol :tag "Mark"))
 139   :group 'gnus-agent)
 140
 141 (defcustom gnus-agent-consider-all-articles nil
 142   "If non-nil, consider also the read articles for downloading."
 143   :version "21.4"
 144   :type 'boolean
 145   :group 'gnus-agent)
 146
 147 (defcustom gnus-agent-max-fetch-size 10000000 ;; 10 Mb
 148   "Chunk size for `gnus-agent-fetch-session'.
 149 The function will split its article fetches into chunks smaller than
 150 this limit."
 151   :group 'gnus-agent
 152   :type 'integer)
 153
 154 (defcustom gnus-agent-enable-expiration 'ENABLE
 155   "The default expiration state for each group.
 156 When set to ENABLE, the default, gnus-agent-expire will expire old
 157 contents from a group's local storage.  This value may be overridden
 158 to disable expiration in specific categories, topics, and groups.  Of
 159 course, you could change gnus-agent-enable-expiration to nil then
 160 enable expiration per categories, topics, and groups."
 161   :group 'gnus-agent
 162   :type '(radio (const :format "Enable " ENABLE)
 163                 (const :format "Disable " DISABLE)))
 164
 165 ;;; Internal variables
 166
 167 (defvar gnus-agent-history-buffers nil)
 168 (defvar gnus-agent-buffer-alist nil)
 169 (defvar gnus-agent-article-alist nil
 170 "An assoc list identifying the articles whose headers have been fetched.
 171 If successfully fetched, these headers will be stored in the group's overview
 172 file.  The key of each assoc pair is the article ID, the value of each assoc
 173 pair is a flag indicating whether the identified article has been downloaded
 174 \(gnus-agent-fetch-articles sets the value to the day of the download).
 175 NOTES:
 176 1) The last element of this list can not be expired as some
 177    routines (for example, get-agent-fetch-headers) use the last
 178    value to track which articles have had their headers retrieved.
 179 2) The gnus-agent-regenerate may destructively modify the value.
 180 ")
 181 (defvar gnus-agent-group-alist nil)
 182 (defvar gnus-category-alist nil)
 183 (defvar gnus-agent-current-history nil)
 184 (defvar gnus-agent-overview-buffer nil)
 185 (defvar gnus-category-predicate-cache nil)
 186 (defvar gnus-category-group-cache nil)
 187 (defvar gnus-agent-spam-hashtb nil)
 188 (defvar gnus-agent-file-name nil)
 189 (defvar gnus-agent-send-mail-function nil)
 190 (defvar gnus-agent-file-coding-system 'raw-text)
 191 (defvar gnus-agent-file-loading-cache nil)
 192 (defvar gnus-agent-file-header-cache nil)
 193
 194 (defvar gnus-agent-auto-agentize-methods '(nntp nnimap)
 195   "Initially, all servers from these methods are agentized.
 196 The user may remove or add servers using the Server buffer.  See Info
 197 node `(gnus)Server Buffer'.")
 198
 199 ;; Dynamic variables
 200 (defvar gnus-headers)
 201 (defvar gnus-score)
 202
 203 ;;;
 204 ;;; Setup
 205 ;;;
 206
 207 (defun gnus-open-agent ()
 208   (setq gnus-agent t)
 209   (gnus-agent-read-servers)
 210   (gnus-category-read)
 211   (gnus-agent-create-buffer)
 212   (add-hook 'gnus-group-mode-hook 'gnus-agent-mode)
 213   (add-hook 'gnus-summary-mode-hook 'gnus-agent-mode)
 214   (add-hook 'gnus-server-mode-hook 'gnus-agent-mode))
 215
 216 (defun gnus-agent-create-buffer ()
 217   (if (gnus-buffer-live-p gnus-agent-overview-buffer)
 218       t
 219     (setq gnus-agent-overview-buffer
 220           (gnus-get-buffer-create " *Gnus agent overview*"))
 221     (with-current-buffer gnus-agent-overview-buffer
 222       (mm-enable-multibyte))
 223     nil))
 224
 225 (gnus-add-shutdown 'gnus-close-agent 'gnus)
 226
 227 (defun gnus-close-agent ()
 228   (setq gnus-category-predicate-cache nil
 229         gnus-category-group-cache nil
 230         gnus-agent-spam-hashtb nil)
 231   (gnus-kill-buffer gnus-agent-overview-buffer))
 232
 233 ;;;
 234 ;;; Utility functions
 235 ;;;
 236
 237 (defun gnus-agent-read-file (file)
 238   "Load FILE and do a `read' there."
 239   (with-temp-buffer
 240     (ignore-errors
 241       (nnheader-insert-file-contents file)
 242       (goto-char (point-min))
 243       (read (current-buffer)))))
 244
 245 (defsubst gnus-agent-method ()
 246   (concat (symbol-name (car gnus-command-method)) "/"
 247           (if (equal (cadr gnus-command-method) "")
 248               "unnamed"
 249             (cadr gnus-command-method))))
 250
 251 (defsubst gnus-agent-directory ()
 252   "The name of the Gnus agent directory."
 253   (nnheader-concat gnus-agent-directory
 254                    (nnheader-translate-file-chars (gnus-agent-method)) "/"))
 255
 256 (defun gnus-agent-lib-file (file)
 257   "The full name of the Gnus agent library FILE."
 258   (expand-file-name file
 259                     (file-name-as-directory
 260                      (expand-file-name "agent.lib" (gnus-agent-directory)))))
 261
 262 (defun gnus-agent-cat-set-property (category property value)
 263   (if value
 264       (setcdr (or (assq property category)
 265               (let ((cell (cons property nil)))
 266                     (setcdr category (cons cell (cdr category)))
 267                     cell)) value)
 268     (let ((category category))
 269       (while (cond ((eq property (caadr category))
 270                     (setcdr category (cddr category))
 271                     nil)
 272                    (t
 273                     (setq category (cdr category)))))))
 274   category)
 275
 276 (defmacro gnus-agent-cat-defaccessor (name prop-name)
 277   "Define accessor and setter methods for manipulating a list of the form
 278 (NAME (PROPERTY1 VALUE1) ... (PROPERTY_N VALUE_N)).
 279 Given the call (gnus-agent-cat-defaccessor func PROPERTY1), the list may be
 280 manipulated as follows:
 281   (func LIST): Returns VALUE1
 282   (setf (func LIST) NEW_VALUE1): Replaces VALUE1 with NEW_VALUE1."
 283   `(progn (defmacro ,name (category)
 284             (list (quote cdr) (list (quote assq)
 285                                     (quote (quote ,prop-name)) category)))
 286
 287           (define-setf-method ,name (category)
 288             (let* ((--category--temp-- (gensym "--category--"))
 289                    (--value--temp-- (gensym "--value--")))
 290               (list (list --category--temp--) ; temporary-variables
 291                     (list category)     ; value-forms
 292                     (list --value--temp--) ; store-variables
 293                     (let* ((category --category--temp--) ; store-form
 294                            (value --value--temp--))
 295                       (list (quote gnus-agent-cat-set-property)
 296                             category
 297                             (quote (quote ,prop-name))
 298                             value))
 299                     (list (quote ,name) --category--temp--) ; access-form
 300                     )))))
 301
 302 (defmacro gnus-agent-cat-name (category)
 303   `(car ,category))
 304
 305 (gnus-agent-cat-defaccessor
 306  gnus-agent-cat-days-until-old    agent-days-until-old)
 307 (gnus-agent-cat-defaccessor
 308  gnus-agent-cat-enable-expiration agent-enable-expiration)
 309 (gnus-agent-cat-defaccessor
 310  gnus-agent-cat-groups            agent-groups)
 311 (gnus-agent-cat-defaccessor
 312  gnus-agent-cat-high-score        agent-high-score)
 313 (gnus-agent-cat-defaccessor
 314  gnus-agent-cat-length-when-long  agent-length-when-long)
 315 (gnus-agent-cat-defaccessor
 316  gnus-agent-cat-length-when-short agent-length-when-short)
 317 (gnus-agent-cat-defaccessor
 318  gnus-agent-cat-low-score         agent-low-score)
 319 (gnus-agent-cat-defaccessor
 320  gnus-agent-cat-predicate         agent-predicate)
 321 (gnus-agent-cat-defaccessor
 322  gnus-agent-cat-score-file        agent-score-file)
 323
 324 (defsetf gnus-agent-cat-groups (category) (groups)
 325   (list 'gnus-agent-set-cat-groups category groups))
 326
 327 (defun gnus-agent-set-cat-groups (category groups)
 328   (unless (eq groups 'ignore)
 329     (let ((new-g groups)
 330           (old-g (gnus-agent-cat-groups category)))
 331       (cond ((eq new-g old-g)
 332              ;; gnus-agent-add-group is fiddling with the group
 333              ;; list. Still, Im done.
 334              nil
 335              )
 336             ((eq new-g (cdr old-g))
 337              ;; gnus-agent-add-group is fiddling with the group list
 338              (setcdr (or (assq 'agent-groups category)
 339                          (let ((cell (cons 'agent-groups nil)))
 340                            (setcdr category (cons cell (cdr category)))
 341                            cell)) new-g))
 342             (t
 343              (let ((groups groups))
 344                (while groups
 345                  (let* ((group        (pop groups))
 346                         (old-category (gnus-group-category group)))
 347                    (if (eq category old-category)
 348                        nil
 349                      (setf (gnus-agent-cat-groups old-category)
 350                            (delete group (gnus-agent-cat-groups
 351                                           old-category))))))
 352                ;; Purge cache as preceeding loop invalidated it.
 353                (setq gnus-category-group-cache nil))
 354
 355              (setcdr (or (assq 'agent-groups category)
 356                          (let ((cell (cons 'agent-groups nil)))
 357                            (setcdr category (cons cell (cdr category)))
 358                            cell)) groups))))))
 359
 360 (defsubst gnus-agent-cat-make (name)
 361   (list name '(agent-predicate . false)))
 362
 363 ;;; Fetching setup functions.
 364
 365 (defun gnus-agent-start-fetch ()
 366   "Initialize data structures for efficient fetching."
 367   (gnus-agent-create-buffer))
 368
 369 (defun gnus-agent-stop-fetch ()
 370   "Save all data structures and clean up."
 371   (setq gnus-agent-spam-hashtb nil)
 372   (save-excursion
 373     (set-buffer nntp-server-buffer)
 374     (widen)))
 375
 376 (defmacro gnus-agent-with-fetch (&rest forms)
 377   "Do FORMS safely."
 378   `(unwind-protect
 379        (let ((gnus-agent-fetching t))
 380          (gnus-agent-start-fetch)
 381          ,@forms)
 382      (gnus-agent-stop-fetch)))
 383
 384 (put 'gnus-agent-with-fetch 'lisp-indent-function 0)
 385 (put 'gnus-agent-with-fetch 'edebug-form-spec '(body))
 386
 387 (defmacro gnus-agent-append-to-list (tail value)
 388   `(setq ,tail (setcdr ,tail (cons ,value nil))))
 389
 390 ;;;
 391 ;;; Mode infestation
 392 ;;;
 393
 394 (defvar gnus-agent-mode-hook nil
 395   "Hook run when installing agent mode.")
 396
 397 (defvar gnus-agent-mode nil)
 398 (defvar gnus-agent-mode-status '(gnus-agent-mode " Plugged"))
 399
 400 (defun gnus-agent-mode ()
 401   "Minor mode for providing a agent support in Gnus buffers."
 402   (let* ((buffer (progn (string-match "^gnus-\\(.*\\)-mode$"
 403                                       (symbol-name major-mode))
 404                         (match-string 1 (symbol-name major-mode))))
 405          (mode (intern (format "gnus-agent-%s-mode" buffer))))
 406     (set (make-local-variable 'gnus-agent-mode) t)
 407     (set mode nil)
 408     (set (make-local-variable mode) t)
 409     ;; Set up the menu.
 410     (when (gnus-visual-p 'agent-menu 'menu)
 411       (funcall (intern (format "gnus-agent-%s-make-menu-bar" buffer))))
 412     (unless (assq 'gnus-agent-mode minor-mode-alist)
 413       (push gnus-agent-mode-status minor-mode-alist))
 414     (unless (assq mode minor-mode-map-alist)
 415       (push (cons mode (symbol-value (intern (format "gnus-agent-%s-mode-map"
 416                                                      buffer))))
 417             minor-mode-map-alist))
 418     (when (eq major-mode 'gnus-group-mode)
 419       (gnus-agent-toggle-plugged gnus-plugged))
 420     (gnus-run-hooks 'gnus-agent-mode-hook
 421                     (intern (format "gnus-agent-%s-mode-hook" buffer)))))
 422
 423 (defvar gnus-agent-group-mode-map (make-sparse-keymap))
 424 (gnus-define-keys gnus-agent-group-mode-map
 425   "Ju" gnus-agent-fetch-groups
 426   "Jc" gnus-enter-category-buffer
 427   "Jj" gnus-agent-toggle-plugged
 428   "Js" gnus-agent-fetch-session
 429   "JY" gnus-agent-synchronize-flags
 430   "JS" gnus-group-send-queue
 431   "Ja" gnus-agent-add-group
 432   "Jr" gnus-agent-remove-group
 433   "Jo" gnus-agent-toggle-group-plugged)
 434
 435 (defun gnus-agent-group-make-menu-bar ()
 436   (unless (boundp 'gnus-agent-group-menu)
 437     (easy-menu-define
 438      gnus-agent-group-menu gnus-agent-group-mode-map ""
 439      '("Agent"
 440        ["Toggle plugged" gnus-agent-toggle-plugged t]
 441        ["Toggle group plugged" gnus-agent-toggle-group-plugged t]
 442        ["List categories" gnus-enter-category-buffer t]
 443        ["Add (current) group to category" gnus-agent-add-group t]
 444        ["Remove (current) group from category" gnus-agent-remove-group t]
 445        ["Send queue" gnus-group-send-queue gnus-plugged]
 446        ("Fetch"
 447         ["All" gnus-agent-fetch-session gnus-plugged]
 448         ["Group" gnus-agent-fetch-group gnus-plugged])
 449        ["Synchronize flags" gnus-agent-synchronize-flags t]
 450        ))))
 451
 452 (defvar gnus-agent-summary-mode-map (make-sparse-keymap))
 453 (gnus-define-keys gnus-agent-summary-mode-map
 454   "Jj" gnus-agent-toggle-plugged
 455   "Ju" gnus-agent-summary-fetch-group
 456   "JS" gnus-agent-fetch-group
 457   "Js" gnus-agent-summary-fetch-series
 458   "J#" gnus-agent-mark-article
 459   "J\M-#" gnus-agent-unmark-article
 460   "@" gnus-agent-toggle-mark
 461   "Jc" gnus-agent-catchup)
 462
 463 (defun gnus-agent-summary-make-menu-bar ()
 464   (unless (boundp 'gnus-agent-summary-menu)
 465     (easy-menu-define
 466      gnus-agent-summary-menu gnus-agent-summary-mode-map ""
 467      '("Agent"
 468        ["Toggle plugged" gnus-agent-toggle-plugged t]
 469        ["Mark as downloadable" gnus-agent-mark-article t]
 470        ["Unmark as downloadable" gnus-agent-unmark-article t]
 471        ["Toggle mark" gnus-agent-toggle-mark t]
 472        ["Fetch downloadable" gnus-agent-summary-fetch-group t]
 473        ["Catchup undownloaded" gnus-agent-catchup t]))))
 474
 475 (defvar gnus-agent-server-mode-map (make-sparse-keymap))
 476 (gnus-define-keys gnus-agent-server-mode-map
 477   "Jj" gnus-agent-toggle-plugged
 478   "Ja" gnus-agent-add-server
 479   "Jr" gnus-agent-remove-server)
 480
 481 (defun gnus-agent-server-make-menu-bar ()
 482   (unless (boundp 'gnus-agent-server-menu)
 483     (easy-menu-define
 484      gnus-agent-server-menu gnus-agent-server-mode-map ""
 485      '("Agent"
 486        ["Toggle plugged" gnus-agent-toggle-plugged t]
 487        ["Add" gnus-agent-add-server t]
 488        ["Remove" gnus-agent-remove-server t]))))
 489
 490 (defun gnus-agent-make-mode-line-string (string mouse-button mouse-func)
 491   (if (and (fboundp 'propertize)
 492            (fboundp 'make-mode-line-mouse-map))
 493       (propertize string 'local-map
 494                   (make-mode-line-mouse-map mouse-button mouse-func))
 495     string))
 496
 497 (defun gnus-agent-toggle-plugged (set-to)
 498   "Toggle whether Gnus is unplugged or not."
 499   (interactive (list (not gnus-plugged)))
 500   (cond ((eq set-to gnus-plugged)
 501          nil)
 502         (set-to
 503          (setq gnus-plugged set-to)
 504          (gnus-run-hooks 'gnus-agent-plugged-hook)
 505          (setcar (cdr gnus-agent-mode-status)
 506                  (gnus-agent-make-mode-line-string " Plugged"
 507                                                    'mouse-2
 508                                                    'gnus-agent-toggle-plugged))
 509          (gnus-agent-go-online gnus-agent-go-online)
 510          (gnus-agent-possibly-synchronize-flags))
 511         (t
 512          (gnus-agent-close-connections)
 513          (setq gnus-plugged set-to)
 514          (gnus-run-hooks 'gnus-agent-unplugged-hook)
 515          (setcar (cdr gnus-agent-mode-status)
 516                  (gnus-agent-make-mode-line-string " Unplugged"
 517                                                    'mouse-2
 518                                                    'gnus-agent-toggle-plugged))))
 519   (set-buffer-modified-p t))
 520
 521 (defmacro gnus-agent-while-plugged (&rest body)
 522   `(let ((original-gnus-plugged gnus-plugged))
 523     (unwind-protect
 524         (progn (gnus-agent-toggle-plugged t)
 525                ,@body)
 526       (gnus-agent-toggle-plugged original-gnus-plugged))))
 527
 528 (put 'gnus-agent-while-plugged 'lisp-indent-function 0)
 529 (put 'gnus-agent-while-plugged 'edebug-form-spec '(body))
 530
 531 (defun gnus-agent-close-connections ()
 532   "Close all methods covered by the Gnus agent."
 533   (let ((methods gnus-agent-covered-methods))
 534     (while methods
 535       (gnus-close-server (pop methods)))))
 536
 537 ;;;###autoload
 538 (defun gnus-unplugged ()
 539   "Start Gnus unplugged."
 540   (interactive)
 541   (setq gnus-plugged nil)
 542   (gnus))
 543
 544 ;;;###autoload
 545 (defun gnus-plugged ()
 546   "Start Gnus plugged."
 547   (interactive)
 548   (setq gnus-plugged t)
 549   (gnus))
 550
 551 ;;;###autoload
 552 (defun gnus-slave-unplugged (&optional arg)
 553   "Read news as a slave unplugged."
 554   (interactive "P")
 555   (setq gnus-plugged nil)
 556   (gnus arg nil 'slave))
 557
 558 ;;;###autoload
 559 (defun gnus-agentize ()
 560   "Allow Gnus to be an offline newsreader.
 561 The normal usage of this command is to put the following as the
 562 last form in your `.gnus.el' file:
 563
 564 \(gnus-agentize)
 565
 566 This will modify the `gnus-setup-news-hook', and
 567 `message-send-mail-real-function' variables, and install the Gnus agent
 568 minor mode in all Gnus buffers."
 569   (interactive)
 570   (gnus-open-agent)
 571   (add-hook 'gnus-setup-news-hook 'gnus-agent-queue-setup)
 572   (unless gnus-agent-send-mail-function
 573     (setq gnus-agent-send-mail-function
 574           (or message-send-mail-real-function
 575                                          message-send-mail-function)
 576           message-send-mail-real-function 'gnus-agent-send-mail))
 577
 578   (unless gnus-agent-covered-methods
 579     (mapcar
 580      (lambda (server)
 581        (if (memq (car (gnus-server-to-method server))
 582                  gnus-agent-auto-agentize-methods)
 583            (setq gnus-agent-covered-methods
 584                  (cons (gnus-server-to-method server)
 585                        gnus-agent-covered-methods ))))
 586      (append (list gnus-select-method) gnus-secondary-select-methods))))
 587
 588 (defun gnus-agent-queue-setup ()
 589   "Make sure the queue group exists."
 590   (unless (gnus-gethash "nndraft:queue" gnus-newsrc-hashtb)
 591     (gnus-request-create-group "queue" '(nndraft ""))
 592     (let ((gnus-level-default-subscribed 1))
 593       (gnus-subscribe-group "nndraft:queue" nil '(nndraft "")))
 594     (gnus-group-set-parameter
 595      "nndraft:queue" 'gnus-dummy '((gnus-draft-mode)))))
 596
 597 (defun gnus-agent-send-mail ()
 598   (if gnus-plugged
 599       (funcall gnus-agent-send-mail-function)
 600     (goto-char (point-min))
 601     (re-search-forward
 602      (concat "^" (regexp-quote mail-header-separator) "\n"))
 603     (replace-match "\n")
 604     (gnus-agent-insert-meta-information 'mail)
 605     (gnus-request-accept-article "nndraft:queue" nil t t)))
 606
 607 (defun gnus-agent-insert-meta-information (type &optional method)
 608   "Insert meta-information into the message that says how it's to be posted.
 609 TYPE can be either `mail' or `news'.  If the latter, then METHOD can
 610 be a select method."
 611   (save-excursion
 612     (message-remove-header gnus-agent-meta-information-header)
 613     (goto-char (point-min))
 614     (insert gnus-agent-meta-information-header ": "
 615             (symbol-name type) " " (format "%S" method)
 616             "\n")
 617     (forward-char -1)
 618     (while (search-backward "\n" nil t)
 619       (replace-match "\\n" t t))))
 620
 621 (defun gnus-agent-restore-gcc ()
 622   "Restore GCC field from saved header."
 623   (save-excursion
 624     (goto-char (point-min))
 625     (while (re-search-forward (concat gnus-agent-gcc-header ":") nil t)
 626       (replace-match "Gcc:" 'fixedcase))))
 627
 628 (defun gnus-agent-any-covered-gcc ()
 629   (save-restriction
 630     (message-narrow-to-headers)
 631     (let* ((gcc (mail-fetch-field "gcc" nil t))
 632            (methods (and gcc
 633                          (mapcar 'gnus-inews-group-method
 634                                  (message-unquote-tokens
 635                                   (message-tokenize-header
 636                                    gcc " ,")))))
 637            covered)
 638       (while (and (not covered) methods)
 639         (setq covered (gnus-agent-method-p (car methods))
 640               methods (cdr methods)))
 641       covered)))
 642
 643 ;;;###autoload
 644 (defun gnus-agent-possibly-save-gcc ()
 645   "Save GCC if Gnus is unplugged."
 646   (when (and (not gnus-plugged) (gnus-agent-any-covered-gcc))
 647     (save-excursion
 648       (goto-char (point-min))
 649       (let ((case-fold-search t))
 650         (while (re-search-forward "^gcc:" nil t)
 651           (replace-match (concat gnus-agent-gcc-header ":") 'fixedcase))))))
 652
 653 (defun gnus-agent-possibly-do-gcc ()
 654   "Do GCC if Gnus is plugged."
 655   (when (or gnus-plugged (not (gnus-agent-any-covered-gcc)))
 656     (gnus-inews-do-gcc)))
 657
 658 ;;;
 659 ;;; Group mode commands
 660 ;;;
 661
 662 (defun gnus-agent-fetch-groups (n)
 663   "Put all new articles in the current groups into the Agent."
 664   (interactive "P")
 665   (unless gnus-plugged
 666     (error "Groups can't be fetched when Gnus is unplugged"))
 667   (gnus-group-iterate n 'gnus-agent-fetch-group))
 668
 669 (defun gnus-agent-fetch-group (&optional group)
 670   "Put all new articles in GROUP into the Agent."
 671   (interactive (list (gnus-group-group-name)))
 672   (setq group (or group gnus-newsgroup-name))
 673   (unless group
 674     (error "No group on the current line"))
 675
 676   (gnus-agent-while-plugged
 677     (let ((gnus-command-method (gnus-find-method-for-group group)))
 678       (gnus-agent-with-fetch
 679         (gnus-agent-fetch-group-1 group gnus-command-method)
 680         (gnus-message 5 "Fetching %s...done" group)))))
 681
 682 (defun gnus-agent-add-group (category arg)
 683   "Add the current group to an agent category."
 684   (interactive
 685    (list
 686     (intern
 687      (completing-read
 688       "Add to category: "
 689       (mapcar (lambda (cat) (list (symbol-name (car cat))))
 690               gnus-category-alist)
 691       nil t))
 692     current-prefix-arg))
 693   (let ((cat (assq category gnus-category-alist))
 694         c groups)
 695     (gnus-group-iterate arg
 696       (lambda (group)
 697         (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
 698           (setf (gnus-agent-cat-groups c)
 699                 (delete group (gnus-agent-cat-groups c))))
 700         (push group groups)))
 701     (setf (gnus-agent-cat-groups cat)
 702           (nconc (gnus-agent-cat-groups cat) groups))
 703     (gnus-category-write)))
 704
 705 (defun gnus-agent-remove-group (arg)
 706   "Remove the current group from its agent category, if any."
 707   (interactive "P")
 708   (let (c)
 709     (gnus-group-iterate arg
 710       (lambda (group)
 711         (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
 712           (setf (gnus-agent-cat-groups c)
 713                 (delete group (gnus-agent-cat-groups c))))))
 714     (gnus-category-write)))
 715
 716 (defun gnus-agent-synchronize-flags ()
 717   "Synchronize unplugged flags with servers."
 718   (interactive)
 719   (save-excursion
 720     (dolist (gnus-command-method gnus-agent-covered-methods)
 721       (when (file-exists-p (gnus-agent-lib-file "flags"))
 722         (gnus-agent-synchronize-flags-server gnus-command-method)))))
 723
 724 (defun gnus-agent-possibly-synchronize-flags ()
 725   "Synchronize flags according to `gnus-agent-synchronize-flags'."
 726   (interactive)
 727   (save-excursion
 728     (dolist (gnus-command-method gnus-agent-covered-methods)
 729       (when (file-exists-p (gnus-agent-lib-file "flags"))
 730         (gnus-agent-possibly-synchronize-flags-server gnus-command-method)))))
 731
 732 (defun gnus-agent-synchronize-flags-server (method)
 733   "Synchronize flags set when unplugged for server."
 734   (let ((gnus-command-method method))
 735     (when (file-exists-p (gnus-agent-lib-file "flags"))
 736       (set-buffer (get-buffer-create " *Gnus Agent flag synchronize*"))
 737       (erase-buffer)
 738       (nnheader-insert-file-contents (gnus-agent-lib-file "flags"))
 739       (if (null (gnus-check-server gnus-command-method))
 740           (gnus-message 1 "Couldn't open server %s" (nth 1 gnus-command-method))
 741         (while (not (eobp))
 742           (if (null (eval (read (current-buffer))))
 743               (progn (forward-line)
 744                      (kill-line -1))
 745             (write-file (gnus-agent-lib-file "flags"))
 746             (error "Couldn't set flags from file %s"
 747                    (gnus-agent-lib-file "flags"))))
 748         (delete-file (gnus-agent-lib-file "flags")))
 749       (kill-buffer nil))))
 750
 751 (defun gnus-agent-possibly-synchronize-flags-server (method)
 752   "Synchronize flags for server according to `gnus-agent-synchronize-flags'."
 753   (when (or (and gnus-agent-synchronize-flags
 754                  (not (eq gnus-agent-synchronize-flags 'ask)))
 755             (and (eq gnus-agent-synchronize-flags 'ask)
 756                  (gnus-y-or-n-p (format "Synchronize flags on server `%s'? "
 757                                         (cadr method)))))
 758     (gnus-agent-synchronize-flags-server method)))
 759
 760 ;;;
 761 ;;; Server mode commands
 762 ;;;
 763
 764 (defun gnus-agent-add-server (server)
 765   "Enroll SERVER in the agent program."
 766   (interactive (list (gnus-server-server-name)))
 767   (unless server
 768     (error "No server on the current line"))
 769   (let ((method (gnus-server-get-method nil (gnus-server-server-name))))
 770     (when (gnus-agent-method-p method)
 771       (error "Server already in the agent program"))
 772     (push method gnus-agent-covered-methods)
 773     (gnus-server-update-server server)
 774     (gnus-agent-write-servers)
 775     (gnus-message 1 "Entered %s into the Agent" server)))
 776
 777 (defun gnus-agent-remove-server (server)
 778   "Remove SERVER from the agent program."
 779   (interactive (list (gnus-server-server-name)))
 780   (unless server
 781     (error "No server on the current line"))
 782   (let ((method (gnus-server-get-method nil (gnus-server-server-name))))
 783     (unless (gnus-agent-method-p method)
 784       (error "Server not in the agent program"))
 785     (setq gnus-agent-covered-methods
 786           (delete method gnus-agent-covered-methods))
 787     (gnus-server-update-server server)
 788     (gnus-agent-write-servers)
 789     (gnus-message 1 "Removed %s from the agent" server)))
 790
 791 (defun gnus-agent-read-servers ()
 792   "Read the alist of covered servers."
 793   (mapcar (lambda (m)
 794             (let ((method (gnus-server-get-method
 795                            nil
 796                            (or m "native"))))
 797               (if method
 798                   (unless (member method gnus-agent-covered-methods)
 799                     (push method gnus-agent-covered-methods))
 800                 (gnus-message 1 "Ignoring disappeared server `%s'" m)
 801                 (sit-for 1))))
 802           (gnus-agent-read-file
 803            (nnheader-concat gnus-agent-directory "lib/servers"))))
 804
 805 (defun gnus-agent-write-servers ()
 806   "Write the alist of covered servers."
 807   (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
 808   (let ((coding-system-for-write nnheader-file-coding-system)
 809         (file-name-coding-system nnmail-pathname-coding-system))
 810     (with-temp-file (nnheader-concat gnus-agent-directory "lib/servers")
 811       (prin1 (mapcar 'gnus-method-simplify gnus-agent-covered-methods)
 812              (current-buffer)))))
 813
 814 ;;;
 815 ;;; Summary commands
 816 ;;;
 817
 818 (defun gnus-agent-mark-article (n &optional unmark)
 819   "Mark the next N articles as downloadable.
 820 If N is negative, mark backward instead.  If UNMARK is non-nil, remove
 821 the mark instead.  The difference between N and the actual number of
 822 articles marked is returned."
 823   (interactive "p")
 824   (let ((backward (< n 0))
 825         (n (abs n)))
 826     (while (and
 827             (> n 0)
 828             (progn
 829               (gnus-summary-set-agent-mark
 830                (gnus-summary-article-number) unmark)
 831               (zerop (gnus-summary-next-subject (if backward -1 1) nil t))))
 832       (setq n (1- n)))
 833     (when (/= 0 n)
 834       (gnus-message 7 "No more articles"))
 835     (gnus-summary-recenter)
 836     (gnus-summary-position-point)
 837     n))
 838
 839 (defun gnus-agent-unmark-article (n)
 840   "Remove the downloadable mark from the next N articles.
 841 If N is negative, unmark backward instead.  The difference between N and
 842 the actual number of articles unmarked is returned."
 843   (interactive "p")
 844   (gnus-agent-mark-article n t))
 845
 846 (defun gnus-agent-toggle-mark (n)
 847   "Toggle the downloadable mark from the next N articles.
 848 If N is negative, toggle backward instead.  The difference between N and
 849 the actual number of articles toggled is returned."
 850   (interactive "p")
 851   (gnus-agent-mark-article n 'toggle))
 852
 853 (defun gnus-summary-set-agent-mark (article &optional unmark)
 854   "Mark ARTICLE as downloadable.  If UNMARK is nil, article is marked.
 855 When UNMARK is t, the article is unmarked.  For any other value, the
 856 article's mark is toggled."
 857   (let ((unmark (cond ((eq nil unmark)
 858                        nil)
 859                       ((eq t unmark)
 860                        t)
 861                       (t
 862                        (memq article gnus-newsgroup-downloadable)))))
 863     (when (gnus-summary-goto-subject article nil t)
 864       (gnus-summary-update-mark
 865        (if unmark
 866            (progn
 867              (setq gnus-newsgroup-downloadable
 868                    (delq article gnus-newsgroup-downloadable))
 869              (gnus-article-mark article))
 870          (progn
 871            (setq gnus-newsgroup-downloadable
 872                  (gnus-add-to-sorted-list gnus-newsgroup-downloadable article))
 873            gnus-downloadable-mark)
 874          )
 875        'unread))))
 876
 877 (defun gnus-agent-get-undownloaded-list ()
 878   "Construct list of articles that have not been downloaded."
 879   (let ((gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name)))
 880     (when (set (make-local-variable 'gnus-newsgroup-agentized)
 881                (gnus-agent-method-p gnus-command-method))
 882       (let* ((alist (gnus-agent-load-alist gnus-newsgroup-name))
 883              (headers (sort (mapcar (lambda (h)
 884                                       (mail-header-number h))
 885                                     gnus-newsgroup-headers) '<))
 886              (undownloaded (list nil))
 887              (tail-undownloaded undownloaded)
 888              (unfetched (list nil))
 889              (tail-unfetched unfetched))
 890         (while (and alist headers)
 891           (let ((a (caar alist))
 892                 (h (car headers)))
 893             (cond ((< a h)
 894                    ;; Ignore IDs in the alist that are not being
 895                    ;; displayed in the summary.
 896                    (pop alist))
 897                   ((> a h)
 898                    ;; Headers that are not in the alist should be
 899                    ;; fictious (see nnagent-retrieve-headers); they
 900                    ;; imply that this article isn't in the agent.
 901                    (gnus-agent-append-to-list tail-undownloaded h)
 902                    (gnus-agent-append-to-list tail-unfetched    h)
 903                    (pop headers))
 904                   ((cdar alist)
 905                    (pop alist)
 906                    (pop headers)
 907                    nil                  ; ignore already downloaded
 908                    )
 909                   (t
 910                    (pop alist)
 911                    (pop headers)
 912                    (gnus-agent-append-to-list tail-undownloaded a)))))
 913
 914         (while headers
 915           (let ((num (pop headers)))
 916             (gnus-agent-append-to-list tail-undownloaded num)
 917             (gnus-agent-append-to-list tail-unfetched    num)))
 918
 919         (setq gnus-newsgroup-undownloaded (cdr undownloaded)
 920               gnus-newsgroup-unfetched    (cdr unfetched))))))
 921
 922 (defun gnus-agent-catchup ()
 923   "Mark as read all unhandled articles.
 924 An article is unhandled if it is neither cached, nor downloaded, nor
 925 downloadable."
 926   (interactive)
 927   (save-excursion
 928     (let ((articles gnus-newsgroup-undownloaded))
 929       (when (or gnus-newsgroup-downloadable
 930                 gnus-newsgroup-cached)
 931         (setq articles (gnus-sorted-ndifference
 932                         (gnus-sorted-ndifference
 933                          (gnus-copy-sequence articles)
 934                          gnus-newsgroup-downloadable)
 935                         gnus-newsgroup-cached)))
 936
 937       (while articles
 938         (gnus-summary-mark-article
 939          (pop articles) gnus-catchup-mark)))
 940     (gnus-summary-position-point)))
 941
 942 (defun gnus-agent-summary-fetch-series ()
 943   (interactive)
 944   (when gnus-newsgroup-processable
 945     (setq gnus-newsgroup-downloadable
 946           (let* ((dl gnus-newsgroup-downloadable)
 947                  (gnus-newsgroup-downloadable
 948                   (sort (gnus-copy-sequence gnus-newsgroup-processable) '<))
 949                  (fetched-articles (gnus-agent-summary-fetch-group)))
 950             ;; The preceeding call to (gnus-agent-summary-fetch-group)
 951             ;; updated gnus-newsgroup-downloadable to remove each
 952             ;; article successfully fetched.
 953
 954             ;; For each article that I processed, remove its
 955             ;; processable mark IF the article is no longer
 956             ;; downloadable (i.e. it's already downloaded)
 957             (dolist (article gnus-newsgroup-processable)
 958               (unless (memq article gnus-newsgroup-downloadable)
 959                 (gnus-summary-remove-process-mark article)))
 960             (gnus-sorted-ndifference dl fetched-articles)))))
 961
 962 (defun gnus-agent-summary-fetch-group (&optional all)
 963   "Fetch the downloadable articles in the group.
 964 Optional arg ALL, if non-nil, means to fetch all articles."
 965   (interactive "P")
 966   (let ((articles
 967          (if all gnus-newsgroup-articles
 968            gnus-newsgroup-downloadable))
 969         (gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name))
 970         fetched-articles)
 971     (gnus-agent-while-plugged
 972       (unless articles
 973         (error "No articles to download"))
 974       (gnus-agent-with-fetch
 975         (setq gnus-newsgroup-undownloaded
 976               (gnus-sorted-ndifference
 977                gnus-newsgroup-undownloaded
 978                (setq fetched-articles
 979                      (gnus-agent-fetch-articles
 980                       gnus-newsgroup-name articles)))))
 981       (save-excursion
 982         (dolist (article articles)
 983           (let ((was-marked-downloadable
 984                  (memq article gnus-newsgroup-downloadable)))
 985             (cond (gnus-agent-mark-unread-after-downloaded
 986                    (setq gnus-newsgroup-downloadable
 987                          (delq article gnus-newsgroup-downloadable))
 988
 989                    ;; The downloadable mark is implemented as a
 990                    ;; type of read mark.  Therefore, marking the
 991                    ;; article as unread is sufficient to clear
 992                    ;; its downloadable flag.
 993                    (gnus-summary-mark-article article gnus-unread-mark))
 994                   (was-marked-downloadable
 995                    (gnus-summary-set-agent-mark article t)))
 996             (when (gnus-summary-goto-subject article nil t)
 997               (gnus-summary-update-download-mark article))))))
 998     fetched-articles))
 999
1000 (defun gnus-agent-fetch-selected-article ()
1001   "Fetch the current article as it is selected.
1002 This can be added to `gnus-select-article-hook' or
1003 `gnus-mark-article-hook'."
1004   (let ((gnus-command-method gnus-current-select-method))
1005     (when (and gnus-plugged (gnus-agent-method-p gnus-command-method))
1006       (when (gnus-agent-fetch-articles
1007              gnus-newsgroup-name
1008              (list gnus-current-article))
1009         (setq gnus-newsgroup-undownloaded
1010               (delq gnus-current-article gnus-newsgroup-undownloaded))
1011         (gnus-summary-update-article-line
1012          gnus-current-article
1013          (gnus-summary-article-header gnus-current-article))))))
1014
1015 ;;;
1016 ;;; Internal functions
1017 ;;;
1018
1019 (defun gnus-agent-save-active (method)
1020   (gnus-agent-save-active-1 method 'gnus-active-to-gnus-format))
1021
1022 (defun gnus-agent-save-active-1 (method function)
1023   (when (gnus-agent-method-p method)
1024     (let* ((gnus-command-method method)
1025            (new (gnus-make-hashtable (count-lines (point-min) (point-max))))
1026            (file (gnus-agent-lib-file "active")))
1027       (funcall function nil new)
1028       (gnus-agent-write-active file new)
1029       (erase-buffer)
1030       (nnheader-insert-file-contents file))))
1031
1032 (defun gnus-agent-write-active (file new)
1033   (let ((orig (gnus-make-hashtable (count-lines (point-min) (point-max))))
1034         (file (gnus-agent-lib-file "active"))
1035         elem osym)
1036     (when (file-exists-p file)
1037       (with-temp-buffer
1038         (nnheader-insert-file-contents file)
1039         (gnus-active-to-gnus-format nil orig))
1040       (mapatoms
1041        (lambda (sym)
1042          (when (and sym (boundp sym))
1043            (if (and (boundp (setq osym (intern (symbol-name sym) orig)))
1044                     (setq elem (symbol-value osym)))
1045                (progn
1046                  (if (and (integerp (car (symbol-value sym)))
1047                           (> (car elem) (car (symbol-value sym))))
1048                      (setcar elem (car (symbol-value sym))))
1049                  (if (integerp (cdr (symbol-value sym)))
1050                      (setcdr elem (cdr (symbol-value sym)))))
1051              (set (intern (symbol-name sym) orig) (symbol-value sym)))))
1052        new))
1053     (gnus-make-directory (file-name-directory file))
1054     (let ((nnmail-active-file-coding-system gnus-agent-file-coding-system))
1055       ;; The hashtable contains real names of groups,  no more prefix
1056       ;; removing, so set `full' to `t'.
1057       (gnus-write-active-file file orig t))))
1058
1059 (defun gnus-agent-save-groups (method)
1060   (gnus-agent-save-active-1 method 'gnus-groups-to-gnus-format))
1061
1062 (defun gnus-agent-save-group-info (method group active)
1063   (when (gnus-agent-method-p method)
1064     (let* ((gnus-command-method method)
1065            (coding-system-for-write nnheader-file-coding-system)
1066            (file-name-coding-system nnmail-pathname-coding-system)
1067            (file (gnus-agent-lib-file "active"))
1068            oactive-min)
1069       (gnus-make-directory (file-name-directory file))
1070       (with-temp-file file
1071         ;; Emacs got problem to match non-ASCII group in multibyte buffer.
1072         (mm-disable-multibyte)
1073         (when (file-exists-p file)
1074           (nnheader-insert-file-contents file))
1075         (goto-char (point-min))
1076         (when (re-search-forward
1077                (concat "^" (regexp-quote group) " ") nil t)
1078           (save-excursion
1079             (read (current-buffer))                      ;; max
1080             (setq oactive-min (read (current-buffer))))  ;; min
1081           (gnus-delete-line))
1082         (insert (format "%S %d %d y\n" (intern group)
1083                         (cdr active)
1084                         (or oactive-min (car active))))
1085         (goto-char (point-max))
1086         (while (search-backward "\\." nil t)
1087           (delete-char 1))))))
1088
1089 (defun gnus-agent-group-path (group)
1090   "Translate GROUP into a file name."
1091   (if nnmail-use-long-file-names
1092       (gnus-group-real-name group)
1093     (nnheader-translate-file-chars
1094      (nnheader-replace-chars-in-string
1095       (nnheader-replace-duplicate-chars-in-string
1096        (nnheader-replace-chars-in-string
1097         (gnus-group-real-name group)
1098         ?/ ?_)
1099        ?. ?_)
1100       ?. ?/))))
1101
1102 (defun gnus-agent-get-function (method)
1103   (if (gnus-online method)
1104       (car method)
1105     (require 'nnagent)
1106     'nnagent))
1107
1108 ;;; History functions
1109
1110 (defun gnus-agent-history-buffer ()
1111   (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
1112
1113 (defun gnus-agent-open-history ()
1114   (save-excursion
1115     (push (cons (gnus-agent-method)
1116                 (set-buffer (gnus-get-buffer-create
1117                              (format " *Gnus agent %s history*"
1118                                      (gnus-agent-method)))))
1119           gnus-agent-history-buffers)
1120     (mm-disable-multibyte) ;; everything is binary
1121     (erase-buffer)
1122     (insert "\n")
1123     (let ((file (gnus-agent-lib-file "history")))
1124       (when (file-exists-p file)
1125         (nnheader-insert-file-contents file))
1126       (set (make-local-variable 'gnus-agent-file-name) file))))
1127
1128 (defun gnus-agent-close-history ()
1129   (when (gnus-buffer-live-p gnus-agent-current-history)
1130     (kill-buffer gnus-agent-current-history)
1131     (setq gnus-agent-history-buffers
1132           (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
1133                 gnus-agent-history-buffers))))
1134
1135 ;;;
1136 ;;; Fetching
1137 ;;;
1138
1139 (defun gnus-agent-fetch-articles (group articles)
1140   "Fetch ARTICLES from GROUP and put them into the Agent."
1141   (when articles
1142     (gnus-agent-load-alist group)
1143     (let* ((alist   gnus-agent-article-alist)
1144            (headers (if (< (length articles) 2) nil gnus-newsgroup-headers))
1145            (selected-sets (list nil))
1146            (current-set-size 0)
1147            article
1148            header-number)
1149       ;; Check each article
1150       (while (setq article (pop articles))
1151         ;; Skip alist entries preceeding this article
1152         (while (> article (or (caar alist) (1+ article)))
1153           (setq alist (cdr alist)))
1154
1155         ;; Prune off articles that we have already fetched.
1156         (unless (and (eq article (caar alist))
1157                      (cdar alist))
1158           ;; Skip headers preceeding this article
1159           (while (> article
1160                     (setq header-number
1161                           (let* ((header (car headers)))
1162                             (if header
1163                                 (mail-header-number header)
1164                               (1+ article)))))
1165             (setq headers (cdr headers)))
1166
1167           ;; Add this article to the current set
1168           (setcar selected-sets (cons article (car selected-sets)))
1169
1170           ;; Update the set size, when the set is too large start a
1171           ;; new one.  I do this after adding the article as I want at
1172           ;; least one article in each set.
1173           (when (< gnus-agent-max-fetch-size
1174                    (setq current-set-size
1175                          (+ current-set-size
1176                             (if (= header-number article)
1177                                 (let ((char-size (mail-header-chars
1178                                                   (car headers))))
1179                                   (if (<= char-size 0)
1180                                       ;; The char size was missing/invalid,
1181                                       ;; assume a worst-case situation of
1182                                       ;; 65 char/line.  If the line count
1183                                       ;; is missing, arbitrarily assume a
1184                                       ;; size of 1000 characters.
1185                                     (max (* 65 (mail-header-lines
1186                                                 (car headers)))
1187                                          1000)
1188                                     char-size))
1189                               0))))
1190             (setcar selected-sets (nreverse (car selected-sets)))
1191             (setq selected-sets (cons nil selected-sets)
1192                   current-set-size 0))))
1193
1194       (when (or (cdr selected-sets) (car selected-sets))
1195         (let* ((fetched-articles (list nil))
1196                (tail-fetched-articles fetched-articles)
1197                (dir (concat
1198                      (gnus-agent-directory)
1199                      (gnus-agent-group-path group) "/"))
1200                (date (time-to-days (current-time)))
1201                (case-fold-search t)
1202                pos crosses id)
1203
1204           (setcar selected-sets (nreverse (car selected-sets)))
1205           (setq selected-sets (nreverse selected-sets))
1206
1207           (gnus-make-directory dir)
1208           (gnus-message 7 "Fetching articles for %s..." group)
1209
1210           (unwind-protect
1211               (while (setq articles (pop selected-sets))
1212                 ;; Fetch the articles from the backend.
1213                 (if (gnus-check-backend-function 'retrieve-articles group)
1214                     (setq pos (gnus-retrieve-articles articles group))
1215                   (with-temp-buffer
1216                     (let (article)
1217                       (while (setq article (pop articles))
1218                         (gnus-message 10 "Fetching article %s for %s..."
1219                                       article group)
1220                         (when (or
1221                                (gnus-backlog-request-article group article
1222                                                              nntp-server-buffer)
1223                                (gnus-request-article article group))
1224                           (goto-char (point-max))
1225                           (push (cons article (point)) pos)
1226                           (insert-buffer-substring nntp-server-buffer)))
1227                       (copy-to-buffer
1228                        nntp-server-buffer (point-min) (point-max))
1229                       (setq pos (nreverse pos)))))
1230                 ;; Then save these articles into the Agent.
1231                 (save-excursion
1232                   (set-buffer nntp-server-buffer)
1233                   (while pos
1234                     (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
1235                     (goto-char (point-min))
1236                     (unless (eobp) ;; Don't save empty articles.
1237                       (when (search-forward "\n\n" nil t)
1238                         (when (search-backward "\nXrefs: " nil t)
1239                           ;; Handle cross posting.
1240                           (goto-char (match-end 0)) ; move to end of header name
1241                           (skip-chars-forward "^ ") ; skip server name
1242                           (skip-chars-forward " ")
1243                           (setq crosses nil)
1244                           (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) *")
1245                             (push (cons (buffer-substring (match-beginning 1)
1246                                                           (match-end 1))
1247                                         (string-to-int
1248                                          (buffer-substring (match-beginning 2)
1249                                                            (match-end 2))))
1250                                   crosses)
1251                             (goto-char (match-end 0)))
1252                           (gnus-agent-crosspost crosses (caar pos) date)))
1253                       (goto-char (point-min))
1254                       (if (not (re-search-forward
1255                                 "^Message-ID: *<\\([^>\n]+\\)>" nil t))
1256                           (setq id "No-Message-ID-in-article")
1257                         (setq id (buffer-substring
1258                                   (match-beginning 1) (match-end 1))))
1259                       (let ((coding-system-for-write
1260                              gnus-agent-file-coding-system))
1261                         (write-region (point-min) (point-max)
1262                                       (concat dir (number-to-string (caar pos)))
1263                                       nil 'silent))
1264
1265                       (gnus-agent-append-to-list
1266                        tail-fetched-articles (caar pos)))
1267                     (widen)
1268                     (pop pos))))
1269
1270             (gnus-agent-save-alist group (cdr fetched-articles) date)
1271             (gnus-message 7 nil))
1272           (cdr fetched-articles))))))
1273
1274 (defun gnus-agent-crosspost (crosses article &optional date)
1275   (setq date (or date t))
1276
1277   (let (gnus-agent-article-alist group alist beg end)
1278     (save-excursion
1279       (set-buffer gnus-agent-overview-buffer)
1280       (when (nnheader-find-nov-line article)
1281         (forward-word 1)
1282         (setq beg (point))
1283         (setq end (progn (forward-line 1) (point)))))
1284     (while crosses
1285       (setq group (caar crosses))
1286       (unless (setq alist (assoc group gnus-agent-group-alist))
1287         (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
1288               gnus-agent-group-alist))
1289       (setcdr alist (cons (cons (cdar crosses) date) (cdr alist)))
1290       (save-excursion
1291         (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
1292                                                     group)))
1293         (when (= (point-max) (point-min))
1294           (push (cons group (current-buffer)) gnus-agent-buffer-alist)
1295           (ignore-errors
1296             (nnheader-insert-file-contents
1297              (gnus-agent-article-name ".overview" group))))
1298         (nnheader-find-nov-line (string-to-number (cdar crosses)))
1299         (insert (string-to-number (cdar crosses)))
1300         (insert-buffer-substring gnus-agent-overview-buffer beg end)
1301         (gnus-agent-check-overview-buffer))
1302       (pop crosses))))
1303
1304 (defun gnus-agent-backup-overview-buffer ()
1305   (when gnus-newsgroup-name
1306     (let ((root (gnus-agent-article-name ".overview" gnus-newsgroup-name))
1307           (cnt 0)
1308           name)
1309       (while (file-exists-p
1310               (setq name (concat root "~"
1311                                  (int-to-string (setq cnt (1+ cnt))) "~"))))
1312       (write-region (point-min) (point-max) name nil 'no-msg)
1313       (gnus-message 1 "Created backup copy of overview in %s." name)))
1314   t)
1315
1316 (defun gnus-agent-check-overview-buffer (&optional buffer)
1317   "Check the overview file given for sanity.
1318 In particular, checks that the file is sorted by article number
1319 and that there are no duplicates."
1320   (let ((prev-num -1)
1321         (backed-up nil))
1322     (save-excursion
1323       (when buffer
1324         (set-buffer buffer))
1325       (save-restriction
1326         (widen)
1327         (goto-char (point-min))
1328
1329         (while (< (point) (point-max))
1330           (let ((p (point))
1331                 (cur (condition-case nil
1332                          (read (current-buffer))
1333                        (error nil))))
1334             (cond
1335              ((or (not (integerp cur))
1336                   (not (eq (char-after) ?\t)))
1337               (or backed-up
1338                   (setq backed-up (gnus-agent-backup-overview-buffer)))
1339               (gnus-message 1
1340                             "Overview buffer contains garbage '%s'."
1341                             (buffer-substring
1342                              p (gnus-point-at-eol))))
1343              ((= cur prev-num)
1344               (or backed-up
1345                   (setq backed-up (gnus-agent-backup-overview-buffer)))
1346               (gnus-message 1
1347                             "Duplicate overview line for %d" cur)
1348               (delete-region (point) (progn (forward-line 1) (point))))
1349              ((< cur prev-num)
1350               (or backed-up
1351                   (setq backed-up (gnus-agent-backup-overview-buffer)))
1352               (gnus-message 1 "Overview buffer not sorted!")
1353               (sort-numeric-fields 1 (point-min) (point-max))
1354               (goto-char (point-min))
1355               (setq prev-num -1))
1356              (t
1357               (setq prev-num cur)))
1358             (forward-line 1)))))))
1359
1360 (defun gnus-agent-flush-cache ()
1361   (save-excursion
1362     (while gnus-agent-buffer-alist
1363       (set-buffer (cdar gnus-agent-buffer-alist))
1364       (let ((coding-system-for-write
1365              gnus-agent-file-coding-system))
1366         (write-region (point-min) (point-max)
1367                       (gnus-agent-article-name ".overview"
1368                                                (caar gnus-agent-buffer-alist))
1369                       nil 'silent))
1370       (pop gnus-agent-buffer-alist))
1371     (while gnus-agent-group-alist
1372       (with-temp-file (gnus-agent-article-name
1373                        ".agentview" (caar gnus-agent-group-alist))
1374         (princ (cdar gnus-agent-group-alist))
1375         (insert "\n")
1376         (princ 1 (current-buffer))
1377         (insert "\n"))
1378       (pop gnus-agent-group-alist))))
1379
1380 (defun gnus-agent-find-parameter (group symbol)
1381   "Search for GROUPs SYMBOL in the group's parameters, the group's
1382 topic parameters, the group's category, or the customizable
1383 variables.  Returns the first non-nil value found."
1384   (or (gnus-group-find-parameter group symbol t)
1385       (gnus-group-parameter-value (cdr (gnus-group-category group)) symbol t)
1386       (symbol-value
1387        (cdr
1388         (assq symbol
1389          '((agent-short-article . gnus-agent-short-article)
1390            (agent-long-article . gnus-agent-long-article)
1391            (agent-low-score . gnus-agent-low-score)
1392            (agent-high-score . gnus-agent-high-score)
1393            (agent-days-until-old . gnus-agent-expire-days)
1394            (agent-enable-expiration
1395             . gnus-agent-enable-expiration)))))))
1396
1397 (defun gnus-agent-fetch-headers (group &optional force)
1398   "Fetch interesting headers into the agent.  The group's overview
1399 file will be updated to include the headers while a list of available
1400 article numbers will be returned."
1401   (let* ((fetch-all (and gnus-agent-consider-all-articles
1402                          ;; Do not fetch all headers if the predicate
1403                          ;; implies that we only consider unread articles.
1404                          (not (gnus-predicate-implies-unread
1405                                (gnus-agent-find-parameter group
1406                                                           'agent-predicate)))))
1407          (articles (if fetch-all
1408                        (gnus-uncompress-range (gnus-active group))
1409                      (gnus-list-of-unread-articles group)))
1410          (gnus-decode-encoded-word-function 'identity)
1411          (file (gnus-agent-article-name ".overview" group)))
1412
1413     (unless fetch-all
1414       ;; Add articles with marks to the list of article headers we want to
1415       ;; fetch.  Don't fetch articles solely on the basis of a recent or seen
1416       ;; mark, but do fetch recent or seen articles if they have other, more
1417       ;; interesting marks.  (We have to fetch articles with boring marks
1418       ;; because otherwise the agent will remove their marks.)
1419       (dolist (arts (gnus-info-marks (gnus-get-info group)))
1420         (unless (memq (car arts) '(seen recent killed cache))
1421           (setq articles (gnus-range-add articles (cdr arts)))))
1422       (setq articles (sort (gnus-uncompress-sequence articles) '<)))
1423
1424     ;; At this point, I have the list of articles to consider for
1425     ;; fetching.  This is the list that I'll return to my caller. Some
1426     ;; of these articles may have already been fetched.  That's OK as
1427     ;; the fetch article code will filter those out.  Internally, I'll
1428     ;; filter this list to just those articles whose headers need to
1429     ;; be fetched.
1430     (let ((articles articles))
1431       ;; Remove known articles.
1432       (when (and (or gnus-agent-cache
1433                      (not gnus-plugged))
1434                  (gnus-agent-load-alist group))
1435         ;; Remove articles marked as downloaded.
1436         (if fetch-all
1437             ;; I want to fetch all headers in the active range.
1438             ;; Therefore, exclude only those headers that are in the
1439             ;; article alist.
1440             ;; NOTE: This is probably NOT what I want to do after
1441             ;; agent expiration in this group.
1442             (setq articles (gnus-agent-uncached-articles articles group))
1443
1444           ;; I want to only fetch those headers that have never been
1445           ;; fetched.  Therefore, exclude all headers that are, or
1446           ;; WERE, in the article alist.
1447           (let ((low (1+ (caar (last gnus-agent-article-alist))))
1448                 (high (cdr (gnus-active group))))
1449             ;; Low can be greater than High when the same group is
1450             ;; fetched twice in the same session {The first fetch will
1451             ;; fill the article alist such that (last
1452             ;; gnus-agent-article-alist) equals (cdr (gnus-active
1453             ;; group))}.  The addition of one(the 1+ above) then
1454             ;; forces Low to be greater than High.  When this happens,
1455             ;; gnus-list-range-intersection returns nil which
1456             ;; indicates that no headers need to be fetched. -- Kevin
1457             (setq articles (gnus-list-range-intersection
1458                             articles (list (cons low high)))))))
1459
1460       (gnus-message
1461        10 "gnus-agent-fetch-headers: undownloaded articles are '%s'"
1462        (gnus-compress-sequence articles t))
1463
1464       (save-excursion
1465         (set-buffer nntp-server-buffer)
1466
1467         (if articles
1468             (progn
1469               (gnus-message 7 "Fetching headers for %s..." group)
1470
1471               ;; Fetch them.
1472               (gnus-make-directory (nnheader-translate-file-chars
1473                                     (file-name-directory file) t))
1474
1475               (unless (eq 'nov (gnus-retrieve-headers articles group))
1476                 (nnvirtual-convert-headers))
1477               (gnus-agent-check-overview-buffer)
1478               ;; Move these headers to the overview buffer so that
1479               ;; gnus-agent-braid-nov can merge them with the contents
1480               ;; of FILE.
1481               (copy-to-buffer
1482                gnus-agent-overview-buffer (point-min) (point-max))
1483               (when (file-exists-p file)
1484                 (gnus-agent-braid-nov group articles file))
1485               (let ((coding-system-for-write
1486                      gnus-agent-file-coding-system))
1487                 (gnus-agent-check-overview-buffer)
1488                 (write-region (point-min) (point-max) file nil 'silent))
1489               (gnus-agent-save-alist group articles nil)
1490               articles)
1491           (ignore-errors
1492             (erase-buffer)
1493             (nnheader-insert-file-contents file)))))
1494     articles))
1495
1496 (defsubst gnus-agent-copy-nov-line (article)
1497   (let (art b e)
1498     (set-buffer gnus-agent-overview-buffer)
1499     (while (and (not (eobp))
1500                 (< (setq art (read (current-buffer))) article))
1501       (forward-line 1))
1502     (beginning-of-line)
1503     (if (or (eobp)
1504             (not (eq article art)))
1505         (set-buffer nntp-server-buffer)
1506       (setq b (point))
1507       (setq e (progn (forward-line 1) (point)))
1508       (set-buffer nntp-server-buffer)
1509       (insert-buffer-substring gnus-agent-overview-buffer b e))))
1510
1511 (defun gnus-agent-braid-nov (group articles file)
1512   "Merge agent overview data with given file.
1513 Takes headers for ARTICLES from `gnus-agent-overview-buffer' and the given
1514 FILE and places the combined headers into `nntp-server-buffer'."
1515   (let (start last)
1516     (set-buffer gnus-agent-overview-buffer)
1517     (goto-char (point-min))
1518     (set-buffer nntp-server-buffer)
1519     (erase-buffer)
1520     (nnheader-insert-file-contents file)
1521     (goto-char (point-max))
1522     (forward-line -1)
1523     (unless (looking-at "[0-9]+\t")
1524       ;; Remove corrupted lines
1525       (gnus-message
1526        1 "Overview %s is corrupted. Removing corrupted lines..." file)
1527       (goto-char (point-min))
1528       (while (not (eobp))
1529         (if (looking-at "[0-9]+\t")
1530             (forward-line 1)
1531           (delete-region (point) (progn (forward-line 1) (point)))))
1532       (forward-line -1))
1533     (unless (or (= (point-min) (point-max))
1534                 (< (setq last (read (current-buffer))) (car articles)))
1535       ;; We do it the hard way.
1536       (when (nnheader-find-nov-line (car articles))
1537         ;; Replacing existing NOV entry
1538         (delete-region (point) (progn (forward-line 1) (point))))
1539       (gnus-agent-copy-nov-line (pop articles))
1540
1541       (ignore-errors
1542         (while articles
1543           (while (let ((art (read (current-buffer))))
1544                    (cond ((< art (car articles))
1545                           (forward-line 1)
1546                           t)
1547                          ((= art (car articles))
1548                           (beginning-of-line)
1549                           (delete-region
1550                            (point) (progn (forward-line 1) (point)))
1551                           nil)
1552                          (t
1553                           (beginning-of-line)
1554                           nil))))
1555
1556           (gnus-agent-copy-nov-line (pop articles)))))
1557
1558     ;; Copy the rest lines
1559     (set-buffer nntp-server-buffer)
1560     (goto-char (point-max))
1561     (when articles
1562       (when last
1563         (set-buffer gnus-agent-overview-buffer)
1564         (ignore-errors
1565           (while (<= (read (current-buffer)) last)
1566             (forward-line 1)))
1567         (beginning-of-line)
1568         (setq start (point))
1569         (set-buffer nntp-server-buffer))
1570       (insert-buffer-substring gnus-agent-overview-buffer start))))
1571
1572 ;; Keeps the compiler from warning about the free variable in
1573 ;; gnus-agent-read-agentview.
1574 (eval-when-compile
1575   (defvar gnus-agent-read-agentview))
1576
1577 (defun gnus-agent-load-alist (group)
1578   "Load the article-state alist for GROUP."
1579   ;; Bind free variable that's used in `gnus-agent-read-agentview'.
1580   (let ((gnus-agent-read-agentview group))
1581     (setq gnus-agent-article-alist
1582           (gnus-cache-file-contents
1583            (gnus-agent-article-name ".agentview" group)
1584            'gnus-agent-file-loading-cache
1585            'gnus-agent-read-agentview))))
1586
1587 ;; Save format may be either 1 or 2.  Two is the new, compressed
1588 ;; format that is still being tested.  Format 1 is uncompressed but
1589 ;; known to be reliable.
1590 (defconst gnus-agent-article-alist-save-format 2)
1591
1592 (defun gnus-agent-read-agentview (file)
1593   "Load FILE and do a `read' there."
1594   (with-temp-buffer
1595     (ignore-errors
1596       (nnheader-insert-file-contents file)
1597       (goto-char (point-min))
1598       (let ((alist (read (current-buffer)))
1599             (version (condition-case nil (read (current-buffer))
1600                        (end-of-file 0)))
1601             changed-version)
1602
1603         (cond
1604          ((= version 0)
1605           (let ((inhibit-quit t)
1606                 entry)
1607             (gnus-agent-open-history)
1608             (set-buffer (gnus-agent-history-buffer))
1609             (goto-char (point-min))
1610             (while (not (eobp))
1611               (if (and (looking-at
1612                         "[^\t\n]+\t\\([0-9]+\\)\t\\([^ \n]+\\) \\([0-9]+\\)")
1613                        (string= (match-string 2)
1614                                 gnus-agent-read-agentview)
1615                        (setq entry (assoc (string-to-number (match-string 3)) alist)))
1616                   (setcdr entry (string-to-number (match-string 1))))
1617               (forward-line 1))
1618             (gnus-agent-close-history)
1619             (setq changed-version t)))
1620          ((= version 1)
1621           (setq changed-version (not (= 1 gnus-agent-article-alist-save-format))))
1622          ((= version 2)
1623           (let (uncomp)
1624             (mapcar
1625              (lambda (comp-list)
1626                (let ((state (car comp-list))
1627                      (sequence (gnus-uncompress-sequence
1628                                 (cdr comp-list))))
1629                  (mapcar (lambda (article-id)
1630                            (setq uncomp (cons (cons article-id state) uncomp)))
1631                          sequence)))
1632              alist)
1633             (setq alist (sort uncomp
1634                               (lambda (first second)
1635                                 (< (car first) (car second))))))))
1636         (when changed-version
1637           (let ((gnus-agent-article-alist alist))
1638             (gnus-agent-save-alist gnus-agent-read-agentview)))
1639         alist))))
1640
1641 (defun gnus-agent-save-alist (group &optional articles state dir)
1642   "Save the article-state alist for GROUP."
1643   (let* ((file-name-coding-system nnmail-pathname-coding-system)
1644          (prev (cons nil gnus-agent-article-alist))
1645          (all prev)
1646          print-level print-length item article)
1647     (while (setq article (pop articles))
1648       (while (and (cdr prev)
1649                   (< (caadr prev) article))
1650         (setq prev (cdr prev)))
1651       (cond
1652        ((not (cdr prev))
1653         (setcdr prev (list (cons article state))))
1654        ((> (caadr prev) article)
1655         (setcdr prev (cons (cons article state) (cdr prev))))
1656        ((= (caadr prev) article)
1657         (setcdr (cadr prev) state)))
1658       (setq prev (cdr prev)))
1659     (setq gnus-agent-article-alist (cdr all))
1660     (if dir
1661         (gnus-make-directory dir)
1662       (gnus-make-directory (gnus-agent-article-name "" group)))
1663     (with-temp-file (if dir
1664                         (expand-file-name ".agentview" dir)
1665                       (gnus-agent-article-name ".agentview" group))
1666       (cond ((eq gnus-agent-article-alist-save-format 1)
1667              (princ gnus-agent-article-alist (current-buffer)))
1668             ((eq gnus-agent-article-alist-save-format 2)
1669              (let ((compressed nil))
1670                (mapcar (lambda (pair)
1671                          (let* ((article-id (car pair))
1672                                 (day-of-download (cdr pair))
1673                                 (comp-list (assq day-of-download compressed)))
1674                            (if comp-list
1675                                (setcdr comp-list
1676                                        (cons article-id (cdr comp-list)))
1677                              (setq compressed
1678                                    (cons (list day-of-download article-id)
1679                                          compressed)))
1680                            nil)) gnus-agent-article-alist)
1681                (mapcar (lambda (comp-list)
1682                          (setcdr comp-list
1683                                  (gnus-compress-sequence
1684                                   (nreverse (cdr comp-list)))))
1685                        compressed)
1686                (princ compressed (current-buffer)))))
1687       (insert "\n")
1688       (princ gnus-agent-article-alist-save-format (current-buffer))
1689       (insert "\n"))))
1690
1691 (defun gnus-agent-article-name (article group)
1692   (expand-file-name article
1693                     (file-name-as-directory
1694                      (expand-file-name (gnus-agent-group-path group)
1695                                        (gnus-agent-directory)))))
1696
1697 (defun gnus-agent-batch-confirmation (msg)
1698   "Show error message and return t."
1699   (gnus-message 1 msg)
1700   t)
1701
1702 ;;;###autoload
1703 (defun gnus-agent-batch-fetch ()
1704   "Start Gnus and fetch session."
1705   (interactive)
1706   (gnus)
1707   (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
1708     (gnus-agent-fetch-session))
1709   (gnus-group-exit))
1710
1711 (defun gnus-agent-fetch-session ()
1712   "Fetch all articles and headers that are eligible for fetching."
1713   (interactive)
1714   (unless gnus-agent-covered-methods
1715     (error "No servers are covered by the Gnus agent"))
1716   (unless gnus-plugged
1717     (error "Can't fetch articles while Gnus is unplugged"))
1718   (let ((methods gnus-agent-covered-methods)
1719         groups group gnus-command-method)
1720     (save-excursion
1721       (while methods
1722         (condition-case err
1723             (progn
1724               (setq gnus-command-method (car methods))
1725               (when (and (or (gnus-server-opened gnus-command-method)
1726                              (gnus-open-server gnus-command-method))
1727                          (gnus-online gnus-command-method))
1728                 (setq groups (gnus-groups-from-server (car methods)))
1729                 (gnus-agent-with-fetch
1730                  (while (setq group (pop groups))
1731                    (when (<= (gnus-group-level group)
1732                              gnus-agent-handle-level)
1733                      (gnus-agent-fetch-group-1
1734                       group gnus-command-method))))))
1735           (error
1736            (unless (funcall gnus-agent-confirmation-function
1737                             (format "Error %s.  Continue? "
1738                                     (error-message-string err)))
1739              (error "Cannot fetch articles into the Gnus agent")))
1740           (quit
1741            (unless (funcall gnus-agent-confirmation-function
1742                             (format
1743                              "Quit fetching session %s.  Continue? "
1744                              (error-message-string err)))
1745              (signal 'quit
1746                      "Cannot fetch articles into the Gnus agent"))))
1747         (pop methods))
1748       (run-hooks 'gnus-agent-fetch-hook)
1749       (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
1750
1751 (defun gnus-agent-fetch-group-1 (group method)
1752   "Fetch GROUP."
1753   (let ((gnus-command-method method)
1754         (gnus-newsgroup-name group)
1755         (gnus-newsgroup-dependencies gnus-newsgroup-dependencies)
1756         (gnus-newsgroup-headers gnus-newsgroup-headers)
1757         (gnus-newsgroup-scored gnus-newsgroup-scored)
1758         (gnus-use-cache gnus-use-cache)
1759         (gnus-summary-expunge-below gnus-summary-expunge-below)
1760         (gnus-summary-mark-below gnus-summary-mark-below)
1761         (gnus-orphan-score gnus-orphan-score)
1762         ;; Maybe some other gnus-summary local variables should also
1763         ;; be put here.
1764
1765         gnus-headers
1766         gnus-score
1767         articles arts
1768         category predicate info marks score-param
1769         )
1770     (unless (gnus-check-group group)
1771       (error "Can't open server for %s" group))
1772
1773     ;; Fetch headers.
1774     (when (or gnus-newsgroup-active
1775               (gnus-active group)
1776               (gnus-activate-group group))
1777       (let ((marked-articles gnus-newsgroup-downloadable))
1778         ;; Identify the articles marked for download
1779         (unless gnus-newsgroup-active
1780           ;; The variable gnus-newsgroup-active was selected as I need
1781           ;; a gnus-summary local variable that is NOT bound to any
1782           ;; value (its global value should default to nil).
1783           (dolist (mark gnus-agent-download-marks)
1784             (let ((arts (cdr (assq mark (gnus-info-marks
1785                                          (setq info (gnus-get-info group)))))))
1786               (when arts
1787                 (setq marked-articles (nconc (gnus-uncompress-range arts)
1788                                              marked-articles))
1789                 ))))
1790         (setq marked-articles (sort marked-articles '<))
1791
1792         ;; Fetch any new articles from the server
1793         (setq articles (gnus-agent-fetch-headers group))
1794
1795         ;; Merge new articles with marked
1796         (setq articles (sort (append marked-articles articles) '<))
1797
1798         (when articles
1799           ;; Parse them and see which articles we want to fetch.
1800           (setq gnus-newsgroup-dependencies
1801                 (or gnus-newsgroup-dependencies
1802                     (make-vector (length articles) 0)))
1803           (setq gnus-newsgroup-headers
1804                 (or gnus-newsgroup-headers
1805                     (gnus-get-newsgroup-headers-xover articles nil nil
1806                                                       group)))
1807           ;; `gnus-agent-overview-buffer' may be killed for
1808           ;; timeout reason.  If so, recreate it.
1809           (gnus-agent-create-buffer)
1810
1811           ;; Figure out how to select articles in this group
1812           (setq category (gnus-group-category group))
1813
1814           (setq predicate
1815                 (gnus-get-predicate
1816                  (gnus-agent-find-parameter group 'agent-predicate)))
1817
1818           ;; If the selection predicate requires scoring, score each header
1819           (unless (memq predicate '(gnus-agent-true gnus-agent-false))
1820             (let ((score-param
1821                    (gnus-agent-find-parameter group 'agent-score)))
1822               ;; Translate score-param into real one
1823               (cond
1824                ((not score-param))
1825                ((eq score-param 'file)
1826                 (setq score-param (gnus-all-score-files group)))
1827                ((stringp (car score-param)))
1828                (t
1829                 (setq score-param (list (list score-param)))))
1830               (when score-param
1831                 (gnus-score-headers score-param))))
1832
1833           (unless (and (eq predicate 'gnus-agent-false)
1834                        (not marked-articles))
1835             (let ((arts (list nil)))
1836               (let ((arts-tail arts)
1837                     (alist (gnus-agent-load-alist group))
1838                     (marked-articles marked-articles)
1839                     (gnus-newsgroup-headers gnus-newsgroup-headers))
1840                 (while (setq gnus-headers (pop gnus-newsgroup-headers))
1841                   (let ((num (mail-header-number gnus-headers)))
1842                     ;; Determine if this article is already in the cache
1843                     (while (and alist
1844                                 (> num (caar alist)))
1845                       (setq alist (cdr alist)))
1846
1847                     (unless (and (eq num (caar alist))
1848                                  (cdar alist))
1849
1850                       ;; Determine if this article was marked for download.
1851                       (while (and marked-articles
1852                                   (> num (car marked-articles)))
1853                         (setq marked-articles
1854                               (cdr marked-articles)))
1855
1856                       ;; When this article is marked, or selected by the
1857                       ;; predicate, add it to the download list
1858                       (when (or (eq num (car marked-articles))
1859                                 (let ((gnus-score
1860                                        (or (cdr
1861                                             (assq num gnus-newsgroup-scored))
1862                                            gnus-summary-default-score))
1863                                       (gnus-agent-long-article
1864                                        (gnus-agent-find-parameter
1865                                         group 'agent-long-article))
1866                                       (gnus-agent-low-score
1867                                        (gnus-agent-find-parameter
1868                                         group 'agent-low-score))
1869                                       (gnus-agent-high-score
1870                                        (gnus-agent-find-parameter
1871                                         group 'agent-high-score))
1872                                       (gnus-agent-expire-days
1873                                        (gnus-agent-find-parameter
1874                                         group 'agent-days-until-old)))
1875                                   (funcall predicate)))
1876                         (gnus-agent-append-to-list arts-tail num))))))
1877
1878               (let (fetched-articles)
1879                 ;; Fetch all selected articles
1880                 (setq gnus-newsgroup-undownloaded
1881                       (gnus-sorted-ndifference
1882                        gnus-newsgroup-undownloaded
1883                        (setq fetched-articles
1884                              (if (cdr arts)
1885                                  (gnus-agent-fetch-articles group (cdr arts))
1886                                nil))))
1887
1888                 (let ((unfetched-articles
1889                        (gnus-sorted-ndifference (cdr arts) fetched-articles)))
1890                   (if gnus-newsgroup-active
1891                       ;; Update the summary buffer
1892                       (progn
1893                         (dolist (article marked-articles)
1894                           (gnus-summary-set-agent-mark article t))
1895                         (dolist (article fetched-articles)
1896                           (if gnus-agent-mark-unread-after-downloaded
1897                               (gnus-summary-mark-article
1898                                article gnus-unread-mark))
1899                           (when (gnus-summary-goto-subject article nil t)
1900                             (gnus-summary-update-download-mark article)))
1901                         (dolist (article unfetched-articles)
1902                           (gnus-summary-mark-article
1903                            article gnus-canceled-mark)))
1904
1905                     ;; Update the group buffer.
1906
1907                     ;; When some, or all, of the marked articles came
1908                     ;; from the download mark.  Remove that mark.  I
1909                     ;; didn't do this earlier as I only want to remove
1910                     ;; the marks after the fetch is completed.
1911
1912                     (dolist (mark gnus-agent-download-marks)
1913                       (when (eq mark 'download)
1914                         (let ((marked-arts
1915                                (assq mark (gnus-info-marks
1916                                            (setq info (gnus-get-info group))))))
1917                           (when (cdr marked-arts)
1918                             (setq marks
1919                                   (delq marked-arts (gnus-info-marks info)))
1920                             (gnus-info-set-marks info marks)))))
1921                     (let ((read (gnus-info-read
1922                                  (or info (setq info (gnus-get-info group))))))
1923                       (gnus-info-set-read
1924                        info (gnus-add-to-range read unfetched-articles)))
1925
1926                     (gnus-group-update-group group t)
1927                     (sit-for 0)
1928
1929                     (gnus-dribble-enter
1930                      (concat "(gnus-group-set-info '"
1931                              (gnus-prin1-to-string info)
1932                              ")"))))))))))))
1933
1934 ;;;
1935 ;;; Agent Category Mode
1936 ;;;
1937
1938 (defvar gnus-category-mode-hook nil
1939   "Hook run in `gnus-category-mode' buffers.")
1940
1941 (defvar gnus-category-line-format "     %(%20c%): %g\n"
1942   "Format of category lines.
1943
1944 Valid specifiers include:
1945 %c  Topic name (string)
1946 %g  The number of groups in the topic (integer)
1947
1948 General format specifiers can also be used.  See Info node
1949 `(gnus)Formatting Variables'.")
1950
1951 (defvar gnus-category-mode-line-format "Gnus: %%b"
1952   "The format specification for the category mode line.")
1953
1954 (defvar gnus-agent-short-article 100
1955   "Articles that have fewer lines than this are short.")
1956
1957 (defvar gnus-agent-long-article 200
1958   "Articles that have more lines than this are long.")
1959
1960 (defvar gnus-agent-low-score 0
1961   "Articles that have a score lower than this have a low score.")
1962
1963 (defvar gnus-agent-high-score 0
1964   "Articles that have a score higher than this have a high score.")
1965
1966
1967 ;;; Internal variables.
1968
1969 (defvar gnus-category-buffer "*Agent Category*")
1970
1971 (defvar gnus-category-line-format-alist
1972   `((?c gnus-tmp-name ?s)
1973     (?g gnus-tmp-groups ?d)))
1974
1975 (defvar gnus-category-mode-line-format-alist
1976   `((?u user-defined ?s)))
1977
1978 (defvar gnus-category-line-format-spec nil)
1979 (defvar gnus-category-mode-line-format-spec nil)
1980
1981 (defvar gnus-category-mode-map nil)
1982 (put 'gnus-category-mode 'mode-class 'special)
1983
1984 (unless gnus-category-mode-map
1985   (setq gnus-category-mode-map (make-sparse-keymap))
1986   (suppress-keymap gnus-category-mode-map)
1987
1988   (gnus-define-keys gnus-category-mode-map
1989     "q" gnus-category-exit
1990     "k" gnus-category-kill
1991     "c" gnus-category-copy
1992     "a" gnus-category-add
1993     "e" gnus-agent-customize-category
1994     "p" gnus-category-edit-predicate
1995     "g" gnus-category-edit-groups
1996     "s" gnus-category-edit-score
1997     "l" gnus-category-list
1998
1999     "\C-c\C-i" gnus-info-find-node
2000     "\C-c\C-b" gnus-bug))
2001
2002 (defvar gnus-category-menu-hook nil
2003   "*Hook run after the creation of the menu.")
2004
2005 (defun gnus-category-make-menu-bar ()
2006   (gnus-turn-off-edit-menu 'category)
2007   (unless (boundp 'gnus-category-menu)
2008     (easy-menu-define
2009      gnus-category-menu gnus-category-mode-map ""
2010      '("Categories"
2011        ["Add" gnus-category-add t]
2012        ["Kill" gnus-category-kill t]
2013        ["Copy" gnus-category-copy t]
2014        ["Edit category" gnus-agent-customize-category t]
2015        ["Edit predicate" gnus-category-edit-predicate t]
2016        ["Edit score" gnus-category-edit-score t]
2017        ["Edit groups" gnus-category-edit-groups t]
2018        ["Exit" gnus-category-exit t]))
2019
2020     (gnus-run-hooks 'gnus-category-menu-hook)))
2021
2022 (defun gnus-category-mode ()
2023   "Major mode for listing and editing agent categories.
2024
2025 All normal editing commands are switched off.
2026 \\<gnus-category-mode-map>
2027 For more in-depth information on this mode, read the manual
2028 \(`\\[gnus-info-find-node]').
2029
2030 The following commands are available:
2031
2032 \\{gnus-category-mode-map}"
2033   (interactive)
2034   (when (gnus-visual-p 'category-menu 'menu)
2035     (gnus-category-make-menu-bar))
2036   (kill-all-local-variables)
2037   (gnus-simplify-mode-line)
2038   (setq major-mode 'gnus-category-mode)
2039   (setq mode-name "Category")
2040   (gnus-set-default-directory)
2041   (setq mode-line-process nil)
2042   (use-local-map gnus-category-mode-map)
2043   (buffer-disable-undo)
2044   (setq truncate-lines t)
2045   (setq buffer-read-only t)
2046   (gnus-run-hooks 'gnus-category-mode-hook))
2047
2048 (defalias 'gnus-category-position-point 'gnus-goto-colon)
2049
2050 (defun gnus-category-insert-line (category)
2051   (let* ((gnus-tmp-name (format "%s" (car category)))
2052          (gnus-tmp-groups (length (gnus-agent-cat-groups category))))
2053     (beginning-of-line)
2054     (gnus-add-text-properties
2055      (point)
2056      (prog1 (1+ (point))
2057        ;; Insert the text.
2058        (eval gnus-category-line-format-spec))
2059      (list 'gnus-category gnus-tmp-name))))
2060
2061 (defun gnus-enter-category-buffer ()
2062   "Go to the Category buffer."
2063   (interactive)
2064   (gnus-category-setup-buffer)
2065   (gnus-configure-windows 'category)
2066   (gnus-category-prepare))
2067
2068 (defun gnus-category-setup-buffer ()
2069   (unless (get-buffer gnus-category-buffer)
2070     (save-excursion
2071       (set-buffer (gnus-get-buffer-create gnus-category-buffer))
2072       (gnus-category-mode))))
2073
2074 (defun gnus-category-prepare ()
2075   (gnus-set-format 'category-mode)
2076   (gnus-set-format 'category t)
2077   (let ((alist gnus-category-alist)
2078         (buffer-read-only nil))
2079     (erase-buffer)
2080     (while alist
2081       (gnus-category-insert-line (pop alist)))
2082     (goto-char (point-min))
2083     (gnus-category-position-point)))
2084
2085 (defun gnus-category-name ()
2086   (or (intern (get-text-property (gnus-point-at-bol) 'gnus-category))
2087       (error "No category on the current line")))
2088
2089 (defun gnus-category-read ()
2090   "Read the category alist."
2091   (setq gnus-category-alist
2092         (or
2093          (with-temp-buffer
2094            (ignore-errors
2095             (nnheader-insert-file-contents (nnheader-concat gnus-agent-directory "lib/categories"))
2096             (goto-char (point-min))
2097             ;; This code isn't temp, it will be needed so long as
2098             ;; anyone may be migrating from an older version.
2099
2100             ;; Once we're certain that people will not revert to an
2101             ;; earlier version, we can take out the old-list code in
2102             ;; gnus-category-write.
2103             (let* ((old-list (read (current-buffer)))
2104                    (new-list (ignore-errors (read (current-buffer)))))
2105               (if new-list
2106                   new-list
2107                 ;; Convert from a positional list to an alist.
2108                 (mapcar
2109                  (lambda (c)
2110                    (setcdr c
2111                            (mapcar*
2112                             (lambda (valu symb)
2113                               (cons symb valu))
2114                             (cdr c)
2115                             '(agent-predicate agent-score-file agent-groups)))
2116                    c)
2117                  old-list)))))
2118          (list (gnus-agent-cat-make 'default)))))
2119
2120 (defun gnus-category-write ()
2121   "Write the category alist."
2122   (setq gnus-category-predicate-cache nil
2123         gnus-category-group-cache nil)
2124   (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
2125   (with-temp-file (nnheader-concat gnus-agent-directory "lib/categories")
2126     ;; This prin1 is temporary.  It exists so that people can revert
2127     ;; to an earlier version of gnus-agent.
2128     (prin1 (mapcar (lambda (c)
2129               (list (car c)
2130                     (cdr (assoc 'agent-predicate c))
2131                     (cdr (assoc 'agent-score-file c))
2132                     (cdr (assoc 'agent-groups c))))
2133                    gnus-category-alist)
2134            (current-buffer))
2135     (newline)
2136     (prin1 gnus-category-alist (current-buffer))))
2137
2138 (defun gnus-category-edit-predicate (category)
2139   "Edit the predicate for CATEGORY."
2140   (interactive (list (gnus-category-name)))
2141   (let ((info (assq category gnus-category-alist)))
2142     (gnus-edit-form
2143      (gnus-agent-cat-predicate info)
2144      (format "Editing the select predicate for category %s" category)
2145      `(lambda (predicate)
2146         ;; Avoid run-time execution of setf form
2147         ;; (setf (gnus-agent-cat-predicate (assq ',category gnus-category-alist))
2148         ;;       predicate)
2149         ;; use its expansion instead:
2150         (gnus-agent-cat-set-property (assq ',category gnus-category-alist)
2151                                      'agent-predicate predicate)
2152
2153         (gnus-category-write)
2154         (gnus-category-list)))))
2155
2156 (defun gnus-category-edit-score (category)
2157   "Edit the score expression for CATEGORY."
2158   (interactive (list (gnus-category-name)))
2159   (let ((info (assq category gnus-category-alist)))
2160     (gnus-edit-form
2161      (gnus-agent-cat-score-file info)
2162      (format "Editing the score expression for category %s" category)
2163      `(lambda (score-file)
2164         ;; Avoid run-time execution of setf form
2165         ;; (setf (gnus-agent-cat-score-file (assq ',category gnus-category-alist))
2166         ;;       score-file)
2167         ;; use its expansion instead:
2168         (gnus-agent-cat-set-property (assq ',category gnus-category-alist)
2169                                      'agent-score-file score-file)
2170
2171         (gnus-category-write)
2172         (gnus-category-list)))))
2173
2174 (defun gnus-category-edit-groups (category)
2175   "Edit the group list for CATEGORY."
2176   (interactive (list (gnus-category-name)))
2177   (let ((info (assq category gnus-category-alist)))
2178     (gnus-edit-form
2179      (gnus-agent-cat-groups info)
2180      (format "Editing the group list for category %s" category)
2181      `(lambda (groups)
2182         ;; Avoid run-time execution of setf form
2183         ;; (setf (gnus-agent-cat-groups (assq ',category gnus-category-alist))
2184         ;;       groups)
2185         ;; use its expansion instead:
2186         (gnus-agent-set-cat-groups (assq ',category gnus-category-alist)
2187                                    groups)
2188
2189         (gnus-category-write)
2190         (gnus-category-list)))))
2191
2192 (defun gnus-category-kill (category)
2193   "Kill the current category."
2194   (interactive (list (gnus-category-name)))
2195   (let ((info (assq category gnus-category-alist))
2196         (buffer-read-only nil))
2197     (gnus-delete-line)
2198     (setq gnus-category-alist (delq info gnus-category-alist))
2199     (gnus-category-write)))
2200
2201 (defun gnus-category-copy (category to)
2202   "Copy the current category."
2203   (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
2204   (let ((info (assq category gnus-category-alist)))
2205     (push (let ((newcat (gnus-copy-sequence info)))
2206             (setf (gnus-agent-cat-name newcat) to)
2207             (setf (gnus-agent-cat-groups newcat) nil)
2208             newcat)
2209           gnus-category-alist)
2210     (gnus-category-write)
2211     (gnus-category-list)))
2212
2213 (defun gnus-category-add (category)
2214   "Create a new category."
2215   (interactive "SCategory name: ")
2216   (when (assq category gnus-category-alist)
2217     (error "Category %s already exists" category))
2218   (push (gnus-agent-cat-make category)
2219         gnus-category-alist)
2220   (gnus-category-write)
2221   (gnus-category-list))
2222
2223 (defun gnus-category-list ()
2224   "List all categories."
2225   (interactive)
2226   (gnus-category-prepare))
2227
2228 (defun gnus-category-exit ()
2229   "Return to the group buffer."
2230   (interactive)
2231   (kill-buffer (current-buffer))
2232   (gnus-configure-windows 'group t))
2233
2234 ;; To avoid having 8-bit characters in the source file.
2235 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
2236
2237 (defvar gnus-category-predicate-alist
2238   '((spam . gnus-agent-spam-p)
2239     (short . gnus-agent-short-p)
2240     (long . gnus-agent-long-p)
2241     (low . gnus-agent-low-scored-p)
2242     (high . gnus-agent-high-scored-p)
2243     (read . gnus-agent-read-p)
2244     (true . gnus-agent-true)
2245     (false . gnus-agent-false))
2246   "Mapping from short score predicate symbols to predicate functions.")
2247
2248 (defun gnus-agent-spam-p ()
2249   "Say whether an article is spam or not."
2250   (unless gnus-agent-spam-hashtb
2251     (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
2252   (if (not (equal (mail-header-references gnus-headers) ""))
2253       nil
2254     (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
2255       (prog1
2256           (gnus-gethash string gnus-agent-spam-hashtb)
2257         (gnus-sethash string t gnus-agent-spam-hashtb)))))
2258
2259 (defun gnus-agent-short-p ()
2260   "Say whether an article is short or not."
2261   (< (mail-header-lines gnus-headers) gnus-agent-short-article))
2262
2263 (defun gnus-agent-long-p ()
2264   "Say whether an article is long or not."
2265   (> (mail-header-lines gnus-headers) gnus-agent-long-article))
2266
2267 (defun gnus-agent-low-scored-p ()
2268   "Say whether an article has a low score or not."
2269   (< gnus-score gnus-agent-low-score))
2270
2271 (defun gnus-agent-high-scored-p ()
2272   "Say whether an article has a high score or not."
2273   (> gnus-score gnus-agent-high-score))
2274
2275 (defun gnus-agent-read-p ()
2276   "Say whether an article is read or not."
2277   (gnus-member-of-range (mail-header-number gnus-headers)
2278                         (gnus-info-read (gnus-get-info gnus-newsgroup-name))))
2279
2280 (defun gnus-category-make-function (predicate)
2281   "Make a function from PREDICATE."
2282   (let ((func (gnus-category-make-function-1 predicate)))
2283     (if (and (= (length func) 1)
2284              (symbolp (car func)))
2285         (car func)
2286       (gnus-byte-compile `(lambda () ,func)))))
2287
2288 (defun gnus-agent-true ()
2289   "Return t."
2290   t)
2291
2292 (defun gnus-agent-false ()
2293   "Return nil."
2294   nil)
2295
2296 (defun gnus-category-make-function-1 (predicate)
2297   "Make a function from PREDICATE."
2298   (cond
2299    ;; Functions are just returned as is.
2300    ((or (symbolp predicate)
2301         (gnus-functionp predicate))
2302     `(,(or (cdr (assq predicate gnus-category-predicate-alist))
2303            predicate)))
2304    ;; More complex predicate.
2305    ((consp predicate)
2306     `(,(cond
2307         ((memq (car predicate) '(& and))
2308          'and)
2309         ((memq (car predicate) '(| or))
2310          'or)
2311         ((memq (car predicate) gnus-category-not)
2312          'not))
2313       ,@(mapcar 'gnus-category-make-function-1 (cdr predicate))))
2314    (t
2315     (error "Unknown predicate type: %s" predicate))))
2316
2317 (defun gnus-get-predicate (predicate)
2318   "Return the function implementing PREDICATE."
2319   (or (cdr (assoc predicate gnus-category-predicate-cache))
2320       (let ((func (gnus-category-make-function predicate)))
2321         (setq gnus-category-predicate-cache
2322               (nconc gnus-category-predicate-cache
2323                      (list (cons predicate func))))
2324         func)))
2325
2326 (defun gnus-predicate-implies-unread (predicate)
2327   "Say whether PREDICATE implies unread articles only.
2328 It is okay to miss some cases, but there must be no false positives.
2329 That is, if this function returns true, then indeed the predicate must
2330 return only unread articles."
2331   (gnus-function-implies-unread-1 (gnus-category-make-function predicate)))
2332
2333 (defun gnus-function-implies-unread-1 (function)
2334   (cond ((eq function (symbol-function 'gnus-agent-read-p))
2335          nil)
2336         ((not function)
2337          nil)
2338         ((symbolp function)
2339          'ignore)
2340         ((memq (car function) '(or and not))
2341          (apply (car function)
2342                 (mapcar 'gnus-function-implies-unread-1 (cdr function))))
2343         (t
2344          (error "Unknown function: %s" function))))
2345
2346 (defun gnus-group-category (group)
2347   "Return the category GROUP belongs to."
2348   (unless gnus-category-group-cache
2349     (setq gnus-category-group-cache (gnus-make-hashtable 1000))
2350     (let ((cs gnus-category-alist)
2351           groups cat)
2352       (while (setq cat (pop cs))
2353         (setq groups (gnus-agent-cat-groups cat))
2354         (while groups
2355           (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
2356   (or (gnus-gethash group gnus-category-group-cache)
2357       (assq 'default gnus-category-alist)))
2358
2359 (defun gnus-agent-expire-group (group &optional articles force)
2360   "Expire all old articles in GROUP.
2361 If you want to force expiring of certain articles, this function can
2362 take ARTICLES, and FORCE parameters as well.
2363
2364 The articles on which the expiration process runs are selected as follows:
2365   if ARTICLES is null, all read and unmarked articles.
2366   if ARTICLES is t, all articles.
2367   if ARTICLES is a list, just those articles.
2368 FORCE is equivalent to setting the expiration predicates to true."
2369   (interactive
2370    (list (let ((def (or (gnus-group-group-name)
2371                         gnus-newsgroup-name)))
2372            (let ((select (read-string (if def
2373                                           (concat "Group Name ("
2374                                                   def "): ")
2375                                         "Group Name: "))))
2376              (if (and (equal "" select)
2377                       def)
2378                  def
2379                select)))))
2380
2381   (if (not group)
2382       (gnus-agent-expire articles group force)
2383     (if (or (not (eq articles t))
2384             (yes-or-no-p
2385              (concat "Are you sure that you want to "
2386                      "expire all articles in " group ".")))
2387         (let ((gnus-command-method (gnus-find-method-for-group group))
2388               (overview (gnus-get-buffer-create " *expire overview*"))
2389               orig)
2390           (unwind-protect
2391               (when (file-exists-p (gnus-agent-lib-file "active"))
2392                 (with-temp-buffer
2393                   (nnheader-insert-file-contents
2394                    (gnus-agent-lib-file "active"))
2395                   (gnus-active-to-gnus-format
2396                    gnus-command-method
2397                    (setq orig (gnus-make-hashtable
2398                                (count-lines (point-min) (point-max))))))
2399                 (save-excursion
2400                   (gnus-agent-expire-group-1
2401                    group overview (gnus-gethash-safe group orig)
2402                    articles force)))
2403             (kill-buffer overview))))
2404     (gnus-message 4 "Expiry...done")))
2405
2406 (defun gnus-agent-expire-group-1 (group overview active articles force)
2407   ;; Internal function - requires caller to have set
2408   ;; gnus-command-method, initialized overview buffer, and to have
2409   ;; provided a non-nil active
2410   (interactive)
2411
2412   (if (eq 'DISABLE (gnus-agent-find-parameter group 'agent-enable-expiration))
2413       (gnus-message 5 "Expiry skipping over %s" group)
2414     (gnus-message 5 "Expiring articles in %s" group)
2415     (gnus-agent-load-alist group)
2416     (let* ((info (gnus-get-info group))
2417            (alist gnus-agent-article-alist)
2418            (dir (concat
2419                  (gnus-agent-directory)
2420                  (gnus-agent-group-path group)
2421                  "/"))
2422            (day (- (time-to-days (current-time))
2423                    (gnus-agent-find-parameter group 'agent-days-until-old)))
2424            (specials (if (and alist
2425                               (not force))
2426                          ;; This could be a bit of a problem.  I need to
2427                          ;; keep the last article to avoid refetching
2428                          ;; headers when using nntp in the backend.  At
2429                          ;; the same time, if someone uses a backend
2430                          ;; that supports article moving then I may have
2431                          ;; to remove the last article to complete the
2432                          ;; move.  Right now, I'm going to assume that
2433                          ;; FORCE overrides specials.
2434                          (list (caar (last alist)))))
2435            (unreads ;; Articles that are excluded from the
2436             ;; expiration process
2437             (cond (gnus-agent-expire-all
2438                    ;; All articles are marked read by global decree
2439                    nil)
2440                   ((eq articles t)
2441                    ;; All articles are marked read by function
2442                    ;; parameter
2443                    nil)
2444                   ((not articles)
2445                    ;; Unread articles are marked protected from
2446                    ;; expiration Don't call
2447                    ;; gnus-list-of-unread-articles as it returns
2448                    ;; articles that have not been fetched into the
2449                    ;; agent.
2450                    (ignore-errors
2451                     (gnus-agent-unread-articles group)))
2452                   (t
2453                    ;; All articles EXCEPT those named by the caller
2454                    ;; are protected from expiration
2455                    (gnus-sorted-difference
2456                     (gnus-uncompress-range
2457                      (cons (caar alist)
2458                            (caar (last alist))))
2459                     (sort articles '<)))))
2460            (marked ;; More articles that are exluded from the
2461             ;; expiration process
2462             (cond (gnus-agent-expire-all
2463                    ;; All articles are unmarked by global decree
2464                    nil)
2465                   ((eq articles t)
2466                    ;; All articles are unmarked by function
2467                    ;; parameter
2468                    nil)
2469                   (articles
2470                    ;; All articles may as well be unmarked as the
2471                    ;; unreads list already names the articles we are
2472                    ;; going to keep
2473                    nil)
2474                   (t
2475                    ;; Ticked and/or dormant articles are excluded
2476                    ;; from expiration
2477                    (nconc
2478                     (gnus-uncompress-range
2479                      (cdr (assq 'tick (gnus-info-marks info))))
2480                     (gnus-uncompress-range
2481                      (cdr (assq 'dormant
2482                                 (gnus-info-marks info))))))))
2483            (nov-file (concat dir ".overview"))
2484            (cnt 0)
2485            (completed -1)
2486            dlist
2487            type)
2488
2489       ;; The normal article alist contains elements that look like
2490       ;; (article# .  fetch_date) I need to combine other
2491       ;; information with this list.  For example, a flag indicating
2492       ;; that a particular article MUST BE KEPT.  To do this, I'm
2493       ;; going to transform the elements to look like (article#
2494       ;; fetch_date keep_flag NOV_entry_marker) Later, I'll reverse
2495       ;; the process to generate the expired article alist.
2496
2497       ;; Convert the alist elements to (article# fetch_date nil
2498       ;; nil).
2499       (setq dlist (mapcar (lambda (e)
2500                             (list (car e) (cdr e) nil nil)) alist))
2501
2502       ;; Convert the keep lists to elements that look like (article#
2503       ;; nil keep_flag nil) then append it to the expanded dlist
2504       ;; These statements are sorted by ascending precidence of the
2505       ;; keep_flag.
2506       (setq dlist (nconc dlist
2507                          (mapcar (lambda (e)
2508                                    (list e nil 'unread  nil))
2509                                  unreads)))
2510       (setq dlist (nconc dlist
2511                          (mapcar (lambda (e)
2512                                    (list e nil 'marked  nil))
2513                                  marked)))
2514       (setq dlist (nconc dlist
2515                          (mapcar (lambda (e)
2516                                    (list e nil 'special nil))
2517                                  specials)))
2518
2519       (set-buffer overview)
2520       (erase-buffer)
2521       (when (file-exists-p nov-file)
2522         (gnus-message 7 "gnus-agent-expire: Loading overview...")
2523         (nnheader-insert-file-contents nov-file)
2524         (goto-char (point-min))
2525
2526         (let (p)
2527           (while (< (setq p (point)) (point-max))
2528             (condition-case nil
2529                 ;; If I successfully read an integer (the plus zero
2530                 ;; ensures a numeric type), prepend a marker entry
2531                 ;; to the list
2532                 (push (list (+ 0 (read (current-buffer))) nil nil
2533                             (set-marker (make-marker) p))
2534                       dlist)
2535               (error
2536                (gnus-message 1 "gnus-agent-expire: read error \
2537 occurred when reading expression at %s in %s.  Skipping to next \
2538 line." (point) nov-file)))
2539             ;; Whether I succeeded, or failed, it doesn't matter.
2540             ;; Move to the next line then try again.
2541             (forward-line 1)))
2542         (gnus-message
2543          7 "gnus-agent-expire: Loading overview... Done"))
2544       (set-buffer-modified-p nil)
2545
2546       ;; At this point, all of the information is in dlist.  The
2547       ;; only problem is that much of it is spread across multiple
2548       ;; entries.  Sort then MERGE!!
2549       (gnus-message 7 "gnus-agent-expire: Sorting entries... ")
2550       ;; If two entries have the same article-number then sort by
2551       ;; ascending keep_flag.
2552       (let ((special 0)
2553             (marked 1)
2554             (unread 2))
2555         (setq dlist
2556               (sort dlist
2557                     (lambda (a b)
2558                       (cond ((< (nth 0 a) (nth 0 b))
2559                              t)
2560                             ((> (nth 0 a) (nth 0 b))
2561                              nil)
2562                             (t
2563                              (let ((a (or (symbol-value (nth 2 a))
2564                                           3))
2565                                    (b (or (symbol-value (nth 2 b))
2566                                           3)))
2567                                (<= a b))))))))
2568       (gnus-message 7 "gnus-agent-expire: Sorting entries... Done")
2569       (gnus-message 7 "gnus-agent-expire: Merging entries... ")
2570       (let ((dlist dlist))
2571         (while (cdr dlist)              ; I'm not at the end-of-list
2572           (if (eq (caar dlist) (caadr dlist))
2573               (let ((first (cdr (car dlist)))
2574                     (secnd (cdr (cadr dlist))))
2575                 (setcar first (or (car first)
2576                                   (car secnd))) ; fetch_date
2577                 (setq first (cdr first)
2578                       secnd (cdr secnd))
2579                 (setcar first (or (car first)
2580                                   (car secnd))) ; Keep_flag
2581                 (setq first (cdr first)
2582                       secnd (cdr secnd))
2583                 (setcar first (or (car first)
2584                                   (car secnd))) ; NOV_entry_marker
2585
2586                 (setcdr dlist (cddr dlist)))
2587             (setq dlist (cdr dlist)))))
2588       (gnus-message 7 "gnus-agent-expire: Merging entries... Done")
2589
2590       (let* ((len (float (length dlist)))
2591              (alist (list nil))
2592              (tail-alist alist))
2593         (while dlist
2594           (let ((new-completed (truncate (* 100.0
2595                                             (/ (setq cnt (1+ cnt))
2596                                                len)))))
2597             (when (> new-completed completed)
2598               (setq completed new-completed)
2599               (gnus-message 9 "%3d%% completed..."  completed)))
2600           (let* ((entry          (car dlist))
2601                  (article-number (nth 0 entry))
2602                  (fetch-date     (nth 1 entry))
2603                  (keep           (nth 2 entry))
2604                  (marker         (nth 3 entry)))
2605
2606             (cond
2607              ;; Kept articles are unread, marked, or special.
2608              (keep
2609               (gnus-message 10
2610                             "gnus-agent-expire: Article %d: Kept %s article."
2611                             article-number keep)
2612               (when fetch-date
2613                 (unless (file-exists-p
2614                          (concat dir (number-to-string
2615                                       article-number)))
2616                   (setf (nth 1 entry) nil)
2617                   (gnus-message 3 "gnus-agent-expire cleared \
2618 download flag on article %d as the cached article file is missing."
2619                                 (caar dlist)))
2620                 (unless marker
2621                   (gnus-message 1 "gnus-agent-expire detected a \
2622 missing NOV entry.  Run gnus-agent-regenerate-group to restore it.")))
2623               (gnus-agent-append-to-list
2624                tail-alist
2625                (cons article-number fetch-date)))
2626
2627              ;; The following articles are READ, UNMARKED, and
2628              ;; ORDINARY.  See if they can be EXPIRED!!!
2629              ((setq type
2630                     (cond
2631                      ((not (integerp fetch-date))
2632                       'read) ;; never fetched article (may expire
2633                      ;; right now)
2634                      ((not (file-exists-p
2635                             (concat dir (number-to-string
2636                                          article-number))))
2637                       (setf (nth 1 entry) nil)
2638                       'externally-expired) ;; Can't find the cached
2639                      ;; article.  Handle case
2640                      ;; as though this article
2641                      ;; was never fetched.
2642
2643                      ;; We now have the arrival day, so we see
2644                      ;; whether it's old enough to be expired.
2645                      ((< fetch-date day)
2646                       'expired)
2647                      (force
2648                       'forced)))
2649
2650               ;; I found some reason to expire this entry.
2651
2652               (let ((actions nil))
2653                 (when (memq type '(forced expired))
2654                   (ignore-errors        ; Just being paranoid.
2655                    (delete-file (concat dir (number-to-string
2656                                              article-number)))
2657                    (push "expired cached article" actions))
2658                   (setf (nth 1 entry) nil)
2659                   )
2660
2661                 (when marker
2662                   (push "NOV entry removed" actions)
2663                   (goto-char marker)
2664                   (gnus-delete-line))
2665
2666                 ;; If considering all articles is set, I can only
2667                 ;; expire article IDs that are no longer in the
2668                 ;; active range.
2669                 (if (and gnus-agent-consider-all-articles
2670                          (>= article-number (car active)))
2671                     ;; I have to keep this ID in the alist
2672                     (gnus-agent-append-to-list
2673                      tail-alist (cons article-number fetch-date))
2674                   (push (format "Removed %s article number from \
2675 article alist" type) actions))
2676
2677                 (gnus-message 7 "gnus-agent-expire: Article %d: %s"
2678                               article-number
2679                               (mapconcat 'identity actions ", "))))
2680              (t
2681               (gnus-message
2682                10 "gnus-agent-expire: Article %d: Article kept as \
2683 expiration tests failed." article-number)
2684               (gnus-agent-append-to-list
2685                tail-alist (cons article-number fetch-date)))
2686              )
2687
2688             ;; Clean up markers as I want to recycle this buffer
2689             ;; over several groups.
2690             (when marker
2691               (set-marker marker nil))
2692
2693             (setq dlist (cdr dlist))))
2694
2695         (setq alist (cdr alist))
2696
2697         (let ((inhibit-quit t))
2698           (unless (equal alist gnus-agent-article-alist)
2699             (setq gnus-agent-article-alist alist)
2700             (gnus-agent-save-alist group))
2701
2702           (when (buffer-modified-p)
2703             (let ((coding-system-for-write
2704                    gnus-agent-file-coding-system))
2705               (gnus-make-directory dir)
2706               (write-region (point-min) (point-max) nov-file nil
2707                             'silent)
2708               ;; clear the modified flag as that I'm not confused by
2709               ;; its status on the next pass through this routine.
2710               (set-buffer-modified-p nil)))
2711
2712           (when (eq articles t)
2713             (gnus-summary-update-info)))))))
2714
2715 (defun gnus-agent-expire (&optional articles group force)
2716   "Expire all old articles.
2717 If you want to force expiring of certain articles, this function can
2718 take ARTICLES, GROUP and FORCE parameters as well.
2719
2720 The articles on which the expiration process runs are selected as follows:
2721   if ARTICLES is null, all read and unmarked articles.
2722   if ARTICLES is t, all articles.
2723   if ARTICLES is a list, just those articles.
2724 Setting GROUP will limit expiration to that group.
2725 FORCE is equivalent to setting the expiration predicates to true."
2726   (interactive)
2727
2728   (if group
2729       (gnus-agent-expire-group group articles force)
2730     (if (or (not (eq articles t))
2731             (yes-or-no-p "Are you sure that you want to expire all \
2732 articles in every agentized group."))
2733         (let ((methods gnus-agent-covered-methods)
2734               gnus-command-method overview orig)
2735           (setq overview (gnus-get-buffer-create " *expire overview*"))
2736           (unwind-protect
2737               (while (setq gnus-command-method (pop methods))
2738                 (when (file-exists-p (gnus-agent-lib-file "active"))
2739                   (with-temp-buffer
2740                     (nnheader-insert-file-contents
2741                      (gnus-agent-lib-file "active"))
2742                     (gnus-active-to-gnus-format
2743                      gnus-command-method
2744                      (setq orig (gnus-make-hashtable
2745                                  (count-lines (point-min) (point-max))))))
2746                   (dolist (expiring-group (gnus-groups-from-server
2747                                            gnus-command-method))
2748                     (let* ((active
2749                             (gnus-gethash-safe expiring-group orig)))
2750
2751                       (when active
2752                         (save-excursion
2753                           (gnus-agent-expire-group-1
2754                            expiring-group overview active articles force)))))))
2755             (kill-buffer overview))
2756           (gnus-message 4 "Expiry...done")))))
2757
2758 ;;;###autoload
2759 (defun gnus-agent-batch ()
2760   "Start Gnus, send queue and fetch session."
2761   (interactive)
2762   (let ((init-file-user "")
2763         (gnus-always-read-dribble-file t))
2764     (gnus))
2765   (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
2766     (gnus-group-send-queue)
2767     (gnus-agent-fetch-session)))
2768
2769 (defun gnus-agent-unread-articles (group)
2770   (let* ((read (gnus-info-read (gnus-get-info group)))
2771          (known (gnus-agent-load-alist group))
2772          (unread (list nil))
2773          (tail-unread unread))
2774     (while (and known read)
2775       (let ((candidate (car (pop known))))
2776         (while (let* ((range (car read))
2777                       (min   (if (numberp range) range (car range)))
2778                       (max   (if (numberp range) range (cdr range))))
2779                  (cond ((or (not min)
2780                             (< candidate min))
2781                         (gnus-agent-append-to-list tail-unread candidate)
2782                         nil)
2783                        ((> candidate max)
2784                         (pop read)))))))
2785     (while known
2786       (gnus-agent-append-to-list tail-unread (car (pop known))))
2787     (cdr unread)))
2788
2789 (defun gnus-agent-uncached-articles (articles group &optional cached-header)
2790   "Restrict ARTICLES to numbers already fetched.
2791 Returns a sublist of ARTICLES that excludes thos article ids in GROUP
2792 that have already been fetched.
2793 If CACHED-HEADER is nil, articles are only excluded if the article itself
2794 has been fetched."
2795
2796   ;; Logically equivalent to: (gnus-sorted-difference articles (mapcar
2797   ;; 'car gnus-agent-article-alist))
2798
2799   ;; Functionally, I don't need to construct a temp list using mapcar.
2800
2801   (if (and (or gnus-agent-cache (not gnus-plugged))
2802            (gnus-agent-load-alist group))
2803     (let* ((ref gnus-agent-article-alist)
2804            (arts articles)
2805            (uncached (list nil))
2806            (tail-uncached uncached))
2807       (while (and ref arts)
2808         (let ((v1 (car arts))
2809               (v2 (caar ref)))
2810           (cond ((< v1 v2) ; v1 does not appear in the reference list
2811                  (gnus-agent-append-to-list tail-uncached v1)
2812                  (pop arts))
2813                 ((= v1 v2)
2814                  (unless (or cached-header (cdar ref)) ; v1 is already cached
2815                    (gnus-agent-append-to-list tail-uncached v1))
2816                  (pop arts)
2817                  (pop ref))
2818                 (t ; reference article (v2) preceeds the list being filtered
2819                  (pop ref)))))
2820       (while arts
2821         (gnus-agent-append-to-list tail-uncached (pop arts)))
2822       (cdr uncached))
2823     ;; if gnus-agent-load-alist fails, no articles are cached.
2824     articles))
2825
2826 (defun gnus-agent-retrieve-headers (articles group &optional fetch-old)
2827   (save-excursion
2828     (gnus-agent-create-buffer)
2829     (let ((gnus-decode-encoded-word-function 'identity)
2830           (file (gnus-agent-article-name ".overview" group))
2831           cached-articles uncached-articles)
2832       (gnus-make-directory (nnheader-translate-file-chars
2833                             (file-name-directory file) t))
2834
2835       ;; Populate temp buffer with known headers
2836       (when (file-exists-p file)
2837         (with-current-buffer gnus-agent-overview-buffer
2838           (erase-buffer)
2839           (let ((nnheader-file-coding-system
2840                  gnus-agent-file-coding-system))
2841             (nnheader-insert-nov-file file (car articles)))))
2842
2843       (if (setq uncached-articles (gnus-agent-uncached-articles articles group
2844                                                                 t))
2845           (progn
2846             ;; Populate nntp-server-buffer with uncached headers
2847             (set-buffer nntp-server-buffer)
2848             (erase-buffer)
2849             (cond ((not (eq 'nov (let (gnus-agent) ; Turn off agent
2850                                    (gnus-retrieve-headers
2851                                     uncached-articles group fetch-old))))
2852                    (nnvirtual-convert-headers))
2853                   ((eq 'nntp (car gnus-current-select-method))
2854                    ;; The author of gnus-get-newsgroup-headers-xover
2855                    ;; reports that the XOVER command is commonly
2856                    ;; unreliable. The problem is that recently
2857                    ;; posted articles may not be entered into the
2858                    ;; NOV database in time to respond to my XOVER
2859                    ;; query.
2860                    ;;
2861                    ;; I'm going to use his assumption that the NOV
2862                    ;; database is updated in order of ascending
2863                    ;; article ID.  Therefore, a response containing
2864                    ;; article ID N implies that all articles from 1
2865                    ;; to N-1 are up-to-date.  Therefore, missing
2866                    ;; articles in that range have expired.
2867
2868                    (set-buffer nntp-server-buffer)
2869                    (let* ((fetched-articles (list nil))
2870                           (tail-fetched-articles fetched-articles)
2871                           (min (cond ((numberp fetch-old)
2872                                       (max 1 (- (car articles) fetch-old)))
2873                                      (fetch-old
2874                                       1)
2875                                      (t
2876                                       (car articles))))
2877                           (max (car (last articles))))
2878
2879                      ;; Get the list of articles that were fetched
2880                      (goto-char (point-min))
2881                      (let ((pm (point-max)))
2882                        (while (< (point) pm)
2883                          (when (looking-at "[0-9]+\t")
2884                            (gnus-agent-append-to-list
2885                             tail-fetched-articles
2886                             (read (current-buffer))))
2887                          (forward-line 1)))
2888
2889                      ;; Clip this list to the headers that will
2890                      ;; actually be returned
2891                      (setq fetched-articles (gnus-list-range-intersection
2892                                              (cdr fetched-articles)
2893                                              (cons min max)))
2894
2895                      ;; Clip the uncached articles list to exclude
2896                      ;; IDs after the last FETCHED header.  The
2897                      ;; excluded IDs may be fetchable using HEAD.
2898                      (if (car tail-fetched-articles)
2899                          (setq uncached-articles
2900                                (gnus-list-range-intersection
2901                                 uncached-articles
2902                                 (cons (car uncached-articles)
2903                                       (car tail-fetched-articles)))))
2904
2905                      ;; Create the list of articles that were
2906                      ;; "successfully" fetched.  Success, in this
2907                      ;; case, means that the ID should not be
2908                      ;; fetched again.  In the case of an expired
2909                      ;; article, the header will not be fetched.
2910                      (setq uncached-articles
2911                            (gnus-sorted-nunion fetched-articles
2912                                                uncached-articles))
2913                      )))
2914
2915             ;; Erase the temp buffer
2916             (set-buffer gnus-agent-overview-buffer)
2917             (erase-buffer)
2918
2919             ;; Copy the nntp-server-buffer to the temp buffer
2920             (set-buffer nntp-server-buffer)
2921             (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
2922
2923             ;; Merge the temp buffer with the known headers (found on
2924             ;; disk in FILE) into the nntp-server-buffer
2925             (when (and uncached-articles (file-exists-p file))
2926               (gnus-agent-braid-nov group uncached-articles file))
2927
2928             ;; Save the new set of known headers to FILE
2929             (set-buffer nntp-server-buffer)
2930             (let ((coding-system-for-write
2931                    gnus-agent-file-coding-system))
2932               (gnus-agent-check-overview-buffer)
2933               (write-region (point-min) (point-max) file nil 'silent))
2934
2935             ;; Update the group's article alist to include the newly
2936             ;; fetched articles.
2937             (gnus-agent-load-alist group)
2938             (gnus-agent-save-alist group uncached-articles nil)
2939             )
2940
2941         ;; Copy the temp buffer to the nntp-server-buffer
2942         (set-buffer nntp-server-buffer)
2943         (erase-buffer)
2944         (insert-buffer-substring gnus-agent-overview-buffer)))
2945
2946     (if (and fetch-old
2947              (not (numberp fetch-old)))
2948         t                               ; Don't remove anything.
2949       (nnheader-nov-delete-outside-range
2950        (if fetch-old (max 1 (- (car articles) fetch-old))
2951          (car articles))
2952        (car (last articles)))
2953       t)
2954
2955     'nov))
2956
2957 (defun gnus-agent-request-article (article group)
2958   "Retrieve ARTICLE in GROUP from the agent cache."
2959   (when (and gnus-agent
2960              (or gnus-agent-cache
2961                  (not gnus-plugged))
2962              (numberp article))
2963     (let* ((gnus-command-method (gnus-find-method-for-group group))
2964            (file (concat
2965                   (gnus-agent-directory)
2966                   (gnus-agent-group-path group) "/"
2967                   (number-to-string article)))
2968            (buffer-read-only nil))
2969       (when (and (file-exists-p file)
2970                  (> (nth 7 (file-attributes file)) 0))
2971         (erase-buffer)
2972         (gnus-kill-all-overlays)
2973         (let ((coding-system-for-read gnus-cache-coding-system))
2974           (insert-file-contents file))
2975         t))))
2976
2977 (defun gnus-agent-regenerate-group (group &optional reread)
2978   "Regenerate GROUP.
2979 If REREAD is t, all articles in the .overview are marked as unread.
2980 If REREAD is not nil, downloaded articles are marked as unread."
2981   (interactive
2982    (list (let ((def (or (gnus-group-group-name)
2983                         gnus-newsgroup-name)))
2984            (let ((select (read-string (if def
2985                                           (concat "Group Name ("
2986                                                   def "): ")
2987                                         "Group Name: "))))
2988              (if (and (equal "" select)
2989                       def)
2990                  def
2991                select)))
2992          (intern-soft
2993           (read-string
2994            "Reread (nil)? (t=>all, nil=>none, some=>all downloaded): "))))
2995   (gnus-message 5 "Regenerating in %s" group)
2996   (let* ((gnus-command-method (or gnus-command-method
2997                                   (gnus-find-method-for-group group)))
2998          (file (gnus-agent-article-name ".overview" group))
2999          (dir (file-name-directory file))
3000          point
3001          (downloaded (if (file-exists-p dir)
3002                          (sort (mapcar (lambda (name) (string-to-int name))
3003                                        (directory-files dir nil "^[0-9]+$" t))
3004                                '>)
3005                        (progn (gnus-make-directory dir) nil)))
3006          dl nov-arts
3007          alist header
3008          regenerated)
3009
3010     (mm-with-unibyte-buffer
3011      (if (file-exists-p file)
3012          (let ((nnheader-file-coding-system
3013                 gnus-agent-file-coding-system))
3014            (nnheader-insert-file-contents file)))
3015      (set-buffer-modified-p nil)
3016
3017      ;; Load the article IDs found in the overview file.  As a
3018      ;; side-effect, validate the file contents.
3019      (let ((load t))
3020        (while load
3021          (setq load nil)
3022          (goto-char (point-min))
3023          (while (< (point) (point-max))
3024            (cond ((and (looking-at "[0-9]+\t")
3025                        (<= (- (match-end 0) (match-beginning 0)) 9))
3026                   (push (read (current-buffer)) nov-arts)
3027                   (forward-line 1)
3028                   (let ((l1 (car nov-arts))
3029                         (l2 (cadr nov-arts)))
3030                     (cond ((not l2)
3031                            nil)
3032                           ((< l1 l2)
3033                            (gnus-message 3 "gnus-agent-regenerate-group: NOV\
3034  entries are NOT in ascending order.")
3035                            ;; Don't sort now as I haven't verified
3036                            ;; that every line begins with a number
3037                            (setq load t))
3038                           ((= l1 l2)
3039                            (forward-line -1)
3040                            (gnus-message 4 "gnus-agent-regenerate-group: NOV\
3041  entries contained duplicate of article %s.      Duplicate deleted." l1)
3042                            (gnus-delete-line)
3043                            (pop nov-arts)))))
3044                  (t
3045                   (gnus-message 1 "gnus-agent-regenerate-group: NOV\
3046  entries contained line that did not begin with an article number.  Deleted\
3047  line.")
3048                   (gnus-delete-line))))
3049          (if load
3050              (progn
3051                (gnus-message 5 "gnus-agent-regenerate-group: Sorting NOV\
3052  entries into ascending order.")
3053                (sort-numeric-fields 1 (point-min) (point-max))
3054                     (setq nov-arts nil)))))
3055      (gnus-agent-check-overview-buffer)
3056
3057      ;; Construct a new article alist whose nodes match every header
3058      ;; in the .overview file.  As a side-effect, missing headers are
3059      ;; reconstructed from the downloaded article file.
3060      (while (or downloaded nov-arts)
3061        (cond ((and downloaded
3062                    (or (not nov-arts)
3063                        (> (car downloaded) (car nov-arts))))
3064               ;; This entry is missing from the overview file
3065               (gnus-message 3 "Regenerating NOV %s %d..." group
3066                             (car downloaded))
3067               (let ((file (concat dir (number-to-string (car downloaded)))))
3068                 (mm-with-unibyte-buffer
3069                  (nnheader-insert-file-contents file)
3070                  (nnheader-remove-body)
3071                  (setq header (nnheader-parse-naked-head)))
3072                 (mail-header-set-number header (car downloaded))
3073                 (if nov-arts
3074                     (let ((key (concat "^" (int-to-string (car nov-arts))
3075                                        "\t")))
3076                       (or (re-search-backward key nil t)
3077                           (re-search-forward key))
3078                       (forward-line 1))
3079                   (goto-char (point-min)))
3080                 (nnheader-insert-nov header))
3081               (setq nov-arts (cons (car downloaded) nov-arts)))
3082              ((eq (car downloaded) (car nov-arts))
3083               ;; This entry in the overview has been downloaded
3084               (push (cons (car downloaded)
3085                           (time-to-days
3086                            (nth 5 (file-attributes
3087                                    (concat dir (number-to-string
3088                                                 (car downloaded))))))) alist)
3089               (pop downloaded)
3090               (pop nov-arts))
3091              (t
3092               ;; This entry in the overview has not been downloaded
3093               (push (cons (car nov-arts) nil) alist)
3094               (pop nov-arts))))
3095
3096      ;; When gnus-agent-consider-all-articles is set,
3097      ;; gnus-agent-regenerate-group should NOT remove article IDs from
3098      ;; the alist.  Those IDs serve as markers to indicate that an
3099      ;; attempt has been made to fetch that article's header.
3100
3101      ;; When gnus-agent-consider-all-articles is NOT set,
3102      ;; gnus-agent-regenerate-group can remove the article ID of every
3103      ;; article (with the exception of the last ID in the list - it's
3104      ;; special) that no longer appears in the overview.  In this
3105      ;; situtation, the last article ID in the list implies that it,
3106      ;; and every article ID preceeding it, have been fetched from the
3107      ;; server.
3108      (if gnus-agent-consider-all-articles
3109          ;; Restore all article IDs that were not found in the overview file.
3110          (let* ((n (cons nil alist))
3111                 (merged n)
3112                 (o (gnus-agent-load-alist group)))
3113            (while o
3114              (let ((nID (caadr n))
3115                    (oID (caar o)))
3116                (cond ((not nID)
3117                       (setq n (setcdr n (list (list oID))))
3118                       (pop o))
3119                      ((< oID nID)
3120                       (setcdr n (cons (list oID) (cdr n)))
3121                       (pop o))
3122                      ((= oID nID)
3123                       (pop o)
3124                       (pop n))
3125                      (t
3126                       (pop n)))))
3127            (setq alist (cdr merged)))
3128        ;; Restore the last article ID if it is not already in the new alist
3129        (let ((n (last alist))
3130              (o (last (gnus-agent-load-alist group))))
3131          (cond ((not o)
3132                 nil)
3133                ((not n)
3134                 (push (cons (caar o) nil) alist))
3135                ((< (caar n) (caar o))
3136                 (setcdr n (list (car o)))))))
3137
3138      (let ((inhibit-quit t))
3139      (if (setq regenerated (buffer-modified-p))
3140          (let ((coding-system-for-write gnus-agent-file-coding-system))
3141            (write-region (point-min) (point-max) file nil 'silent)))
3142
3143     (setq regenerated (or regenerated
3144                           (and reread gnus-agent-article-alist)
3145                           (not (equal alist gnus-agent-article-alist)))
3146           )
3147
3148     (setq gnus-agent-article-alist alist)
3149
3150     (when regenerated
3151          (gnus-agent-save-alist group)))
3152      )
3153
3154     (when (and reread gnus-agent-article-alist)
3155       (gnus-make-ascending-articles-unread
3156        group
3157        (delq nil (mapcar (function (lambda (c)
3158                                      (cond ((eq reread t)
3159                                             (car c))
3160                                            ((cdr c)
3161                                             (car c)))))
3162                          gnus-agent-article-alist)))
3163
3164       (when (gnus-buffer-live-p gnus-group-buffer)
3165         (gnus-group-update-group group t)
3166         (sit-for 0))
3167       )
3168
3169     (gnus-message 5 nil)
3170     regenerated))
3171
3172 ;;;###autoload
3173 (defun gnus-agent-regenerate (&optional clean reread)
3174   "Regenerate all agent covered files.
3175 If CLEAN, don't read existing active files."
3176   (interactive "P")
3177   (let (regenerated)
3178     (gnus-message 4 "Regenerating Gnus agent files...")
3179     (dolist (gnus-command-method gnus-agent-covered-methods)
3180       (let ((active-file (gnus-agent-lib-file "active"))
3181             active-hashtb active-changed
3182             point)
3183         (gnus-make-directory (file-name-directory active-file))
3184         (if clean
3185             (setq active-hashtb (gnus-make-hashtable 1000))
3186           (mm-with-unibyte-buffer
3187            (if (file-exists-p active-file)
3188                (let ((nnheader-file-coding-system
3189                       gnus-agent-file-coding-system))
3190                  (nnheader-insert-file-contents active-file))
3191              (setq active-changed t))
3192            (gnus-active-to-gnus-format
3193             nil (setq active-hashtb
3194                       (gnus-make-hashtable
3195                        (count-lines (point-min) (point-max)))))))
3196         (dolist (group (gnus-groups-from-server gnus-command-method))
3197           (setq regenerated (or (gnus-agent-regenerate-group group reread)
3198                                 regenerated))
3199           (let ((min (or (caar gnus-agent-article-alist) 1))
3200                 (max (or (caar (last gnus-agent-article-alist)) 0))
3201                 (active (gnus-gethash-safe (gnus-group-real-name group)
3202                                            active-hashtb))
3203                 (read (gnus-info-read (gnus-get-info group))))
3204             (if (not active)
3205                 (progn
3206                   (setq active (cons min max)
3207                         active-changed t)
3208                   (gnus-sethash group active active-hashtb))
3209               (when (> (car active) min)
3210                 (setcar active min)
3211                 (setq active-changed t))
3212               (when (< (cdr active) max)
3213                 (setcdr active max)
3214                 (setq active-changed t)))))
3215         (when active-changed
3216           (setq regenerated t)
3217           (gnus-message 4 "Regenerate %s" active-file)
3218           (let ((nnmail-active-file-coding-system
3219                  gnus-agent-file-coding-system))
3220             (gnus-write-active-file active-file active-hashtb)))))
3221     (gnus-message 4 "Regenerating Gnus agent files...done")
3222     regenerated))
3223
3224 (defun gnus-agent-go-online (&optional force)
3225   "Switch servers into online status."
3226   (interactive (list t))
3227   (dolist (server gnus-opened-servers)
3228     (when (eq (nth 1 server) 'offline)
3229       (if (if (eq force 'ask)
3230               (gnus-y-or-n-p
3231                (format "Switch %s:%s into online status? "
3232                        (caar server) (cadar server)))
3233             force)
3234           (setcar (nthcdr 1 server) 'close)))))
3235
3236 (defun gnus-agent-toggle-group-plugged (group)
3237   "Toggle the status of the server of the current group."
3238   (interactive (list (gnus-group-group-name)))
3239   (let* ((method (gnus-find-method-for-group group))
3240          (status (cadr (assoc method gnus-opened-servers))))
3241     (if (eq status 'offline)
3242         (gnus-server-set-status method 'closed)
3243       (gnus-close-server method)
3244       (gnus-server-set-status method 'offline))
3245     (message "Turn %s:%s from %s to %s." (car method) (cadr method)
3246              (if (eq status 'offline) 'offline 'online)
3247              (if (eq status 'offline) 'online 'offline))))
3248
3249 (defun gnus-agent-group-covered-p (group)
3250   (member (gnus-group-method group)
3251           gnus-agent-covered-methods))
3252
3253 (add-hook 'gnus-group-prepare-hook
3254           (lambda ()
3255             'gnus-agent-do-once
3256
3257             (when (listp gnus-agent-expire-days)
3258               (beep)
3259               (beep)
3260               (gnus-message 1 "WARNING: gnus-agent-expire-days no longer\
3261  supports being set to a list.")(sleep-for 3)
3262               (gnus-message 1 "Change your configuration to set it to an\
3263  integer.")(sleep-for 3)
3264               (gnus-message 1 "I am now setting group parameters on each\
3265  group to match the configuration that the list offered.")
3266
3267               (save-excursion
3268                 (let ((groups (gnus-group-listed-groups)))
3269                   (while groups
3270                     (let* ((group (pop groups))
3271                            (days gnus-agent-expire-days)
3272                            (day (catch 'found
3273                                   (while days
3274                                     (when (eq 0 (string-match
3275                                                  (caar days)
3276                                                  group))
3277                                       (throw 'found (cadar days)))
3278                                     (pop days))
3279                                   nil)))
3280                       (when day
3281                         (gnus-group-set-parameter group 'agent-days-until-old
3282                                                   day))))))
3283
3284               (let ((h gnus-group-prepare-hook))
3285                 (while h
3286                   (let ((func (pop h)))
3287                     (when (and (listp func)
3288                                (eq (cadr (caddr func)) 'gnus-agent-do-once))
3289                       (remove-hook 'gnus-group-prepare-hook func)
3290                       (setq h nil)))))
3291
3292               (gnus-message 1 "I have finished setting group parameters on\
3293  each group. You may now customize your groups and/or topics to control the\
3294  agent."))))
3295
3296 (provide 'gnus-agent)
3297
3298 ;;; gnus-agent.el ends here