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

   1 ;;; gnus-agent.el --- unplugged support for Gnus
   2 ;; Copyright (C) 1997,98 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   5 ;; This file is part of GNU Emacs.
   6
   7 ;; GNU Emacs is free software; you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published by
   9 ;; the Free Software Foundation; either version 2, or (at your option)
  10 ;; any later version.
  11
  12 ;; GNU Emacs is distributed in the hope that it will be useful,
  13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ;; GNU General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 ;; Boston, MA 02111-1307, USA.
  21
  22 ;;; Commentary:
  23
  24 ;;; Code:
  25
  26 (require 'gnus)
  27 (require 'gnus-cache)
  28 (require 'nnvirtual)
  29 (require 'gnus-sum)
  30 (eval-when-compile (require 'cl))
  31
  32 (defcustom gnus-agent-directory (nnheader-concat gnus-directory "agent/")
  33   "Where the Gnus agent will store its files."
  34   :group 'gnus-agent
  35   :type 'directory)
  36
  37 (defcustom gnus-agent-plugged-hook nil
  38   "Hook run when plugging into the network."
  39   :group 'gnus-agent
  40   :type 'hook)
  41
  42 (defcustom gnus-agent-unplugged-hook nil
  43   "Hook run when unplugging from the network."
  44   :group 'gnus-agent
  45   :type 'hook)
  46
  47 (defcustom gnus-agent-handle-level gnus-level-subscribed
  48   "Groups on levels higher than this variable will be ignored by the Agent."
  49   :group 'gnus-agent
  50   :type 'integer)
  51
  52 (defcustom gnus-agent-expire-days 7
  53   "Read articles older than this will be expired."
  54   :group 'gnus-agent
  55   :type 'integer)
  56
  57 (defcustom gnus-agent-expire-all nil
  58   "If non-nil, also expire unread, ticked and dormant articles.
  59 If nil, only read articles will be expired."
  60   :group 'gnus-agent
  61   :type 'boolean)
  62
  63 (defcustom gnus-agent-group-mode-hook nil
  64   "Hook run in Agent group minor modes."
  65   :group 'gnus-agent
  66   :type 'hook)
  67
  68 (defcustom gnus-agent-summary-mode-hook nil
  69   "Hook run in Agent summary minor modes."
  70   :group 'gnus-agent
  71   :type 'hook)
  72
  73 (defcustom gnus-agent-server-mode-hook nil
  74   "Hook run in Agent summary minor modes."
  75   :group 'gnus-agent
  76   :type 'hook)
  77
  78 ;;; Internal variables
  79
  80 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
  81
  82 (defvar gnus-agent-history-buffers nil)
  83 (defvar gnus-agent-buffer-alist nil)
  84 (defvar gnus-agent-article-alist nil)
  85 (defvar gnus-agent-group-alist nil)
  86 (defvar gnus-agent-covered-methods nil)
  87 (defvar gnus-category-alist nil)
  88 (defvar gnus-agent-current-history nil)
  89 (defvar gnus-agent-overview-buffer nil)
  90 (defvar gnus-category-predicate-cache nil)
  91 (defvar gnus-category-group-cache nil)
  92 (defvar gnus-agent-spam-hashtb nil)
  93 (defvar gnus-agent-file-name nil)
  94 (defvar gnus-agent-send-mail-function nil)
  95 (defvar gnus-agent-article-file-coding-system 'no-conversion)
  96
  97 ;; Dynamic variables
  98 (defvar gnus-headers)
  99 (defvar gnus-score)
 100
 101 ;;;
 102 ;;; Setup
 103 ;;;
 104
 105 (defun gnus-open-agent ()
 106   (setq gnus-agent t)
 107   (gnus-agent-read-servers)
 108   (gnus-category-read)
 109   (setq gnus-agent-overview-buffer
 110         (gnus-get-buffer-create " *Gnus agent overview*"))
 111   (add-hook 'gnus-group-mode-hook 'gnus-agent-mode)
 112   (add-hook 'gnus-summary-mode-hook 'gnus-agent-mode)
 113   (add-hook 'gnus-server-mode-hook 'gnus-agent-mode))
 114
 115 (gnus-add-shutdown 'gnus-close-agent 'gnus)
 116
 117 (defun gnus-close-agent ()
 118   (setq gnus-agent-covered-methods nil
 119         gnus-category-predicate-cache nil
 120         gnus-category-group-cache nil
 121         gnus-agent-spam-hashtb nil)
 122   (gnus-kill-buffer gnus-agent-overview-buffer))
 123
 124 ;;;
 125 ;;; Utility functions
 126 ;;;
 127
 128 (defun gnus-agent-read-file (file)
 129   "Load FILE and do a `read' there."
 130   (nnheader-temp-write nil
 131     (ignore-errors
 132       (nnheader-insert-file-contents file)
 133       (goto-char (point-min))
 134       (read (current-buffer)))))
 135
 136 (defsubst gnus-agent-method ()
 137   (concat (symbol-name (car gnus-command-method)) "/"
 138           (if (equal (cadr gnus-command-method) "")
 139               "unnamed"
 140             (cadr gnus-command-method))))
 141
 142 (defsubst gnus-agent-directory ()
 143   "Path of the Gnus agent directory."
 144   (nnheader-concat gnus-agent-directory
 145                    (nnheader-translate-file-chars (gnus-agent-method)) "/"))
 146
 147 (defun gnus-agent-lib-file (file)
 148   "The full path of the Gnus agent library FILE."
 149   (concat (gnus-agent-directory) "agent.lib/" file))
 150
 151 ;;; Fetching setup functions.
 152
 153 (defun gnus-agent-start-fetch ()
 154   "Initialize data structures for efficient fetching."
 155   (gnus-agent-open-history)
 156   (setq gnus-agent-current-history (gnus-agent-history-buffer)))
 157
 158 (defun gnus-agent-stop-fetch ()
 159   "Save all data structures and clean up."
 160   (gnus-agent-save-history)
 161   (gnus-agent-close-history)
 162   (setq gnus-agent-spam-hashtb nil)
 163   (save-excursion
 164     (set-buffer nntp-server-buffer)
 165     (widen)))
 166
 167 (defmacro gnus-agent-with-fetch (&rest forms)
 168   "Do FORMS safely."
 169   `(unwind-protect
 170        (progn
 171          (gnus-agent-start-fetch)
 172          ,@forms)
 173      (gnus-agent-stop-fetch)))
 174
 175 (put 'gnus-agent-with-fetch 'lisp-indent-function 0)
 176 (put 'gnus-agent-with-fetch 'edebug-form-spec '(body))
 177
 178 ;;;
 179 ;;; Mode infestation
 180 ;;;
 181
 182 (defvar gnus-agent-mode-hook nil
 183   "Hook run when installing agent mode.")
 184
 185 (defvar gnus-agent-mode nil)
 186 (defvar gnus-agent-mode-status '(gnus-agent-mode " Plugged"))
 187
 188 (defun gnus-agent-mode ()
 189   "Minor mode for providing a agent support in Gnus buffers."
 190   (let* ((buffer (progn (string-match "^gnus-\\(.*\\)-mode$"
 191                                       (symbol-name major-mode))
 192                         (match-string 1 (symbol-name major-mode))))
 193          (mode (intern (format "gnus-agent-%s-mode" buffer))))
 194     (set (make-local-variable 'gnus-agent-mode) t)
 195     (set mode nil)
 196     (set (make-local-variable mode) t)
 197     ;; Set up the menu.
 198     (when (gnus-visual-p 'agent-menu 'menu)
 199       (funcall (intern (format "gnus-agent-%s-make-menu-bar" buffer))))
 200     (unless (assq 'gnus-agent-mode minor-mode-alist)
 201       (push gnus-agent-mode-status minor-mode-alist))
 202     (unless (assq mode minor-mode-map-alist)
 203       (push (cons mode (symbol-value (intern (format "gnus-agent-%s-mode-map"
 204                                                      buffer))))
 205             minor-mode-map-alist))
 206     (when (eq major-mode 'gnus-group-mode)
 207       (gnus-agent-toggle-plugged gnus-plugged))
 208     (gnus-run-hooks 'gnus-agent-mode-hook
 209                     (intern (format "gnus-agent-%s-mode-hook" buffer)))))
 210
 211 (defvar gnus-agent-group-mode-map (make-sparse-keymap))
 212 (gnus-define-keys gnus-agent-group-mode-map
 213   "Ju" gnus-agent-fetch-groups
 214   "Jc" gnus-enter-category-buffer
 215   "Jj" gnus-agent-toggle-plugged
 216   "Js" gnus-agent-fetch-session
 217   "JS" gnus-group-send-drafts
 218   "Ja" gnus-agent-add-group)
 219
 220 (defun gnus-agent-group-make-menu-bar ()
 221   (unless (boundp 'gnus-agent-group-menu)
 222     (easy-menu-define
 223      gnus-agent-group-menu gnus-agent-group-mode-map ""
 224      '("Agent"
 225        ["Toggle plugged" gnus-agent-toggle-plugged t]
 226        ["List categories" gnus-enter-category-buffer t]
 227        ["Send drafts" gnus-group-send-drafts gnus-plugged]
 228        ("Fetch"
 229         ["All" gnus-agent-fetch-session gnus-plugged]
 230         ["Group" gnus-agent-fetch-group gnus-plugged])))))
 231
 232 (defvar gnus-agent-summary-mode-map (make-sparse-keymap))
 233 (gnus-define-keys gnus-agent-summary-mode-map
 234   "Jj" gnus-agent-toggle-plugged
 235   "J#" gnus-agent-mark-article
 236   "J\M-#" gnus-agent-unmark-article
 237   "@" gnus-agent-toggle-mark
 238   "Jc" gnus-agent-catchup)
 239
 240 (defun gnus-agent-summary-make-menu-bar ()
 241   (unless (boundp 'gnus-agent-summary-menu)
 242     (easy-menu-define
 243      gnus-agent-summary-menu gnus-agent-summary-mode-map ""
 244      '("Agent"
 245        ["Toggle plugged" gnus-agent-toggle-plugged t]
 246        ["Mark as downloadable" gnus-agent-mark-article t]
 247        ["Unmark as downloadable" gnus-agent-unmark-article t]
 248        ["Toggle mark" gnus-agent-toggle-mark t]
 249        ["Catchup undownloaded" gnus-agent-catchup t]))))
 250
 251 (defvar gnus-agent-server-mode-map (make-sparse-keymap))
 252 (gnus-define-keys gnus-agent-server-mode-map
 253   "Jj" gnus-agent-toggle-plugged
 254   "Ja" gnus-agent-add-server
 255   "Jr" gnus-agent-remove-server)
 256
 257 (defun gnus-agent-server-make-menu-bar ()
 258   (unless (boundp 'gnus-agent-server-menu)
 259     (easy-menu-define
 260      gnus-agent-server-menu gnus-agent-server-mode-map ""
 261      '("Agent"
 262        ["Toggle plugged" gnus-agent-toggle-plugged t]
 263        ["Add" gnus-agent-add-server t]
 264        ["Remove" gnus-agent-remove-server t]))))
 265
 266 (defun gnus-agent-toggle-plugged (plugged)
 267   "Toggle whether Gnus is unplugged or not."
 268   (interactive (list (not gnus-plugged)))
 269   (if plugged
 270       (progn
 271         (setq gnus-plugged plugged)
 272         (gnus-run-hooks 'gnus-agent-plugged-hook)
 273         (setcar (cdr gnus-agent-mode-status) " Plugged"))
 274     (gnus-agent-close-connections)
 275     (setq gnus-plugged plugged)
 276     (gnus-run-hooks 'gnus-agent-unplugged-hook)
 277     (setcar (cdr gnus-agent-mode-status) " Unplugged"))
 278   (set-buffer-modified-p t))
 279
 280 (defun gnus-agent-close-connections ()
 281   "Close all methods covered by the Gnus agent."
 282   (let ((methods gnus-agent-covered-methods))
 283     (while methods
 284       (gnus-close-server (pop methods)))))
 285
 286 ;;;###autoload
 287 (defun gnus-unplugged ()
 288   "Start Gnus unplugged."
 289   (interactive)
 290   (setq gnus-plugged nil)
 291   (gnus))
 292
 293 ;;;###autoload
 294 (defun gnus-plugged ()
 295   "Start Gnus plugged."
 296   (interactive)
 297   (setq gnus-plugged t)
 298   (gnus))
 299
 300 ;;;###autoload
 301 (defun gnus-agentize ()
 302   "Allow Gnus to be an offline newsreader.
 303 The normal usage of this command is to put the following as the
 304 last form in your `.gnus.el' file:
 305
 306 \(gnus-agentize)
 307
 308 This will modify the `gnus-before-startup-hook', `gnus-post-method',
 309 and `message-send-mail-function' variables, and install the Gnus
 310 agent minor mode in all Gnus buffers."
 311   (interactive)
 312   (gnus-open-agent)
 313   (add-hook 'gnus-setup-news-hook 'gnus-agent-queue-setup)
 314   (unless gnus-agent-send-mail-function
 315     (setq gnus-agent-send-mail-function message-send-mail-function
 316           message-send-mail-function 'gnus-agent-send-mail))
 317   (unless gnus-agent-covered-methods
 318     (setq gnus-agent-covered-methods (list gnus-select-method))))
 319
 320 (defun gnus-agent-queue-setup ()
 321   "Make sure the queue group exists."
 322   (unless (gnus-gethash "nndraft:queue" gnus-newsrc-hashtb)
 323     (gnus-request-create-group "queue" '(nndraft ""))
 324     (let ((gnus-level-default-subscribed 1))
 325       (gnus-subscribe-group "nndraft:queue" nil '(nndraft "")))
 326     (gnus-group-set-parameter
 327      "nndraft:queue" 'gnus-dummy '((gnus-draft-mode)))))
 328
 329 (defun gnus-agent-send-mail ()
 330   (if gnus-plugged
 331       (funcall gnus-agent-send-mail-function)
 332     (goto-char (point-min))
 333     (re-search-forward
 334      (concat "^" (regexp-quote mail-header-separator) "\n"))
 335     (replace-match "\n")
 336     (gnus-agent-insert-meta-information 'mail)
 337     (gnus-request-accept-article "nndraft:queue")))
 338
 339 (defun gnus-agent-insert-meta-information (type &optional method)
 340   "Insert meta-information into the message that says how it's to be posted.
 341 TYPE can be either `mail' or `news'.  If the latter METHOD can
 342 be a select method."
 343   (save-excursion
 344     (message-remove-header gnus-agent-meta-information-header)
 345     (goto-char (point-min))
 346     (insert gnus-agent-meta-information-header ": "
 347             (symbol-name type) " " (format "%S" method)
 348             "\n")
 349     (forward-char -1)
 350     (while (search-backward "\n" nil t)
 351       (replace-match "\\n" t t))))
 352
 353 ;;;
 354 ;;; Group mode commands
 355 ;;;
 356
 357 (defun gnus-agent-fetch-groups (n)
 358   "Put all new articles in the current groups into the Agent."
 359   (interactive "P")
 360   (gnus-group-iterate n 'gnus-agent-fetch-group))
 361
 362 (defun gnus-agent-fetch-group (group)
 363   "Put all new articles in GROUP into the Agent."
 364   (interactive (list (gnus-group-group-name)))
 365   (unless group
 366     (error "No group on the current line"))
 367   (let ((gnus-command-method (gnus-find-method-for-group group)))
 368     (gnus-agent-with-fetch
 369       (gnus-agent-fetch-group-1 group gnus-command-method)
 370       (gnus-message 5 "Fetching %s...done" group))))
 371
 372 (defun gnus-agent-add-group (category arg)
 373   "Add the current group to an agent category."
 374   (interactive
 375    (list
 376     (intern
 377      (completing-read
 378       "Add to category: "
 379       (mapcar (lambda (cat) (list (symbol-name (car cat))))
 380               gnus-category-alist)
 381       nil t))
 382     current-prefix-arg))
 383   (let ((cat (assq category gnus-category-alist))
 384         c groups)
 385     (gnus-group-iterate arg
 386       (lambda (group)
 387         (when (cadddr (setq c (gnus-group-category group)))
 388           (setf (cadddr c) (delete group (cadddr c))))
 389         (push group groups)))
 390     (setf (cadddr cat) (nconc (cadddr cat) groups))
 391     (gnus-category-write)))
 392
 393 ;;;
 394 ;;; Server mode commands
 395 ;;;
 396
 397 (defun gnus-agent-add-server (server)
 398   "Enroll SERVER in the agent program."
 399   (interactive (list (gnus-server-server-name)))
 400   (unless server
 401     (error "No server on the current line"))
 402   (let ((method (gnus-server-get-method nil (gnus-server-server-name))))
 403     (when (member method gnus-agent-covered-methods)
 404       (error "Server already in the agent program"))
 405     (push method gnus-agent-covered-methods)
 406     (gnus-agent-write-servers)
 407     (message "Entered %s into the Agent" server)))
 408
 409 (defun gnus-agent-remove-server (server)
 410   "Remove SERVER from the agent program."
 411   (interactive (list (gnus-server-server-name)))
 412   (unless server
 413     (error "No server on the current line"))
 414   (let ((method (gnus-server-get-method nil (gnus-server-server-name))))
 415     (unless (member method gnus-agent-covered-methods)
 416       (error "Server not in the agent program"))
 417     (setq gnus-agent-covered-methods
 418           (delete method gnus-agent-covered-methods))
 419     (gnus-agent-write-servers)
 420     (message "Removed %s from the agent" server)))
 421
 422 (defun gnus-agent-read-servers ()
 423   "Read the alist of covered servers."
 424   (setq gnus-agent-covered-methods
 425         (gnus-agent-read-file
 426          (nnheader-concat gnus-agent-directory "lib/servers"))))
 427
 428 (defun gnus-agent-write-servers ()
 429   "Write the alist of covered servers."
 430   (nnheader-temp-write (nnheader-concat gnus-agent-directory "lib/servers")
 431     (prin1 gnus-agent-covered-methods (current-buffer))))
 432
 433 ;;;
 434 ;;; Summary commands
 435 ;;;
 436
 437 (defun gnus-agent-mark-article (n &optional unmark)
 438   "Mark the next N articles as downloadable.
 439 If N is negative, mark backward instead.  If UNMARK is non-nil, remove
 440 the mark instead.  The difference between N and the actual number of
 441 articles marked is returned."
 442   (interactive "p")
 443   (let ((backward (< n 0))
 444         (n (abs n)))
 445     (while (and
 446             (> n 0)
 447             (progn
 448               (gnus-summary-set-agent-mark
 449                (gnus-summary-article-number) unmark)
 450               (zerop (gnus-summary-next-subject (if backward -1 1) nil t))))
 451       (setq n (1- n)))
 452     (when (/= 0 n)
 453       (gnus-message 7 "No more articles"))
 454     (gnus-summary-recenter)
 455     (gnus-summary-position-point)
 456     n))
 457
 458 (defun gnus-agent-unmark-article (n)
 459   "Remove the downloadable mark from the next N articles.
 460 If N is negative, unmark backward instead.  The difference between N and
 461 the actual number of articles unmarked is returned."
 462   (interactive "p")
 463   (gnus-agent-mark-article n t))
 464
 465 (defun gnus-agent-toggle-mark (n)
 466   "Toggle the downloadable mark from the next N articles.
 467 If N is negative, toggle backward instead.  The difference between N and
 468 the actual number of articles toggled is returned."
 469   (interactive "p")
 470   (gnus-agent-mark-article n 'toggle))
 471
 472 (defun gnus-summary-set-agent-mark (article &optional unmark)
 473   "Mark ARTICLE as downloadable."
 474   (let ((unmark (if (and (not (null unmark)) (not (eq t unmark)))
 475                     (memq article gnus-newsgroup-downloadable)
 476                   unmark)))
 477     (if unmark
 478         (progn
 479           (setq gnus-newsgroup-downloadable
 480                 (delq article gnus-newsgroup-downloadable))
 481           (push article gnus-newsgroup-undownloaded))
 482       (setq gnus-newsgroup-undownloaded
 483             (delq article gnus-newsgroup-undownloaded))
 484       (push article gnus-newsgroup-downloadable))
 485     (gnus-summary-update-mark
 486      (if unmark gnus-undownloaded-mark gnus-downloadable-mark)
 487      'unread)))
 488
 489 (defun gnus-agent-get-undownloaded-list ()
 490   "Mark all unfetched articles as read."
 491   (let ((gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name)))
 492     (when (and (not gnus-plugged)
 493                (gnus-agent-method-p gnus-command-method))
 494       (gnus-agent-load-alist gnus-newsgroup-name)
 495       (let ((articles gnus-newsgroup-unreads)
 496             article)
 497         (while (setq article (pop articles))
 498           (unless (or (cdr (assq article gnus-agent-article-alist))
 499                   (memq article gnus-newsgroup-downloadable))
 500             (push article gnus-newsgroup-undownloaded)))))))
 501
 502 (defun gnus-agent-catchup ()
 503   "Mark all undownloaded articles as read."
 504   (interactive)
 505   (save-excursion
 506     (while gnus-newsgroup-undownloaded
 507       (gnus-summary-mark-article
 508        (pop gnus-newsgroup-undownloaded) gnus-catchup-mark)))
 509   (gnus-summary-position-point))
 510
 511 ;;;
 512 ;;; Internal functions
 513 ;;;
 514
 515 (defun gnus-agent-save-active (method)
 516   (when (gnus-agent-method-p method)
 517     (let* ((gnus-command-method method)
 518            (file (gnus-agent-lib-file "active")))
 519       (gnus-make-directory (file-name-directory file))
 520       (let ((coding-system-for-write gnus-agent-article-file-coding-system))
 521         (write-region (point-min) (point-max) file nil 'silent))
 522       (when (file-exists-p (gnus-agent-lib-file "groups"))
 523         (delete-file (gnus-agent-lib-file "groups"))))))
 524
 525 (defun gnus-agent-save-groups (method)
 526   (let* ((gnus-command-method method)
 527          (file (gnus-agent-lib-file "groups")))
 528     (gnus-make-directory (file-name-directory file))
 529     (write-region (point-min) (point-max) file nil 'silent))
 530     (when (file-exists-p (gnus-agent-lib-file "active"))
 531       (delete-file (gnus-agent-lib-file "active"))))
 532
 533 (defun gnus-agent-save-group-info (method group active)
 534   (when (gnus-agent-method-p method)
 535     (let* ((gnus-command-method method)
 536            (file (if nntp-server-list-active-group
 537                      (gnus-agent-lib-file "active")
 538                    (gnus-agent-lib-file "groups"))))
 539       (gnus-make-directory (file-name-directory file))
 540       (nnheader-temp-write file
 541         (when (file-exists-p file)
 542           (nnheader-insert-file-contents file))
 543         (goto-char (point-min))
 544         (if nntp-server-list-active-group
 545             (progn
 546               (when (re-search-forward
 547                      (concat "^" (regexp-quote group) " ") nil t)
 548                 (gnus-delete-line))
 549               (insert group " " (number-to-string (cdr active)) " "
 550                       (number-to-string (car active)) "\n"))
 551           (when (re-search-forward (concat (regexp-quote group) " ") nil t)
 552             (gnus-delete-line))
 553           (insert-buffer-substring nntp-server-buffer))))))
 554
 555 (defun gnus-agent-group-path (group)
 556   "Translate GROUP into a path."
 557   (if nnmail-use-long-file-names
 558       (gnus-group-real-name group)
 559     (nnheader-replace-chars-in-string
 560      (nnheader-translate-file-chars (gnus-group-real-name group))
 561      ?. ?/)))
 562
 563 \f
 564
 565 (defun gnus-agent-method-p (method)
 566   "Say whether METHOD is covered by the agent."
 567   (member method gnus-agent-covered-methods))
 568
 569 (defun gnus-agent-get-function (method)
 570   (if (and (not gnus-plugged)
 571            (gnus-agent-method-p method))
 572       (progn
 573         (require 'nnagent)
 574         'nnagent)
 575     (car method)))
 576
 577 ;;; History functions
 578
 579 (defun gnus-agent-history-buffer ()
 580   (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
 581
 582 (defun gnus-agent-open-history ()
 583   (save-excursion
 584     (push (cons (gnus-agent-method)
 585                 (set-buffer (gnus-get-buffer-create
 586                              (format " *Gnus agent %s history*"
 587                                      (gnus-agent-method)))))
 588           gnus-agent-history-buffers)
 589     (erase-buffer)
 590     (insert "\n")
 591     (let ((file (gnus-agent-lib-file "history")))
 592       (when (file-exists-p file)
 593         (insert-file file))
 594       (set (make-local-variable 'gnus-agent-file-name) file))))
 595
 596 (defun gnus-agent-save-history ()
 597   (save-excursion
 598     (set-buffer gnus-agent-current-history)
 599     (gnus-make-directory (file-name-directory gnus-agent-file-name))
 600     (write-region (1+ (point-min)) (point-max)
 601                   gnus-agent-file-name nil 'silent)))
 602
 603 (defun gnus-agent-close-history ()
 604   (when (gnus-buffer-live-p gnus-agent-current-history)
 605     (kill-buffer gnus-agent-current-history)
 606     (setq gnus-agent-history-buffers
 607           (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
 608                 gnus-agent-history-buffers))))
 609
 610 (defun gnus-agent-enter-history (id group-arts date)
 611   (save-excursion
 612     (set-buffer gnus-agent-current-history)
 613     (goto-char (point-max))
 614     (insert id "\t" (number-to-string date) "\t")
 615     (while group-arts
 616       (insert (caar group-arts) " " (number-to-string (cdr (pop group-arts)))
 617               " "))
 618     (insert "\n")))
 619
 620 (defun gnus-agent-article-in-history-p (id)
 621   (save-excursion
 622     (set-buffer (gnus-agent-history-buffer))
 623     (goto-char (point-min))
 624     (search-forward (concat "\n" id "\t") nil t)))
 625
 626 (defun gnus-agent-history-path (id)
 627   (save-excursion
 628     (set-buffer (gnus-agent-history-buffer))
 629     (goto-char (point-min))
 630     (when (search-forward (concat "\n" id "\t") nil t)
 631       (let ((method (gnus-agent-method)))
 632         (let (paths group)
 633           (while (not (numberp (setq group (read (current-buffer)))))
 634             (push (concat method "/" group) paths))
 635           (nreverse paths))))))
 636
 637 ;;;
 638 ;;; Fetching
 639 ;;;
 640
 641 (defun gnus-agent-fetch-articles (group articles)
 642   "Fetch ARTICLES from GROUP and put them into the Agent."
 643   (when articles
 644     ;; Prune off articles that we have already fetched.
 645     (while (and articles
 646                 (cdr (assq (car articles) gnus-agent-article-alist)))
 647      (pop articles))
 648     (let ((arts articles))
 649       (while (cdr arts)
 650         (if (cdr (assq (cadr arts) gnus-agent-article-alist))
 651             (setcdr arts (cddr arts))
 652           (setq arts (cdr arts)))))
 653     (when articles
 654       (let ((dir (concat
 655                   (gnus-agent-directory)
 656                   (gnus-agent-group-path group) "/"))
 657             (date (gnus-time-to-day (current-time)))
 658             (case-fold-search t)
 659             pos crosses id elem)
 660         (gnus-make-directory dir)
 661         (gnus-message 7 "Fetching articles for %s..." group)
 662         ;; Fetch the articles from the backend.
 663         (if (gnus-check-backend-function 'retrieve-articles group)
 664             (setq pos (gnus-retrieve-articles articles group))
 665           (nnheader-temp-write nil
 666             (let (article)
 667               (while (setq article (pop articles))
 668                 (when (gnus-request-article article group)
 669                   (goto-char (point-max))
 670                   (push (cons article (point)) pos)
 671                   (insert-buffer-substring nntp-server-buffer)))
 672               (copy-to-buffer nntp-server-buffer (point-min) (point-max))
 673               (setq pos (nreverse pos)))))
 674         ;; Then save these articles into the Agent.
 675         (save-excursion
 676           (set-buffer nntp-server-buffer)
 677           (while pos
 678             (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
 679             (goto-char (point-min))
 680             (when (search-forward "\n\n" nil t)
 681               (when (search-backward "\nXrefs: " nil t)
 682                 ;; Handle crossposting.
 683                 (skip-chars-forward "^ ")
 684                 (skip-chars-forward " ")
 685                 (setq crosses nil)
 686                 (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) +")
 687                   (push (cons (buffer-substring (match-beginning 1)
 688                                                 (match-end 1))
 689                               (buffer-substring (match-beginning 2)
 690                                                 (match-end 2)))
 691                         crosses)
 692                   (goto-char (match-end 0)))
 693                 (gnus-agent-crosspost crosses (caar pos))))
 694             (goto-char (point-min))
 695             (if (not (re-search-forward "^Message-ID: *<\\([^>\n]+\\)>" nil t))
 696                 (setq id "No-Message-ID-in-article")
 697               (setq id (buffer-substring (match-beginning 1) (match-end 1))))
 698             (let ((coding-system-for-write
 699                    gnus-agent-article-file-coding-system))
 700               (write-region (point-min) (point-max)
 701                             (concat dir (number-to-string (caar pos)))
 702                             nil 'silent))
 703             (when (setq elem (assq (caar pos) gnus-agent-article-alist))
 704               (setcdr elem t))
 705             (gnus-agent-enter-history
 706              id (or crosses (list (cons group (caar pos)))) date)
 707             (widen)
 708             (pop pos)))
 709         (gnus-agent-save-alist group)))))
 710
 711 (defun gnus-agent-crosspost (crosses article)
 712   (let (gnus-agent-article-alist group alist beg end)
 713     (save-excursion
 714       (set-buffer gnus-agent-overview-buffer)
 715       (when (nnheader-find-nov-line article)
 716         (forward-word 1)
 717         (setq beg (point))
 718         (setq end (progn (forward-line 1) (point)))))
 719     (while crosses
 720       (setq group (caar crosses))
 721       (unless (setq alist (assoc group gnus-agent-group-alist))
 722         (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
 723               gnus-agent-group-alist))
 724       (setcdr alist (cons (cons (cdar crosses) t) (cdr alist)))
 725       (save-excursion
 726         (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
 727                                                group)))
 728         (when (= (point-max) (point-min))
 729           (push (cons group (current-buffer)) gnus-agent-buffer-alist)
 730           (ignore-errors
 731             (nnheader-insert-file-contents
 732              (gnus-agent-article-name ".overview" group))))
 733         (nnheader-find-nov-line (string-to-number (cdar crosses)))
 734         (insert (string-to-number (cdar crosses)))
 735         (insert-buffer-substring gnus-agent-overview-buffer beg end))
 736       (pop crosses))))
 737
 738 (defun gnus-agent-flush-cache ()
 739   (save-excursion
 740     (while gnus-agent-buffer-alist
 741       (set-buffer (cdar gnus-agent-buffer-alist))
 742       (write-region (point-min) (point-max)
 743                     (gnus-agent-article-name ".overview"
 744                                              (caar gnus-agent-buffer-alist))
 745                      nil 'silent)
 746       (pop gnus-agent-buffer-alist))
 747     (while gnus-agent-group-alist
 748       (nnheader-temp-write (caar gnus-agent-group-alist)
 749         (princ (cdar gnus-agent-group-alist))
 750         (insert "\n"))
 751       (pop gnus-agent-group-alist))))
 752
 753 (defun gnus-agent-fetch-headers (group &optional force)
 754   (let ((articles (if (gnus-agent-load-alist group)
 755                       (gnus-sorted-intersection
 756                        (gnus-list-of-unread-articles group)
 757                        (gnus-uncompress-range
 758                         (cons (1+ (caar (last gnus-agent-article-alist)))
 759                               (cdr (gnus-active group)))))
 760                     (gnus-list-of-unread-articles group))))
 761     ;; Fetch them.
 762     (when articles
 763       (gnus-message 7 "Fetching headers for %s..." group)
 764       (save-excursion
 765         (set-buffer nntp-server-buffer)
 766         (unless (eq 'nov (gnus-retrieve-headers articles group))
 767           (nnvirtual-convert-headers))
 768         ;; Save these headers for later processing.
 769         (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
 770         (let (file)
 771           (when (file-exists-p
 772                  (setq file (gnus-agent-article-name ".overview" group)))
 773             (gnus-agent-braid-nov group articles file))
 774           (gnus-make-directory (nnheader-translate-file-chars
 775                                 (file-name-directory file)))
 776           (write-region (point-min) (point-max) file nil 'silent)
 777           (gnus-agent-save-alist group articles nil)
 778           (gnus-agent-enter-history
 779            "last-header-fetched-for-session"
 780            (list (cons group (nth (- (length  articles) 1) articles)))
 781            (gnus-time-to-day (current-time)))
 782           articles)))))
 783
 784 (defsubst gnus-agent-copy-nov-line (article)
 785   (let (b e)
 786     (set-buffer gnus-agent-overview-buffer)
 787     (setq b (point))
 788     (if (eq article (read (current-buffer)))
 789         (setq e (progn (forward-line 1) (point)))
 790       (progn
 791         (beginning-of-line)
 792         (setq e b)))
 793     (set-buffer nntp-server-buffer)
 794     (insert-buffer-substring gnus-agent-overview-buffer b e)))
 795
 796 (defun gnus-agent-braid-nov (group articles file)
 797   (set-buffer gnus-agent-overview-buffer)
 798   (goto-char (point-min))
 799   (set-buffer nntp-server-buffer)
 800   (erase-buffer)
 801   (nnheader-insert-file-contents file)
 802   (goto-char (point-max))
 803   (if (or (= (point-min) (point-max))
 804           (progn
 805             (forward-line -1)
 806             (< (read (current-buffer)) (car articles))))
 807       ;; We have only headers that are after the older headers,
 808       ;; so we just append them.
 809       (progn
 810         (goto-char (point-max))
 811         (insert-buffer-substring gnus-agent-overview-buffer))
 812     ;; We do it the hard way.
 813     (nnheader-find-nov-line (car articles))
 814     (gnus-agent-copy-nov-line (car articles))
 815     (pop articles)
 816     (while (and articles
 817                 (not (eobp)))
 818       (while (and (not (eobp))
 819                   (< (read (current-buffer)) (car articles)))
 820         (forward-line 1))
 821       (beginning-of-line)
 822       (unless (eobp)
 823         (gnus-agent-copy-nov-line (car articles))
 824         (setq articles (cdr articles))))
 825     (when articles
 826       (let (b e)
 827         (set-buffer gnus-agent-overview-buffer)
 828         (setq b (point)
 829               e (point-max))
 830         (set-buffer nntp-server-buffer)
 831         (insert-buffer-substring gnus-agent-overview-buffer b e)))))
 832
 833 (defun gnus-agent-load-alist (group &optional dir)
 834   "Load the article-state alist for GROUP."
 835   (setq gnus-agent-article-alist
 836         (gnus-agent-read-file
 837          (if dir
 838              (concat dir ".agentview")
 839            (gnus-agent-article-name ".agentview" group)))))
 840
 841 (defun gnus-agent-save-alist (group &optional articles state dir)
 842   "Save the article-state alist for GROUP."
 843   (nnheader-temp-write (if dir
 844                            (concat dir ".agentview")
 845                          (gnus-agent-article-name ".agentview" group))
 846     (princ (setq gnus-agent-article-alist
 847                  (nconc gnus-agent-article-alist
 848                         (mapcar (lambda (article) (cons article state))
 849                                 articles)))
 850            (current-buffer))
 851     (insert "\n")))
 852
 853 (defun gnus-agent-article-name (article group)
 854   (concat (gnus-agent-directory) (gnus-agent-group-path group) "/"
 855           (if (stringp article) article (string-to-number article))))
 856
 857 ;;;###autoload
 858 (defun gnus-agent-batch-fetch ()
 859   "Start Gnus and fetch session."
 860   (interactive)
 861   (gnus)
 862   (gnus-agent-fetch-session)
 863   (gnus-group-exit))
 864
 865 (defun gnus-agent-fetch-session ()
 866   "Fetch all articles and headers that are eligible for fetching."
 867   (interactive)
 868   (unless gnus-agent-covered-methods
 869     (error "No servers are covered by the Gnus agent"))
 870   (unless gnus-plugged
 871     (error "Can't fetch articles while Gnus is unplugged"))
 872   (let ((methods gnus-agent-covered-methods)
 873         groups group gnus-command-method)
 874     (save-excursion
 875       (while methods
 876         (setq gnus-command-method (car methods))
 877         (when (or (gnus-server-opened gnus-command-method)
 878                   (gnus-open-server gnus-command-method))
 879           (setq groups (gnus-groups-from-server (car methods)))
 880           (gnus-agent-with-fetch
 881             (while (setq group (pop groups))
 882               (when (<= (gnus-group-level group) gnus-agent-handle-level)
 883                 (gnus-agent-fetch-group-1 group gnus-command-method)))))
 884         (pop methods))
 885       (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
 886
 887 (defun gnus-agent-fetch-group-1 (group method)
 888   "Fetch GROUP."
 889   (let ((gnus-command-method method)
 890         gnus-newsgroup-dependencies gnus-newsgroup-headers
 891         gnus-newsgroup-scored gnus-headers gnus-score
 892         gnus-use-cache articles arts
 893         category predicate info marks score-param)
 894     ;; Fetch headers.
 895     (when (and (or (gnus-active group) (gnus-activate-group group))
 896                (setq articles (gnus-agent-fetch-headers group)))
 897       ;; Parse them and see which articles we want to fetch.
 898       (setq gnus-newsgroup-dependencies
 899             (make-vector (length articles) 0))
 900       (setq gnus-newsgroup-headers
 901             (gnus-get-newsgroup-headers-xover articles nil nil group))
 902       (setq category (gnus-group-category group))
 903       (setq predicate
 904             (gnus-get-predicate
 905              (or (gnus-group-get-parameter group 'agent-predicate)
 906                  (cadr category))))
 907       (setq score-param
 908             (or (gnus-group-get-parameter group 'agent-score)
 909                 (caddr category)))
 910       (when score-param
 911         (gnus-score-headers (list (list score-param))))
 912       (setq arts nil)
 913       (while (setq gnus-headers (pop gnus-newsgroup-headers))
 914         (setq gnus-score
 915               (or (cdr (assq (mail-header-number gnus-headers)
 916                              gnus-newsgroup-scored))
 917                   gnus-summary-default-score))
 918         (when (funcall predicate)
 919           (push (mail-header-number gnus-headers)
 920                 arts)))
 921       ;; Fetch the articles.
 922       (when arts
 923         (gnus-agent-fetch-articles group arts)))
 924     ;; Perhaps we have some additional articles to fetch.
 925     (setq arts (assq 'download (gnus-info-marks
 926                                 (setq info (gnus-get-info group)))))
 927     (when (cdr arts)
 928       (gnus-agent-fetch-articles
 929        group (gnus-uncompress-range (cdr arts)))
 930       (setq marks (delq arts (gnus-info-marks info)))
 931       (gnus-info-set-marks info marks))))
 932
 933 ;;;
 934 ;;; Agent Category Mode
 935 ;;;
 936
 937 (defvar gnus-category-mode-hook nil
 938   "Hook run in `gnus-category-mode' buffers.")
 939
 940 (defvar gnus-category-line-format "     %(%20c%): %g\n"
 941   "Format of category lines.")
 942
 943 (defvar gnus-category-mode-line-format "Gnus: %%b"
 944   "The format specification for the category mode line.")
 945
 946 (defvar gnus-agent-short-article 100
 947   "Articles that have fewer lines than this are short.")
 948
 949 (defvar gnus-agent-long-article 200
 950   "Articles that have more lines than this are long.")
 951
 952 (defvar gnus-agent-low-score 0
 953   "Articles that have a score lower than this have a low score.")
 954
 955 (defvar gnus-agent-high-score 0
 956   "Articles that have a score higher than this have a high score.")
 957
 958
 959 ;;; Internal variables.
 960
 961 (defvar gnus-category-buffer "*Agent Category*")
 962
 963 (defvar gnus-category-line-format-alist
 964   `((?c gnus-tmp-name ?s)
 965     (?g gnus-tmp-groups ?d)))
 966
 967 (defvar gnus-category-mode-line-format-alist
 968   `((?u user-defined ?s)))
 969
 970 (defvar gnus-category-line-format-spec nil)
 971 (defvar gnus-category-mode-line-format-spec nil)
 972
 973 (defvar gnus-category-mode-map nil)
 974 (put 'gnus-category-mode 'mode-class 'special)
 975
 976 (unless gnus-category-mode-map
 977   (setq gnus-category-mode-map (make-sparse-keymap))
 978   (suppress-keymap gnus-category-mode-map)
 979
 980   (gnus-define-keys gnus-category-mode-map
 981     "q" gnus-category-exit
 982     "k" gnus-category-kill
 983     "c" gnus-category-copy
 984     "a" gnus-category-add
 985     "p" gnus-category-edit-predicate
 986     "g" gnus-category-edit-groups
 987     "s" gnus-category-edit-score
 988     "l" gnus-category-list
 989
 990     "\C-c\C-i" gnus-info-find-node
 991     "\C-c\C-b" gnus-bug))
 992
 993 (defvar gnus-category-menu-hook nil
 994   "*Hook run after the creation of the menu.")
 995
 996 (defun gnus-category-make-menu-bar ()
 997   (gnus-turn-off-edit-menu 'category)
 998   (unless (boundp 'gnus-category-menu)
 999     (easy-menu-define
1000      gnus-category-menu gnus-category-mode-map ""
1001      '("Categories"
1002        ["Add" gnus-category-add t]
1003        ["Kill" gnus-category-kill t]
1004        ["Copy" gnus-category-copy t]
1005        ["Edit predicate" gnus-category-edit-predicate t]
1006        ["Edit score" gnus-category-edit-score t]
1007        ["Edit groups" gnus-category-edit-groups t]
1008        ["Exit" gnus-category-exit t]))
1009
1010     (gnus-run-hooks 'gnus-category-menu-hook)))
1011
1012 (defun gnus-category-mode ()
1013   "Major mode for listing and editing agent categories.
1014
1015 All normal editing commands are switched off.
1016 \\<gnus-category-mode-map>
1017 For more in-depth information on this mode, read the manual
1018 (`\\[gnus-info-find-node]').
1019
1020 The following commands are available:
1021
1022 \\{gnus-category-mode-map}"
1023   (interactive)
1024   (when (gnus-visual-p 'category-menu 'menu)
1025     (gnus-category-make-menu-bar))
1026   (kill-all-local-variables)
1027   (gnus-simplify-mode-line)
1028   (setq major-mode 'gnus-category-mode)
1029   (setq mode-name "Category")
1030   (gnus-set-default-directory)
1031   (setq mode-line-process nil)
1032   (use-local-map gnus-category-mode-map)
1033   (buffer-disable-undo (current-buffer))
1034   (setq truncate-lines t)
1035   (setq buffer-read-only t)
1036   (gnus-run-hooks 'gnus-category-mode-hook))
1037
1038 (defalias 'gnus-category-position-point 'gnus-goto-colon)
1039
1040 (defun gnus-category-insert-line (category)
1041   (let* ((gnus-tmp-name (car category))
1042          (gnus-tmp-groups (length (cadddr category))))
1043     (beginning-of-line)
1044     (gnus-add-text-properties
1045      (point)
1046      (prog1 (1+ (point))
1047        ;; Insert the text.
1048        (eval gnus-category-line-format-spec))
1049      (list 'gnus-category gnus-tmp-name))))
1050
1051 (defun gnus-enter-category-buffer ()
1052   "Go to the Category buffer."
1053   (interactive)
1054   (gnus-category-setup-buffer)
1055   (gnus-configure-windows 'category)
1056   (gnus-category-prepare))
1057
1058 (defun gnus-category-setup-buffer ()
1059   (unless (get-buffer gnus-category-buffer)
1060     (save-excursion
1061       (set-buffer (gnus-get-buffer-create gnus-category-buffer))
1062       (gnus-category-mode))))
1063
1064 (defun gnus-category-prepare ()
1065   (gnus-set-format 'category-mode)
1066   (gnus-set-format 'category t)
1067   (let ((alist gnus-category-alist)
1068         (buffer-read-only nil))
1069     (erase-buffer)
1070     (while alist
1071       (gnus-category-insert-line (pop alist)))
1072     (goto-char (point-min))
1073     (gnus-category-position-point)))
1074
1075 (defun gnus-category-name ()
1076   (or (get-text-property (gnus-point-at-bol) 'gnus-category)
1077       (error "No category on the current line")))
1078
1079 (defun gnus-category-read ()
1080   "Read the category alist."
1081   (setq gnus-category-alist
1082         (or (gnus-agent-read-file
1083              (nnheader-concat gnus-agent-directory "lib/categories"))
1084             (list (list 'default 'short nil nil)))))
1085
1086 (defun gnus-category-write ()
1087   "Write the category alist."
1088   (setq gnus-category-predicate-cache nil
1089         gnus-category-group-cache nil)
1090   (nnheader-temp-write (nnheader-concat gnus-agent-directory "lib/categories")
1091     (prin1 gnus-category-alist (current-buffer))))
1092
1093 (defun gnus-category-edit-predicate (category)
1094   "Edit the predicate for CATEGORY."
1095   (interactive (list (gnus-category-name)))
1096   (let ((info (assq category gnus-category-alist)))
1097     (gnus-edit-form
1098      (cadr info) (format "Editing the predicate for category %s" category)
1099      `(lambda (predicate)
1100         (setf (cadr (assq ',category gnus-category-alist)) predicate)
1101         (gnus-category-write)
1102         (gnus-category-list)))))
1103
1104 (defun gnus-category-edit-score (category)
1105   "Edit the score expression for CATEGORY."
1106   (interactive (list (gnus-category-name)))
1107   (let ((info (assq category gnus-category-alist)))
1108     (gnus-edit-form
1109      (caddr info)
1110      (format "Editing the score expression for category %s" category)
1111      `(lambda (groups)
1112         (setf (caddr (assq ',category gnus-category-alist)) groups)
1113         (gnus-category-write)
1114         (gnus-category-list)))))
1115
1116 (defun gnus-category-edit-groups (category)
1117   "Edit the group list for CATEGORY."
1118   (interactive (list (gnus-category-name)))
1119   (let ((info (assq category gnus-category-alist)))
1120     (gnus-edit-form
1121      (cadddr info) (format "Editing the group list for category %s" category)
1122      `(lambda (groups)
1123         (setf (cadddr (assq ',category gnus-category-alist)) groups)
1124         (gnus-category-write)
1125         (gnus-category-list)))))
1126
1127 (defun gnus-category-kill (category)
1128   "Kill the current category."
1129   (interactive (list (gnus-category-name)))
1130   (let ((info (assq category gnus-category-alist))
1131         (buffer-read-only nil))
1132     (gnus-delete-line)
1133     (gnus-category-write)
1134     (setq gnus-category-alist (delq info gnus-category-alist))))
1135
1136 (defun gnus-category-copy (category to)
1137   "Copy the current category."
1138   (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
1139   (let ((info (assq category gnus-category-alist)))
1140     (push (list to (gnus-copy-sequence (cadr info))
1141                 (gnus-copy-sequence (caddr info)) nil)
1142           gnus-category-alist)
1143     (gnus-category-write)
1144     (gnus-category-list)))
1145
1146 (defun gnus-category-add (category)
1147   "Create a new category."
1148   (interactive "SCategory name: ")
1149   (when (assq category gnus-category-alist)
1150     (error "Category %s already exists" category))
1151   (push (list category 'true nil nil)
1152         gnus-category-alist)
1153   (gnus-category-write)
1154   (gnus-category-list))
1155
1156 (defun gnus-category-list ()
1157   "List all categories."
1158   (interactive)
1159   (gnus-category-prepare))
1160
1161 (defun gnus-category-exit ()
1162   "Return to the group buffer."
1163   (interactive)
1164   (kill-buffer (current-buffer))
1165   (gnus-configure-windows 'group t))
1166
1167 ;; To avoid having 8-bit characters in the source file.
1168 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
1169
1170 (defvar gnus-category-predicate-alist
1171   '((spam . gnus-agent-spam-p)
1172     (short . gnus-agent-short-p)
1173     (long . gnus-agent-long-p)
1174     (low . gnus-agent-low-scored-p)
1175     (high . gnus-agent-high-scored-p)
1176     (true . gnus-agent-true)
1177     (false . gnus-agent-false))
1178   "Mapping from short score predicate symbols to predicate functions.")
1179
1180 (defun gnus-agent-spam-p ()
1181   "Say whether an article is spam or not."
1182   (unless gnus-agent-spam-hashtb
1183     (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
1184   (if (not (equal (mail-header-references gnus-headers) ""))
1185       nil
1186     (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
1187       (prog1
1188           (gnus-gethash string gnus-agent-spam-hashtb)
1189         (gnus-sethash string t gnus-agent-spam-hashtb)))))
1190
1191 (defun gnus-agent-short-p ()
1192   "Say whether an article is short or not."
1193   (< (mail-header-lines gnus-headers) gnus-agent-short-article))
1194
1195 (defun gnus-agent-long-p ()
1196   "Say whether an article is long or not."
1197   (> (mail-header-lines gnus-headers) gnus-agent-long-article))
1198
1199 (defun gnus-agent-low-scored-p ()
1200   "Say whether an article has a low score or not."
1201   (< gnus-score gnus-agent-low-score))
1202
1203 (defun gnus-agent-high-scored-p ()
1204   "Say whether an article has a high score or not."
1205   (> gnus-score gnus-agent-high-score))
1206
1207 (defun gnus-category-make-function (cat)
1208   "Make a function from category CAT."
1209   `(lambda () ,(gnus-category-make-function-1 cat)))
1210
1211 (defun gnus-agent-true ()
1212   "Return t."
1213   t)
1214
1215 (defun gnus-agent-false ()
1216   "Return nil."
1217   nil)
1218
1219 (defun gnus-category-make-function-1 (cat)
1220   "Make a function from category CAT."
1221   (cond
1222    ;; Functions are just returned as is.
1223    ((or (symbolp cat)
1224         (gnus-functionp cat))
1225     `(,(or (cdr (assq cat gnus-category-predicate-alist))
1226            cat)))
1227    ;; More complex category.
1228    ((consp cat)
1229     `(,(cond
1230         ((memq (car cat) '(& and))
1231          'and)
1232         ((memq (car cat) '(| or))
1233          'or)
1234         ((memq (car cat) gnus-category-not)
1235          'not))
1236       ,@(mapcar 'gnus-category-make-function-1 (cdr cat))))
1237    (t
1238     (error "Unknown category type: %s" cat))))
1239
1240 (defun gnus-get-predicate (predicate)
1241   "Return the predicate for CATEGORY."
1242   (or (cdr (assoc predicate gnus-category-predicate-cache))
1243       (cdar (push (cons predicate
1244                         (gnus-category-make-function predicate))
1245                   gnus-category-predicate-cache))))
1246
1247 (defun gnus-group-category (group)
1248   "Return the category GROUP belongs to."
1249   (unless gnus-category-group-cache
1250     (setq gnus-category-group-cache (gnus-make-hashtable 1000))
1251     (let ((cs gnus-category-alist)
1252           groups cat)
1253       (while (setq cat (pop cs))
1254         (setq groups (cadddr cat))
1255         (while groups
1256           (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
1257   (or (gnus-gethash group gnus-category-group-cache)
1258       (assq 'default gnus-category-alist)))
1259
1260 (defun gnus-agent-expire ()
1261   "Expire all old articles."
1262   (interactive)
1263   (let ((methods gnus-agent-covered-methods)
1264         (day (- (gnus-time-to-day (current-time)) gnus-agent-expire-days))
1265         gnus-command-method sym group articles
1266         history overview file histories elem art nov-file low info
1267         unreads marked article)
1268     (save-excursion
1269       (setq overview (gnus-get-buffer-create " *expire overview*"))
1270       (while (setq gnus-command-method (pop methods))
1271         (let ((expiry-hashtb (gnus-make-hashtable 1023)))
1272         (gnus-agent-open-history)
1273         (set-buffer
1274          (setq gnus-agent-current-history
1275                (setq history (gnus-agent-history-buffer))))
1276         (goto-char (point-min))
1277         (when (> (buffer-size) 1)
1278           (goto-char (point-min))
1279           (while (not (eobp))
1280             (skip-chars-forward "^\t")
1281             (if (> (read (current-buffer)) day)
1282                 ;; New article; we don't expire it.
1283                 (forward-line 1)
1284               ;; Old article.  Schedule it for possible nuking.
1285               (while (not (eolp))
1286                 (setq sym (let ((obarray expiry-hashtb))
1287                             (read (current-buffer))))
1288                 (if (boundp sym)
1289                     (set sym (cons (cons (read (current-buffer)) (point))
1290                                    (symbol-value sym)))
1291                   (set sym (list (cons (read (current-buffer)) (point)))))
1292                 (skip-chars-forward " "))
1293               (forward-line 1)))
1294           ;; We now have all articles that can possibly be expired.
1295           (mapatoms
1296            (lambda (sym)
1297              (setq group (symbol-name sym)
1298                    articles (sort (symbol-value sym) 'car-less-than-car)
1299                    low (car (gnus-active group))
1300                    info (gnus-get-info group)
1301                    unreads (ignore-errors (gnus-list-of-unread-articles group))
1302                    marked (nconc (gnus-uncompress-range
1303                                   (cdr (assq 'tick (gnus-info-marks info))))
1304                                  (gnus-uncompress-range
1305                                   (cdr (assq 'dormant
1306                                              (gnus-info-marks info)))))
1307                    nov-file (gnus-agent-article-name ".overview" group))
1308              (gnus-agent-load-alist group)
1309              (gnus-message 5 "Expiring articles in %s" group)
1310              (set-buffer overview)
1311              (erase-buffer)
1312              (when (file-exists-p nov-file)
1313                (nnheader-insert-file-contents nov-file))
1314              (goto-char (point-min))
1315              (setq article 0)
1316              (while (setq elem (pop articles))
1317                (setq article (car elem))
1318                (when (or (null low)
1319                          (< article low)
1320                          gnus-agent-expire-all
1321                          (and (not (memq article unreads))
1322                               (not (memq article marked))))
1323                  ;; Find and nuke the NOV line.
1324                  (while (and (not (eobp))
1325                              (or (not (numberp
1326                                        (setq art (read (current-buffer)))))
1327                                  (< art article)))
1328                    (if (file-exists-p
1329                         (gnus-agent-article-name
1330                          (number-to-string art) group))
1331                        (forward-line 1)
1332                      ;; Remove old NOV lines that have no articles.
1333                      (gnus-delete-line)))
1334                  (if (or (eobp)
1335                          (/= art article))
1336                      (beginning-of-line)
1337                    (gnus-delete-line))
1338                  ;; Nuke the article.
1339                  (when (file-exists-p (setq file (gnus-agent-article-name
1340                                                   (number-to-string article)
1341                                                   group)))
1342                    (delete-file file))
1343                  ;; Schedule the history line for nuking.
1344                  (push (cdr elem) histories)))
1345              (gnus-make-directory (file-name-directory nov-file))
1346              (write-region (point-min) (point-max) nov-file nil 'silent)
1347              ;; Delete the unwanted entries in the alist.
1348              (setq gnus-agent-article-alist
1349                    (sort gnus-agent-article-alist 'car-less-than-car))
1350              (let* ((alist gnus-agent-article-alist)
1351                     (prev (cons nil alist))
1352                     (first prev)
1353                     expired)
1354                (while (and alist
1355                            (<= (caar alist) article))
1356                  (if (or (not (cdar alist))
1357                          (not (file-exists-p
1358                                (gnus-agent-article-name
1359                                 (number-to-string
1360                                  (caar alist))
1361                                 group))))
1362                      (progn
1363                        (push (caar alist) expired)
1364                        (setcdr prev (setq alist (cdr alist))))
1365                    (setq prev alist
1366                          alist (cdr alist))))
1367                (setq gnus-agent-article-alist (cdr first))
1368                (gnus-agent-save-alist group)
1369                ;; Mark all articles up to the first article
1370                ;; in `gnus-article-alist' as read.
1371                (when (caar gnus-agent-article-alist)
1372                  (setcar (nthcdr 2 info)
1373                          (gnus-range-add
1374                           (nth 2 info)
1375                           (cons 1 (- (caar gnus-agent-article-alist) 1)))))
1376                ;; Maybe everything has been expired from `gnus-article-alist'
1377                ;; and so the above marking as read could not be conducted,
1378                ;; or there are expired article within the range of the alist.
1379                (when (or (not (caar gnus-agent-article-alist))
1380                          (> (car expired) (caar gnus-agent-article-alist)))
1381                (setcar (nthcdr 2 info)
1382                        (gnus-add-to-range
1383                         (nth 2 info)
1384                         (nreverse expired))))
1385                (gnus-dribble-enter
1386                 (concat "(gnus-group-set-info '"
1387                         (gnus-prin1-to-string info)
1388                         ")"))))
1389            expiry-hashtb)
1390           (set-buffer history)
1391           (setq histories (nreverse (sort histories '<)))
1392           (while histories
1393             (goto-char (pop histories))
1394             (gnus-delete-line))
1395           (gnus-agent-save-history)
1396           (gnus-agent-close-history))
1397         (gnus-message 4 "Expiry...done"))))))
1398
1399 ;;;###autoload
1400 (defun gnus-agent-batch ()
1401   (interactive)
1402   (let ((init-file-user "")
1403         (gnus-always-read-dribble-file t))
1404     (gnus))
1405   (gnus-group-send-drafts)
1406   (gnus-agent-fetch-session))
1407
1408 (provide 'gnus-agent)
1409
1410 ;;; gnus-agent.el ends here