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

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