1 ;;; gnus-agent.el --- unplugged support for Gnus
2 ;; Copyright (C) 1997,98 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; This file is part of GNU Emacs.
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)
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.
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.
30 (eval-when-compile (require 'cl))
32 (defcustom gnus-agent-directory (nnheader-concat gnus-directory "agent/")
33 "Where the Gnus agent will store its files."
37 (defcustom gnus-agent-plugged-hook nil
38 "Hook run when plugging into the network."
42 (defcustom gnus-agent-unplugged-hook nil
43 "Hook run when unplugging from the network."
47 (defcustom gnus-agent-handle-level gnus-level-subscribed
48 "Groups on levels higher than this variable will be ignored by the Agent."
52 (defcustom gnus-agent-expire-days 7
53 "Read articles older than this will be expired."
57 (defcustom gnus-agent-expire-all nil
58 "If non-nil, also expire unread, ticked and dormant articles.
59 If nil, only read articles will be expired."
63 (defcustom gnus-agent-group-mode-hook nil
64 "Hook run in Agent group minor modes."
68 (defcustom gnus-agent-summary-mode-hook nil
69 "Hook run in Agent summary minor modes."
73 (defcustom gnus-agent-server-mode-hook nil
74 "Hook run in Agent summary minor modes."
78 ;;; Internal variables
80 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
82 (defvar gnus-agent-history-buffers nil)
83 (defvar gnus-agent-buffer-alist nil)
84 (defvar gnus-agent-article-alist nil)
85 (defvar gnus-agent-group-alist nil)
86 (defvar gnus-agent-covered-methods nil)
87 (defvar gnus-category-alist nil)
88 (defvar gnus-agent-current-history nil)
89 (defvar gnus-agent-overview-buffer nil)
90 (defvar gnus-category-predicate-cache nil)
91 (defvar gnus-category-group-cache nil)
92 (defvar gnus-agent-spam-hashtb nil)
93 (defvar gnus-agent-file-name nil)
94 (defvar gnus-agent-send-mail-function nil)
95 (defvar gnus-agent-article-file-coding-system 'no-conversion)
105 (defun gnus-open-agent ()
107 (gnus-agent-read-servers)
109 (setq gnus-agent-overview-buffer
110 (gnus-get-buffer-create " *Gnus agent overview*"))
111 (add-hook 'gnus-group-mode-hook 'gnus-agent-mode)
112 (add-hook 'gnus-summary-mode-hook 'gnus-agent-mode)
113 (add-hook 'gnus-server-mode-hook 'gnus-agent-mode))
115 (gnus-add-shutdown 'gnus-close-agent 'gnus)
117 (defun gnus-close-agent ()
118 (setq gnus-agent-covered-methods nil
119 gnus-category-predicate-cache nil
120 gnus-category-group-cache nil
121 gnus-agent-spam-hashtb nil)
122 (gnus-kill-buffer gnus-agent-overview-buffer))
125 ;;; Utility functions
128 (defun gnus-agent-read-file (file)
129 "Load FILE and do a `read' there."
130 (nnheader-temp-write nil
132 (insert-file-contents file)
133 (goto-char (point-min))
134 (read (current-buffer)))))
136 (defsubst gnus-agent-method ()
137 (concat (symbol-name (car gnus-command-method)) "/"
138 (if (equal (cadr gnus-command-method) "")
140 (cadr gnus-command-method))))
142 (defsubst gnus-agent-directory ()
143 "Path of the Gnus agent directory."
144 (nnheader-concat gnus-agent-directory
145 (nnheader-translate-file-chars (gnus-agent-method)) "/"))
147 (defun gnus-agent-lib-file (file)
148 "The full path of the Gnus agent library FILE."
149 (concat (gnus-agent-directory) "agent.lib/" file))
151 ;;; Fetching setup functions.
153 (defun gnus-agent-start-fetch ()
154 "Initialize data structures for efficient fetching."
155 (gnus-agent-open-history)
156 (setq gnus-agent-current-history (gnus-agent-history-buffer)))
158 (defun gnus-agent-stop-fetch ()
159 "Save all data structures and clean up."
160 (gnus-agent-save-history)
161 (gnus-agent-close-history)
162 (setq gnus-agent-spam-hashtb nil)
164 (set-buffer nntp-server-buffer)
167 (defmacro gnus-agent-with-fetch (&rest forms)
171 (gnus-agent-start-fetch)
173 (gnus-agent-stop-fetch)))
175 (put 'gnus-agent-with-fetch 'lisp-indent-function 0)
176 (put 'gnus-agent-with-fetch 'edebug-form-spec '(body))
182 (defvar gnus-agent-mode-hook nil
183 "Hook run when installing agent mode.")
185 (defvar gnus-agent-mode nil)
186 (defvar gnus-agent-mode-status '(gnus-agent-mode " Plugged"))
188 (defun gnus-agent-mode ()
189 "Minor mode for providing a agent support in Gnus buffers."
190 (let* ((buffer (progn (string-match "^gnus-\\(.*\\)-mode$"
191 (symbol-name major-mode))
192 (match-string 1 (symbol-name major-mode))))
193 (mode (intern (format "gnus-agent-%s-mode" buffer))))
194 (set (make-local-variable 'gnus-agent-mode) t)
196 (set (make-local-variable mode) t)
198 (when (gnus-visual-p 'agent-menu 'menu)
199 (funcall (intern (format "gnus-agent-%s-make-menu-bar" buffer))))
200 (unless (assq 'gnus-agent-mode minor-mode-alist)
201 (push gnus-agent-mode-status minor-mode-alist))
202 (unless (assq mode minor-mode-map-alist)
203 (push (cons mode (symbol-value (intern (format "gnus-agent-%s-mode-map"
205 minor-mode-map-alist))
206 (gnus-agent-toggle-plugged gnus-plugged)
207 (gnus-run-hooks 'gnus-agent-mode-hook
208 (intern (format "gnus-agent-%s-mode-hook" buffer)))))
210 (defvar gnus-agent-group-mode-map (make-sparse-keymap))
211 (gnus-define-keys gnus-agent-group-mode-map
212 "Ju" gnus-agent-fetch-groups
213 "Jc" gnus-enter-category-buffer
214 "Jj" gnus-agent-toggle-plugged
215 "Js" gnus-agent-fetch-session
216 "JS" gnus-group-send-drafts
217 "Ja" gnus-agent-add-group)
219 (defun gnus-agent-group-make-menu-bar ()
220 (unless (boundp 'gnus-agent-group-menu)
222 gnus-agent-group-menu gnus-agent-group-mode-map ""
224 ["Toggle plugged" gnus-agent-toggle-plugged t]
225 ["List categories" gnus-enter-category-buffer t]
226 ["Send drafts" gnus-group-send-drafts gnus-plugged]
228 ["All" gnus-agent-fetch-session gnus-plugged]
229 ["Group" gnus-agent-fetch-group gnus-plugged])))))
231 (defvar gnus-agent-summary-mode-map (make-sparse-keymap))
232 (gnus-define-keys gnus-agent-summary-mode-map
233 "Jj" gnus-agent-toggle-plugged
234 "J#" gnus-agent-mark-article
235 "J\M-#" gnus-agent-unmark-article
236 "@" gnus-agent-toggle-mark
237 "Jc" gnus-agent-catchup)
239 (defun gnus-agent-summary-make-menu-bar ()
240 (unless (boundp 'gnus-agent-summary-menu)
242 gnus-agent-summary-menu gnus-agent-summary-mode-map ""
244 ["Toggle plugged" gnus-agent-toggle-plugged t]
245 ["Mark as downloadable" gnus-agent-mark-article t]
246 ["Unmark as downloadable" gnus-agent-unmark-article t]
247 ["Toggle mark" gnus-agent-toggle-mark t]
248 ["Catchup undownloaded" gnus-agent-catchup t]))))
250 (defvar gnus-agent-server-mode-map (make-sparse-keymap))
251 (gnus-define-keys gnus-agent-server-mode-map
252 "Jj" gnus-agent-toggle-plugged
253 "Ja" gnus-agent-add-server
254 "Jr" gnus-agent-remove-server)
256 (defun gnus-agent-server-make-menu-bar ()
257 (unless (boundp 'gnus-agent-server-menu)
259 gnus-agent-server-menu gnus-agent-server-mode-map ""
261 ["Toggle plugged" gnus-agent-toggle-plugged t]
262 ["Add" gnus-agent-add-server t]
263 ["Remove" gnus-agent-remove-server t]))))
265 (defun gnus-agent-toggle-plugged (plugged)
266 "Toggle whether Gnus is unplugged or not."
267 (interactive (list (not gnus-plugged)))
270 (setq gnus-plugged plugged)
271 (gnus-run-hooks 'gnus-agent-plugged-hook)
272 (setcar (cdr gnus-agent-mode-status) " Plugged"))
273 (gnus-agent-close-connections)
274 (setq gnus-plugged plugged)
275 (gnus-run-hooks 'gnus-agent-unplugged-hook)
276 (setcar (cdr gnus-agent-mode-status) " Unplugged"))
277 (set-buffer-modified-p t))
279 (defun gnus-agent-close-connections ()
280 "Close all methods covered by the Gnus agent."
281 (let ((methods gnus-agent-covered-methods))
283 (gnus-close-server (pop methods)))))
286 (defun gnus-unplugged ()
287 "Start Gnus unplugged."
289 (setq gnus-plugged nil)
293 (defun gnus-plugged ()
294 "Start Gnus plugged."
296 (setq gnus-plugged t)
300 (defun gnus-agentize ()
301 "Allow Gnus to be an offline newsreader.
302 The normal usage of this command is to put the following as the
303 last form in your `.gnus.el' file:
307 This will modify the `gnus-before-startup-hook', `gnus-post-method',
308 and `message-send-mail-function' variables, and install the Gnus
309 agent minor mode in all Gnus buffers."
312 (add-hook 'gnus-setup-news-hook 'gnus-agent-queue-setup)
313 (unless gnus-agent-send-mail-function
314 (setq gnus-agent-send-mail-function message-send-mail-function
315 message-send-mail-function 'gnus-agent-send-mail))
316 (unless gnus-agent-covered-methods
317 (setq gnus-agent-covered-methods (list gnus-select-method))))
319 (defun gnus-agent-queue-setup ()
320 "Make sure the queue group exists."
321 (unless (gnus-gethash "nndraft:queue" gnus-newsrc-hashtb)
322 (gnus-request-create-group "queue" '(nndraft ""))
323 (let ((gnus-level-default-subscribed 1))
324 (gnus-subscribe-group "nndraft:queue" nil '(nndraft "")))
325 (gnus-group-set-parameter
326 "nndraft:queue" 'gnus-dummy '((gnus-draft-mode)))))
328 (defun gnus-agent-send-mail ()
330 (funcall gnus-agent-send-mail-function)
331 (goto-char (point-min))
333 (concat "^" (regexp-quote mail-header-separator) "\n"))
335 (gnus-agent-insert-meta-information 'mail)
336 (gnus-request-accept-article "nndraft:queue")))
338 (defun gnus-agent-insert-meta-information (type &optional method)
339 "Insert meta-information into the message that says how it's to be posted.
340 TYPE can be either `mail' or `news'. If the latter METHOD can
343 (message-remove-header gnus-agent-meta-information-header)
344 (goto-char (point-min))
345 (insert gnus-agent-meta-information-header ": "
346 (symbol-name type) " " (format "%S" method)
349 (while (search-backward "\n" nil t)
350 (replace-match "\\n" t t))))
353 ;;; Group mode commands
356 (defun gnus-agent-fetch-groups (n)
357 "Put all new articles in the current groups into the Agent."
359 (gnus-group-iterate n 'gnus-agent-fetch-group))
361 (defun gnus-agent-fetch-group (group)
362 "Put all new articles in GROUP into the Agent."
363 (interactive (list (gnus-group-group-name)))
365 (error "No group on the current line"))
366 (let ((gnus-command-method (gnus-find-method-for-group group)))
367 (gnus-agent-with-fetch
368 (gnus-agent-fetch-group-1 group gnus-command-method)
369 (gnus-message 5 "Fetching %s...done" group))))
371 (defun gnus-agent-add-group (category arg)
372 "Add the current group to an agent category."
378 (mapcar (lambda (cat) (list (symbol-name (car cat))))
382 (let ((cat (assq category gnus-category-alist))
384 (gnus-group-iterate arg
386 (when (cadddr (setq c (gnus-group-category group)))
387 (setf (cadddr c) (delete group (cadddr c))))
388 (push group groups)))
389 (setf (cadddr cat) (nconc (cadddr cat) groups))
390 (gnus-category-write)))
393 ;;; Server mode commands
396 (defun gnus-agent-add-server (server)
397 "Enroll SERVER in the agent program."
398 (interactive (list (gnus-server-server-name)))
400 (error "No server on the current line"))
401 (let ((method (gnus-server-get-method nil (gnus-server-server-name))))
402 (when (member method gnus-agent-covered-methods)
403 (error "Server already in the agent program"))
404 (push method gnus-agent-covered-methods)
405 (gnus-agent-write-servers)
406 (message "Entered %s into the Agent" server)))
408 (defun gnus-agent-remove-server (server)
409 "Remove SERVER from the agent program."
410 (interactive (list (gnus-server-server-name)))
412 (error "No server on the current line"))
413 (let ((method (gnus-server-get-method nil (gnus-server-server-name))))
414 (unless (member method gnus-agent-covered-methods)
415 (error "Server not in the agent program"))
416 (setq gnus-agent-covered-methods
417 (delete method gnus-agent-covered-methods))
418 (gnus-agent-write-servers)
419 (message "Removed %s from the agent" server)))
421 (defun gnus-agent-read-servers ()
422 "Read the alist of covered servers."
423 (setq gnus-agent-covered-methods
424 (gnus-agent-read-file
425 (nnheader-concat gnus-agent-directory "lib/servers"))))
427 (defun gnus-agent-write-servers ()
428 "Write the alist of covered servers."
429 (nnheader-temp-write (nnheader-concat gnus-agent-directory "lib/servers")
430 (prin1 gnus-agent-covered-methods (current-buffer))))
436 (defun gnus-agent-mark-article (n &optional unmark)
437 "Mark the next N articles as downloadable.
438 If N is negative, mark backward instead. If UNMARK is non-nil, remove
439 the mark instead. The difference between N and the actual number of
440 articles marked is returned."
442 (let ((backward (< n 0))
447 (gnus-summary-set-agent-mark
448 (gnus-summary-article-number) unmark)
449 (zerop (gnus-summary-next-subject (if backward -1 1) nil t))))
452 (gnus-message 7 "No more articles"))
453 (gnus-summary-recenter)
454 (gnus-summary-position-point)
457 (defun gnus-agent-unmark-article (n)
458 "Remove the downloadable mark from the next N articles.
459 If N is negative, unmark backward instead. The difference between N and
460 the actual number of articles unmarked is returned."
462 (gnus-agent-mark-article n t))
464 (defun gnus-agent-toggle-mark (n)
465 "Toggle the downloadable mark from the next N articles.
466 If N is negative, toggle backward instead. The difference between N and
467 the actual number of articles toggled is returned."
469 (gnus-agent-mark-article n 'toggle))
471 (defun gnus-summary-set-agent-mark (article &optional unmark)
472 "Mark ARTICLE as downloadable."
473 (let ((unmark (if (and (not (null unmark)) (not (eq t unmark)))
474 (memq article gnus-newsgroup-downloadable)
478 (setq gnus-newsgroup-downloadable
479 (delq article gnus-newsgroup-downloadable))
480 (push article gnus-newsgroup-undownloaded))
481 (setq gnus-newsgroup-undownloaded
482 (delq article gnus-newsgroup-undownloaded))
483 (push article gnus-newsgroup-downloadable))
484 (gnus-summary-update-mark
485 (if unmark gnus-undownloaded-mark gnus-downloadable-mark)
488 (defun gnus-agent-get-undownloaded-list ()
489 "Mark all unfetched articles as read."
490 (let ((gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name)))
491 (when (and (not gnus-plugged)
492 (gnus-agent-method-p gnus-command-method))
493 (gnus-agent-load-alist gnus-newsgroup-name)
494 (let ((articles gnus-newsgroup-unreads)
496 (while (setq article (pop articles))
497 (unless (or (cdr (assq article gnus-agent-article-alist))
498 (memq article gnus-newsgroup-downloadable))
499 (push article gnus-newsgroup-undownloaded)))))))
501 (defun gnus-agent-catchup ()
502 "Mark all undownloaded articles as read."
505 (while gnus-newsgroup-undownloaded
506 (gnus-summary-mark-article
507 (pop gnus-newsgroup-undownloaded) gnus-catchup-mark)))
508 (gnus-summary-position-point))
511 ;;; Internal functions
514 (defun gnus-agent-save-active (method)
515 (when (gnus-agent-method-p method)
516 (let* ((gnus-command-method method)
517 (file (gnus-agent-lib-file "active")))
518 (gnus-make-directory (file-name-directory file))
519 (let ((coding-system-for-write gnus-agent-article-file-coding-system))
520 (write-region (point-min) (point-max) file nil 'silent))
521 (when (file-exists-p (gnus-agent-lib-file "groups"))
522 (delete-file (gnus-agent-lib-file "groups"))))))
524 (defun gnus-agent-save-groups (method)
525 (let* ((gnus-command-method method)
526 (file (gnus-agent-lib-file "groups")))
527 (gnus-make-directory (file-name-directory file))
528 (write-region (point-min) (point-max) file nil 'silent))
529 (when (file-exists-p (gnus-agent-lib-file "active"))
530 (delete-file (gnus-agent-lib-file "active"))))
532 (defun gnus-agent-save-group-info (method group active)
533 (when (gnus-agent-method-p method)
534 (let* ((gnus-command-method method)
535 (file (if nntp-server-list-active-group
536 (gnus-agent-lib-file "active")
537 (gnus-agent-lib-file "groups"))))
538 (gnus-make-directory (file-name-directory file))
539 (nnheader-temp-write file
540 (when (file-exists-p file)
541 (insert-file-contents file))
542 (goto-char (point-min))
543 (if nntp-server-list-active-group
545 (when (re-search-forward
546 (concat "^" (regexp-quote group) " ") nil t)
548 (insert group " " (number-to-string (cdr active)) " "
549 (number-to-string (car active)) "\n"))
550 (when (re-search-forward (concat (regexp-quote group) " ") nil t)
552 (insert-buffer-substring nntp-server-buffer))))))
554 (defun gnus-agent-group-path (group)
555 "Translate GROUP into a path."
556 (if nnmail-use-long-file-names
557 (gnus-group-real-name group)
558 (nnheader-replace-chars-in-string
559 (nnheader-translate-file-chars (gnus-group-real-name group))
564 (defun gnus-agent-method-p (method)
565 "Say whether METHOD is covered by the agent."
566 (member method gnus-agent-covered-methods))
568 (defun gnus-agent-get-function (method)
569 (if (and (not gnus-plugged)
570 (gnus-agent-method-p method))
576 ;;; History functions
578 (defun gnus-agent-history-buffer ()
579 (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
581 (defun gnus-agent-open-history ()
583 (push (cons (gnus-agent-method)
584 (set-buffer (gnus-get-buffer-create
585 (format " *Gnus agent %s history*"
586 (gnus-agent-method)))))
587 gnus-agent-history-buffers)
590 (let ((file (gnus-agent-lib-file "history")))
591 (when (file-exists-p file)
593 (set (make-local-variable 'gnus-agent-file-name) file))))
595 (defun gnus-agent-save-history ()
597 (set-buffer gnus-agent-current-history)
598 (gnus-make-directory (file-name-directory gnus-agent-file-name))
599 (write-region (1+ (point-min)) (point-max)
600 gnus-agent-file-name nil 'silent)))
602 (defun gnus-agent-close-history ()
603 (when (gnus-buffer-live-p gnus-agent-current-history)
604 (kill-buffer gnus-agent-current-history)
605 (setq gnus-agent-history-buffers
606 (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
607 gnus-agent-history-buffers))))
609 (defun gnus-agent-enter-history (id group-arts date)
611 (set-buffer gnus-agent-current-history)
612 (goto-char (point-max))
613 (insert id "\t" (number-to-string date) "\t")
615 (insert (caar group-arts) " " (number-to-string (cdr (pop group-arts)))
619 (defun gnus-agent-article-in-history-p (id)
621 (set-buffer (gnus-agent-history-buffer))
622 (goto-char (point-min))
623 (search-forward (concat "\n" id "\t") nil t)))
625 (defun gnus-agent-history-path (id)
627 (set-buffer (gnus-agent-history-buffer))
628 (goto-char (point-min))
629 (when (search-forward (concat "\n" id "\t") nil t)
630 (let ((method (gnus-agent-method)))
632 (while (not (numberp (setq group (read (current-buffer)))))
633 (push (concat method "/" group) paths))
634 (nreverse paths))))))
640 (defun gnus-agent-fetch-articles (group articles)
641 "Fetch ARTICLES from GROUP and put them into the Agent."
643 ;; Prune off articles that we have already fetched.
645 (cdr (assq (car articles) gnus-agent-article-alist)))
647 (let ((arts articles))
649 (if (cdr (assq (cadr arts) gnus-agent-article-alist))
650 (setcdr arts (cddr arts))
651 (setq arts (cdr arts)))))
654 (gnus-agent-directory)
655 (gnus-agent-group-path group) "/"))
656 (date (gnus-time-to-day (current-time)))
658 pos alists crosses id elem)
659 (gnus-make-directory dir)
660 (gnus-message 7 "Fetching articles for %s..." group)
661 ;; Fetch the articles from the backend.
662 (if (gnus-check-backend-function 'retrieve-articles group)
663 (setq pos (gnus-retrieve-articles articles group))
664 (nnheader-temp-write nil
665 (let ((buf (current-buffer))
667 (while (setq article (pop articles))
668 (when (gnus-request-article article group)
669 (goto-char (point-max))
670 (push (cons article (point)) pos)
671 (insert-buffer-substring nntp-server-buffer)))
672 (copy-to-buffer nntp-server-buffer (point-min) (point-max))
673 (setq pos (nreverse pos)))))
674 ;; Then save these articles into the Agent.
676 (set-buffer nntp-server-buffer)
678 (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
679 (goto-char (point-min))
680 (when (search-forward "\n\n" nil t)
681 (when (search-backward "\nXrefs: " nil t)
682 ;; Handle crossposting.
683 (skip-chars-forward "^ ")
684 (skip-chars-forward " ")
686 (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) +")
687 (push (cons (buffer-substring (match-beginning 1)
689 (buffer-substring (match-beginning 2)
692 (goto-char (match-end 0)))
693 (gnus-agent-crosspost crosses (caar pos))))
694 (goto-char (point-min))
695 (if (not (re-search-forward "^Message-ID: *<\\([^>\n]+\\)>" nil t))
696 (setq id "No-Message-ID-in-article")
697 (setq id (buffer-substring (match-beginning 1) (match-end 1))))
698 (let ((coding-system-for-write
699 gnus-agent-article-file-coding-system))
700 (write-region (point-min) (point-max)
701 (concat dir (number-to-string (caar pos)))
703 (when (setq elem (assq (caar pos) gnus-agent-article-alist))
705 (gnus-agent-enter-history
706 id (or crosses (list (cons group (caar pos)))) date)
709 (gnus-agent-save-alist group)))))
711 (defun gnus-agent-crosspost (crosses article)
712 (let (gnus-agent-article-alist group alist beg end)
714 (set-buffer gnus-agent-overview-buffer)
715 (when (nnheader-find-nov-line article)
718 (setq end (progn (forward-line 1) (point)))))
720 (setq group (caar crosses))
721 (unless (setq alist (assoc group gnus-agent-group-alist))
722 (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
723 gnus-agent-group-alist))
724 (setcdr alist (cons (cons (cdar crosses) t) (cdr alist)))
726 (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
728 (when (= (point-max) (point-min))
729 (push (cons group (current-buffer)) gnus-agent-buffer-alist)
731 (insert-file-contents
732 (gnus-agent-article-name ".overview" group))))
733 (nnheader-find-nov-line (string-to-number (cdar crosses)))
734 (insert (string-to-number (cdar crosses)))
735 (insert-buffer-substring gnus-agent-overview-buffer beg end))
738 (defun gnus-agent-flush-cache ()
740 (while gnus-agent-buffer-alist
741 (set-buffer (cdar gnus-agent-buffer-alist))
742 (write-region (point-min) (point-max)
743 (gnus-agent-article-name ".overview"
744 (caar gnus-agent-buffer-alist))
746 (pop gnus-agent-buffer-alist))
747 (while gnus-agent-group-alist
748 (nnheader-temp-write (caar gnus-agent-group-alist)
749 (princ (cdar gnus-agent-group-alist))
751 (pop gnus-agent-group-alist))))
753 (defun gnus-agent-fetch-headers (group articles &optional force)
754 (gnus-agent-load-alist group)
755 ;; Find out what headers we need to retrieve.
758 (assq (car articles) gnus-agent-article-alist))
760 (let ((arts articles))
762 (if (assq (cadr arts) gnus-agent-article-alist)
763 (setcdr arts (cddr arts))
764 (setq arts (cdr arts)))))
767 (gnus-message 7 "Fetching headers for %s..." group)
769 (set-buffer nntp-server-buffer)
770 (unless (eq 'nov (gnus-retrieve-headers articles group))
771 (nnvirtual-convert-headers))
772 ;; Save these headers for later processing.
773 (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
776 (setq file (gnus-agent-article-name ".overview" group)))
777 (gnus-agent-braid-nov group articles file))
778 (gnus-make-directory (nnheader-translate-file-chars
779 (file-name-directory file)))
780 (write-region (point-min) (point-max) file nil 'silent)
781 (gnus-agent-save-alist group articles nil)
782 (gnus-agent-enter-history "last-header-fetched-for-session"
783 (list (cons group (nth (- (length articles) 1) articles)))
784 (gnus-time-to-day (current-time)))
787 (defsubst gnus-agent-copy-nov-line (article)
789 (set-buffer gnus-agent-overview-buffer)
791 (if (eq article (read (current-buffer)))
792 (setq e (progn (forward-line 1) (point)))
794 (set-buffer nntp-server-buffer)
795 (insert-buffer-substring gnus-agent-overview-buffer b e)))
797 (defun gnus-agent-braid-nov (group articles file)
799 (set-buffer gnus-agent-overview-buffer)
800 (goto-char (point-min))
801 (set-buffer nntp-server-buffer)
803 (insert-file-contents file)
804 (goto-char (point-max))
805 (if (or (= (point-min) (point-max))
808 (< (read (current-buffer)) (car articles))))
809 ;; We have only headers that are after the older headers,
810 ;; so we just append them.
812 (goto-char (point-max))
813 (insert-buffer-substring gnus-agent-overview-buffer))
814 ;; We do it the hard way.
815 (nnheader-find-nov-line (car articles))
816 (gnus-agent-copy-nov-line (car articles))
820 (while (and (not (eobp))
821 (< (read (current-buffer)) (car articles)))
825 (gnus-agent-copy-nov-line (car articles))
826 (setq articles (cdr articles))))
829 (set-buffer gnus-agent-overview-buffer)
832 (set-buffer nntp-server-buffer)
833 (insert-buffer-substring gnus-agent-overview-buffer b e))))))
835 (defun gnus-agent-load-alist (group &optional dir)
836 "Load the article-state alist for GROUP."
837 (setq gnus-agent-article-alist
838 (gnus-agent-read-file
840 (concat dir ".agentview")
841 (gnus-agent-article-name ".agentview" group)))))
843 (defun gnus-agent-save-alist (group &optional articles state dir)
844 "Load the article-state alist for GROUP."
845 (nnheader-temp-write (if dir
846 (concat dir ".agentview")
847 (gnus-agent-article-name ".agentview" group))
848 (princ (setq gnus-agent-article-alist
849 (nconc gnus-agent-article-alist
850 (mapcar (lambda (article) (cons article state))
855 (defun gnus-agent-article-name (article group)
856 (concat (gnus-agent-directory) (gnus-agent-group-path group) "/"
857 (if (stringp article) article (string-to-number article))))
860 (defun gnus-agent-batch-fetch ()
861 "Start Gnus and fetch session."
864 (gnus-agent-fetch-session)
867 (defun gnus-agent-fetch-session ()
868 "Fetch all articles and headers that are eligible for fetching."
870 (unless gnus-agent-covered-methods
871 (error "No servers are covered by the Gnus agent"))
873 (error "Can't fetch articles while Gnus is unplugged"))
874 (let ((methods gnus-agent-covered-methods)
875 groups group gnus-command-method)
878 (setq gnus-command-method (car methods))
879 (when (or (gnus-server-opened gnus-command-method)
880 (gnus-open-server gnus-command-method))
881 (setq groups (gnus-groups-from-server (car methods)))
882 (gnus-agent-with-fetch
883 (while (setq group (pop groups))
884 (when (<= (gnus-group-level group) gnus-agent-handle-level)
885 (gnus-agent-fetch-group-1 group gnus-command-method)))))
887 (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
889 (defun gnus-agent-fetch-group-1 (group method)
891 (let ((gnus-command-method method)
892 gnus-newsgroup-dependencies gnus-newsgroup-headers
893 gnus-newsgroup-scored gnus-headers gnus-score
894 gnus-use-cache articles score arts
895 category predicate info marks score-param)
897 (when (and (or (gnus-active group) (gnus-activate-group group))
898 (setq articles (gnus-list-of-unread-articles group))
899 (gnus-agent-fetch-headers group articles))
900 ;; Parse them and see which articles we want to fetch.
901 (setq gnus-newsgroup-dependencies
902 (make-vector (length articles) 0))
903 (setq gnus-newsgroup-headers
904 (gnus-get-newsgroup-headers-xover articles nil nil group))
905 (setq category (gnus-group-category group))
908 (or (gnus-group-get-parameter group 'agent-predicate)
911 (or (gnus-group-get-parameter group 'agent-score)
914 (gnus-score-headers (list (list score-param))))
916 (while (setq gnus-headers (pop gnus-newsgroup-headers))
918 (or (cdr (assq (mail-header-number gnus-headers)
919 gnus-newsgroup-scored))
920 gnus-summary-default-score))
921 (when (funcall predicate)
922 (push (mail-header-number gnus-headers)
924 ;; Fetch the articles.
926 (gnus-agent-fetch-articles group arts)))
927 ;; Perhaps we have some additional articles to fetch.
928 (setq arts (assq 'download (gnus-info-marks
929 (setq info (gnus-get-info group)))))
931 (gnus-agent-fetch-articles
932 group (gnus-uncompress-range (cdr arts)))
933 (setq marks (delq arts (gnus-info-marks info)))
934 (gnus-info-set-marks info marks))))
937 ;;; Agent Category Mode
940 (defvar gnus-category-mode-hook nil
941 "Hook run in `gnus-category-mode' buffers.")
943 (defvar gnus-category-line-format " %(%20c%): %g\n"
944 "Format of category lines.")
946 (defvar gnus-category-mode-line-format "Gnus: %%b"
947 "The format specification for the category mode line.")
949 (defvar gnus-agent-short-article 100
950 "Articles that have fewer lines than this are short.")
952 (defvar gnus-agent-long-article 200
953 "Articles that have more lines than this are long.")
955 (defvar gnus-agent-low-score 0
956 "Articles that have a score lower than this have a low score.")
958 (defvar gnus-agent-high-score 0
959 "Articles that have a score higher than this have a high score.")
962 ;;; Internal variables.
964 (defvar gnus-category-buffer "*Agent Category*")
966 (defvar gnus-category-line-format-alist
970 (defvar gnus-category-mode-line-format-alist
971 `((?u user-defined ?s)))
973 (defvar gnus-category-line-format-spec nil)
974 (defvar gnus-category-mode-line-format-spec nil)
976 (defvar gnus-category-mode-map nil)
977 (put 'gnus-category-mode 'mode-class 'special)
979 (unless gnus-category-mode-map
980 (setq gnus-category-mode-map (make-sparse-keymap))
981 (suppress-keymap gnus-category-mode-map)
983 (gnus-define-keys gnus-category-mode-map
984 "q" gnus-category-exit
985 "k" gnus-category-kill
986 "c" gnus-category-copy
987 "a" gnus-category-add
988 "p" gnus-category-edit-predicate
989 "g" gnus-category-edit-groups
990 "s" gnus-category-edit-score
991 "l" gnus-category-list
993 "\C-c\C-i" gnus-info-find-node
994 "\C-c\C-b" gnus-bug))
996 (defvar gnus-category-menu-hook nil
997 "*Hook run after the creation of the menu.")
999 (defun gnus-category-make-menu-bar ()
1000 (gnus-turn-off-edit-menu 'category)
1001 (unless (boundp 'gnus-category-menu)
1003 gnus-category-menu gnus-category-mode-map ""
1005 ["Add" gnus-category-add t]
1006 ["Kill" gnus-category-kill t]
1007 ["Copy" gnus-category-copy t]
1008 ["Edit predicate" gnus-category-edit-predicate t]
1009 ["Edit score" gnus-category-edit-score t]
1010 ["Edit groups" gnus-category-edit-groups t]
1011 ["Exit" gnus-category-exit t]))
1013 (gnus-run-hooks 'gnus-category-menu-hook)))
1015 (defun gnus-category-mode ()
1016 "Major mode for listing and editing agent categories.
1018 All normal editing commands are switched off.
1019 \\<gnus-category-mode-map>
1020 For more in-depth information on this mode, read the manual
1021 (`\\[gnus-info-find-node]').
1023 The following commands are available:
1025 \\{gnus-category-mode-map}"
1027 (when (gnus-visual-p 'category-menu 'menu)
1028 (gnus-category-make-menu-bar))
1029 (kill-all-local-variables)
1030 (gnus-simplify-mode-line)
1031 (setq major-mode 'gnus-category-mode)
1032 (setq mode-name "Category")
1033 (gnus-set-default-directory)
1034 (setq mode-line-process nil)
1035 (use-local-map gnus-category-mode-map)
1036 (buffer-disable-undo (current-buffer))
1037 (setq truncate-lines t)
1038 (setq buffer-read-only t)
1039 (gnus-run-hooks 'gnus-category-mode-hook))
1041 (defalias 'gnus-category-position-point 'gnus-goto-colon)
1043 (defun gnus-category-insert-line (category)
1044 (let* ((name (car category))
1045 (groups (length (cadddr category))))
1047 (gnus-add-text-properties
1051 (eval gnus-category-line-format-spec))
1052 (list 'gnus-category name))))
1054 (defun gnus-enter-category-buffer ()
1055 "Go to the Category buffer."
1057 (gnus-category-setup-buffer)
1058 (gnus-configure-windows 'category)
1059 (gnus-category-prepare))
1061 (defun gnus-category-setup-buffer ()
1062 (unless (get-buffer gnus-category-buffer)
1064 (set-buffer (gnus-get-buffer-create gnus-category-buffer))
1065 (gnus-category-mode))))
1067 (defun gnus-category-prepare ()
1068 (gnus-set-format 'category-mode)
1069 (gnus-set-format 'category t)
1070 (let ((alist gnus-category-alist)
1071 (buffer-read-only nil))
1074 (gnus-category-insert-line (pop alist)))
1075 (goto-char (point-min))
1076 (gnus-category-position-point)))
1078 (defun gnus-category-name ()
1079 (or (get-text-property (gnus-point-at-bol) 'gnus-category)
1080 (error "No category on the current line")))
1082 (defun gnus-category-read ()
1083 "Read the category alist."
1084 (setq gnus-category-alist
1085 (or (gnus-agent-read-file
1086 (nnheader-concat gnus-agent-directory "lib/categories"))
1087 (list (list 'default 'short nil nil)))))
1089 (defun gnus-category-write ()
1090 "Write the category alist."
1091 (setq gnus-category-predicate-cache nil
1092 gnus-category-group-cache nil)
1093 (nnheader-temp-write (nnheader-concat gnus-agent-directory "lib/categories")
1094 (prin1 gnus-category-alist (current-buffer))))
1096 (defun gnus-category-edit-predicate (category)
1097 "Edit the predicate for CATEGORY."
1098 (interactive (list (gnus-category-name)))
1099 (let ((info (assq category gnus-category-alist)))
1101 (cadr info) (format "Editing the predicate for category %s" category)
1102 `(lambda (predicate)
1103 (setf (cadr (assq ',category gnus-category-alist)) predicate)
1104 (gnus-category-write)
1105 (gnus-category-list)))))
1107 (defun gnus-category-edit-score (category)
1108 "Edit the score expression for CATEGORY."
1109 (interactive (list (gnus-category-name)))
1110 (let ((info (assq category gnus-category-alist)))
1113 (format "Editing the score expression for category %s" category)
1115 (setf (caddr (assq ',category gnus-category-alist)) groups)
1116 (gnus-category-write)
1117 (gnus-category-list)))))
1119 (defun gnus-category-edit-groups (category)
1120 "Edit the group list for CATEGORY."
1121 (interactive (list (gnus-category-name)))
1122 (let ((info (assq category gnus-category-alist)))
1124 (cadddr info) (format "Editing the group list for category %s" category)
1126 (setf (cadddr (assq ',category gnus-category-alist)) groups)
1127 (gnus-category-write)
1128 (gnus-category-list)))))
1130 (defun gnus-category-kill (category)
1131 "Kill the current category."
1132 (interactive (list (gnus-category-name)))
1133 (let ((info (assq category gnus-category-alist))
1134 (buffer-read-only nil))
1136 (gnus-category-write)
1137 (setq gnus-category-alist (delq info gnus-category-alist))))
1139 (defun gnus-category-copy (category to)
1140 "Copy the current category."
1141 (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
1142 (let ((info (assq category gnus-category-alist)))
1143 (push (list to (gnus-copy-sequence (cadr info))
1144 (gnus-copy-sequence (caddr info)) nil)
1145 gnus-category-alist)
1146 (gnus-category-write)
1147 (gnus-category-list)))
1149 (defun gnus-category-add (category)
1150 "Create a new category."
1151 (interactive "SCategory name: ")
1152 (when (assq category gnus-category-alist)
1153 (error "Category %s already exists" category))
1154 (push (list category 'true nil nil)
1155 gnus-category-alist)
1156 (gnus-category-write)
1157 (gnus-category-list))
1159 (defun gnus-category-list ()
1160 "List all categories."
1162 (gnus-category-prepare))
1164 (defun gnus-category-exit ()
1165 "Return to the group buffer."
1167 (kill-buffer (current-buffer))
1168 (gnus-configure-windows 'group t))
1170 ;; To avoid having 8-bit characters in the source file.
1171 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
1173 (defvar gnus-category-predicate-alist
1174 '((spam . gnus-agent-spam-p)
1175 (short . gnus-agent-short-p)
1176 (long . gnus-agent-long-p)
1177 (low . gnus-agent-low-scored-p)
1178 (high . gnus-agent-high-scored-p)
1179 (true . gnus-agent-true)
1180 (false . gnus-agent-false))
1181 "Mapping from short score predicate symbols to predicate functions.")
1183 (defun gnus-agent-spam-p ()
1184 "Say whether an article is spam or not."
1185 (unless gnus-agent-spam-hashtb
1186 (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
1187 (if (not (equal (mail-header-references gnus-headers) ""))
1189 (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
1191 (gnus-gethash string gnus-agent-spam-hashtb)
1192 (gnus-sethash string t gnus-agent-spam-hashtb)))))
1194 (defun gnus-agent-short-p ()
1195 "Say whether an article is short or not."
1196 (< (mail-header-lines gnus-headers) gnus-agent-short-article))
1198 (defun gnus-agent-long-p ()
1199 "Say whether an article is long or not."
1200 (> (mail-header-lines gnus-headers) gnus-agent-long-article))
1202 (defun gnus-agent-low-scored-p ()
1203 "Say whether an article has a low score or not."
1204 (< gnus-score gnus-agent-low-score))
1206 (defun gnus-agent-high-scored-p ()
1207 "Say whether an article has a high score or not."
1208 (> gnus-score gnus-agent-high-score))
1210 (defun gnus-category-make-function (cat)
1211 "Make a function from category CAT."
1212 `(lambda () ,(gnus-category-make-function-1 cat)))
1214 (defun gnus-agent-true ()
1218 (defun gnus-agent-false ()
1222 (defun gnus-category-make-function-1 (cat)
1223 "Make a function from category CAT."
1225 ;; Functions are just returned as is.
1227 (gnus-functionp cat))
1228 `(,(or (cdr (assq cat gnus-category-predicate-alist))
1230 ;; More complex category.
1233 ((memq (car cat) '(& and))
1235 ((memq (car cat) '(| or))
1237 ((memq (car cat) gnus-category-not)
1239 ,@(mapcar 'gnus-category-make-function-1 (cdr cat))))
1241 (error "Unknown category type: %s" cat))))
1243 (defun gnus-get-predicate (predicate)
1244 "Return the predicate for CATEGORY."
1245 (or (cdr (assoc predicate gnus-category-predicate-cache))
1246 (cdar (push (cons predicate
1247 (gnus-category-make-function predicate))
1248 gnus-category-predicate-cache))))
1250 (defun gnus-group-category (group)
1251 "Return the category GROUP belongs to."
1252 (unless gnus-category-group-cache
1253 (setq gnus-category-group-cache (gnus-make-hashtable 1000))
1254 (let ((cs gnus-category-alist)
1256 (while (setq cat (pop cs))
1257 (setq groups (cadddr cat))
1259 (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
1260 (or (gnus-gethash group gnus-category-group-cache)
1261 (assq 'default gnus-category-alist)))
1263 (defun gnus-agent-expire ()
1264 "Expire all old articles."
1266 (let ((methods gnus-agent-covered-methods)
1267 (day (- (gnus-time-to-day (current-time)) gnus-agent-expire-days))
1268 gnus-command-method sym group articles
1269 history overview file histories elem art nov-file low info
1270 unreads marked article)
1272 (setq overview (gnus-get-buffer-create " *expire overview*"))
1273 (while (setq gnus-command-method (pop methods))
1274 (let ((expiry-hashtb (gnus-make-hashtable 1023)))
1275 (gnus-agent-open-history)
1277 (setq gnus-agent-current-history
1278 (setq history (gnus-agent-history-buffer))))
1279 (goto-char (point-min))
1280 (when (> (buffer-size) 1)
1281 (goto-char (point-min))
1283 (skip-chars-forward "^\t")
1284 (if (> (read (current-buffer)) day)
1285 ;; New article; we don't expire it.
1287 ;; Old article. Schedule it for possible nuking.
1289 (setq sym (let ((obarray expiry-hashtb))
1290 (read (current-buffer))))
1292 (set sym (cons (cons (read (current-buffer)) (point))
1293 (symbol-value sym)))
1294 (set sym (list (cons (read (current-buffer)) (point)))))
1295 (skip-chars-forward " "))
1297 ;; We now have all articles that can possibly be expired.
1300 (setq group (symbol-name sym)
1301 articles (sort (symbol-value sym) 'car-less-than-car)
1302 low (car (gnus-active group))
1303 info (gnus-get-info group)
1304 unreads (ignore-errors (gnus-list-of-unread-articles group))
1305 marked (nconc (gnus-uncompress-range
1306 (cdr (assq 'tick (gnus-info-marks info))))
1307 (gnus-uncompress-range
1309 (gnus-info-marks info)))))
1310 nov-file (gnus-agent-article-name ".overview" group))
1311 (gnus-agent-load-alist group)
1312 (gnus-message 5 "Expiring articles in %s" group)
1313 (set-buffer overview)
1315 (when (file-exists-p nov-file)
1316 (insert-file-contents nov-file))
1317 (goto-char (point-min))
1319 (while (setq elem (pop articles))
1320 (setq article (car elem))
1321 (when (or (null low)
1323 gnus-agent-expire-all
1324 (and (not (memq article unreads))
1325 (not (memq article marked))))
1326 ;; Find and nuke the NOV line.
1327 (while (and (not (eobp))
1329 (setq art (read (current-buffer)))))
1332 (gnus-agent-article-name
1333 (number-to-string art) group))
1335 ;; Remove old NOV lines that have no articles.
1336 (gnus-delete-line)))
1341 ;; Nuke the article.
1342 (when (file-exists-p (setq file (gnus-agent-article-name
1343 (number-to-string article)
1346 ;; Schedule the history line for nuking.
1347 (push (cdr elem) histories)))
1348 (gnus-make-directory (file-name-directory nov-file))
1349 (write-region (point-min) (point-max) nov-file nil 'silent)
1350 ;; Delete the unwanted entries in the alist.
1351 (setq gnus-agent-article-alist
1352 (sort gnus-agent-article-alist 'car-less-than-car))
1353 (let* ((alist gnus-agent-article-alist)
1354 (prev (cons nil alist))
1357 (<= (caar alist) article))
1358 (if (or (not (cdar alist))
1360 (gnus-agent-article-name
1364 (setcdr prev (setq alist (cdr alist)))
1366 alist (cdr alist))))
1367 (setq gnus-agent-article-alist (cdr first))
1368 ;;; Mark all articles up to the first article
1369 ;;; in `gnus-article-alist' as read.
1370 (when (caar gnus-agent-article-alist)
1371 (setcar (nthcdr 2 info)
1374 (cons 1 (- (caar gnus-agent-article-alist) 1)))))
1376 (concat "(gnus-group-set-info '"
1377 (gnus-prin1-to-string info)
1379 (gnus-agent-save-alist group)))
1381 (set-buffer history)
1382 (setq histories (nreverse (sort histories '<)))
1384 (goto-char (pop histories))
1386 (gnus-agent-save-history)
1387 (gnus-agent-close-history))
1388 (gnus-message 4 "Expiry...done"))))))
1391 (defun gnus-agent-batch ()
1393 (let ((init-file-user "")
1394 (gnus-always-read-dribble-file t))
1396 (gnus-group-send-drafts)
1397 (gnus-agent-fetch-session))
1399 (provide 'gnus-agent)
1401 ;;; gnus-agent.el ends here