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

   1 ;;; gnus-agent.el --- unplugged support for Semi-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   (when (gnus-agent-load-alist group)
 755     (let ((articles (gnus-uncompress-range
 756                      (cons (1+ (caar (last (gnus-agent-load-alist group))))
 757                            (cdr (gnus-active group))))))
 758       ;; Fetch them.
 759       (when articles
 760         (gnus-message 7 "Fetching headers for %s..." group)
 761         (save-excursion
 762           (set-buffer nntp-server-buffer)
 763           (unless (eq 'nov (gnus-retrieve-headers articles group))
 764             (nnvirtual-convert-headers))
 765           (goto-char (point-min))
 766           (while (not (eobp))
 767             (goto-char (point-at-eol))
 768             (insert "\t")
 769             (forward-line 1))
 770           ;; Save these headers for later processing.
 771           (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
 772           (let (file)
 773             (when (file-exists-p
 774                    (setq file (gnus-agent-article-name ".overview" group)))
 775               (gnus-agent-braid-nov group articles file))
 776             (gnus-make-directory (nnheader-translate-file-chars
 777                                   (file-name-directory file)))
 778             (write-region (point-min) (point-max) file nil 'silent)
 779             (gnus-agent-save-alist group articles nil)
 780             (gnus-agent-enter-history
 781              "last-header-fetched-for-session"
 782              (list (cons group (nth (- (length  articles) 1) articles)))
 783              (gnus-time-to-day (current-time)))
 784             articles))))))
 785
 786 (defsubst gnus-agent-copy-nov-line (article)
 787   (let (b e)
 788     (set-buffer gnus-agent-overview-buffer)
 789     (setq b (point))
 790     (if (eq article (read (current-buffer)))
 791         (setq e (progn (forward-line 1) (point)))
 792       (progn
 793         (beginning-of-line)
 794         (setq e b)))
 795     (set-buffer nntp-server-buffer)
 796     (insert-buffer-substring gnus-agent-overview-buffer b e)))
 797
 798 (defun gnus-agent-braid-nov (group articles file)
 799   (set-buffer gnus-agent-overview-buffer)
 800   (goto-char (point-min))
 801   (set-buffer nntp-server-buffer)
 802   (erase-buffer)
 803   (nnheader-insert-file-contents file)
 804   (goto-char (point-max))
 805   (if (or (= (point-min) (point-max))
 806           (progn
 807             (forward-line -1)
 808             (< (read (current-buffer)) (car articles))))
 809       ;; We have only headers that are after the older headers,
 810       ;; so we just append them.
 811       (progn
 812         (goto-char (point-max))
 813         (insert-buffer-substring gnus-agent-overview-buffer))
 814     ;; We do it the hard way.
 815     (nnheader-find-nov-line (car articles))
 816     (gnus-agent-copy-nov-line (car articles))
 817     (pop articles)
 818     (while (and articles
 819                 (not (eobp)))
 820       (while (and (not (eobp))
 821                   (< (read (current-buffer)) (car articles)))
 822         (forward-line 1))
 823       (beginning-of-line)
 824       (unless (eobp)
 825         (gnus-agent-copy-nov-line (car articles))
 826         (setq articles (cdr articles))))
 827     (when articles
 828       (let (b e)
 829         (set-buffer gnus-agent-overview-buffer)
 830         (setq b (point)
 831               e (point-max))
 832         (set-buffer nntp-server-buffer)
 833         (insert-buffer-substring gnus-agent-overview-buffer b e)))))
 834
 835 (defun gnus-agent-load-alist (group &optional dir)
 836   "Load the article-state alist for GROUP."
 837   (setq gnus-agent-article-alist
 838         (gnus-agent-read-file
 839          (if dir
 840              (concat dir ".agentview")
 841            (gnus-agent-article-name ".agentview" group)))))
 842
 843 (defun gnus-agent-save-alist (group &optional articles state dir)
 844   "Save the article-state alist for GROUP."
 845   (nnheader-temp-write (if dir
 846                            (concat dir ".agentview")
 847                          (gnus-agent-article-name ".agentview" group))
 848     (princ (setq gnus-agent-article-alist
 849                  (nconc gnus-agent-article-alist
 850                         (mapcar (lambda (article) (cons article state))
 851                                 articles)))
 852            (current-buffer))
 853     (insert "\n")))
 854
 855 (defun gnus-agent-article-name (article group)
 856   (concat (gnus-agent-directory) (gnus-agent-group-path group) "/"
 857           (if (stringp article) article (string-to-number article))))
 858
 859 ;;;###autoload
 860 (defun gnus-agent-batch-fetch ()
 861   "Start Gnus and fetch session."
 862   (interactive)
 863   (gnus)
 864   (gnus-agent-fetch-session)
 865   (gnus-group-exit))
 866
 867 (defun gnus-agent-fetch-session ()
 868   "Fetch all articles and headers that are eligible for fetching."
 869   (interactive)
 870   (unless gnus-agent-covered-methods
 871     (error "No servers are covered by the Gnus agent"))
 872   (unless gnus-plugged
 873     (error "Can't fetch articles while Gnus is unplugged"))
 874   (let ((methods gnus-agent-covered-methods)
 875         groups group gnus-command-method)
 876     (save-excursion
 877       (while methods
 878         (setq gnus-command-method (car methods))
 879         (when (or (gnus-server-opened gnus-command-method)
 880                   (gnus-open-server gnus-command-method))
 881           (setq groups (gnus-groups-from-server (car methods)))
 882           (gnus-agent-with-fetch
 883             (while (setq group (pop groups))
 884               (when (<= (gnus-group-level group) gnus-agent-handle-level)
 885                 (gnus-agent-fetch-group-1 group gnus-command-method)))))
 886         (pop methods))
 887       (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
 888
 889 (defun gnus-agent-fetch-group-1 (group method)
 890   "Fetch GROUP."
 891   (let ((gnus-command-method method)
 892         gnus-newsgroup-dependencies gnus-newsgroup-headers
 893         gnus-newsgroup-scored gnus-headers gnus-score
 894         gnus-use-cache articles arts
 895         category predicate info marks score-param)
 896     ;; Fetch headers.
 897     (when (and (or (gnus-active group) (gnus-activate-group group))
 898                (setq articles (gnus-agent-fetch-headers group)))
 899       ;; Parse them and see which articles we want to fetch.
 900       (setq gnus-newsgroup-dependencies
 901             (make-vector (length articles) 0))
 902       (setq gnus-newsgroup-headers
 903             (gnus-get-newsgroup-headers-xover articles nil nil group))
 904       (setq category (gnus-group-category group))
 905       (setq predicate
 906             (gnus-get-predicate
 907              (or (gnus-group-get-parameter group 'agent-predicate)
 908                  (cadr category))))
 909       (setq score-param
 910             (or (gnus-group-get-parameter group 'agent-score)
 911                 (caddr category)))
 912       (when score-param
 913         (gnus-score-headers (list (list score-param))))
 914       (setq arts nil)
 915       (while (setq gnus-headers (pop gnus-newsgroup-headers))
 916         (setq gnus-score
 917               (or (cdr (assq (mail-header-number gnus-headers)
 918                              gnus-newsgroup-scored))
 919                   gnus-summary-default-score))
 920         (when (funcall predicate)
 921           (push (mail-header-number gnus-headers)
 922                 arts)))
 923       ;; Fetch the articles.
 924       (when arts
 925         (gnus-agent-fetch-articles group arts)))
 926     ;; Perhaps we have some additional articles to fetch.
 927     (setq arts (assq 'download (gnus-info-marks
 928                                 (setq info (gnus-get-info group)))))
 929     (when (cdr arts)
 930       (gnus-agent-fetch-articles
 931        group (gnus-uncompress-range (cdr arts)))
 932       (setq marks (delq arts (gnus-info-marks info)))
 933       (gnus-info-set-marks info marks))))
 934
 935 ;;;
 936 ;;; Agent Category Mode
 937 ;;;
 938
 939 (defvar gnus-category-mode-hook nil
 940   "Hook run in `gnus-category-mode' buffers.")
 941
 942 (defvar gnus-category-line-format "     %(%20c%): %g\n"
 943   "Format of category lines.")
 944
 945 (defvar gnus-category-mode-line-format "Gnus: %%b"
 946   "The format specification for the category mode line.")
 947
 948 (defvar gnus-agent-short-article 100
 949   "Articles that have fewer lines than this are short.")
 950
 951 (defvar gnus-agent-long-article 200
 952   "Articles that have more lines than this are long.")
 953
 954 (defvar gnus-agent-low-score 0
 955   "Articles that have a score lower than this have a low score.")
 956
 957 (defvar gnus-agent-high-score 0
 958   "Articles that have a score higher than this have a high score.")
 959
 960
 961 ;;; Internal variables.
 962
 963 (defvar gnus-category-buffer "*Agent Category*")
 964
 965 (defvar gnus-category-line-format-alist
 966   `((?c gnus-tmp-name ?s)
 967     (?g gnus-tmp-groups ?d)))
 968
 969 (defvar gnus-category-mode-line-format-alist
 970   `((?u user-defined ?s)))
 971
 972 (defvar gnus-category-line-format-spec nil)
 973 (defvar gnus-category-mode-line-format-spec nil)
 974
 975 (defvar gnus-category-mode-map nil)
 976 (put 'gnus-category-mode 'mode-class 'special)
 977
 978 (unless gnus-category-mode-map
 979   (setq gnus-category-mode-map (make-sparse-keymap))
 980   (suppress-keymap gnus-category-mode-map)
 981
 982   (gnus-define-keys gnus-category-mode-map
 983     "q" gnus-category-exit
 984     "k" gnus-category-kill
 985     "c" gnus-category-copy
 986     "a" gnus-category-add
 987     "p" gnus-category-edit-predicate
 988     "g" gnus-category-edit-groups
 989     "s" gnus-category-edit-score
 990     "l" gnus-category-list
 991
 992     "\C-c\C-i" gnus-info-find-node
 993     "\C-c\C-b" gnus-bug))
 994
 995 (defvar gnus-category-menu-hook nil
 996   "*Hook run after the creation of the menu.")
 997
 998 (defun gnus-category-make-menu-bar ()
 999   (gnus-turn-off-edit-menu 'category)
1000   (unless (boundp 'gnus-category-menu)
1001     (easy-menu-define
1002      gnus-category-menu gnus-category-mode-map ""
1003      '("Categories"
1004        ["Add" gnus-category-add t]
1005        ["Kill" gnus-category-kill t]
1006        ["Copy" gnus-category-copy t]
1007        ["Edit predicate" gnus-category-edit-predicate t]
1008        ["Edit score" gnus-category-edit-score t]
1009        ["Edit groups" gnus-category-edit-groups t]
1010        ["Exit" gnus-category-exit t]))
1011
1012     (gnus-run-hooks 'gnus-category-menu-hook)))
1013
1014 (defun gnus-category-mode ()
1015   "Major mode for listing and editing agent categories.
1016
1017 All normal editing commands are switched off.
1018 \\<gnus-category-mode-map>
1019 For more in-depth information on this mode, read the manual
1020 (`\\[gnus-info-find-node]').
1021
1022 The following commands are available:
1023
1024 \\{gnus-category-mode-map}"
1025   (interactive)
1026   (when (gnus-visual-p 'category-menu 'menu)
1027     (gnus-category-make-menu-bar))
1028   (kill-all-local-variables)
1029   (gnus-simplify-mode-line)
1030   (setq major-mode 'gnus-category-mode)
1031   (setq mode-name "Category")
1032   (gnus-set-default-directory)
1033   (setq mode-line-process nil)
1034   (use-local-map gnus-category-mode-map)
1035   (buffer-disable-undo (current-buffer))
1036   (setq truncate-lines t)
1037   (setq buffer-read-only t)
1038   (gnus-run-hooks 'gnus-category-mode-hook))
1039
1040 (defalias 'gnus-category-position-point 'gnus-goto-colon)
1041
1042 (defun gnus-category-insert-line (category)
1043   (let* ((gnus-tmp-name (car category))
1044          (gnus-tmp-groups (length (cadddr category))))
1045     (beginning-of-line)
1046     (gnus-add-text-properties
1047      (point)
1048      (prog1 (1+ (point))
1049        ;; Insert the text.
1050        (eval gnus-category-line-format-spec))
1051      (list 'gnus-category gnus-tmp-name))))
1052
1053 (defun gnus-enter-category-buffer ()
1054   "Go to the Category buffer."
1055   (interactive)
1056   (gnus-category-setup-buffer)
1057   (gnus-configure-windows 'category)
1058   (gnus-category-prepare))
1059
1060 (defun gnus-category-setup-buffer ()
1061   (unless (get-buffer gnus-category-buffer)
1062     (save-excursion
1063       (set-buffer (gnus-get-buffer-create gnus-category-buffer))
1064       (gnus-category-mode))))
1065
1066 (defun gnus-category-prepare ()
1067   (gnus-set-format 'category-mode)
1068   (gnus-set-format 'category t)
1069   (let ((alist gnus-category-alist)
1070         (buffer-read-only nil))
1071     (erase-buffer)
1072     (while alist
1073       (gnus-category-insert-line (pop alist)))
1074     (goto-char (point-min))
1075     (gnus-category-position-point)))
1076
1077 (defun gnus-category-name ()
1078   (or (get-text-property (gnus-point-at-bol) 'gnus-category)
1079       (error "No category on the current line")))
1080
1081 (defun gnus-category-read ()
1082   "Read the category alist."
1083   (setq gnus-category-alist
1084         (or (gnus-agent-read-file
1085              (nnheader-concat gnus-agent-directory "lib/categories"))
1086             (list (list 'default 'short nil nil)))))
1087
1088 (defun gnus-category-write ()
1089   "Write the category alist."
1090   (setq gnus-category-predicate-cache nil
1091         gnus-category-group-cache nil)
1092   (nnheader-temp-write (nnheader-concat gnus-agent-directory "lib/categories")
1093     (prin1 gnus-category-alist (current-buffer))))
1094
1095 (defun gnus-category-edit-predicate (category)
1096   "Edit the predicate for CATEGORY."
1097   (interactive (list (gnus-category-name)))
1098   (let ((info (assq category gnus-category-alist)))
1099     (gnus-edit-form
1100      (cadr info) (format "Editing the predicate for category %s" category)
1101      `(lambda (predicate)
1102         (setf (cadr (assq ',category gnus-category-alist)) predicate)
1103         (gnus-category-write)
1104         (gnus-category-list)))))
1105
1106 (defun gnus-category-edit-score (category)
1107   "Edit the score expression for CATEGORY."
1108   (interactive (list (gnus-category-name)))
1109   (let ((info (assq category gnus-category-alist)))
1110     (gnus-edit-form
1111      (caddr info)
1112      (format "Editing the score expression for category %s" category)
1113      `(lambda (groups)
1114         (setf (caddr (assq ',category gnus-category-alist)) groups)
1115         (gnus-category-write)
1116         (gnus-category-list)))))
1117
1118 (defun gnus-category-edit-groups (category)
1119   "Edit the group list for CATEGORY."
1120   (interactive (list (gnus-category-name)))
1121   (let ((info (assq category gnus-category-alist)))
1122     (gnus-edit-form
1123      (cadddr info) (format "Editing the group list for category %s" category)
1124      `(lambda (groups)
1125         (setf (cadddr (assq ',category gnus-category-alist)) groups)
1126         (gnus-category-write)
1127         (gnus-category-list)))))
1128
1129 (defun gnus-category-kill (category)
1130   "Kill the current category."
1131   (interactive (list (gnus-category-name)))
1132   (let ((info (assq category gnus-category-alist))
1133         (buffer-read-only nil))
1134     (gnus-delete-line)
1135     (gnus-category-write)
1136     (setq gnus-category-alist (delq info gnus-category-alist))))
1137
1138 (defun gnus-category-copy (category to)
1139   "Copy the current category."
1140   (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
1141   (let ((info (assq category gnus-category-alist)))
1142     (push (list to (gnus-copy-sequence (cadr info))
1143                 (gnus-copy-sequence (caddr info)) nil)
1144           gnus-category-alist)
1145     (gnus-category-write)
1146     (gnus-category-list)))
1147
1148 (defun gnus-category-add (category)
1149   "Create a new category."
1150   (interactive "SCategory name: ")
1151   (when (assq category gnus-category-alist)
1152     (error "Category %s already exists" category))
1153   (push (list category 'true nil nil)
1154         gnus-category-alist)
1155   (gnus-category-write)
1156   (gnus-category-list))
1157
1158 (defun gnus-category-list ()
1159   "List all categories."
1160   (interactive)
1161   (gnus-category-prepare))
1162
1163 (defun gnus-category-exit ()
1164   "Return to the group buffer."
1165   (interactive)
1166   (kill-buffer (current-buffer))
1167   (gnus-configure-windows 'group t))
1168
1169 ;; To avoid having 8-bit characters in the source file.
1170 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
1171
1172 (defvar gnus-category-predicate-alist
1173   '((spam . gnus-agent-spam-p)
1174     (short . gnus-agent-short-p)
1175     (long . gnus-agent-long-p)
1176     (low . gnus-agent-low-scored-p)
1177     (high . gnus-agent-high-scored-p)
1178     (true . gnus-agent-true)
1179     (false . gnus-agent-false))
1180   "Mapping from short score predicate symbols to predicate functions.")
1181
1182 (defun gnus-agent-spam-p ()
1183   "Say whether an article is spam or not."
1184   (unless gnus-agent-spam-hashtb
1185     (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
1186   (if (not (equal (mail-header-references gnus-headers) ""))
1187       nil
1188     (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
1189       (prog1
1190           (gnus-gethash string gnus-agent-spam-hashtb)
1191         (gnus-sethash string t gnus-agent-spam-hashtb)))))
1192
1193 (defun gnus-agent-short-p ()
1194   "Say whether an article is short or not."
1195   (< (mail-header-lines gnus-headers) gnus-agent-short-article))
1196
1197 (defun gnus-agent-long-p ()
1198   "Say whether an article is long or not."
1199   (> (mail-header-lines gnus-headers) gnus-agent-long-article))
1200
1201 (defun gnus-agent-low-scored-p ()
1202   "Say whether an article has a low score or not."
1203   (< gnus-score gnus-agent-low-score))
1204
1205 (defun gnus-agent-high-scored-p ()
1206   "Say whether an article has a high score or not."
1207   (> gnus-score gnus-agent-high-score))
1208
1209 (defun gnus-category-make-function (cat)
1210   "Make a function from category CAT."
1211   `(lambda () ,(gnus-category-make-function-1 cat)))
1212
1213 (defun gnus-agent-true ()
1214   "Return t."
1215   t)
1216
1217 (defun gnus-agent-false ()
1218   "Return nil."
1219   nil)
1220
1221 (defun gnus-category-make-function-1 (cat)
1222   "Make a function from category CAT."
1223   (cond
1224    ;; Functions are just returned as is.
1225    ((or (symbolp cat)
1226         (gnus-functionp cat))
1227     `(,(or (cdr (assq cat gnus-category-predicate-alist))
1228            cat)))
1229    ;; More complex category.
1230    ((consp cat)
1231     `(,(cond
1232         ((memq (car cat) '(& and))
1233          'and)
1234         ((memq (car cat) '(| or))
1235          'or)
1236         ((memq (car cat) gnus-category-not)
1237          'not))
1238       ,@(mapcar 'gnus-category-make-function-1 (cdr cat))))
1239    (t
1240     (error "Unknown category type: %s" cat))))
1241
1242 (defun gnus-get-predicate (predicate)
1243   "Return the predicate for CATEGORY."
1244   (or (cdr (assoc predicate gnus-category-predicate-cache))
1245       (cdar (push (cons predicate
1246                         (gnus-category-make-function predicate))
1247                   gnus-category-predicate-cache))))
1248
1249 (defun gnus-group-category (group)
1250   "Return the category GROUP belongs to."
1251   (unless gnus-category-group-cache
1252     (setq gnus-category-group-cache (gnus-make-hashtable 1000))
1253     (let ((cs gnus-category-alist)
1254           groups cat)
1255       (while (setq cat (pop cs))
1256         (setq groups (cadddr cat))
1257         (while groups
1258           (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
1259   (or (gnus-gethash group gnus-category-group-cache)
1260       (assq 'default gnus-category-alist)))
1261
1262 (defun gnus-agent-expire ()
1263   "Expire all old articles."
1264   (interactive)
1265   (let ((methods gnus-agent-covered-methods)
1266         (day (- (gnus-time-to-day (current-time)) gnus-agent-expire-days))
1267         gnus-command-method sym group articles
1268         history overview file histories elem art nov-file low info
1269         unreads marked article)
1270     (save-excursion
1271       (setq overview (gnus-get-buffer-create " *expire overview*"))
1272       (while (setq gnus-command-method (pop methods))
1273         (let ((expiry-hashtb (gnus-make-hashtable 1023)))
1274         (gnus-agent-open-history)
1275         (set-buffer
1276          (setq gnus-agent-current-history
1277                (setq history (gnus-agent-history-buffer))))
1278         (goto-char (point-min))
1279         (when (> (buffer-size) 1)
1280           (goto-char (point-min))
1281           (while (not (eobp))
1282             (skip-chars-forward "^\t")
1283             (if (> (read (current-buffer)) day)
1284                 ;; New article; we don't expire it.
1285                 (forward-line 1)
1286               ;; Old article.  Schedule it for possible nuking.
1287               (while (not (eolp))
1288                 (setq sym (let ((obarray expiry-hashtb))
1289                             (read (current-buffer))))
1290                 (if (boundp sym)
1291                     (set sym (cons (cons (read (current-buffer)) (point))
1292                                    (symbol-value sym)))
1293                   (set sym (list (cons (read (current-buffer)) (point)))))
1294                 (skip-chars-forward " "))
1295               (forward-line 1)))
1296           ;; We now have all articles that can possibly be expired.
1297           (mapatoms
1298            (lambda (sym)
1299              (setq group (symbol-name sym)
1300                    articles (sort (symbol-value sym) 'car-less-than-car)
1301                    low (car (gnus-active group))
1302                    info (gnus-get-info group)
1303                    unreads (ignore-errors (gnus-list-of-unread-articles group))
1304                    marked (nconc (gnus-uncompress-range
1305                                   (cdr (assq 'tick (gnus-info-marks info))))
1306                                  (gnus-uncompress-range
1307                                   (cdr (assq 'dormant
1308                                              (gnus-info-marks info)))))
1309                    nov-file (gnus-agent-article-name ".overview" group))
1310              (gnus-agent-load-alist group)
1311              (gnus-message 5 "Expiring articles in %s" group)
1312              (set-buffer overview)
1313              (erase-buffer)
1314              (when (file-exists-p nov-file)
1315                (nnheader-insert-file-contents nov-file))
1316              (goto-char (point-min))
1317              (setq article 0)
1318              (while (setq elem (pop articles))
1319                (setq article (car elem))
1320                (when (or (null low)
1321                          (< article low)
1322                          gnus-agent-expire-all
1323                          (and (not (memq article unreads))
1324                               (not (memq article marked))))
1325                  ;; Find and nuke the NOV line.
1326                  (while (and (not (eobp))
1327                              (or (not (numberp
1328                                        (setq art (read (current-buffer)))))
1329                                  (< art article)))
1330                    (if (file-exists-p
1331                         (gnus-agent-article-name
1332                          (number-to-string art) group))
1333                        (forward-line 1)
1334                      ;; Remove old NOV lines that have no articles.
1335                      (gnus-delete-line)))
1336                  (if (or (eobp)
1337                          (/= art article))
1338                      (beginning-of-line)
1339                    (gnus-delete-line))
1340                  ;; Nuke the article.
1341                  (when (file-exists-p (setq file (gnus-agent-article-name
1342                                                   (number-to-string article)
1343                                                   group)))
1344                    (delete-file file))
1345                  ;; Schedule the history line for nuking.
1346                  (push (cdr elem) histories)))
1347              (gnus-make-directory (file-name-directory nov-file))
1348              (write-region (point-min) (point-max) nov-file nil 'silent)
1349              ;; Delete the unwanted entries in the alist.
1350              (setq gnus-agent-article-alist
1351                    (sort gnus-agent-article-alist 'car-less-than-car))
1352              (let* ((alist gnus-agent-article-alist)
1353                     (prev (cons nil alist))
1354                     (first prev))
1355                (while (and alist
1356                            (<= (caar alist) article))
1357                  (if (or (not (cdar alist))
1358                          (not (file-exists-p
1359                                (gnus-agent-article-name
1360                                 (number-to-string
1361                                  (caar alist))
1362                                 group))))
1363                      (setcdr prev (setq alist (cdr alist)))
1364                    (setq prev alist
1365                          alist (cdr alist))))
1366                (setq gnus-agent-article-alist (cdr first))
1367                ;;; Mark all articles up to the first article
1368                ;;; in `gnus-article-alist' as read.
1369                (when (caar gnus-agent-article-alist)
1370                  (setcar (nthcdr 2 info)
1371                          (gnus-range-add
1372                           (nth 2 info)
1373                           (cons 1 (- (caar gnus-agent-article-alist) 1)))))
1374                (gnus-dribble-enter
1375                 (concat "(gnus-group-set-info '"
1376                         (gnus-prin1-to-string info)
1377                         ")"))
1378                (gnus-agent-save-alist group)))
1379            expiry-hashtb)
1380           (set-buffer history)
1381           (setq histories (nreverse (sort histories '<)))
1382           (while histories
1383             (goto-char (pop histories))
1384             (gnus-delete-line))
1385           (gnus-agent-save-history)
1386           (gnus-agent-close-history))
1387         (gnus-message 4 "Expiry...done"))))))
1388
1389 ;;;###autoload
1390 (defun gnus-agent-batch ()
1391   (interactive)
1392   (let ((init-file-user "")
1393         (gnus-always-read-dribble-file t))
1394     (gnus))
1395   (gnus-group-send-drafts)
1396   (gnus-agent-fetch-session))
1397
1398 (provide 'gnus-agent)
1399
1400 ;;; gnus-agent.el ends here