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

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