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