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 'raw-text)
  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       (mm-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   (gnus-agent-save-active-1 method 'gnus-active-to-gnus-format))
 550
 551 (defun gnus-agent-save-active-1 (method function)
 552   (when (gnus-agent-method-p method)
 553     (let* ((gnus-command-method method)
 554            (new (gnus-make-hashtable (count-lines (point-min) (point-max))))
 555            (file (gnus-agent-lib-file "active")))
 556       (funcall function nil new)
 557       (gnus-agent-write-active file new)
 558       (erase-buffer)
 559       (insert-file-contents-literally file))))
 560
 561 (defun gnus-agent-write-active (file new)
 562   (let ((orig (gnus-make-hashtable (count-lines (point-min) (point-max))))
 563         (file (gnus-agent-lib-file "active"))
 564         elem osym)
 565     (when (file-exists-p file)
 566       (with-temp-buffer
 567         (insert-file-contents file)
 568         (gnus-active-to-gnus-format nil orig))
 569       (mapatoms
 570        (lambda (sym)
 571          (when (and sym (boundp sym))
 572            (if (and (boundp (setq osym (intern (symbol-name sym) orig)))
 573                     (setq elem (symbol-value osym)))
 574                (setcdr elem (cdr (symbol-value sym)))
 575              (set (intern (symbol-name sym) orig) (symbol-value sym)))))
 576        new))
 577     (gnus-make-directory (file-name-directory file))
 578     (let ((coding-system-for-write gnus-agent-file-coding-system))
 579       (gnus-write-active-file file orig))))
 580
 581 (defun gnus-agent-save-groups (method)
 582   (gnus-agent-save-active-1 method 'gnus-groups-to-gnus-format))
 583
 584 (defun gnus-agent-save-group-info (method group active)
 585   (when (gnus-agent-method-p method)
 586     (let* ((gnus-command-method method)
 587            (file (gnus-agent-lib-file "active")))
 588       (gnus-make-directory (file-name-directory file))
 589       (with-temp-file file
 590         (when (file-exists-p file)
 591           (mm-insert-file-contents file))
 592         (goto-char (point-min))
 593         (when (re-search-forward
 594                (concat "^" (regexp-quote group) " ") nil t)
 595           (gnus-delete-line))
 596         (insert group " " (number-to-string (cdr active)) " "
 597                 (number-to-string (car active)) " y\n")))))
 598
 599 (defun gnus-agent-group-path (group)
 600   "Translate GROUP into a path."
 601   (if nnmail-use-long-file-names
 602       (gnus-group-real-name group)
 603     (nnheader-replace-chars-in-string
 604      (nnheader-translate-file-chars (gnus-group-real-name group))
 605      ?. ?/)))
 606
 607 \f
 608
 609 (defun gnus-agent-method-p (method)
 610   "Say whether METHOD is covered by the agent."
 611   (member method gnus-agent-covered-methods))
 612
 613 (defun gnus-agent-get-function (method)
 614   (if (and (not gnus-plugged)
 615            (gnus-agent-method-p method))
 616       (progn
 617         (require 'nnagent)
 618         'nnagent)
 619     (car method)))
 620
 621 ;;; History functions
 622
 623 (defun gnus-agent-history-buffer ()
 624   (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
 625
 626 (defun gnus-agent-open-history ()
 627   (save-excursion
 628     (push (cons (gnus-agent-method)
 629                 (set-buffer (gnus-get-buffer-create
 630                              (format " *Gnus agent %s history*"
 631                                      (gnus-agent-method)))))
 632           gnus-agent-history-buffers)
 633     (erase-buffer)
 634     (insert "\n")
 635     (let ((file (gnus-agent-lib-file "history")))
 636       (when (file-exists-p file)
 637         (insert-file file))
 638       (set (make-local-variable 'gnus-agent-file-name) file))))
 639
 640 (defun gnus-agent-save-history ()
 641   (save-excursion
 642     (set-buffer gnus-agent-current-history)
 643     (gnus-make-directory (file-name-directory gnus-agent-file-name))
 644     (let ((coding-system-for-write gnus-agent-file-coding-system))
 645       (write-region (1+ (point-min)) (point-max)
 646                     gnus-agent-file-name nil 'silent))))
 647
 648 (defun gnus-agent-close-history ()
 649   (when (gnus-buffer-live-p gnus-agent-current-history)
 650     (kill-buffer gnus-agent-current-history)
 651     (setq gnus-agent-history-buffers
 652           (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
 653                 gnus-agent-history-buffers))))
 654
 655 (defun gnus-agent-enter-history (id group-arts date)
 656   (save-excursion
 657     (set-buffer gnus-agent-current-history)
 658     (goto-char (point-max))
 659     (insert id "\t" (number-to-string date) "\t")
 660     (while group-arts
 661       (insert (caar group-arts) " " (number-to-string (cdr (pop group-arts)))
 662               " "))
 663     (insert "\n")))
 664
 665 (defun gnus-agent-article-in-history-p (id)
 666   (save-excursion
 667     (set-buffer (gnus-agent-history-buffer))
 668     (goto-char (point-min))
 669     (search-forward (concat "\n" id "\t") nil t)))
 670
 671 (defun gnus-agent-history-path (id)
 672   (save-excursion
 673     (set-buffer (gnus-agent-history-buffer))
 674     (goto-char (point-min))
 675     (when (search-forward (concat "\n" id "\t") nil t)
 676       (let ((method (gnus-agent-method)))
 677         (let (paths group)
 678           (while (not (numberp (setq group (read (current-buffer)))))
 679             (push (concat method "/" group) paths))
 680           (nreverse paths))))))
 681
 682 ;;;
 683 ;;; Fetching
 684 ;;;
 685
 686 (defun gnus-agent-fetch-articles (group articles)
 687   "Fetch ARTICLES from GROUP and put them into the Agent."
 688   (when articles
 689     ;; Prune off articles that we have already fetched.
 690     (while (and articles
 691                 (cdr (assq (car articles) gnus-agent-article-alist)))
 692      (pop articles))
 693     (let ((arts articles))
 694       (while (cdr arts)
 695         (if (cdr (assq (cadr arts) gnus-agent-article-alist))
 696             (setcdr arts (cddr arts))
 697           (setq arts (cdr arts)))))
 698     (when articles
 699       (let ((dir (concat
 700                   (gnus-agent-directory)
 701                   (gnus-agent-group-path group) "/"))
 702             (date (time-to-days (current-time)))
 703             (case-fold-search t)
 704             pos crosses id elem)
 705         (gnus-make-directory dir)
 706         (gnus-message 7 "Fetching articles for %s..." group)
 707         ;; Fetch the articles from the backend.
 708         (if (gnus-check-backend-function 'retrieve-articles group)
 709             (setq pos (gnus-retrieve-articles articles group))
 710           (with-temp-buffer
 711             (let (article)
 712               (while (setq article (pop articles))
 713                 (when (gnus-request-article article group)
 714                   (goto-char (point-max))
 715                   (push (cons article (point)) pos)
 716                   (insert-buffer-substring nntp-server-buffer)))
 717               (copy-to-buffer nntp-server-buffer (point-min) (point-max))
 718               (setq pos (nreverse pos)))))
 719         ;; Then save these articles into the Agent.
 720         (save-excursion
 721           (set-buffer nntp-server-buffer)
 722           (while pos
 723             (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
 724             (goto-char (point-min))
 725             (when (search-forward "\n\n" nil t)
 726               (when (search-backward "\nXrefs: " nil t)
 727                 ;; Handle crossposting.
 728                 (skip-chars-forward "^ ")
 729                 (skip-chars-forward " ")
 730                 (setq crosses nil)
 731                 (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) +")
 732                   (push (cons (buffer-substring (match-beginning 1)
 733                                                 (match-end 1))
 734                               (buffer-substring (match-beginning 2)
 735                                                 (match-end 2)))
 736                         crosses)
 737                   (goto-char (match-end 0)))
 738                 (gnus-agent-crosspost crosses (caar pos))))
 739             (goto-char (point-min))
 740             (if (not (re-search-forward "^Message-ID: *<\\([^>\n]+\\)>" nil t))
 741                 (setq id "No-Message-ID-in-article")
 742               (setq id (buffer-substring (match-beginning 1) (match-end 1))))
 743             (let ((coding-system-for-write
 744                    gnus-agent-file-coding-system))
 745               (write-region (point-min) (point-max)
 746                             (concat dir (number-to-string (caar pos)))
 747                             nil 'silent))
 748             (when (setq elem (assq (caar pos) gnus-agent-article-alist))
 749               (setcdr elem t))
 750             (gnus-agent-enter-history
 751              id (or crosses (list (cons group (caar pos)))) date)
 752             (widen)
 753             (pop pos)))
 754         (gnus-agent-save-alist group)))))
 755
 756 (defun gnus-agent-crosspost (crosses article)
 757   (let (gnus-agent-article-alist group alist beg end)
 758     (save-excursion
 759       (set-buffer gnus-agent-overview-buffer)
 760       (when (nnheader-find-nov-line article)
 761         (forward-word 1)
 762         (setq beg (point))
 763         (setq end (progn (forward-line 1) (point)))))
 764     (while crosses
 765       (setq group (caar crosses))
 766       (unless (setq alist (assoc group gnus-agent-group-alist))
 767         (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
 768               gnus-agent-group-alist))
 769       (setcdr alist (cons (cons (cdar crosses) t) (cdr alist)))
 770       (save-excursion
 771         (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
 772                                                group)))
 773         (when (= (point-max) (point-min))
 774           (push (cons group (current-buffer)) gnus-agent-buffer-alist)
 775           (ignore-errors
 776             (mm-insert-file-contents
 777              (gnus-agent-article-name ".overview" group))))
 778         (nnheader-find-nov-line (string-to-number (cdar crosses)))
 779         (insert (string-to-number (cdar crosses)))
 780         (insert-buffer-substring gnus-agent-overview-buffer beg end))
 781       (pop crosses))))
 782
 783 (defun gnus-agent-flush-cache ()
 784   (save-excursion
 785     (while gnus-agent-buffer-alist
 786       (set-buffer (cdar gnus-agent-buffer-alist))
 787       (let ((coding-system-for-write
 788              gnus-agent-file-coding-system))
 789         (write-region (point-min) (point-max)
 790                       (gnus-agent-article-name ".overview"
 791                                                (caar gnus-agent-buffer-alist))
 792                       nil 'silent))
 793       (pop gnus-agent-buffer-alist))
 794     (while gnus-agent-group-alist
 795       (with-temp-file (caar gnus-agent-group-alist)
 796         (princ (cdar gnus-agent-group-alist))
 797         (insert "\n"))
 798       (pop gnus-agent-group-alist))))
 799
 800 (defun gnus-agent-fetch-headers (group &optional force)
 801   (let ((articles (gnus-list-of-unread-articles group))
 802         (gnus-decode-encoded-word-function 'identity)
 803         (file (gnus-agent-article-name ".overview" group)))
 804     ;; add article with marks to list of article headers we want to fetch
 805     (dolist (arts (gnus-info-marks (gnus-get-info group)))
 806       (setq articles (union (gnus-uncompress-sequence (cdr arts))
 807                            articles)))
 808     (setq articles (sort articles '<))
 809     ;; remove known articles
 810     (when (gnus-agent-load-alist group)
 811       (setq articles (gnus-sorted-intersection
 812                      articles
 813                      (gnus-uncompress-range
 814                       (cons (1+ (caar (last gnus-agent-article-alist)))
 815                             (cdr (gnus-active group)))))))
 816     ;; Fetch them.
 817     (gnus-make-directory (nnheader-translate-file-chars
 818                           (file-name-directory file)))
 819     (when articles
 820       (gnus-message 7 "Fetching headers for %s..." group)
 821       (save-excursion
 822         (set-buffer nntp-server-buffer)
 823         (unless (eq 'nov (gnus-retrieve-headers articles group))
 824           (nnvirtual-convert-headers))
 825         ;; Save these headers for later processing.
 826         (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
 827         (when (file-exists-p file)
 828           (gnus-agent-braid-nov group articles file))
 829         (let ((coding-system-for-write
 830                gnus-agent-file-coding-system))
 831           (write-region (point-min) (point-max) file nil 'silent))
 832         (gnus-agent-save-alist group articles nil)
 833         (gnus-agent-enter-history
 834          "last-header-fetched-for-session"
 835          (list (cons group (nth (- (length  articles) 1) articles)))
 836          (time-to-days (current-time)))
 837         articles))))
 838
 839 (defsubst gnus-agent-copy-nov-line (article)
 840   (let (b e)
 841     (set-buffer gnus-agent-overview-buffer)
 842     (setq b (point))
 843     (if (eq article (read (current-buffer)))
 844         (setq e (progn (forward-line 1) (point)))
 845       (progn
 846         (beginning-of-line)
 847         (setq e b)))
 848     (set-buffer nntp-server-buffer)
 849     (insert-buffer-substring gnus-agent-overview-buffer b e)))
 850
 851 (defun gnus-agent-braid-nov (group articles file)
 852   (set-buffer gnus-agent-overview-buffer)
 853   (goto-char (point-min))
 854   (set-buffer nntp-server-buffer)
 855   (erase-buffer)
 856   (mm-insert-file-contents file)
 857   (goto-char (point-max))
 858   (if (or (= (point-min) (point-max))
 859           (progn
 860             (forward-line -1)
 861             (< (read (current-buffer)) (car articles))))
 862       ;; We have only headers that are after the older headers,
 863       ;; so we just append them.
 864       (progn
 865         (goto-char (point-max))
 866         (insert-buffer-substring gnus-agent-overview-buffer))
 867     ;; We do it the hard way.
 868     (nnheader-find-nov-line (car articles))
 869     (gnus-agent-copy-nov-line (car articles))
 870     (pop articles)
 871     (while (and articles
 872                 (not (eobp)))
 873       (while (and (not (eobp))
 874                   (< (read (current-buffer)) (car articles)))
 875         (forward-line 1))
 876       (beginning-of-line)
 877       (unless (eobp)
 878         (gnus-agent-copy-nov-line (car articles))
 879         (setq articles (cdr articles))))
 880     (when articles
 881       (let (b e)
 882         (set-buffer gnus-agent-overview-buffer)
 883         (setq b (point)
 884               e (point-max))
 885         (set-buffer nntp-server-buffer)
 886         (insert-buffer-substring gnus-agent-overview-buffer b e)))))
 887
 888 (defun gnus-agent-load-alist (group &optional dir)
 889   "Load the article-state alist for GROUP."
 890   (setq gnus-agent-article-alist
 891         (gnus-agent-read-file
 892          (if dir
 893              (concat dir ".agentview")
 894            (gnus-agent-article-name ".agentview" group)))))
 895
 896 (defun gnus-agent-save-alist (group &optional articles state dir)
 897   "Save the article-state alist for GROUP."
 898   (with-temp-file (if dir
 899                       (concat dir ".agentview")
 900                     (gnus-agent-article-name ".agentview" group))
 901     (princ (setq gnus-agent-article-alist
 902                  (nconc gnus-agent-article-alist
 903                         (mapcar (lambda (article) (cons article state))
 904                                 articles)))
 905            (current-buffer))
 906     (insert "\n")))
 907
 908 (defun gnus-agent-article-name (article group)
 909   (concat (gnus-agent-directory) (gnus-agent-group-path group) "/"
 910           (if (stringp article) article (string-to-number article))))
 911
 912 ;;;###autoload
 913 (defun gnus-agent-batch-fetch ()
 914   "Start Gnus and fetch session."
 915   (interactive)
 916   (gnus)
 917   (gnus-agent-fetch-session)
 918   (gnus-group-exit))
 919
 920 (defun gnus-agent-fetch-session ()
 921   "Fetch all articles and headers that are eligible for fetching."
 922   (interactive)
 923   (unless gnus-agent-covered-methods
 924     (error "No servers are covered by the Gnus agent"))
 925   (unless gnus-plugged
 926     (error "Can't fetch articles while Gnus is unplugged"))
 927   (let ((methods gnus-agent-covered-methods)
 928         groups group gnus-command-method)
 929     (save-excursion
 930       (while methods
 931         (setq gnus-command-method (car methods))
 932         (when (or (gnus-server-opened gnus-command-method)
 933                   (gnus-open-server gnus-command-method))
 934           (setq groups (gnus-groups-from-server (car methods)))
 935           (gnus-agent-with-fetch
 936             (while (setq group (pop groups))
 937               (when (<= (gnus-group-level group) gnus-agent-handle-level)
 938                 (gnus-agent-fetch-group-1 group gnus-command-method)))))
 939         (pop methods))
 940       (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
 941
 942 (defun gnus-agent-fetch-group-1 (group method)
 943   "Fetch GROUP."
 944   (let ((gnus-command-method method)
 945         (gnus-newsgroup-name group)
 946         gnus-newsgroup-dependencies gnus-newsgroup-headers
 947         gnus-newsgroup-scored gnus-headers gnus-score
 948         gnus-use-cache articles arts
 949         category predicate info marks score-param)
 950     ;; Fetch headers.
 951     (when (and (or (gnus-active group) (gnus-activate-group group))
 952                (setq articles (gnus-agent-fetch-headers group)))
 953       ;; Parse them and see which articles we want to fetch.
 954       (setq gnus-newsgroup-dependencies
 955             (make-vector (length articles) 0))
 956       ;; No need to call `gnus-get-newsgroup-headers-xover' with
 957       ;; the entire .overview for group as we still have the just
 958       ;; downloaded headers in `gnus-agent-overview-buffer'.
 959       (let ((nntp-server-buffer gnus-agent-overview-buffer))
 960         (setq gnus-newsgroup-headers
 961               (gnus-get-newsgroup-headers-xover articles nil nil group)))
 962       (setq category (gnus-group-category group))
 963       (setq predicate
 964             (gnus-get-predicate
 965              (or (gnus-group-get-parameter group 'agent-predicate t)
 966                  (cadr category))))
 967       ;; Do we want to download everything, or nothing?
 968       (if (or (eq (caaddr predicate) 'gnus-agent-true)
 969               (eq (caaddr predicate) 'gnus-agent-false))
 970           ;; Yes.
 971           (setq arts (symbol-value
 972                       (cadr (assoc (caaddr predicate)
 973                                    '((gnus-agent-true articles)
 974                                      (gnus-agent-false nil))))))
 975         ;; No, we need to decide what we want.
 976         (setq score-param
 977               (let ((score-method
 978                      (or
 979                       (gnus-group-get-parameter group 'agent-score t)
 980                       (caddr category))))
 981                 (when score-method
 982                   (require 'gnus-score)
 983                   (if (eq score-method 'file)
 984                       (let ((entries
 985                              (gnus-score-load-files
 986                               (gnus-all-score-files group)))
 987                             list score-file)
 988                         (while (setq list (car entries))
 989                           (push (car list) score-file)
 990                           (setq list (cdr list))
 991                           (while list
 992                             (when (member (caar list)
 993                                           gnus-agent-scoreable-headers)
 994                               (push (car list) score-file))
 995                             (setq list (cdr list)))
 996                           (setq score-param
 997                                 (append score-param (list (nreverse score-file)))
 998                                 score-file nil entries (cdr entries)))
 999                         (list score-param))
1000                     (if (stringp (car score-method))
1001                         score-method
1002                       (list (list score-method)))))))
1003         (when score-param
1004           (gnus-score-headers score-param))
1005         (setq arts nil)
1006         (while (setq gnus-headers (pop gnus-newsgroup-headers))
1007           (setq gnus-score
1008                 (or (cdr (assq (mail-header-number gnus-headers)
1009                                gnus-newsgroup-scored))
1010                     gnus-summary-default-score))
1011           (when (funcall predicate)
1012             (push (mail-header-number gnus-headers)
1013                   arts))))
1014       ;; Fetch the articles.
1015       (when arts
1016         (gnus-agent-fetch-articles group arts)))
1017     ;; Perhaps we have some additional articles to fetch.
1018     (setq arts (assq 'download (gnus-info-marks
1019                                 (setq info (gnus-get-info group)))))
1020     (when (cdr arts)
1021       (gnus-agent-fetch-articles
1022        group (gnus-uncompress-range (cdr arts)))
1023       (setq marks (delq arts (gnus-info-marks info)))
1024       (gnus-info-set-marks info marks)
1025       (gnus-dribble-enter
1026        (concat "(gnus-group-set-info '"
1027                (gnus-prin1-to-string info)
1028                ")")))))
1029
1030 ;;;
1031 ;;; Agent Category Mode
1032 ;;;
1033
1034 (defvar gnus-category-mode-hook nil
1035   "Hook run in `gnus-category-mode' buffers.")
1036
1037 (defvar gnus-category-line-format "     %(%20c%): %g\n"
1038   "Format of category lines.")
1039
1040 (defvar gnus-category-mode-line-format "Gnus: %%b"
1041   "The format specification for the category mode line.")
1042
1043 (defvar gnus-agent-short-article 100
1044   "Articles that have fewer lines than this are short.")
1045
1046 (defvar gnus-agent-long-article 200
1047   "Articles that have more lines than this are long.")
1048
1049 (defvar gnus-agent-low-score 0
1050   "Articles that have a score lower than this have a low score.")
1051
1052 (defvar gnus-agent-high-score 0
1053   "Articles that have a score higher than this have a high score.")
1054
1055
1056 ;;; Internal variables.
1057
1058 (defvar gnus-category-buffer "*Agent Category*")
1059
1060 (defvar gnus-category-line-format-alist
1061   `((?c gnus-tmp-name ?s)
1062     (?g gnus-tmp-groups ?d)))
1063
1064 (defvar gnus-category-mode-line-format-alist
1065   `((?u user-defined ?s)))
1066
1067 (defvar gnus-category-line-format-spec nil)
1068 (defvar gnus-category-mode-line-format-spec nil)
1069
1070 (defvar gnus-category-mode-map nil)
1071 (put 'gnus-category-mode 'mode-class 'special)
1072
1073 (unless gnus-category-mode-map
1074   (setq gnus-category-mode-map (make-sparse-keymap))
1075   (suppress-keymap gnus-category-mode-map)
1076
1077   (gnus-define-keys gnus-category-mode-map
1078     "q" gnus-category-exit
1079     "k" gnus-category-kill
1080     "c" gnus-category-copy
1081     "a" gnus-category-add
1082     "p" gnus-category-edit-predicate
1083     "g" gnus-category-edit-groups
1084     "s" gnus-category-edit-score
1085     "l" gnus-category-list
1086
1087     "\C-c\C-i" gnus-info-find-node
1088     "\C-c\C-b" gnus-bug))
1089
1090 (defvar gnus-category-menu-hook nil
1091   "*Hook run after the creation of the menu.")
1092
1093 (defun gnus-category-make-menu-bar ()
1094   (gnus-turn-off-edit-menu 'category)
1095   (unless (boundp 'gnus-category-menu)
1096     (easy-menu-define
1097      gnus-category-menu gnus-category-mode-map ""
1098      '("Categories"
1099        ["Add" gnus-category-add t]
1100        ["Kill" gnus-category-kill t]
1101        ["Copy" gnus-category-copy t]
1102        ["Edit predicate" gnus-category-edit-predicate t]
1103        ["Edit score" gnus-category-edit-score t]
1104        ["Edit groups" gnus-category-edit-groups t]
1105        ["Exit" gnus-category-exit t]))
1106
1107     (gnus-run-hooks 'gnus-category-menu-hook)))
1108
1109 (defun gnus-category-mode ()
1110   "Major mode for listing and editing agent categories.
1111
1112 All normal editing commands are switched off.
1113 \\<gnus-category-mode-map>
1114 For more in-depth information on this mode, read the manual
1115 (`\\[gnus-info-find-node]').
1116
1117 The following commands are available:
1118
1119 \\{gnus-category-mode-map}"
1120   (interactive)
1121   (when (gnus-visual-p 'category-menu 'menu)
1122     (gnus-category-make-menu-bar))
1123   (kill-all-local-variables)
1124   (gnus-simplify-mode-line)
1125   (setq major-mode 'gnus-category-mode)
1126   (setq mode-name "Category")
1127   (gnus-set-default-directory)
1128   (setq mode-line-process nil)
1129   (use-local-map gnus-category-mode-map)
1130   (buffer-disable-undo)
1131   (setq truncate-lines t)
1132   (setq buffer-read-only t)
1133   (gnus-run-hooks 'gnus-category-mode-hook))
1134
1135 (defalias 'gnus-category-position-point 'gnus-goto-colon)
1136
1137 (defun gnus-category-insert-line (category)
1138   (let* ((gnus-tmp-name (car category))
1139          (gnus-tmp-groups (length (cadddr category))))
1140     (beginning-of-line)
1141     (gnus-add-text-properties
1142      (point)
1143      (prog1 (1+ (point))
1144        ;; Insert the text.
1145        (eval gnus-category-line-format-spec))
1146      (list 'gnus-category gnus-tmp-name))))
1147
1148 (defun gnus-enter-category-buffer ()
1149   "Go to the Category buffer."
1150   (interactive)
1151   (gnus-category-setup-buffer)
1152   (gnus-configure-windows 'category)
1153   (gnus-category-prepare))
1154
1155 (defun gnus-category-setup-buffer ()
1156   (unless (get-buffer gnus-category-buffer)
1157     (save-excursion
1158       (set-buffer (gnus-get-buffer-create gnus-category-buffer))
1159       (gnus-category-mode))))
1160
1161 (defun gnus-category-prepare ()
1162   (gnus-set-format 'category-mode)
1163   (gnus-set-format 'category t)
1164   (let ((alist gnus-category-alist)
1165         (buffer-read-only nil))
1166     (erase-buffer)
1167     (while alist
1168       (gnus-category-insert-line (pop alist)))
1169     (goto-char (point-min))
1170     (gnus-category-position-point)))
1171
1172 (defun gnus-category-name ()
1173   (or (get-text-property (gnus-point-at-bol) 'gnus-category)
1174       (error "No category on the current line")))
1175
1176 (defun gnus-category-read ()
1177   "Read the category alist."
1178   (setq gnus-category-alist
1179         (or (gnus-agent-read-file
1180              (nnheader-concat gnus-agent-directory "lib/categories"))
1181             (list (list 'default 'short nil nil)))))
1182
1183 (defun gnus-category-write ()
1184   "Write the category alist."
1185   (setq gnus-category-predicate-cache nil
1186         gnus-category-group-cache nil)
1187   (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
1188   (with-temp-file (nnheader-concat gnus-agent-directory "lib/categories")
1189     (prin1 gnus-category-alist (current-buffer))))
1190
1191 (defun gnus-category-edit-predicate (category)
1192   "Edit the predicate for CATEGORY."
1193   (interactive (list (gnus-category-name)))
1194   (let ((info (assq category gnus-category-alist)))
1195     (gnus-edit-form
1196      (cadr info) (format "Editing the predicate for category %s" category)
1197      `(lambda (predicate)
1198         (setf (cadr (assq ',category gnus-category-alist)) predicate)
1199         (gnus-category-write)
1200         (gnus-category-list)))))
1201
1202 (defun gnus-category-edit-score (category)
1203   "Edit the score expression for CATEGORY."
1204   (interactive (list (gnus-category-name)))
1205   (let ((info (assq category gnus-category-alist)))
1206     (gnus-edit-form
1207      (caddr info)
1208      (format "Editing the score expression for category %s" category)
1209      `(lambda (groups)
1210         (setf (caddr (assq ',category gnus-category-alist)) groups)
1211         (gnus-category-write)
1212         (gnus-category-list)))))
1213
1214 (defun gnus-category-edit-groups (category)
1215   "Edit the group list for CATEGORY."
1216   (interactive (list (gnus-category-name)))
1217   (let ((info (assq category gnus-category-alist)))
1218     (gnus-edit-form
1219      (cadddr info) (format "Editing the group list for category %s" category)
1220      `(lambda (groups)
1221         (setf (cadddr (assq ',category gnus-category-alist)) groups)
1222         (gnus-category-write)
1223         (gnus-category-list)))))
1224
1225 (defun gnus-category-kill (category)
1226   "Kill the current category."
1227   (interactive (list (gnus-category-name)))
1228   (let ((info (assq category gnus-category-alist))
1229         (buffer-read-only nil))
1230     (gnus-delete-line)
1231     (gnus-category-write)
1232     (setq gnus-category-alist (delq info gnus-category-alist))))
1233
1234 (defun gnus-category-copy (category to)
1235   "Copy the current category."
1236   (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
1237   (let ((info (assq category gnus-category-alist)))
1238     (push (list to (gnus-copy-sequence (cadr info))
1239                 (gnus-copy-sequence (caddr info)) nil)
1240           gnus-category-alist)
1241     (gnus-category-write)
1242     (gnus-category-list)))
1243
1244 (defun gnus-category-add (category)
1245   "Create a new category."
1246   (interactive "SCategory name: ")
1247   (when (assq category gnus-category-alist)
1248     (error "Category %s already exists" category))
1249   (push (list category 'false nil nil)
1250         gnus-category-alist)
1251   (gnus-category-write)
1252   (gnus-category-list))
1253
1254 (defun gnus-category-list ()
1255   "List all categories."
1256   (interactive)
1257   (gnus-category-prepare))
1258
1259 (defun gnus-category-exit ()
1260   "Return to the group buffer."
1261   (interactive)
1262   (kill-buffer (current-buffer))
1263   (gnus-configure-windows 'group t))
1264
1265 ;; To avoid having 8-bit characters in the source file.
1266 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
1267
1268 (defvar gnus-category-predicate-alist
1269   '((spam . gnus-agent-spam-p)
1270     (short . gnus-agent-short-p)
1271     (long . gnus-agent-long-p)
1272     (low . gnus-agent-low-scored-p)
1273     (high . gnus-agent-high-scored-p)
1274     (true . gnus-agent-true)
1275     (false . gnus-agent-false))
1276   "Mapping from short score predicate symbols to predicate functions.")
1277
1278 (defun gnus-agent-spam-p ()
1279   "Say whether an article is spam or not."
1280   (unless gnus-agent-spam-hashtb
1281     (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
1282   (if (not (equal (mail-header-references gnus-headers) ""))
1283       nil
1284     (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
1285       (prog1
1286           (gnus-gethash string gnus-agent-spam-hashtb)
1287         (gnus-sethash string t gnus-agent-spam-hashtb)))))
1288
1289 (defun gnus-agent-short-p ()
1290   "Say whether an article is short or not."
1291   (< (mail-header-lines gnus-headers) gnus-agent-short-article))
1292
1293 (defun gnus-agent-long-p ()
1294   "Say whether an article is long or not."
1295   (> (mail-header-lines gnus-headers) gnus-agent-long-article))
1296
1297 (defun gnus-agent-low-scored-p ()
1298   "Say whether an article has a low score or not."
1299   (< gnus-score gnus-agent-low-score))
1300
1301 (defun gnus-agent-high-scored-p ()
1302   "Say whether an article has a high score or not."
1303   (> gnus-score gnus-agent-high-score))
1304
1305 (defun gnus-category-make-function (cat)
1306   "Make a function from category CAT."
1307   `(lambda () ,(gnus-category-make-function-1 cat)))
1308
1309 (defun gnus-agent-true ()
1310   "Return t."
1311   t)
1312
1313 (defun gnus-agent-false ()
1314   "Return nil."
1315   nil)
1316
1317 (defun gnus-category-make-function-1 (cat)
1318   "Make a function from category CAT."
1319   (cond
1320    ;; Functions are just returned as is.
1321    ((or (symbolp cat)
1322         (gnus-functionp cat))
1323     `(,(or (cdr (assq cat gnus-category-predicate-alist))
1324            cat)))
1325    ;; More complex category.
1326    ((consp cat)
1327     `(,(cond
1328         ((memq (car cat) '(& and))
1329          'and)
1330         ((memq (car cat) '(| or))
1331          'or)
1332         ((memq (car cat) gnus-category-not)
1333          'not))
1334       ,@(mapcar 'gnus-category-make-function-1 (cdr cat))))
1335    (t
1336     (error "Unknown category type: %s" cat))))
1337
1338 (defun gnus-get-predicate (predicate)
1339   "Return the predicate for CATEGORY."
1340   (or (cdr (assoc predicate gnus-category-predicate-cache))
1341       (cdar (push (cons predicate
1342                         (gnus-category-make-function predicate))
1343                   gnus-category-predicate-cache))))
1344
1345 (defun gnus-group-category (group)
1346   "Return the category GROUP belongs to."
1347   (unless gnus-category-group-cache
1348     (setq gnus-category-group-cache (gnus-make-hashtable 1000))
1349     (let ((cs gnus-category-alist)
1350           groups cat)
1351       (while (setq cat (pop cs))
1352         (setq groups (cadddr cat))
1353         (while groups
1354           (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
1355   (or (gnus-gethash group gnus-category-group-cache)
1356       (assq 'default gnus-category-alist)))
1357
1358 (defun gnus-agent-expire ()
1359   "Expire all old articles."
1360   (interactive)
1361   (let ((methods gnus-agent-covered-methods)
1362         (day (- (time-to-days (current-time)) gnus-agent-expire-days))
1363         gnus-command-method sym group articles
1364         history overview file histories elem art nov-file low info
1365         unreads marked article orig lowest highest)
1366     (save-excursion
1367       (with-temp-buffer
1368         (insert-file-contents file)
1369         (gnus-active-to-gnus-format
1370          nil (setq orig (gnus-make-hashtable
1371                          (count-lines (point-min) (point-max))))))
1372       (setq overview (gnus-get-buffer-create " *expire overview*"))
1373       (while (setq gnus-command-method (pop methods))
1374         (let ((expiry-hashtb (gnus-make-hashtable 1023)))
1375         (gnus-agent-open-history)
1376         (set-buffer
1377          (setq gnus-agent-current-history
1378                (setq history (gnus-agent-history-buffer))))
1379         (goto-char (point-min))
1380         (when (> (buffer-size) 1)
1381           (goto-char (point-min))
1382           (while (not (eobp))
1383             (skip-chars-forward "^\t")
1384             (if (> (read (current-buffer)) day)
1385                 ;; New article; we don't expire it.
1386                 (forward-line 1)
1387               ;; Old article.  Schedule it for possible nuking.
1388               (while (not (eolp))
1389                 (setq sym (let ((obarray expiry-hashtb))
1390                             (read (current-buffer))))
1391                 (if (boundp sym)
1392                     (set sym (cons (cons (read (current-buffer)) (point))
1393                                    (symbol-value sym)))
1394                   (set sym (list (cons (read (current-buffer)) (point)))))
1395                 (skip-chars-forward " "))
1396               (forward-line 1)))
1397           ;; We now have all articles that can possibly be expired.
1398           (mapatoms
1399            (lambda (sym)
1400              (setq group (symbol-name sym)
1401                    articles (sort (symbol-value sym) 'car-less-than-car)
1402                    low (car (gnus-active group))
1403                    info (gnus-get-info group)
1404                    unreads (ignore-errors (gnus-list-of-unread-articles group))
1405                    marked (nconc (gnus-uncompress-range
1406                                   (cdr (assq 'tick (gnus-info-marks info))))
1407                                  (gnus-uncompress-range
1408                                   (cdr (assq 'dormant
1409                                              (gnus-info-marks info)))))
1410                    nov-file (gnus-agent-article-name ".overview" group)
1411                    lowest nil
1412                    highest nil)
1413              (gnus-agent-load-alist group)
1414              (gnus-message 5 "Expiring articles in %s" group)
1415              (set-buffer overview)
1416              (erase-buffer)
1417              (when (file-exists-p nov-file)
1418                (mm-insert-file-contents nov-file))
1419              (goto-char (point-min))
1420              (setq article 0)
1421              (while (setq elem (pop articles))
1422                (setq article (car elem))
1423                (when (or (null low)
1424                          (< article low)
1425                          gnus-agent-expire-all
1426                          (and (not (memq article unreads))
1427                               (not (memq article marked))))
1428                  ;; Find and nuke the NOV line.
1429                  (while (and (not (eobp))
1430                              (or (not (numberp
1431                                        (setq art (read (current-buffer)))))
1432                                  (< art article)))
1433                    (if (file-exists-p
1434                         (gnus-agent-article-name
1435                          (number-to-string art) group))
1436                        (progn
1437                          (unless lowest
1438                            (setq lowest art))
1439                          (setq highest art)
1440                          (forward-line 1))
1441                      ;; Remove old NOV lines that have no articles.
1442                      (gnus-delete-line)))
1443                  (if (or (eobp)
1444                          (/= art article))
1445                      (beginning-of-line)
1446                    (gnus-delete-line))
1447                  ;; Nuke the article.
1448                  (when (file-exists-p (setq file (gnus-agent-article-name
1449                                                   (number-to-string article)
1450                                                   group)))
1451                    (delete-file file))
1452                  ;; Schedule the history line for nuking.
1453                  (push (cdr elem) histories)))
1454              (gnus-make-directory (file-name-directory nov-file))
1455              (let ((coding-system-for-write
1456                     gnus-agent-file-coding-system))
1457                (write-region (point-min) (point-max) nov-file nil 'silent))
1458              ;; Delete the unwanted entries in the alist.
1459              (setq gnus-agent-article-alist
1460                    (sort gnus-agent-article-alist 'car-less-than-car))
1461              (let* ((alist gnus-agent-article-alist)
1462                     (prev (cons nil alist))
1463                     (first prev)
1464                     expired)
1465                (while (and alist
1466                            (<= (caar alist) article))
1467                  (if (or (not (cdar alist))
1468                          (not (file-exists-p
1469                                (gnus-agent-article-name
1470                                 (number-to-string
1471                                  (caar alist))
1472                                 group))))
1473                      (progn
1474                        (push (caar alist) expired)
1475                        (setcdr prev (setq alist (cdr alist))))
1476                    (setq prev alist
1477                          alist (cdr alist))))
1478                (setq gnus-agent-article-alist (cdr first))
1479                (gnus-agent-save-alist group)
1480                ;; Mark all articles up to the first article
1481                ;; in `gnus-article-alist' as read.
1482                (when (and info (caar gnus-agent-article-alist))
1483                  (setcar (nthcdr 2 info)
1484                          (gnus-range-add
1485                           (nth 2 info)
1486                           (cons 1 (- (caar gnus-agent-article-alist) 1)))))
1487                ;; Maybe everything has been expired from `gnus-article-alist'
1488                ;; and so the above marking as read could not be conducted,
1489                ;; or there are expired article within the range of the alist.
1490                (when (and info
1491                           expired
1492                           (or (not (caar gnus-agent-article-alist))
1493                               (> (car expired)
1494                                  (caar gnus-agent-article-alist))))
1495                  (setcar (nthcdr 2 info)
1496                          (gnus-add-to-range
1497                           (nth 2 info)
1498                           (nreverse expired))))
1499                (gnus-dribble-enter
1500                 (concat "(gnus-group-set-info '"
1501                         (gnus-prin1-to-string info)
1502                         ")")))
1503              (when lowest
1504                (if (gnus-gethash group orig)
1505                    (setcar (gnus-gethash group orig) lowest)
1506                  (gnus-sethash group (cons lowest highest) orig))))
1507            expiry-hashtb)
1508           (set-buffer history)
1509           (setq histories (nreverse (sort histories '<)))
1510           (while histories
1511             (goto-char (pop histories))
1512             (gnus-delete-line))
1513           (gnus-agent-save-history)
1514           (gnus-agent-close-history)
1515           (gnus-write-active-file
1516            (gnus-agent-lib-file "active") orig))
1517         (gnus-message 4 "Expiry...done"))))))
1518
1519 ;;;###autoload
1520 (defun gnus-agent-batch ()
1521   (interactive)
1522   (let ((init-file-user "")
1523         (gnus-always-read-dribble-file t))
1524     (gnus))
1525   (gnus-group-send-drafts)
1526   (gnus-agent-fetch-session))
1527
1528 (provide 'gnus-agent)
1529
1530 ;;; gnus-agent.el ends here