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