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

   1 ;;; gnus-agent.el --- unplugged support for Gnus
   2 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002
   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 undownloaded articles as read."
 774   (interactive)
 775   (save-excursion
 776     (while gnus-newsgroup-undownloaded
 777       (gnus-summary-mark-article
 778        (pop gnus-newsgroup-undownloaded) gnus-catchup-mark)))
 779   (gnus-summary-position-point))
 780
 781 (defun gnus-agent-summary-fetch-series ()
 782   (interactive)
 783   (when gnus-newsgroup-processable
 784     (setq gnus-newsgroup-downloadable
 785           (let* ((dl gnus-newsgroup-downloadable)
 786                  (gnus-newsgroup-downloadable (sort gnus-newsgroup-processable '<))
 787                  (fetched-articles (gnus-agent-summary-fetch-group)))
 788             (dolist (article fetched-articles)
 789               (gnus-summary-remove-process-mark article))
 790             (gnus-sorted-ndifference dl fetched-articles)))))
 791
 792 (defun gnus-agent-summary-fetch-group (&optional all)
 793   "Fetch the downloadable articles in the group.
 794 Optional arg ALL, if non-nil, means to fetch all articles."
 795   (interactive "P")
 796   (let ((articles
 797          (if all gnus-newsgroup-articles
 798            gnus-newsgroup-downloadable))
 799         (gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name))
 800         (state gnus-plugged)
 801         fetched-articles)
 802     (unwind-protect
 803         (progn
 804           (unless state
 805             (gnus-agent-toggle-plugged t))
 806           (unless articles
 807             (error "No articles to download"))
 808           (gnus-agent-with-fetch
 809             (setq gnus-newsgroup-undownloaded
 810                   (gnus-sorted-ndifference gnus-newsgroup-undownloaded
 811                                            (setq fetched-articles (gnus-agent-fetch-articles gnus-newsgroup-name articles)))))
 812           (save-excursion
 813
 814 (dolist (article articles)
 815               (setq gnus-newsgroup-downloadable
 816                     (delq article gnus-newsgroup-downloadable))
 817               (if gnus-agent-mark-unread-after-downloaded
 818                   (gnus-summary-mark-article article gnus-unread-mark))
 819               (when (gnus-summary-goto-subject article nil t)
 820                 (gnus-summary-update-download-mark article)))))
 821       (when (and (not state)
 822                  gnus-plugged)
 823         (gnus-agent-toggle-plugged nil)))
 824     fetched-articles))
 825
 826 (defun gnus-agent-fetch-selected-article ()
 827   "Fetch the current article as it is selected.
 828 This can be added to `gnus-select-article-hook' or
 829 `gnus-mark-article-hook'."
 830   (let ((gnus-command-method gnus-current-select-method))
 831     (when (and gnus-plugged (gnus-agent-method-p gnus-command-method))
 832       (when (gnus-agent-fetch-articles
 833              gnus-newsgroup-name
 834              (list gnus-current-article))
 835         (setq gnus-newsgroup-undownloaded
 836               (delq gnus-current-article gnus-newsgroup-undownloaded))
 837         (gnus-summary-update-line gnus-current-article)))))
 838
 839 ;;;
 840 ;;; Internal functions
 841 ;;;
 842
 843 (defun gnus-agent-save-active (method)
 844   (gnus-agent-save-active-1 method 'gnus-active-to-gnus-format))
 845
 846 (defun gnus-agent-save-active-1 (method function)
 847   (when (gnus-agent-method-p method)
 848     (let* ((gnus-command-method method)
 849            (new (gnus-make-hashtable (count-lines (point-min) (point-max))))
 850            (file (gnus-agent-lib-file "active")))
 851       (funcall function nil new)
 852       (gnus-agent-write-active file new)
 853       (erase-buffer)
 854       (nnheader-insert-file-contents file))))
 855
 856 (defun gnus-agent-write-active (file new)
 857   (let ((orig (gnus-make-hashtable (count-lines (point-min) (point-max))))
 858         (file (gnus-agent-lib-file "active"))
 859         elem osym)
 860     (when (file-exists-p file)
 861       (with-temp-buffer
 862         (nnheader-insert-file-contents file)
 863         (gnus-active-to-gnus-format nil orig))
 864       (mapatoms
 865        (lambda (sym)
 866          (when (and sym (boundp sym))
 867            (if (and (boundp (setq osym (intern (symbol-name sym) orig)))
 868                     (setq elem (symbol-value osym)))
 869                (progn
 870                  (if (and (integerp (car (symbol-value sym)))
 871                           (> (car elem) (car (symbol-value sym))))
 872                      (setcar elem (car (symbol-value sym))))
 873                  (if (integerp (cdr (symbol-value sym)))
 874                      (setcdr elem (cdr (symbol-value sym)))))
 875              (set (intern (symbol-name sym) orig) (symbol-value sym)))))
 876        new))
 877     (gnus-make-directory (file-name-directory file))
 878     (let ((nnmail-active-file-coding-system gnus-agent-file-coding-system))
 879       ;; The hashtable contains real names of groups,  no more prefix
 880       ;; removing, so set `full' to `t'.
 881       (gnus-write-active-file file orig t))))
 882
 883 (defun gnus-agent-save-groups (method)
 884   (gnus-agent-save-active-1 method 'gnus-groups-to-gnus-format))
 885
 886 (defun gnus-agent-save-group-info (method group active)
 887   (when (gnus-agent-method-p method)
 888     (let* ((gnus-command-method method)
 889            (coding-system-for-write nnheader-file-coding-system)
 890            (file-name-coding-system nnmail-pathname-coding-system)
 891            (file (gnus-agent-lib-file "active"))
 892            oactive-min)
 893       (gnus-make-directory (file-name-directory file))
 894       (with-temp-file file
 895         ;; Emacs got problem to match non-ASCII group in multibyte buffer.
 896         (mm-disable-multibyte)
 897         (when (file-exists-p file)
 898           (nnheader-insert-file-contents file))
 899         (goto-char (point-min))
 900         (when (re-search-forward
 901                (concat "^" (regexp-quote group) " ") nil t)
 902           (save-excursion
 903             (read (current-buffer))                      ;; max
 904             (setq oactive-min (read (current-buffer))))  ;; min
 905           (gnus-delete-line))
 906         (insert (format "%S %d %d y\n" (intern group)
 907                         (cdr active)
 908                         (or oactive-min (car active))))
 909         (goto-char (point-max))
 910         (while (search-backward "\\." nil t)
 911           (delete-char 1))))))
 912
 913 (defun gnus-agent-group-path (group)
 914   "Translate GROUP into a path."
 915   (if nnmail-use-long-file-names
 916       (gnus-group-real-name group)
 917     (nnheader-translate-file-chars
 918      (nnheader-replace-chars-in-string
 919       (nnheader-replace-duplicate-chars-in-string
 920        (nnheader-replace-chars-in-string
 921         (gnus-group-real-name group)
 922         ?/ ?_)
 923        ?. ?_)
 924       ?. ?/))))
 925
 926 (defun gnus-agent-get-function (method)
 927   (if (gnus-online method)
 928       (car method)
 929     (require 'nnagent)
 930     'nnagent))
 931
 932 ;;; History functions
 933
 934 (defun gnus-agent-history-buffer ()
 935   (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
 936
 937 (defun gnus-agent-open-history ()
 938   (save-excursion
 939     (push (cons (gnus-agent-method)
 940                 (set-buffer (gnus-get-buffer-create
 941                              (format " *Gnus agent %s history*"
 942                                      (gnus-agent-method)))))
 943           gnus-agent-history-buffers)
 944     (mm-disable-multibyte) ;; everything is binary
 945     (erase-buffer)
 946     (insert "\n")
 947     (let ((file (gnus-agent-lib-file "history")))
 948       (when (file-exists-p file)
 949         (nnheader-insert-file-contents file))
 950       (set (make-local-variable 'gnus-agent-file-name) file))))
 951
 952 (defun gnus-agent-close-history ()
 953   (when (gnus-buffer-live-p gnus-agent-current-history)
 954     (kill-buffer gnus-agent-current-history)
 955     (setq gnus-agent-history-buffers
 956           (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
 957                 gnus-agent-history-buffers))))
 958
 959 ;;;
 960 ;;; Fetching
 961 ;;;
 962
 963 (defun gnus-agent-fetch-articles (group articles)
 964   "Fetch ARTICLES from GROUP and put them into the Agent."
 965   (when articles
 966     (gnus-agent-load-alist group)
 967     (let* ((alist   gnus-agent-article-alist)
 968            (headers (if (< (length articles) 2) nil gnus-newsgroup-headers))
 969            (selected-sets (list nil))
 970            (current-set-size 0)
 971            article
 972            header-number)
 973       ;; Check each article
 974       (while (setq article (pop articles))
 975         ;; Skip alist entries preceeding this article
 976         (while (> article (or (caar alist) (1+ article)))
 977           (setq alist (cdr alist)))
 978
 979         ;; Prune off articles that we have already fetched.
 980         (unless (and (eq article (caar alist))
 981                      (cdar alist))
 982           ;; Skip headers preceeding this article
 983           (while (> article
 984                     (setq header-number
 985                           (let* ((header (car headers)))
 986                             (if header
 987                                 (mail-header-number header)
 988                               (1+ article)))))
 989             (setq headers (cdr headers)))
 990
 991           ;; Add this article to the current set
 992           (setcar selected-sets (cons article (car selected-sets)))
 993
 994           ;; Update the set size, when the set is too large start a
 995           ;; new one.  I do this after adding the article as I want at
 996           ;; least one article in each set.
 997           (when (< gnus-agent-max-fetch-size
 998                    (setq current-set-size (+ current-set-size (if (= header-number article)
 999                                                                   (mail-header-chars (car headers))
1000                                                                 0))))
1001             (setcar selected-sets (nreverse (car selected-sets)))
1002             (setq selected-sets (cons nil selected-sets)
1003                   current-set-size 0))))
1004
1005       (when (or (cdr selected-sets) (car selected-sets))
1006         (let* ((fetched-articles (list nil))
1007                (tail-fetched-articles fetched-articles)
1008                (dir (concat
1009                      (gnus-agent-directory)
1010                      (gnus-agent-group-path group) "/"))
1011                (date (time-to-days (current-time)))
1012                (case-fold-search t)
1013                pos crosses id)
1014
1015           (setcar selected-sets (nreverse (car selected-sets)))
1016           (setq selected-sets (nreverse selected-sets))
1017
1018           (gnus-make-directory dir)
1019           (gnus-message 7 "Fetching articles for %s..." group)
1020
1021           (unwind-protect
1022               (while (setq articles (pop selected-sets))
1023                 ;; Fetch the articles from the backend.
1024                 (if (gnus-check-backend-function 'retrieve-articles group)
1025                     (setq pos (gnus-retrieve-articles articles group))
1026                   (with-temp-buffer
1027                     (let (article)
1028                       (while (setq article (pop articles))
1029                         (gnus-message 10 "Fetching article %s for %s..."
1030                                       article group)
1031                         (when (or
1032                                (gnus-backlog-request-article group article
1033                                                              nntp-server-buffer)
1034                                (gnus-request-article article group))
1035                           (goto-char (point-max))
1036                           (push (cons article (point)) pos)
1037                           (insert-buffer-substring nntp-server-buffer)))
1038                       (copy-to-buffer nntp-server-buffer (point-min) (point-max))
1039                       (setq pos (nreverse pos)))))
1040                 ;; Then save these articles into the Agent.
1041                 (save-excursion
1042                   (set-buffer nntp-server-buffer)
1043                   (while pos
1044                     (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
1045                     (goto-char (point-min))
1046                     (unless (eobp) ;; Don't save empty articles.
1047                       (when (search-forward "\n\n" nil t)
1048                         (when (search-backward "\nXrefs: " nil t)
1049                           ;; Handle cross posting.
1050                           (goto-char (match-end 0)) ; move to end of header name
1051                           (skip-chars-forward "^ ") ; skip server name
1052                           (skip-chars-forward " ")
1053                           (setq crosses nil)
1054                           (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) *")
1055                             (push (cons (buffer-substring (match-beginning 1)
1056                                                           (match-end 1))
1057                                         (string-to-int (buffer-substring (match-beginning 2)
1058                                                                          (match-end 2))))
1059                                   crosses)
1060                             (goto-char (match-end 0)))
1061                           (gnus-agent-crosspost crosses (caar pos) date)))
1062                       (goto-char (point-min))
1063                       (if (not (re-search-forward
1064                                 "^Message-ID: *<\\([^>\n]+\\)>" nil t))
1065                           (setq id "No-Message-ID-in-article")
1066                         (setq id (buffer-substring (match-beginning 1) (match-end 1))))
1067                       (let ((coding-system-for-write
1068                              gnus-agent-file-coding-system))
1069                         (write-region (point-min) (point-max)
1070                                       (concat dir (number-to-string (caar pos)))
1071                                       nil 'silent))
1072
1073                       (gnus-agent-append-to-list tail-fetched-articles (caar pos)))
1074                     (widen)
1075                     (pop pos))))
1076
1077             (gnus-agent-save-alist group (cdr fetched-articles) date))
1078           (cdr fetched-articles))))))
1079
1080 (defun gnus-agent-crosspost (crosses article &optional date)
1081   (setq date (or date t))
1082
1083   (let (gnus-agent-article-alist group alist beg end)
1084     (save-excursion
1085       (set-buffer gnus-agent-overview-buffer)
1086       (when (nnheader-find-nov-line article)
1087         (forward-word 1)
1088         (setq beg (point))
1089         (setq end (progn (forward-line 1) (point)))))
1090     (while crosses
1091       (setq group (caar crosses))
1092       (unless (setq alist (assoc group gnus-agent-group-alist))
1093         (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
1094               gnus-agent-group-alist))
1095       (setcdr alist (cons (cons (cdar crosses) date) (cdr alist)))
1096       (save-excursion
1097         (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
1098                                                     group)))
1099         (when (= (point-max) (point-min))
1100           (push (cons group (current-buffer)) gnus-agent-buffer-alist)
1101           (ignore-errors
1102             (nnheader-insert-file-contents
1103              (gnus-agent-article-name ".overview" group))))
1104         (nnheader-find-nov-line (string-to-number (cdar crosses)))
1105         (insert (string-to-number (cdar crosses)))
1106         (insert-buffer-substring gnus-agent-overview-buffer beg end)
1107         (gnus-agent-check-overview-buffer))
1108       (pop crosses))))
1109
1110 (defun gnus-agent-check-overview-buffer (&optional buffer)
1111   "Check the overview file given for sanity.
1112 In particular, checks that the file is sorted by article number
1113 and that there are no duplicates."
1114   (let ((prev-num -1))
1115     (save-excursion
1116       (when buffer
1117         (set-buffer buffer))
1118       (save-restriction
1119         (widen)
1120         (goto-char (point-min))
1121
1122         (while (< (point) (point-max))
1123           (let ((p (point))
1124                 (cur (condition-case nil
1125                          (read (current-buffer))
1126                        (error nil))))
1127             (cond
1128              ((or (not (integerp cur))
1129                   (not (eq (char-after) ?\t)))
1130               (gnus-message 1
1131                             "Overview buffer contains garbage '%s'."
1132                             (buffer-substring
1133                              p (gnus-point-at-eol))))
1134              ((= cur prev-num)
1135               (gnus-message 1
1136                             "Duplicate overview line for %d" cur)
1137               (delete-region (point) (progn (forward-line 1) (point))))
1138              ((< cur 0)
1139               (gnus-message 1 "Junk article number %d" cur)
1140               (delete-region (point) (progn (forward-line 1) (point))))
1141              ((< cur prev-num)
1142               (sort-numeric-fields 1 (point-min) (point-max))
1143               (goto-char (point-min))
1144               (setq prev-num -1)
1145               (gnus-message 1 "Overview buffer not sorted!"))
1146              (t
1147               (setq prev-num cur)))
1148             (forward-line 1)))))))
1149
1150 (defun gnus-agent-flush-cache ()
1151   (save-excursion
1152     (while gnus-agent-buffer-alist
1153       (set-buffer (cdar gnus-agent-buffer-alist))
1154       (let ((coding-system-for-write
1155              gnus-agent-file-coding-system))
1156         (write-region (point-min) (point-max)
1157                       (gnus-agent-article-name ".overview"
1158                                                (caar gnus-agent-buffer-alist))
1159                       nil 'silent))
1160       (pop gnus-agent-buffer-alist))
1161     (while gnus-agent-group-alist
1162       (with-temp-file (gnus-agent-article-name ".agentview" (caar gnus-agent-group-alist))
1163         (princ (cdar gnus-agent-group-alist))
1164         (insert "\n")
1165         (princ 1 (current-buffer))
1166         (insert "\n"))
1167       (pop gnus-agent-group-alist))))
1168
1169 (defun gnus-agent-fetch-headers (group &optional force)
1170   "Fetch interesting headers into the agent.  The group's overview
1171 file will be updated to include the headers while a list of available
1172 article numbers will be returned."
1173   (let* ((fetch-all (and gnus-agent-consider-all-articles
1174                          ;; Do not fetch all headers if the predicate
1175                          ;; implies that we only consider unread articles.
1176                          (not (gnus-predicate-implies-unread
1177                                (or (gnus-group-find-parameter
1178                                     group 'agent-predicate t)
1179                                    (cadr (gnus-group-category group)))))))
1180          (articles (if fetch-all
1181                        (gnus-uncompress-range (gnus-active group))
1182                      (gnus-list-of-unread-articles group)))
1183          (gnus-decode-encoded-word-function 'identity)
1184          (file (gnus-agent-article-name ".overview" group))
1185          gnus-agent-cache)
1186
1187     (unless fetch-all
1188       ;; Add articles with marks to the list of article headers we want to
1189       ;; fetch.  Don't fetch articles solely on the basis of a recent or seen
1190       ;; mark, but do fetch recent or seen articles if they have other, more
1191       ;; interesting marks.  (We have to fetch articles with boring marks
1192       ;; because otherwise the agent will remove their marks.)
1193       (dolist (arts (gnus-info-marks (gnus-get-info group)))
1194         (unless (memq (car arts) '(seen recent killed cache))
1195           (setq articles (gnus-range-add articles (cdr arts)))))
1196       (setq articles (sort (gnus-uncompress-sequence articles) '<)))
1197
1198     ;; At this point, I have the list of articles to consider for fetching.
1199     ;; This is the list that I'll return to my caller. Some of these articles may have already
1200     ;; been fetched.  That's OK as the fetch article code will filter those out.
1201     ;; Internally, I'll filter this list to just those articles whose headers need to be fetched.
1202     (let ((articles articles))
1203       ;; Remove known articles.
1204       (when (gnus-agent-load-alist group)
1205         ;; Remove articles marked as downloaded.
1206         (if fetch-all
1207             ;; I want to fetch all headers in the active range.
1208             ;; Therefore, exclude only those headers that are in the article alist.
1209             ;; NOTE: This is probably NOT what I want to do after agent expiration in this group.
1210             (setq articles (gnus-agent-uncached-articles articles group))
1211
1212           ;; I want to only fetch those headers that have never been fetched.
1213           ;; Therefore, exclude all headers that are, or WERE, in the article alist.
1214           (let ((low (1+ (caar (last gnus-agent-article-alist))))
1215                 (high (cdr (gnus-active group))))
1216             ;; Low can be greater than High when the same group is fetched twice
1217             ;; in the same session {The first fetch will fill the article alist
1218             ;; such that (last gnus-agent-article-alist) equals (cdr (gnus-active group))}.
1219             ;; The addition of one(the 1+ above) then forces Low to be greater than High.
1220             ;; When this happens, gnus-list-range-intersection returns nil which indicates
1221             ;; that no headers need to be fetched. -- Kevin
1222             (setq articles (gnus-list-range-intersection
1223                             articles (list (cons low high)))))))
1224       (save-excursion
1225         (set-buffer nntp-server-buffer)
1226
1227         (if articles
1228             (progn
1229               (gnus-message 7 "Fetching headers for %s..." group)
1230
1231               ;; Fetch them.
1232               (gnus-make-directory (nnheader-translate-file-chars
1233                                     (file-name-directory file) t))
1234
1235               (unless (eq 'nov (gnus-retrieve-headers articles group))
1236                 (nnvirtual-convert-headers))
1237               (gnus-agent-check-overview-buffer)
1238               ;; Move these headers to the overview buffer so that gnus-agent-braid-nov can merge them
1239               ;; with the contents of FILE.
1240               (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
1241               (when (file-exists-p file)
1242                 (gnus-agent-braid-nov group articles file))
1243               (let ((coding-system-for-write
1244                      gnus-agent-file-coding-system))
1245                 (gnus-agent-check-overview-buffer)
1246                 (write-region (point-min) (point-max) file nil 'silent))
1247               (gnus-agent-save-alist group articles nil)
1248               articles)
1249           (ignore-errors
1250             (erase-buffer)
1251             (nnheader-insert-file-contents file))))
1252       )
1253     articles))
1254
1255 (defsubst gnus-agent-copy-nov-line (article)
1256   (let (art b e)
1257     (set-buffer gnus-agent-overview-buffer)
1258     (while (and (not (eobp))
1259                 (< (setq art (read (current-buffer))) article))
1260       (forward-line 1))
1261     (beginning-of-line)
1262     (if (or (eobp)
1263             (not (eq article art)))
1264         (set-buffer nntp-server-buffer)
1265       (setq b (point))
1266       (setq e (progn (forward-line 1) (point)))
1267       (set-buffer nntp-server-buffer)
1268       (insert-buffer-substring gnus-agent-overview-buffer b e))))
1269
1270 (defun gnus-agent-braid-nov (group articles file)
1271   "Merges the article headers identified by ARTICLES from gnus-agent-overview-buffer with the contents
1272 of FILE placing the combined headers in nntp-server-buffer."
1273   (let (start last)
1274     (set-buffer gnus-agent-overview-buffer)
1275     (goto-char (point-min))
1276     (set-buffer nntp-server-buffer)
1277     (erase-buffer)
1278     (nnheader-insert-file-contents file)
1279     (goto-char (point-max))
1280     (forward-line -1)
1281     (unless (looking-at "[0-9]+\t")
1282       ;; Remove corrupted lines
1283       (gnus-message 1 "Overview %s is corrupted. Removing corrupted lines..." file)
1284       (goto-char (point-min))
1285       (while (not (eobp))
1286         (if (looking-at "[0-9]+\t")
1287             (forward-line 1)
1288           (delete-region (point) (progn (forward-line 1) (point)))))
1289       (forward-line -1))
1290     (unless (or (= (point-min) (point-max))
1291                 (< (setq last (read (current-buffer))) (car articles)))
1292       ;; We do it the hard way.
1293       (when (nnheader-find-nov-line (car articles))
1294         ;; Replacing existing NOV entry
1295         (delete-region (point) (progn (forward-line 1) (point))))
1296       (gnus-agent-copy-nov-line (pop articles))
1297
1298       (ignore-errors
1299         (while articles
1300           (while (let ((art (read (current-buffer))))
1301                    (cond ((< art (car articles))
1302                           (forward-line 1)
1303                           t)
1304                          ((= art (car articles))
1305                           (beginning-of-line)
1306                           (delete-region (point) (progn (forward-line 1) (point)))
1307                           nil)
1308                          (t
1309                           (beginning-of-line)
1310                           nil))))
1311
1312           (gnus-agent-copy-nov-line (pop articles)))))
1313
1314     ;; Copy the rest lines
1315     (set-buffer nntp-server-buffer)
1316     (goto-char (point-max))
1317     (when articles
1318       (when last
1319         (set-buffer gnus-agent-overview-buffer)
1320         (ignore-errors
1321           (while (<= (read (current-buffer)) last)
1322             (forward-line 1)))
1323         (beginning-of-line)
1324         (setq start (point))
1325         (set-buffer nntp-server-buffer))
1326       (insert-buffer-substring gnus-agent-overview-buffer start))))
1327
1328 (eval-when-compile ; Keeps the compiler from warning about the free variable in gnus-agent-read-agentview
1329   (defvar gnus-agent-read-agentview))
1330
1331 (defun gnus-agent-load-alist (group)
1332   (let ((gnus-agent-read-agentview group)) ; Binds free variable that's used in gnus-agent-read-agentview
1333     "Load the article-state alist for GROUP."
1334     (setq gnus-agent-article-alist
1335           (gnus-cache-file-contents
1336            (gnus-agent-article-name ".agentview" group)
1337            'gnus-agent-file-loading-cache
1338            'gnus-agent-read-agentview))))
1339
1340 ;; 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.
1341 (defconst gnus-agent-article-alist-save-format 2)
1342
1343 (defun gnus-agent-read-agentview (file)
1344   "Load FILE and do a `read' there."
1345   (with-temp-buffer
1346     (ignore-errors
1347       (nnheader-insert-file-contents file)
1348       (goto-char (point-min))
1349       (let ((alist (read (current-buffer)))
1350             (version (condition-case nil (read (current-buffer))
1351                        (end-of-file 0)))
1352             changed-version)
1353
1354         (cond ((= version 0)
1355                (let ((inhibit-quit t)
1356                      entry)
1357                  (gnus-agent-open-history)
1358                  (set-buffer (gnus-agent-history-buffer))
1359                  (goto-char (point-min))
1360                  (while (not (eobp))
1361                    (if (and (looking-at
1362                              "[^\t\n]+\t\\([0-9]+\\)\t\\([^ \n]+\\) \\([0-9]+\\)")
1363                             (string= (match-string 2)
1364                                      gnus-agent-read-agentview)
1365                             (setq entry (assoc (string-to-number (match-string 3)) alist)))
1366                        (setcdr entry (string-to-number (match-string 1))))
1367                    (forward-line 1))
1368                  (gnus-agent-close-history)
1369                  (setq changed-version t)))
1370               ((= version 1)
1371                (setq changed-version (not (= 1 gnus-agent-article-alist-save-format))))
1372               ((= version 2)
1373                (let (uncomp)
1374                  (mapcar (lambda (comp-list)
1375                            (let ((state (car comp-list))
1376                                  (sequence (gnus-uncompress-sequence (cdr comp-list))))
1377                              (mapcar (lambda (article-id)
1378                                        (setq uncomp (cons (cons article-id state) uncomp))) sequence))) alist)
1379                  (setq alist (sort uncomp (lambda (first second) (< (car first) (car second)))))
1380                  )
1381                ))
1382         (when changed-version
1383           (let ((gnus-agent-article-alist alist))
1384             (gnus-agent-save-alist gnus-agent-read-agentview)))
1385         alist))))
1386
1387 (defun gnus-agent-save-alist (group &optional articles state dir)
1388   "Save the article-state alist for GROUP."
1389   (let* ((file-name-coding-system nnmail-pathname-coding-system)
1390          (prev (cons nil gnus-agent-article-alist))
1391          (all prev)
1392          print-level print-length item article)
1393     (while (setq article (pop articles))
1394       (while (and (cdr prev)
1395                   (< (caadr prev) article))
1396         (setq prev (cdr prev)))
1397       (cond
1398        ((not (cdr prev))
1399         (setcdr prev (list (cons article state))))
1400        ((> (caadr prev) article)
1401         (setcdr prev (cons (cons article state) (cdr prev))))
1402        ((= (caadr prev) article)
1403         (setcdr (cadr prev) state)))
1404       (setq prev (cdr prev)))
1405     (setq gnus-agent-article-alist (cdr all))
1406     (if dir
1407         (gnus-make-directory dir)
1408       (gnus-make-directory (gnus-agent-article-name "" group)))
1409     (with-temp-file (if dir
1410                         (expand-file-name ".agentview" dir)
1411                       (gnus-agent-article-name ".agentview" group))
1412       (cond ((eq gnus-agent-article-alist-save-format 1)
1413              (princ gnus-agent-article-alist (current-buffer)))
1414             ((eq gnus-agent-article-alist-save-format 2)
1415              (let ((compressed nil))
1416                (mapcar (lambda (pair)
1417                          (let* ((article-id (car pair))
1418                                 (day-of-download (cdr pair))
1419                                 (comp-list (assq day-of-download compressed)))
1420                            (if comp-list
1421                                (setcdr comp-list (cons article-id (cdr comp-list)))
1422                              (setq compressed (cons (list day-of-download article-id) compressed)))
1423                            nil)) gnus-agent-article-alist)
1424                (mapcar (lambda (comp-list) (setcdr comp-list (gnus-compress-sequence (nreverse (cdr comp-list))))) compressed)
1425                (princ compressed (current-buffer))
1426                )
1427              )
1428             )
1429       (insert "\n")
1430       (princ gnus-agent-article-alist-save-format (current-buffer))
1431       (insert "\n"))))
1432
1433 (defun gnus-agent-article-name (article group)
1434   (expand-file-name (if (stringp article) article (string-to-number article))
1435                     (file-name-as-directory
1436                      (expand-file-name (gnus-agent-group-path group)
1437                                        (gnus-agent-directory)))))
1438
1439 (defun gnus-agent-batch-confirmation (msg)
1440   "Show error message and return t."
1441   (gnus-message 1 msg)
1442   t)
1443
1444 ;;;###autoload
1445 (defun gnus-agent-batch-fetch ()
1446   "Start Gnus and fetch session."
1447   (interactive)
1448   (gnus)
1449   (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
1450     (gnus-agent-fetch-session))
1451   (gnus-group-exit))
1452
1453 (defun gnus-agent-fetch-session ()
1454   "Fetch all articles and headers that are eligible for fetching."
1455   (interactive)
1456   (unless gnus-agent-covered-methods
1457     (error "No servers are covered by the Gnus agent"))
1458   (unless gnus-plugged
1459     (error "Can't fetch articles while Gnus is unplugged"))
1460   (let ((methods gnus-agent-covered-methods)
1461         groups group gnus-command-method)
1462     (save-excursion
1463       (while methods
1464         (condition-case err
1465             (progn
1466               (setq gnus-command-method (car methods))
1467               (when (and (or (gnus-server-opened gnus-command-method)
1468                              (gnus-open-server gnus-command-method))
1469                          (gnus-online gnus-command-method))
1470                 (setq groups (gnus-groups-from-server (car methods)))
1471                 (gnus-agent-with-fetch
1472                   (while (setq group (pop groups))
1473                     (when (<= (gnus-group-level group) gnus-agent-handle-level)
1474                       (gnus-agent-fetch-group-1 group gnus-command-method))))))
1475           (error
1476            (unless (funcall gnus-agent-confirmation-function
1477                             (format "Error %s.  Continue? " (cdr err)))
1478              (error "Cannot fetch articles into the Gnus agent")))
1479           (quit
1480            (unless (funcall gnus-agent-confirmation-function
1481                             (format "Quit fetching session %s.  Continue? "
1482                                     (cdr err)))
1483              (signal 'quit "Cannot fetch articles into the Gnus agent"))))
1484         (pop methods))
1485       (run-hooks 'gnus-agent-fetch-hook)
1486       (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
1487
1488 (defun gnus-agent-fetch-group-1 (group method)
1489   "Fetch GROUP."
1490   (let ((gnus-command-method method)
1491         (gnus-newsgroup-name group)
1492         (gnus-newsgroup-dependencies gnus-newsgroup-dependencies)
1493         (gnus-newsgroup-headers gnus-newsgroup-headers)
1494         (gnus-newsgroup-scored gnus-newsgroup-scored)
1495         (gnus-use-cache gnus-use-cache)
1496         (gnus-summary-expunge-below gnus-summary-expunge-below)
1497         (gnus-summary-mark-below gnus-summary-mark-below)
1498         (gnus-orphan-score gnus-orphan-score)
1499         ;; Maybe some other gnus-summary local variables should also
1500         ;; be put here.
1501
1502         gnus-headers
1503         gnus-score
1504         articles arts
1505         category predicate info marks score-param
1506         )
1507     (unless (gnus-check-group group)
1508       (error "Can't open server for %s" group))
1509
1510     ;; Fetch headers.
1511     (when (or gnus-newsgroup-active
1512               (gnus-active group)
1513               (gnus-activate-group group))
1514       (let ((marked-articles gnus-newsgroup-downloadable))
1515         ;; Identify the articles marked for download
1516         (unless gnus-newsgroup-active ;; This needs to be a
1517           ;; gnus-summary local variable
1518           ;; that is NOT bound to any
1519           ;; value above (It's global
1520           ;; value should default to nil).
1521           (dolist (mark gnus-agent-download-marks)
1522             (let ((arts (cdr (assq mark (gnus-info-marks
1523                                          (setq info (gnus-get-info group)))))))
1524               (when arts
1525                 (setq marked-articles (nconc (gnus-uncompress-range arts)
1526                                              marked-articles))
1527                 ))))
1528         (setq marked-articles (sort marked-articles '<))
1529
1530         ;; Fetch any new articles from the server
1531         (setq articles (gnus-agent-fetch-headers group))
1532
1533         ;; Merge new articles with marked
1534         (setq articles (sort (append marked-articles articles) '<))
1535
1536         (when articles
1537           ;; Parse them and see which articles we want to fetch.
1538           (setq gnus-newsgroup-dependencies
1539                 (or gnus-newsgroup-dependencies
1540                     (make-vector (length articles) 0)))
1541
1542           (setq gnus-newsgroup-headers
1543                 (or gnus-newsgroup-headers
1544                     (gnus-get-newsgroup-headers-xover articles nil nil
1545                                                       group)))
1546           ;; `gnus-agent-overview-buffer' may be killed for
1547           ;; timeout reason.  If so, recreate it.
1548           (gnus-agent-create-buffer)
1549
1550           ;; Figure out how to select articles in this group
1551           (setq category (gnus-group-category group))
1552
1553           (setq predicate
1554                 (gnus-get-predicate
1555                  (or (gnus-group-find-parameter group 'agent-predicate t)
1556                      (cadr category))))
1557
1558           ;; If the selection predicate requires scoring, score each header
1559           (unless (memq predicate '(gnus-agent-true gnus-agent-false))
1560             (let ((score-param
1561                    (or (gnus-group-get-parameter group 'agent-score t)
1562                        (caddr category))))
1563               ;; Translate score-param into real one
1564               (cond
1565                ((not score-param))
1566                ((eq score-param 'file)
1567                 (setq score-param (gnus-all-score-files group)))
1568                ((stringp (car score-param)))
1569                (t
1570                 (setq score-param (list (list score-param)))))
1571               (when score-param
1572                 (gnus-score-headers score-param))))
1573
1574           (unless (and (eq predicate 'gnus-agent-false)
1575                        (not marked-articles))
1576             (let* ((arts (list nil))
1577                    (arts-tail arts)
1578                    (alist (gnus-agent-load-alist group))
1579                    (chunk-size 0)
1580                    (marked-articles marked-articles)
1581                    fetched-articles)
1582               (while (setq gnus-headers (pop gnus-newsgroup-headers))
1583                 (let ((num (mail-header-number gnus-headers)))
1584                   ;; Determine if this article is already in the cache
1585                   (while (and alist
1586                               (> num (caar alist)))
1587                     (setq alist (cdr alist)))
1588
1589                   (unless (and (eq num (caar alist))
1590                                (cdar alist))
1591
1592                     ;; Determine if this article was marked for download.
1593                     (while (and marked-articles
1594                                 (> num (car marked-articles)))
1595                       (setq marked-articles
1596                             (cdr marked-articles)))
1597
1598                     ;; When this article is marked, or selected by the
1599                     ;; predicate, add it to the download list
1600                     (when (or (eq num (car marked-articles))
1601                               (let ((gnus-score
1602                                      (or (cdr (assq num gnus-newsgroup-scored))
1603                                          gnus-summary-default-score)))
1604                                 (funcall predicate)))
1605                       (gnus-agent-append-to-list arts-tail num)))))
1606
1607               ;; Fetch all selected articles
1608               (when (cdr arts)
1609                 (setq gnus-newsgroup-undownloaded
1610                       (gnus-sorted-ndifference gnus-newsgroup-undownloaded
1611                                                (setq fetched-articles (gnus-agent-fetch-articles group (cdr arts)))))
1612
1613                 (let ((unfetched-articles (gnus-sorted-ndifference (cdr arts) fetched-articles)))
1614                   (if gnus-newsgroup-active
1615                       (progn
1616                         (dolist (article (cdr arts))
1617                           (setq gnus-newsgroup-downloadable
1618                                 (delq article gnus-newsgroup-downloadable))
1619                           (when (gnus-summary-goto-subject article nil t)
1620                             (gnus-summary-update-download-mark article)))
1621                         (dolist (article fetched-articles)
1622                           (if gnus-agent-mark-unread-after-downloaded
1623                               (gnus-summary-mark-article article gnus-unread-mark)))
1624                         (dolist (article unfetched-articles)
1625                           (gnus-summary-mark-article article gnus-canceled-mark)))
1626                     ;; When some, or all, of the marked articles came
1627                     ;; from the download mark.  Remove that mark.  I
1628                     ;; didn't do this earlier as I only want to remove
1629                     ;; the marks after the fetch is completed.
1630
1631                     (dolist (mark gnus-agent-download-marks)
1632                       (when (eq mark 'download)
1633                         (let ((marked-arts (assq mark (gnus-info-marks
1634                                                        (setq info (gnus-get-info group))))))
1635                           (when (cdr marked-arts)
1636                             (setq marks (delq marked-arts (gnus-info-marks info)))
1637                             (gnus-info-set-marks info marks)))))
1638                     (let ((read (gnus-info-read (or info (setq info (gnus-get-info group))))))
1639                       (gnus-info-set-read info (gnus-add-to-range read unfetched-articles)))
1640
1641                     (gnus-group-update-group group t)
1642                     (sit-for 0)
1643
1644                     (gnus-dribble-enter
1645                      (concat "(gnus-group-set-info '"
1646                              (gnus-prin1-to-string info)
1647                              ")"))))))))))))
1648
1649 ;;;
1650 ;;; Agent Category Mode
1651 ;;;
1652
1653 (defvar gnus-category-mode-hook nil
1654   "Hook run in `gnus-category-mode' buffers.")
1655
1656 (defvar gnus-category-line-format "     %(%20c%): %g\n"
1657   "Format of category lines.
1658
1659 Valid specifiers include:
1660 %c  Topic name (string)
1661 %g  The number of groups in the topic (integer)
1662
1663 General format specifiers can also be used.  See Info node
1664 `(gnus)Formatting Variables'.")
1665
1666 (defvar gnus-category-mode-line-format "Gnus: %%b"
1667   "The format specification for the category mode line.")
1668
1669 (defvar gnus-agent-short-article 100
1670   "Articles that have fewer lines than this are short.")
1671
1672 (defvar gnus-agent-long-article 200
1673   "Articles that have more lines than this are long.")
1674
1675 (defvar gnus-agent-low-score 0
1676   "Articles that have a score lower than this have a low score.")
1677
1678 (defvar gnus-agent-high-score 0
1679   "Articles that have a score higher than this have a high score.")
1680
1681
1682 ;;; Internal variables.
1683
1684 (defvar gnus-category-buffer "*Agent Category*")
1685
1686 (defvar gnus-category-line-format-alist
1687   `((?c gnus-tmp-name ?s)
1688     (?g gnus-tmp-groups ?d)))
1689
1690 (defvar gnus-category-mode-line-format-alist
1691   `((?u user-defined ?s)))
1692
1693 (defvar gnus-category-line-format-spec nil)
1694 (defvar gnus-category-mode-line-format-spec nil)
1695
1696 (defvar gnus-category-mode-map nil)
1697 (put 'gnus-category-mode 'mode-class 'special)
1698
1699 (unless gnus-category-mode-map
1700   (setq gnus-category-mode-map (make-sparse-keymap))
1701   (suppress-keymap gnus-category-mode-map)
1702
1703   (gnus-define-keys gnus-category-mode-map
1704     "q" gnus-category-exit
1705     "k" gnus-category-kill
1706     "c" gnus-category-copy
1707     "a" gnus-category-add
1708     "p" gnus-category-edit-predicate
1709     "g" gnus-category-edit-groups
1710     "s" gnus-category-edit-score
1711     "l" gnus-category-list
1712
1713     "\C-c\C-i" gnus-info-find-node
1714     "\C-c\C-b" gnus-bug))
1715
1716 (defvar gnus-category-menu-hook nil
1717   "*Hook run after the creation of the menu.")
1718
1719 (defun gnus-category-make-menu-bar ()
1720   (gnus-turn-off-edit-menu 'category)
1721   (unless (boundp 'gnus-category-menu)
1722     (easy-menu-define
1723      gnus-category-menu gnus-category-mode-map ""
1724      '("Categories"
1725        ["Add" gnus-category-add t]
1726        ["Kill" gnus-category-kill t]
1727        ["Copy" gnus-category-copy t]
1728        ["Edit predicate" gnus-category-edit-predicate t]
1729        ["Edit score" gnus-category-edit-score t]
1730        ["Edit groups" gnus-category-edit-groups t]
1731        ["Exit" gnus-category-exit t]))
1732
1733     (gnus-run-hooks 'gnus-category-menu-hook)))
1734
1735 (defun gnus-category-mode ()
1736   "Major mode for listing and editing agent categories.
1737
1738 All normal editing commands are switched off.
1739 \\<gnus-category-mode-map>
1740 For more in-depth information on this mode, read the manual
1741 \(`\\[gnus-info-find-node]').
1742
1743 The following commands are available:
1744
1745 \\{gnus-category-mode-map}"
1746   (interactive)
1747   (when (gnus-visual-p 'category-menu 'menu)
1748     (gnus-category-make-menu-bar))
1749   (kill-all-local-variables)
1750   (gnus-simplify-mode-line)
1751   (setq major-mode 'gnus-category-mode)
1752   (setq mode-name "Category")
1753   (gnus-set-default-directory)
1754   (setq mode-line-process nil)
1755   (use-local-map gnus-category-mode-map)
1756   (buffer-disable-undo)
1757   (setq truncate-lines t)
1758   (setq buffer-read-only t)
1759   (gnus-run-hooks 'gnus-category-mode-hook))
1760
1761 (defalias 'gnus-category-position-point 'gnus-goto-colon)
1762
1763 (defun gnus-category-insert-line (category)
1764   (let* ((gnus-tmp-name (format "%s" (car category)))
1765          (gnus-tmp-groups (length (cadddr category))))
1766     (beginning-of-line)
1767     (gnus-add-text-properties
1768      (point)
1769      (prog1 (1+ (point))
1770        ;; Insert the text.
1771        (eval gnus-category-line-format-spec))
1772      (list 'gnus-category gnus-tmp-name))))
1773
1774 (defun gnus-enter-category-buffer ()
1775   "Go to the Category buffer."
1776   (interactive)
1777   (gnus-category-setup-buffer)
1778   (gnus-configure-windows 'category)
1779   (gnus-category-prepare))
1780
1781 (defun gnus-category-setup-buffer ()
1782   (unless (get-buffer gnus-category-buffer)
1783     (save-excursion
1784       (set-buffer (gnus-get-buffer-create gnus-category-buffer))
1785       (gnus-category-mode))))
1786
1787 (defun gnus-category-prepare ()
1788   (gnus-set-format 'category-mode)
1789   (gnus-set-format 'category t)
1790   (let ((alist gnus-category-alist)
1791         (buffer-read-only nil))
1792     (erase-buffer)
1793     (while alist
1794       (gnus-category-insert-line (pop alist)))
1795     (goto-char (point-min))
1796     (gnus-category-position-point)))
1797
1798 (defun gnus-category-name ()
1799   (or (intern (get-text-property (gnus-point-at-bol) 'gnus-category))
1800       (error "No category on the current line")))
1801
1802 (defun gnus-category-read ()
1803   "Read the category alist."
1804   (setq gnus-category-alist
1805         (or (gnus-agent-read-file
1806              (nnheader-concat gnus-agent-directory "lib/categories"))
1807             (list (list 'default 'short nil nil)))))
1808
1809 (defun gnus-category-write ()
1810   "Write the category alist."
1811   (setq gnus-category-predicate-cache nil
1812         gnus-category-group-cache nil)
1813   (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
1814   (with-temp-file (nnheader-concat gnus-agent-directory "lib/categories")
1815     (prin1 gnus-category-alist (current-buffer))))
1816
1817 (defun gnus-category-edit-predicate (category)
1818   "Edit the predicate for CATEGORY."
1819   (interactive (list (gnus-category-name)))
1820   (let ((info (assq category gnus-category-alist)))
1821     (gnus-edit-form
1822      (cadr info) (format "Editing the predicate for category %s" category)
1823      `(lambda (predicate)
1824         (setcar (cdr (assq ',category gnus-category-alist)) predicate)
1825         (gnus-category-write)
1826         (gnus-category-list)))))
1827
1828 (defun gnus-category-edit-score (category)
1829   "Edit the score expression for CATEGORY."
1830   (interactive (list (gnus-category-name)))
1831   (let ((info (assq category gnus-category-alist)))
1832     (gnus-edit-form
1833      (caddr info)
1834      (format "Editing the score expression for category %s" category)
1835      `(lambda (groups)
1836         (setcar (cddr (assq ',category gnus-category-alist)) groups)
1837         (gnus-category-write)
1838         (gnus-category-list)))))
1839
1840 (defun gnus-category-edit-groups (category)
1841   "Edit the group list for CATEGORY."
1842   (interactive (list (gnus-category-name)))
1843   (let ((info (assq category gnus-category-alist)))
1844     (gnus-edit-form
1845      (cadddr info) (format "Editing the group list for category %s" category)
1846      `(lambda (groups)
1847         (setcar (nthcdr 3 (assq ',category gnus-category-alist)) groups)
1848         (gnus-category-write)
1849         (gnus-category-list)))))
1850
1851 (defun gnus-category-kill (category)
1852   "Kill the current category."
1853   (interactive (list (gnus-category-name)))
1854   (let ((info (assq category gnus-category-alist))
1855         (buffer-read-only nil))
1856     (gnus-delete-line)
1857     (setq gnus-category-alist (delq info gnus-category-alist))
1858     (gnus-category-write)))
1859
1860 (defun gnus-category-copy (category to)
1861   "Copy the current category."
1862   (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
1863   (let ((info (assq category gnus-category-alist)))
1864     (push (list to (gnus-copy-sequence (cadr info))
1865                 (gnus-copy-sequence (caddr info)) nil)
1866           gnus-category-alist)
1867     (gnus-category-write)
1868     (gnus-category-list)))
1869
1870 (defun gnus-category-add (category)
1871   "Create a new category."
1872   (interactive "SCategory name: ")
1873   (when (assq category gnus-category-alist)
1874     (error "Category %s already exists" category))
1875   (push (list category 'false nil nil)
1876         gnus-category-alist)
1877   (gnus-category-write)
1878   (gnus-category-list))
1879
1880 (defun gnus-category-list ()
1881   "List all categories."
1882   (interactive)
1883   (gnus-category-prepare))
1884
1885 (defun gnus-category-exit ()
1886   "Return to the group buffer."
1887   (interactive)
1888   (kill-buffer (current-buffer))
1889   (gnus-configure-windows 'group t))
1890
1891 ;; To avoid having 8-bit characters in the source file.
1892 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
1893
1894 (defvar gnus-category-predicate-alist
1895   '((spam . gnus-agent-spam-p)
1896     (short . gnus-agent-short-p)
1897     (long . gnus-agent-long-p)
1898     (low . gnus-agent-low-scored-p)
1899     (high . gnus-agent-high-scored-p)
1900     (read . gnus-agent-read-p)
1901     (true . gnus-agent-true)
1902     (false . gnus-agent-false))
1903   "Mapping from short score predicate symbols to predicate functions.")
1904
1905 (defun gnus-agent-spam-p ()
1906   "Say whether an article is spam or not."
1907   (unless gnus-agent-spam-hashtb
1908     (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
1909   (if (not (equal (mail-header-references gnus-headers) ""))
1910       nil
1911     (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
1912       (prog1
1913           (gnus-gethash string gnus-agent-spam-hashtb)
1914         (gnus-sethash string t gnus-agent-spam-hashtb)))))
1915
1916 (defun gnus-agent-short-p ()
1917   "Say whether an article is short or not."
1918   (< (mail-header-lines gnus-headers) gnus-agent-short-article))
1919
1920 (defun gnus-agent-long-p ()
1921   "Say whether an article is long or not."
1922   (> (mail-header-lines gnus-headers) gnus-agent-long-article))
1923
1924 (defun gnus-agent-low-scored-p ()
1925   "Say whether an article has a low score or not."
1926   (< gnus-score gnus-agent-low-score))
1927
1928 (defun gnus-agent-high-scored-p ()
1929   "Say whether an article has a high score or not."
1930   (> gnus-score gnus-agent-high-score))
1931
1932 (defun gnus-agent-read-p ()
1933   "Say whether an article is read or not."
1934   (gnus-member-of-range (mail-header-number gnus-headers)
1935                         (gnus-info-read (gnus-get-info gnus-newsgroup-name))))
1936
1937 (defun gnus-category-make-function (cat)
1938   "Make a function from category CAT."
1939   (let ((func (gnus-category-make-function-1 cat)))
1940     (if (and (= (length func) 1)
1941              (symbolp (car func)))
1942         (car func)
1943       (gnus-byte-compile `(lambda () ,func)))))
1944
1945 (defun gnus-agent-true ()
1946   "Return t."
1947   t)
1948
1949 (defun gnus-agent-false ()
1950   "Return nil."
1951   nil)
1952
1953 (defun gnus-category-make-function-1 (cat)
1954   "Make a function from category CAT."
1955   (cond
1956    ;; Functions are just returned as is.
1957    ((or (symbolp cat)
1958         (gnus-functionp cat))
1959     `(,(or (cdr (assq cat gnus-category-predicate-alist))
1960            cat)))
1961    ;; More complex category.
1962    ((consp cat)
1963     `(,(cond
1964         ((memq (car cat) '(& and))
1965          'and)
1966         ((memq (car cat) '(| or))
1967          'or)
1968         ((memq (car cat) gnus-category-not)
1969          'not))
1970       ,@(mapcar 'gnus-category-make-function-1 (cdr cat))))
1971    (t
1972     (error "Unknown category type: %s" cat))))
1973
1974 (defun gnus-get-predicate (predicate)
1975   "Return the predicate for CATEGORY."
1976   (or (cdr (assoc predicate gnus-category-predicate-cache))
1977       (let ((func (gnus-category-make-function predicate)))
1978         (setq gnus-category-predicate-cache
1979               (nconc gnus-category-predicate-cache
1980                      (list (cons predicate func))))
1981         func)))
1982
1983 (defun gnus-predicate-implies-unread (predicate)
1984   "Say whether PREDICATE implies unread articles only.
1985 It is okay to miss some cases, but there must be no false positives.
1986 That is, if this function returns true, then indeed the predicate must
1987 return only unread articles."
1988   ;; Todo: make this work in more cases.
1989   (equal predicate '(not read)))
1990
1991 (defun gnus-group-category (group)
1992   "Return the category GROUP belongs to."
1993   (unless gnus-category-group-cache
1994     (setq gnus-category-group-cache (gnus-make-hashtable 1000))
1995     (let ((cs gnus-category-alist)
1996           groups cat)
1997       (while (setq cat (pop cs))
1998         (setq groups (cadddr cat))
1999         (while groups
2000           (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
2001   (or (gnus-gethash group gnus-category-group-cache)
2002       (assq 'default gnus-category-alist)))
2003
2004 (defun gnus-agent-expire (&optional articles group force)
2005   "Expire all old articles.
2006 If you want to force expiring of certain articles, this function can
2007 take ARTICLES, GROUP and FORCE parameters as well.
2008
2009 The articles on which the expiration process runs are selected as follows:
2010   if ARTICLES is null, all read and unmarked articles.
2011   if ARTICLES is t, all articles.
2012   if ARTICLES is a list, just those articles.
2013 Setting GROUP will limit expiration to that group.
2014 FORCE is equivalent to setting gnus-agent-expire-days to zero(0)."
2015   (interactive)
2016
2017   (if (or (not (eq articles t))
2018           (yes-or-no-p (concat "Are you sure that you want to expire all articles in " (if group group "every agentized group") ".")))
2019       (let ((methods (if group
2020                          (list (gnus-find-method-for-group group))
2021                        gnus-agent-covered-methods))
2022             (day (if (numberp gnus-agent-expire-days)
2023                      (- (time-to-days (current-time)) gnus-agent-expire-days)
2024                    nil))
2025             gnus-command-method sym arts pos
2026             history overview file histories elem art nov-file low info
2027             unreads marked article orig lowest highest found days)
2028         (save-excursion
2029           (setq overview (gnus-get-buffer-create " *expire overview*"))
2030           (unwind-protect
2031               (while (setq gnus-command-method (pop methods))
2032                 (when (file-exists-p (gnus-agent-lib-file "active"))
2033                   (with-temp-buffer
2034                     (nnheader-insert-file-contents (gnus-agent-lib-file "active"))
2035                     (gnus-active-to-gnus-format
2036                      gnus-command-method
2037                      (setq orig (gnus-make-hashtable
2038                                  (count-lines (point-min) (point-max))))))
2039                   (dolist (expiring-group (gnus-groups-from-server gnus-command-method))
2040                     (if (or (not group)
2041                             (equal group expiring-group))
2042                         (let* ((dir (concat
2043                                      (gnus-agent-directory)
2044                                      (gnus-agent-group-path expiring-group) "/"))
2045                                (active
2046                                 (gnus-gethash-safe expiring-group orig)))
2047                           (when active
2048                             (gnus-agent-load-alist expiring-group)
2049                             (gnus-message 5 "Expiring articles in %s" expiring-group)
2050                             (let* ((info (gnus-get-info expiring-group))
2051                                    (alist gnus-agent-article-alist)
2052                                    (specials (if alist
2053                                                  (list (caar (last alist)))))
2054                                    (unreads ;; Articles that are excluded from the expiration process
2055                                     (cond (gnus-agent-expire-all
2056                                            ;; All articles are marked read by global decree
2057                                            nil)
2058                                           ((eq articles t)
2059                                            ;; All articles are marked read by function parameter
2060                                            nil)
2061                                           ((not articles)
2062                                            ;; Unread articles are marked protected from expiration
2063                                            ;; Don't call gnus-list-of-unread-articles as it returns articles that have not been fetched into the agent.
2064                                            (ignore-errors (gnus-agent-unread-articles expiring-group)))
2065                                           (t
2066                                            ;; All articles EXCEPT those named by the caller are protected from expiration
2067                                            (gnus-sorted-difference (gnus-uncompress-range (cons (caar alist) (caar (last alist)))) (sort articles '<)))))
2068                                    (marked ;; More articles that are exluded from the expiration process
2069                                     (cond (gnus-agent-expire-all
2070                                            ;; All articles are unmarked by global decree
2071                                            nil)
2072                                           ((eq articles t)
2073                                            ;; All articles are unmarked by function parameter
2074                                            nil)
2075                                           (articles
2076                                            ;; All articles may as well be unmarked as the unreads list already names the articles we are going to keep
2077                                            nil)
2078                                           (t
2079                                            ;; Ticked and/or dormant articles are excluded from expiration
2080                                            (nconc
2081                                             (gnus-uncompress-range
2082                                              (cdr (assq 'tick (gnus-info-marks info))))
2083                                             (gnus-uncompress-range
2084                                              (cdr (assq 'dormant
2085                                                         (gnus-info-marks info))))))))
2086                                    (nov-file (concat dir ".overview"))
2087                                    (cnt 0)
2088                                    (completed -1)
2089                                    dlist
2090                                    type)
2091
2092                               ;; The normal article alist contains elements that look like (article# . fetch_date)
2093                               ;; I need to combine other information with this list.  For example, a flag indicating that a particular article MUST BE KEPT.
2094                               ;; To do this, I'm going to transform the elements to look like (article# fetch_date keep_flag NOV_entry_marker)
2095                               ;; Later, I'll reverse the process to generate the expired article alist.
2096
2097                               ;; Convert the alist elements to (article# fetch_date nil nil).
2098                               (setq dlist (mapcar (lambda (e) (list (car e) (cdr e) nil nil)) alist))
2099
2100                               ;; Convert the keep lists to elements that look like (article# nil keep_flag nil) then append it to the expanded dlist
2101                               ;; These statements are sorted by ascending precidence of the keep_flag.
2102                               (setq dlist (nconc dlist
2103                                                  (mapcar (lambda (e) (list e nil 'unread  nil)) unreads)))
2104                               (setq dlist (nconc dlist
2105                                                  (mapcar (lambda (e) (list e nil 'marked  nil)) marked)))
2106                               (setq dlist (nconc dlist
2107                                                  (mapcar (lambda (e) (list e nil 'special nil)) specials)))
2108
2109                               (set-buffer overview)
2110                               (erase-buffer)
2111                               (when (file-exists-p nov-file)
2112                                 (gnus-message 7 "gnus-agent-expire: Loading overview...")
2113                                 (nnheader-insert-file-contents nov-file)
2114                                 (goto-char (point-min))
2115
2116                                 (let (p)
2117                                   (while (< (setq p (point)) (point-max))
2118                                     (condition-case nil
2119                                         ;; If I successfully read an integer (the plus zero ensures a numeric type), prepend a marker entry to the list
2120                                         (push (list (+ 0 (read (current-buffer))) nil nil (set-marker (make-marker) p)) dlist)
2121                                       (error
2122                                        (gnus-message 1 "gnus-agent-expire: read error occurred when reading expression at %s in %s.  Skipping to next line." (point) nov-file)))
2123                                     ;; Whether I succeeded, or failed, it doesn't matter.  Move to the next line then try again.
2124                                     (forward-line 1)))
2125                                 (gnus-message 7 "gnus-agent-expire: Loading overview... Done"))
2126                               (set-buffer-modified-p nil)
2127
2128                               ;; 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!!
2129                               (gnus-message 7 "gnus-agent-expire: Sorting entries... ")
2130                               (let ((special 0) ; If two entries have the same article-number then sort by ascending keep_flag.
2131                                     (marked 1)
2132                                     (unread 2))
2133                                 (setq dlist
2134                                       (sort dlist
2135                                             (lambda (a b)
2136                                               (cond ((< (nth 0 a) (nth 0 b))
2137                                                      t)
2138                                                     ((> (nth 0 a) (nth 0 b))
2139                                                      nil)
2140                                                     (t
2141                                                      (let ((a (or (symbol-value (nth 2 a)) 3))
2142                                                            (b (or (symbol-value (nth 2 b)) 3)))
2143                                                        (<= a b))))))))
2144                               (gnus-message 7 "gnus-agent-expire: Sorting entries... Done")
2145                               (gnus-message 7 "gnus-agent-expire: Merging entries... ")
2146                               (let ((dlist dlist))
2147                                 (while (cdr dlist) ; I'm not at the end-of-list
2148                                   (if (eq (caar dlist) (caadr dlist))
2149                                       (let ((first (cdr (car dlist)))
2150                                             (secnd (cdr (cadr dlist))))
2151                                         (setcar first (or (car first) (car secnd))) ; fetch_date
2152                                         (setq first (cdr first)
2153                                               secnd (cdr secnd))
2154                                         (setcar first (or (car first) (car secnd))) ; Keep_flag
2155                                         (setq first (cdr first)
2156                                               secnd (cdr secnd))
2157                                         (setcar first (or (car first) (car secnd))) ; NOV_entry_marker
2158
2159                                         (setcdr dlist (cddr dlist)))
2160                                     (setq dlist (cdr dlist)))))
2161                               (gnus-message 7 "gnus-agent-expire: Merging entries... Done")
2162
2163                               (let* ((len (float (length dlist)))
2164                                      (alist (list nil))
2165                                      (tail-alist alist))
2166                                 (while dlist
2167                                   (let ((new-completed (* 100.0 (/ (setq cnt (1+ cnt)) len))))
2168                                     (when (> new-completed completed)
2169                                       (setq completed new-completed)
2170                                       (gnus-message 9 "%3d%% completed..."  completed)))
2171                                   (let* ((entry (car dlist))
2172                                          (article-number (nth 0 entry))
2173                                          (fetch-date (nth 1 entry))
2174                                          (keep (nth 2 entry))
2175                                          (marker (nth 3 entry)))
2176
2177                                     (cond
2178                                      ;; Kept articles are unread, marked, or special.
2179                                      (keep
2180                                       (when fetch-date
2181                                         (unless (file-exists-p (concat dir (number-to-string article-number)))
2182                                           (setf (nth 1 entry) nil)
2183                                           (gnus-message 3 "gnus-agent-expire cleared download flag on article %d as the cached article file is missing." (caar dlist)))
2184                                         (unless marker
2185                                           (gnus-message 1 "gnus-agent-expire detected a missing NOV entry.  Run gnus-agent-regenerate-group to restore it.")))
2186                                       (gnus-agent-append-to-list tail-alist (cons article-number fetch-date)))
2187
2188                                      ;; The following articles are READ, UNMARKED, and ORDINARY.
2189                                      ;; See if they can be EXPIRED!!!
2190                                      ((setq type
2191                                             (cond
2192                                              ((not (integerp fetch-date))
2193                                               'read) ;; never fetched article (may expire right now)
2194                                              ((not (file-exists-p (concat dir (number-to-string article-number))))
2195                                               (setf (nth 1 entry) nil)
2196                                               'externally-expired) ;; Can't find the cached article.  Handle case as though this article was never fetched.
2197
2198                                              ;; We now have the arrival day, so we see
2199                                              ;; whether it's old enough to be expired.
2200                                              ((< fetch-date
2201                                                  (if (numberp day)
2202                                                      day
2203                                                    (let (found
2204                                                          (days gnus-agent-expire-days))
2205                                                      (while (and (not found)
2206                                                                  days)
2207                                                        (when (eq 0 (string-match (caar days) expiring-group))
2208                                                          (setq found (cadar days)))
2209                                                        (pop days))
2210                                                      found)))
2211                                               'expired)
2212                                              (force
2213                                               'forced)))
2214
2215                                       ;; I found some reason to expire this entry.
2216
2217                                       (let ((actions nil))
2218                                         (when (memq type '(forced expired))
2219                                           (ignore-errors ; Just being paranoid.
2220                                             (delete-file (concat dir (number-to-string article-number)))
2221                                             (push "expired cached article" actions))
2222                                           (setf (nth 1 entry) nil)
2223                                           )
2224
2225                                         (when marker
2226                                           (push "NOV entry removed" article)
2227                                           (goto-char marker)
2228                                           (gnus-delete-line))
2229
2230                                         ;; If considering all articles is set, I can only expire article IDs that are no longer in the active range.
2231                                         (if (and gnus-agent-consider-all-articles
2232                                                  (>= article-number (car active)))
2233                                             ;; I have to keep this ID in the alist
2234                                             (gnus-agent-append-to-list tail-alist (cons article-number fetch-date))
2235                                           (push (format "Removed %s article number from article alist" type) actions))
2236
2237                                         (gnus-message 7 "gnus-agent-expire: Article %d: %s" article-number (mapconcat 'identity actions ", "))))
2238                                      )
2239
2240                                     ;; Clean up markers as I want to recycle this buffer over several groups.
2241                                     (when marker
2242                                       (set-marker marker nil))
2243
2244                                     (setq dlist (cdr dlist))))
2245
2246                                 (setq alist (cdr alist))
2247
2248                                 (let ((inhibit-quit t))
2249                                   (unless (equal alist gnus-agent-article-alist)
2250                                     (setq gnus-agent-article-alist alist)
2251                                     (gnus-agent-save-alist expiring-group))
2252
2253                                   (when (buffer-modified-p)
2254                                     (let ((coding-system-for-write
2255                                            gnus-agent-file-coding-system))
2256                                       (gnus-make-directory dir)
2257                                       (write-region (point-min) (point-max) nov-file nil 'silent)
2258                                       ;; clear the modified flag as that I'm not confused by its status on the next pass through this routine.
2259                                       (set-buffer-modified-p nil)))
2260
2261                                   (when (eq articles t)
2262                                     (gnus-summary-update-info)))))))))))
2263             (kill-buffer overview)))))
2264   (gnus-message 4 "Expiry...done"))
2265
2266 ;;;###autoload
2267 (defun gnus-agent-batch ()
2268   "Start Gnus, send queue and fetch session."
2269   (interactive)
2270   (let ((init-file-user "")
2271         (gnus-always-read-dribble-file t))
2272     (gnus))
2273   (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
2274     (gnus-group-send-queue)
2275     (gnus-agent-fetch-session)))
2276
2277 (defun gnus-agent-unread-articles (group)
2278   (let* ((read (gnus-info-read (gnus-get-info group)))
2279          (known (gnus-agent-load-alist group))
2280          (unread (list nil))
2281          (tail-unread unread))
2282     (while (and known read)
2283       (let ((candidate (car (pop known))))
2284         (while (let* ((range (car read))
2285                       (min   (if (numberp range) range (car range)))
2286                       (max   (if (numberp range) range (cdr range))))
2287                  (cond ((or (not min)
2288                             (< candidate min))
2289                         (gnus-agent-append-to-list tail-unread candidate)
2290                         nil)
2291                        ((> candidate max)
2292                         (pop read)))))))
2293     (while known
2294       (gnus-agent-append-to-list tail-unread (car (pop known))))
2295     (cdr unread)))
2296
2297 (defun gnus-agent-uncached-articles (articles group &optional cached-header)
2298   "Constructs sublist of ARTICLES that excludes those articles ids in GROUP that have already been fetched.
2299  If CACHED-HEADER is nil, articles are only excluded if the article itself has been fetched."
2300
2301 ;; Logically equivalent to: (gnus-sorted-difference articles (mapcar 'car gnus-agent-article-alist))
2302 ;; Functionally, I don't need to construct a temp list using mapcar.
2303
2304   (if (gnus-agent-load-alist group)
2305     (let* ((ref gnus-agent-article-alist)
2306            (arts articles)
2307            (uncached (list nil))
2308            (tail-uncached uncached))
2309       (while (and ref arts)
2310         (let ((v1 (car arts))
2311               (v2 (caar ref)))
2312           (cond ((< v1 v2) ; the article (v1) does not appear in the reference list
2313                  (gnus-agent-append-to-list tail-uncached v1)
2314                  (pop arts))
2315                 ((= v1 v2)
2316                  (unless (or cached-header (cdar ref)) ; the article (v1) is already cached
2317                    (gnus-agent-append-to-list tail-uncached v1))
2318                  (pop arts)
2319                  (pop ref))
2320                 (t ; the reference article (v2) preceeds the list being filtered
2321                  (pop ref)))))
2322       (while arts
2323         (gnus-agent-append-to-list tail-uncached (pop arts)))
2324       (cdr uncached))
2325     ;; if gnus-agent-load-alist fails, no articles are cached.
2326     articles))
2327
2328 (defun gnus-agent-retrieve-headers (articles group &optional fetch-old)
2329   (save-excursion
2330     (gnus-agent-create-buffer)
2331     (let ((gnus-decode-encoded-word-function 'identity)
2332           (file (gnus-agent-article-name ".overview" group))
2333           cached-articles uncached-articles)
2334       (gnus-make-directory (nnheader-translate-file-chars
2335                             (file-name-directory file) t))
2336
2337       ;; Populate temp buffer with known headers
2338       (when (file-exists-p file)
2339         (with-current-buffer gnus-agent-overview-buffer
2340           (erase-buffer)
2341           (let ((nnheader-file-coding-system
2342                  gnus-agent-file-coding-system))
2343             (nnheader-insert-nov-file file (car articles)))))
2344
2345       (if (setq uncached-articles (gnus-agent-uncached-articles articles group t))
2346           (progn
2347             ;; Populate nntp-server-buffer with uncached headers
2348             (set-buffer nntp-server-buffer)
2349             (erase-buffer)
2350             (let (gnus-agent-cache)     ; Turn off agent cache
2351               (cond ((not (eq 'nov (gnus-retrieve-headers
2352                                     uncached-articles group fetch-old)))
2353                      (nnvirtual-convert-headers))
2354                     ((eq 'nntp (car gnus-current-select-method))
2355                      ;; The author of gnus-get-newsgroup-headers-xover reports that the XOVER command
2356                      ;; is commonly unreliable. The problem is that recently posted articles may not
2357                      ;; be entered into the NOV database in time to respond to my XOVER query.
2358                      ;;
2359                      ;; I'm going to use his assumption that the NOV database is updated in order
2360                      ;; of ascending article ID.  Therefore, a response containing article ID N
2361                      ;; implies that all articles from 1 to N-1 are up-to-date.  Therefore,
2362                      ;; missing articles in that range have expired.
2363
2364                      (set-buffer nntp-server-buffer)
2365                      (let* ((fetched-articles (list nil))
2366                             (tail-fetched-articles fetched-articles)
2367                             (min (cond ((numberp fetch-old)
2368                                         (max 1 (- (car articles) fetch-old)))
2369                                        (fetch-old
2370                                         1)
2371                                        (t
2372                                         (car articles))))
2373                             (max (car (last articles))))
2374
2375                        ;; Get the list of articles that were fetched
2376                        (goto-char (point-min))
2377                        (ignore-errors
2378                          (while t
2379                            (gnus-agent-append-to-list tail-fetched-articles (read (current-buffer)))
2380                            (forward-line 1)))
2381
2382                        ;; Clip this list to the headers that will actually be returned
2383                        (setq fetched-articles (gnus-list-range-intersection
2384                                                (cdr fetched-articles)
2385                                                (cons min max)))
2386
2387                        ;; Clip the uncached articles list to exclude IDs after the last FETCHED header.
2388                        ;; The excluded IDs may be fetchable using HEAD.
2389                        (if (car tail-fetched-articles)
2390                            (setq uncached-articles (gnus-list-range-intersection
2391                                                     uncached-articles
2392                                                     (cons (car uncached-articles) (car tail-fetched-articles)))))
2393
2394                        ;; Create the list of articles that were "successfully" fetched.  Success, in
2395                        ;; this case, means that the ID should not be fetched again.  In the case of
2396                        ;; an expired article, the header will not be fetched.
2397                        (setq uncached-articles (gnus-sorted-nunion fetched-articles uncached-articles))
2398                        ))))
2399
2400             ;; Erase the temp buffer
2401             (set-buffer gnus-agent-overview-buffer)
2402             (erase-buffer)
2403
2404             ;; Copy the nntp-server-buffer to the temp buffer
2405             (set-buffer nntp-server-buffer)
2406             (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
2407
2408             ;; Merge the temp buffer with the known headers (found on disk in FILE) into the nntp-server-buffer
2409             (when (and uncached-articles (file-exists-p file))
2410               (gnus-agent-braid-nov group uncached-articles file))
2411
2412             ;; Save the new set of known headers to FILE
2413             (set-buffer nntp-server-buffer)
2414             (let ((coding-system-for-write
2415                    gnus-agent-file-coding-system))
2416               (gnus-agent-check-overview-buffer)
2417               (write-region (point-min) (point-max) file nil 'silent))
2418
2419             ;; Update the group's article alist to include the newly fetched articles.
2420             (gnus-agent-load-alist group)
2421             (gnus-agent-save-alist group uncached-articles nil)
2422             )
2423
2424         ;; Copy the temp buffer to the nntp-server-buffer
2425         (set-buffer nntp-server-buffer)
2426         (erase-buffer)
2427         (insert-buffer-substring gnus-agent-overview-buffer)))
2428
2429     (if (and fetch-old
2430              (not (numberp fetch-old)))
2431         t                               ; Don't remove anything.
2432       (nnheader-nov-delete-outside-range
2433        (if fetch-old (max 1 (- (car articles) fetch-old))
2434          (car articles))
2435        (car (last articles)))
2436       t)
2437
2438     'nov))
2439
2440 (defun gnus-agent-request-article (article group)
2441   "Retrieve ARTICLE in GROUP from the agent cache."
2442   (let* ((gnus-command-method (gnus-find-method-for-group group))
2443          (file (concat
2444                   (gnus-agent-directory)
2445                   (gnus-agent-group-path group) "/"
2446                   (number-to-string article)))
2447          (buffer-read-only nil))
2448     (when (and (file-exists-p file)
2449                (> (nth 7 (file-attributes file)) 0))
2450       (erase-buffer)
2451       (gnus-kill-all-overlays)
2452       (let ((coding-system-for-read gnus-cache-coding-system))
2453         (insert-file-contents file))
2454       t)))
2455
2456 (defun gnus-agent-regenerate-group (group &optional reread)
2457   "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."
2458   (gnus-message 5 "Regenerating in %s" group)
2459   (let* ((gnus-command-method (or gnus-command-method
2460                                   (gnus-find-method-for-group group)))
2461          (file (gnus-agent-article-name ".overview" group))
2462          (dir (file-name-directory file))
2463          point
2464          (downloaded (if (file-exists-p dir)
2465                          (sort (mapcar (lambda (name) (string-to-int name))
2466                                        (directory-files dir nil "^[0-9]+$" t))
2467                                '>)
2468                        (progn (gnus-make-directory dir) nil)))
2469          dl nov-arts
2470          alist header
2471          regenerated)
2472
2473     (mm-with-unibyte-buffer
2474      (if (file-exists-p file)
2475          (let ((nnheader-file-coding-system
2476                 gnus-agent-file-coding-system))
2477            (nnheader-insert-file-contents file)))
2478      (set-buffer-modified-p nil)
2479
2480      ;; Load the article IDs found in the overview file.  As a side-effect, validate the file contents.
2481      (let ((load t))
2482        (while load
2483          (setq load nil)
2484          (goto-char (point-min))
2485          (while (< (point) (point-max))
2486            (cond ((looking-at "[0-9]+\t")
2487                   (push (read (current-buffer)) nov-arts)
2488                   (forward-line 1)
2489                   (let ((l1 (car nov-arts))
2490                         (l2 (cadr nov-arts)))
2491                     (cond ((not l2)
2492                            nil)
2493                           ((< l1 l2)
2494                            (gnus-message 3 "gnus-agent-regenerate-group: NOV entries are NOT in ascending order.")
2495                            ;; Don't sort now as I haven't verified that every line begins with a number
2496                            (setq load t))
2497                           ((= l1 l2)
2498                            (forward-line -1)
2499                            (gnus-message 4 "gnus-agent-regenerate-group: NOV entries contained duplicate of article %s.  Duplicate deleted." l1)
2500                            (gnus-delete-line)
2501                            (pop nov-arts)))))
2502                  (t
2503                   (gnus-message 1 "gnus-agent-regenerate-group: NOV entries contained line that did not begin with an article number.  Deleted line.")
2504                   (gnus-delete-line))))
2505          (if load
2506              (progn
2507                (gnus-message 5 "gnus-agent-regenerate-group: Sorting NOV entries into ascending order.")
2508                (sort-numeric-fields 1 (point-min) (point-max))
2509                     (setq nov-arts nil)))))
2510      (gnus-agent-check-overview-buffer)
2511
2512      ;; Construct a new article alist whose nodes match every header in the .overview file.
2513      ;; As a side-effect, missing headers are reconstructed from the downloaded article file.
2514      (while (or downloaded nov-arts)
2515        (cond ((and downloaded
2516                    (or (not nov-arts)
2517                        (> (car downloaded) (car nov-arts))))
2518               ;; This entry is missing from the overview file
2519               (gnus-message 3 "Regenerating NOV %s %d..." group (car downloaded))
2520               (let ((file (concat dir (number-to-string (car downloaded)))))
2521                 (mm-with-unibyte-buffer
2522                  (nnheader-insert-file-contents file)
2523                  (nnheader-remove-body)
2524                  (setq header (nnheader-parse-naked-head)))
2525                 (mail-header-set-number header (car downloaded))
2526                 (if nov-arts
2527                     (let ((key (concat "^" (int-to-string (car nov-arts)) "\t")))
2528                       (or (re-search-backward key nil t)
2529                           (re-search-forward key))
2530                       (forward-line 1))
2531                   (goto-char (point-min)))
2532                 (nnheader-insert-nov header))
2533               (setq nov-arts (cons (car downloaded) nov-arts)))
2534              ((eq (car downloaded) (car nov-arts))
2535               ;; This entry in the overview has been downloaded
2536               (push (cons (car downloaded) (time-to-days (nth 5 (file-attributes (concat dir (number-to-string (car downloaded))))))) alist)
2537               (pop downloaded)
2538               (pop nov-arts))
2539              (t
2540               ;; This entry in the overview has not been downloaded
2541               (push (cons (car nov-arts) nil) alist)
2542               (pop nov-arts))))
2543
2544      ;; When gnus-agent-consider-all-articles is set, gnus-agent-regenerate-group should NOT remove article IDs
2545      ;; from the alist.  Those IDs serve as markers to indicate that an attempt has been made to fetch that
2546      ;; article's header.
2547
2548      ;; When gnus-agent-consider-all-articles is NOT set, gnus-agent-regenerate-group can remove the article
2549      ;; ID of every article (with the exception of the last ID in the list - it's special) that no longer appears in the overview.
2550      ;; In this situtation, the last article ID in the list implies that it, and every article ID preceeding it,
2551      ;; have been fetched from the server.
2552      (if gnus-agent-consider-all-articles
2553          ;; Restore all article IDs that were not found in the overview file.
2554          (let* ((n (cons nil alist))
2555                 (merged n)
2556                 (o (gnus-agent-load-alist group)))
2557            (while o
2558              (let ((nID (caadr n))
2559                    (oID (caar o)))
2560                (cond ((not nID)
2561                       (setq n (setcdr n (list (list oID))))
2562                       (pop o))
2563                      ((< oID nID)
2564                       (setcdr n (cons (list oID) (cdr n)))
2565                       (pop o))
2566                      ((= oID nID)
2567                       (pop o)
2568                       (pop n))
2569                      (t
2570                       (pop n)))))
2571            (setq alist (cdr merged)))
2572        ;; Restore the last article ID if it is not already in the new alist
2573        (let ((n (last alist))
2574              (o (last (gnus-agent-load-alist group))))
2575          (cond ((not n)
2576                 (when o
2577                   (push (cons (caar o) nil) alist)))
2578                ((< (caar n) (caar o))
2579                 (setcdr n (list (car o)))))))
2580
2581      (let ((inhibit-quit t))
2582      (if (setq regenerated (buffer-modified-p))
2583          (let ((coding-system-for-write gnus-agent-file-coding-system))
2584            (write-region (point-min) (point-max) file nil 'silent)))
2585
2586     (setq regenerated (or regenerated
2587                           (and reread gnus-agent-article-alist)
2588                           (not (equal alist gnus-agent-article-alist)))
2589           )
2590
2591     (setq gnus-agent-article-alist alist)
2592
2593     (when regenerated
2594          (gnus-agent-save-alist group)))
2595      )
2596
2597     (when (and reread gnus-agent-article-alist)
2598       (gnus-make-ascending-articles-unread
2599        group
2600        (delq nil (mapcar (function (lambda (c)
2601                                      (cond ((eq reread t)
2602                                             (car c))
2603                                            ((cdr c)
2604                                             (car c)))))
2605                          gnus-agent-article-alist)))
2606
2607       (when (gnus-buffer-live-p gnus-group-buffer)
2608         (gnus-group-update-group group t)
2609         (sit-for 0))
2610       )
2611
2612     regenerated))
2613
2614 ;;;###autoload
2615 (defun gnus-agent-regenerate (&optional clean reread)
2616   "Regenerate all agent covered files.
2617 If CLEAN, don't read existing active files."
2618   (interactive "P")
2619   (let (regenerated)
2620     (gnus-message 4 "Regenerating Gnus agent files...")
2621     (dolist (gnus-command-method gnus-agent-covered-methods)
2622       (let ((active-file (gnus-agent-lib-file "active"))
2623             active-hashtb active-changed
2624             point)
2625         (gnus-make-directory (file-name-directory active-file))
2626         (if clean
2627             (setq active-hashtb (gnus-make-hashtable 1000))
2628           (mm-with-unibyte-buffer
2629            (if (file-exists-p active-file)
2630                (let ((nnheader-file-coding-system
2631                       gnus-agent-file-coding-system))
2632                  (nnheader-insert-file-contents active-file))
2633              (setq active-changed t))
2634            (gnus-active-to-gnus-format
2635             nil (setq active-hashtb
2636                       (gnus-make-hashtable
2637                        (count-lines (point-min) (point-max)))))))
2638         (dolist (group (gnus-groups-from-server gnus-command-method))
2639           (setq regenerated (or (gnus-agent-regenerate-group group reread)
2640                                 regenerated))
2641           (let ((min (or (caar gnus-agent-article-alist) 1))
2642                 (max (or (caar (last gnus-agent-article-alist)) 0))
2643                 (active (gnus-gethash-safe (gnus-group-real-name group)
2644                                            active-hashtb))
2645                 (read (gnus-info-read (gnus-get-info group))))
2646             (if (not active)
2647                 (progn
2648                   (setq active (cons min max)
2649                         active-changed t)
2650                   (gnus-sethash group active active-hashtb))
2651               (when (> (car active) min)
2652                 (setcar active min)
2653                 (setq active-changed t))
2654               (when (< (cdr active) max)
2655                 (setcdr active max)
2656                 (setq active-changed t)))))
2657         (when active-changed
2658           (setq regenerated t)
2659           (gnus-message 4 "Regenerate %s" active-file)
2660           (let ((nnmail-active-file-coding-system gnus-agent-file-coding-system))
2661             (gnus-write-active-file active-file active-hashtb)))))
2662     (gnus-message 4 "Regenerating Gnus agent files...done")
2663     regenerated))
2664
2665 (defun gnus-agent-go-online (&optional force)
2666   "Switch servers into online status."
2667   (interactive (list t))
2668   (dolist (server gnus-opened-servers)
2669     (when (eq (nth 1 server) 'offline)
2670       (if (if (eq force 'ask)
2671               (gnus-y-or-n-p
2672                (format "Switch %s:%s into online status? "
2673                        (caar server) (cadar server)))
2674             force)
2675           (setcar (nthcdr 1 server) 'close)))))
2676
2677 (defun gnus-agent-toggle-group-plugged (group)
2678   "Toggle the status of the server of the current group."
2679   (interactive (list (gnus-group-group-name)))
2680   (let* ((method (gnus-find-method-for-group group))
2681          (status (cadr (assoc method gnus-opened-servers))))
2682     (if (eq status 'offline)
2683         (gnus-server-set-status method 'closed)
2684       (gnus-close-server method)
2685       (gnus-server-set-status method 'offline))
2686     (message "Turn %s:%s from %s to %s." (car method) (cadr method)
2687              (if (eq status 'offline) 'offline 'online)
2688              (if (eq status 'offline) 'online 'offline))))
2689
2690 (defun gnus-agent-group-covered-p (group)
2691   (member (gnus-group-method group)
2692           gnus-agent-covered-methods))
2693
2694 (provide 'gnus-agent)
2695
2696 ;;; gnus-agent.el ends here