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 (gnus-agent-lib-file "active")))
536 (gnus-make-directory (file-name-directory file))
537 (nnheader-temp-write file
538 (when (file-exists-p file)
539 (insert-file-contents file))
540 (goto-char (point-min))
541 (when (re-search-forward (concat "^" (regexp-quote group) " ") nil t)
543 (insert group " " (number-to-string (cdr active)) " "
544 (number-to-string (car active)) "\n")))))
546 (defun gnus-agent-group-path (group)
547 "Translate GROUP into a path."
548 (if nnmail-use-long-file-names
549 (gnus-group-real-name group)
550 (nnheader-replace-chars-in-string
551 (nnheader-translate-file-chars (gnus-group-real-name group))
556 (defun gnus-agent-method-p (method)
557 "Say whether METHOD is covered by the agent."
558 (member method gnus-agent-covered-methods))
560 (defun gnus-agent-get-function (method)
561 (if (and (not gnus-plugged)
562 (gnus-agent-method-p method))
568 ;;; History functions
570 (defun gnus-agent-history-buffer ()
571 (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
573 (defun gnus-agent-open-history ()
575 (push (cons (gnus-agent-method)
576 (set-buffer (gnus-get-buffer-create
577 (format " *Gnus agent %s history*"
578 (gnus-agent-method)))))
579 gnus-agent-history-buffers)
582 (let ((file (gnus-agent-lib-file "history")))
583 (when (file-exists-p file)
585 (set (make-local-variable 'gnus-agent-file-name) file))))
587 (defun gnus-agent-save-history ()
589 (set-buffer gnus-agent-current-history)
590 (gnus-make-directory (file-name-directory gnus-agent-file-name))
591 (write-region (1+ (point-min)) (point-max)
592 gnus-agent-file-name nil 'silent)))
594 (defun gnus-agent-close-history ()
595 (when (gnus-buffer-live-p gnus-agent-current-history)
596 (kill-buffer gnus-agent-current-history)
597 (setq gnus-agent-history-buffers
598 (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
599 gnus-agent-history-buffers))))
601 (defun gnus-agent-enter-history (id group-arts date)
603 (set-buffer gnus-agent-current-history)
604 (goto-char (point-max))
605 (insert id "\t" (number-to-string date) "\t")
607 (insert (caar group-arts) " " (number-to-string (cdr (pop group-arts)))
611 (defun gnus-agent-article-in-history-p (id)
613 (set-buffer (gnus-agent-history-buffer))
614 (goto-char (point-min))
615 (search-forward (concat "\n" id "\t") nil t)))
617 (defun gnus-agent-history-path (id)
619 (set-buffer (gnus-agent-history-buffer))
620 (goto-char (point-min))
621 (when (search-forward (concat "\n" id "\t") nil t)
622 (let ((method (gnus-agent-method)))
624 (while (not (numberp (setq group (read (current-buffer)))))
625 (push (concat method "/" group) paths))
626 (nreverse paths))))))
632 (defun gnus-agent-fetch-articles (group articles)
633 "Fetch ARTICLES from GROUP and put them into the Agent."
635 ;; Prune off articles that we have already fetched.
637 (cdr (assq (car articles) gnus-agent-article-alist)))
639 (let ((arts articles))
641 (if (cdr (assq (cadr arts) gnus-agent-article-alist))
642 (setcdr arts (cddr arts))
643 (setq arts (cdr arts)))))
646 (gnus-agent-directory)
647 (gnus-agent-group-path group) "/"))
648 (date (gnus-time-to-day (current-time)))
650 pos alists crosses id elem)
651 (gnus-make-directory dir)
652 (gnus-message 7 "Fetching articles for %s..." group)
653 ;; Fetch the articles from the backend.
654 (if (gnus-check-backend-function 'retrieve-articles group)
655 (setq pos (gnus-retrieve-articles articles group))
656 (nnheader-temp-write nil
657 (let ((buf (current-buffer))
659 (while (setq article (pop articles))
660 (when (gnus-request-article article group)
661 (goto-char (point-max))
662 (push (cons article (point)) pos)
663 (insert-buffer-substring nntp-server-buffer)))
664 (copy-to-buffer nntp-server-buffer (point-min) (point-max))
665 (setq pos (nreverse pos)))))
666 ;; Then save these articles into the Agent.
668 (set-buffer nntp-server-buffer)
670 (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
671 (goto-char (point-min))
672 (when (search-forward "\n\n" nil t)
673 (when (search-backward "\nXrefs: " nil t)
674 ;; Handle crossposting.
675 (skip-chars-forward "^ ")
676 (skip-chars-forward " ")
678 (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) +")
679 (push (cons (buffer-substring (match-beginning 1)
681 (buffer-substring (match-beginning 2)
684 (goto-char (match-end 0)))
685 (gnus-agent-crosspost crosses (caar pos))))
686 (goto-char (point-min))
687 (if (not (re-search-forward "^Message-ID: *<\\([^>\n]+\\)>" nil t))
688 (setq id "No-Message-ID-in-article")
689 (setq id (buffer-substring (match-beginning 1) (match-end 1))))
690 (let ((coding-system-for-write
691 gnus-agent-article-file-coding-system))
692 (write-region (point-min) (point-max)
693 (concat dir (number-to-string (caar pos)))
695 (when (setq elem (assq (caar pos) gnus-agent-article-alist))
697 (gnus-agent-enter-history
698 id (or crosses (list (cons group (caar pos)))) date)
701 (gnus-agent-save-alist group)))))
703 (defun gnus-agent-crosspost (crosses article)
704 (let (gnus-agent-article-alist group alist beg end)
706 (set-buffer gnus-agent-overview-buffer)
707 (when (nnheader-find-nov-line article)
710 (setq end (progn (forward-line 1) (point)))))
712 (setq group (caar crosses))
713 (unless (setq alist (assoc group gnus-agent-group-alist))
714 (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
715 gnus-agent-group-alist))
716 (setcdr alist (cons (cons (cdar crosses) t) (cdr alist)))
718 (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
720 (when (= (point-max) (point-min))
721 (push (cons group (current-buffer)) gnus-agent-buffer-alist)
723 (insert-file-contents
724 (gnus-agent-article-name ".overview" group))))
725 (nnheader-find-nov-line (string-to-number (cdar crosses)))
726 (insert (string-to-number (cdar crosses)))
727 (insert-buffer-substring gnus-agent-overview-buffer beg end))
730 (defun gnus-agent-flush-cache ()
732 (while gnus-agent-buffer-alist
733 (set-buffer (cdar gnus-agent-buffer-alist))
734 (write-region (point-min) (point-max)
735 (gnus-agent-article-name ".overview"
736 (caar gnus-agent-buffer-alist))
738 (pop gnus-agent-buffer-alist))
739 (while gnus-agent-group-alist
740 (nnheader-temp-write (caar gnus-agent-group-alist)
741 (princ (cdar gnus-agent-group-alist))
743 (pop gnus-agent-group-alist))))
745 (defun gnus-agent-fetch-headers (group articles &optional force)
746 (gnus-agent-load-alist group)
747 ;; Find out what headers we need to retrieve.
750 (assq (car articles) gnus-agent-article-alist))
752 (let ((arts articles))
754 (if (assq (cadr arts) gnus-agent-article-alist)
755 (setcdr arts (cddr arts))
756 (setq arts (cdr arts)))))
759 (gnus-message 7 "Fetching headers for %s..." group)
761 (set-buffer nntp-server-buffer)
762 (unless (eq 'nov (gnus-retrieve-headers articles group))
763 (nnvirtual-convert-headers))
764 ;; Save these headers for later processing.
765 (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
768 (setq file (gnus-agent-article-name ".overview" group)))
769 (gnus-agent-braid-nov group articles file))
770 (gnus-make-directory (nnheader-translate-file-chars
771 (file-name-directory file)))
772 (write-region (point-min) (point-max) file nil 'silent)
773 (gnus-agent-save-alist group articles nil)
774 (gnus-agent-enter-history "last-header-fetched-for-session"
775 (list (cons group (nth (- (length articles) 1) articles)))
776 (gnus-time-to-day (current-time)))
779 (defsubst gnus-agent-copy-nov-line (article)
781 (set-buffer gnus-agent-overview-buffer)
783 (if (eq article (read (current-buffer)))
784 (setq e (progn (forward-line 1) (point)))
786 (set-buffer nntp-server-buffer)
787 (insert-buffer-substring gnus-agent-overview-buffer b e)))
789 (defun gnus-agent-braid-nov (group articles file)
791 (set-buffer gnus-agent-overview-buffer)
792 (goto-char (point-min))
793 (set-buffer nntp-server-buffer)
795 (insert-file-contents file)
796 (goto-char (point-min))
797 (if (or (= (point-min) (point-max))
800 (< (read (current-buffer)) (car articles))))
801 ;; We have only headers that are after the older headers,
802 ;; so we just append them.
804 (goto-char (point-max))
805 (insert-buffer-substring gnus-agent-overview-buffer))
806 ;; We do it the hard way.
807 (nnheader-find-nov-line (car articles))
808 (gnus-agent-copy-nov-line (car articles))
812 (while (and (not (eobp))
813 (< (read (current-buffer)) (car articles)))
817 (gnus-agent-copy-nov-line (car articles))
818 (setq articles (cdr articles))))
821 (set-buffer gnus-agent-overview-buffer)
824 (set-buffer nntp-server-buffer)
825 (insert-buffer-substring gnus-agent-overview-buffer b e))))))
827 (defun gnus-agent-load-alist (group &optional dir)
828 "Load the article-state alist for GROUP."
829 (setq gnus-agent-article-alist
830 (gnus-agent-read-file
832 (concat dir ".agentview")
833 (gnus-agent-article-name ".agentview" group)))))
835 (defun gnus-agent-save-alist (group &optional articles state dir)
836 "Load the article-state alist for GROUP."
837 (nnheader-temp-write (if dir
838 (concat dir ".agentview")
839 (gnus-agent-article-name ".agentview" group))
840 (princ (setq gnus-agent-article-alist
841 (nconc gnus-agent-article-alist
842 (mapcar (lambda (article) (cons article state))
847 (defun gnus-agent-article-name (article group)
848 (concat (gnus-agent-directory) (gnus-agent-group-path group) "/"
849 (if (stringp article) article (string-to-number article))))
852 (defun gnus-agent-batch-fetch ()
853 "Start Gnus and fetch session."
856 (gnus-agent-fetch-session)
859 (defun gnus-agent-fetch-session ()
860 "Fetch all articles and headers that are eligible for fetching."
862 (unless gnus-agent-covered-methods
863 (error "No servers are covered by the Gnus agent"))
865 (error "Can't fetch articles while Gnus is unplugged"))
866 (let ((methods gnus-agent-covered-methods)
867 groups group gnus-command-method)
870 (setq gnus-command-method (car methods))
871 (when (or (gnus-server-opened gnus-command-method)
872 (gnus-open-server gnus-command-method))
873 (setq groups (gnus-groups-from-server (car methods)))
874 (gnus-agent-with-fetch
875 (while (setq group (pop groups))
876 (when (<= (gnus-group-level group) gnus-agent-handle-level)
877 (gnus-agent-fetch-group-1 group gnus-command-method)))))
879 (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
881 (defun gnus-agent-fetch-group-1 (group method)
883 (let ((gnus-command-method method)
884 gnus-newsgroup-dependencies gnus-newsgroup-headers
885 gnus-newsgroup-scored gnus-headers gnus-score
886 gnus-use-cache articles score arts
887 category predicate info marks score-param)
889 (when (and (or (gnus-active group) (gnus-activate-group group))
890 (setq articles (gnus-list-of-unread-articles group))
891 (gnus-agent-fetch-headers group articles))
892 ;; Parse them and see which articles we want to fetch.
893 (setq gnus-newsgroup-dependencies
894 (make-vector (length articles) 0))
895 (setq gnus-newsgroup-headers
896 (gnus-get-newsgroup-headers-xover articles nil nil group))
897 (setq category (gnus-group-category group))
900 (or (gnus-group-get-parameter group 'agent-predicate)
903 (or (gnus-group-get-parameter group 'agent-score)
906 (gnus-score-headers (list (list score-param))))
908 (while (setq gnus-headers (pop gnus-newsgroup-headers))
910 (or (cdr (assq (mail-header-number gnus-headers)
911 gnus-newsgroup-scored))
912 gnus-summary-default-score))
913 (when (funcall predicate)
914 (push (mail-header-number gnus-headers)
916 ;; Fetch the articles.
918 (gnus-agent-fetch-articles group arts)))
919 ;; Perhaps we have some additional articles to fetch.
920 (setq arts (assq 'download (gnus-info-marks
921 (setq info (gnus-get-info group)))))
923 (gnus-agent-fetch-articles
924 group (gnus-uncompress-range (cdr arts)))
925 (setq marks (delq arts (gnus-info-marks info)))
926 (gnus-info-set-marks info marks))))
929 ;;; Agent Category Mode
932 (defvar gnus-category-mode-hook nil
933 "Hook run in `gnus-category-mode' buffers.")
935 (defvar gnus-category-line-format " %(%20c%): %g\n"
936 "Format of category lines.")
938 (defvar gnus-category-mode-line-format "Gnus: %%b"
939 "The format specification for the category mode line.")
941 (defvar gnus-agent-short-article 100
942 "Articles that have fewer lines than this are short.")
944 (defvar gnus-agent-long-article 200
945 "Articles that have more lines than this are long.")
947 (defvar gnus-agent-low-score 0
948 "Articles that have a score lower than this have a low score.")
950 (defvar gnus-agent-high-score 0
951 "Articles that have a score higher than this have a high score.")
954 ;;; Internal variables.
956 (defvar gnus-category-buffer "*Agent Category*")
958 (defvar gnus-category-line-format-alist
962 (defvar gnus-category-mode-line-format-alist
963 `((?u user-defined ?s)))
965 (defvar gnus-category-line-format-spec nil)
966 (defvar gnus-category-mode-line-format-spec nil)
968 (defvar gnus-category-mode-map nil)
969 (put 'gnus-category-mode 'mode-class 'special)
971 (unless gnus-category-mode-map
972 (setq gnus-category-mode-map (make-sparse-keymap))
973 (suppress-keymap gnus-category-mode-map)
975 (gnus-define-keys gnus-category-mode-map
976 "q" gnus-category-exit
977 "k" gnus-category-kill
978 "c" gnus-category-copy
979 "a" gnus-category-add
980 "p" gnus-category-edit-predicate
981 "g" gnus-category-edit-groups
982 "s" gnus-category-edit-score
983 "l" gnus-category-list
985 "\C-c\C-i" gnus-info-find-node
986 "\C-c\C-b" gnus-bug))
988 (defvar gnus-category-menu-hook nil
989 "*Hook run after the creation of the menu.")
991 (defun gnus-category-make-menu-bar ()
992 (gnus-turn-off-edit-menu 'category)
993 (unless (boundp 'gnus-category-menu)
995 gnus-category-menu gnus-category-mode-map ""
997 ["Add" gnus-category-add t]
998 ["Kill" gnus-category-kill t]
999 ["Copy" gnus-category-copy t]
1000 ["Edit predicate" gnus-category-edit-predicate t]
1001 ["Edit score" gnus-category-edit-score t]
1002 ["Edit groups" gnus-category-edit-groups t]
1003 ["Exit" gnus-category-exit t]))
1005 (gnus-run-hooks 'gnus-category-menu-hook)))
1007 (defun gnus-category-mode ()
1008 "Major mode for listing and editing agent categories.
1010 All normal editing commands are switched off.
1011 \\<gnus-category-mode-map>
1012 For more in-depth information on this mode, read the manual
1013 (`\\[gnus-info-find-node]').
1015 The following commands are available:
1017 \\{gnus-category-mode-map}"
1019 (when (gnus-visual-p 'category-menu 'menu)
1020 (gnus-category-make-menu-bar))
1021 (kill-all-local-variables)
1022 (gnus-simplify-mode-line)
1023 (setq major-mode 'gnus-category-mode)
1024 (setq mode-name "Category")
1025 (gnus-set-default-directory)
1026 (setq mode-line-process nil)
1027 (use-local-map gnus-category-mode-map)
1028 (buffer-disable-undo (current-buffer))
1029 (setq truncate-lines t)
1030 (setq buffer-read-only t)
1031 (gnus-run-hooks 'gnus-category-mode-hook))
1033 (defalias 'gnus-category-position-point 'gnus-goto-colon)
1035 (defun gnus-category-insert-line (category)
1036 (let* ((name (car category))
1037 (groups (length (cadddr category))))
1039 (gnus-add-text-properties
1043 (eval gnus-category-line-format-spec))
1044 (list 'gnus-category name))))
1046 (defun gnus-enter-category-buffer ()
1047 "Go to the Category buffer."
1049 (gnus-category-setup-buffer)
1050 (gnus-configure-windows 'category)
1051 (gnus-category-prepare))
1053 (defun gnus-category-setup-buffer ()
1054 (unless (get-buffer gnus-category-buffer)
1056 (set-buffer (gnus-get-buffer-create gnus-category-buffer))
1057 (gnus-category-mode))))
1059 (defun gnus-category-prepare ()
1060 (gnus-set-format 'category-mode)
1061 (gnus-set-format 'category t)
1062 (let ((alist gnus-category-alist)
1063 (buffer-read-only nil))
1066 (gnus-category-insert-line (pop alist)))
1067 (goto-char (point-min))
1068 (gnus-category-position-point)))
1070 (defun gnus-category-name ()
1071 (or (get-text-property (gnus-point-at-bol) 'gnus-category)
1072 (error "No category on the current line")))
1074 (defun gnus-category-read ()
1075 "Read the category alist."
1076 (setq gnus-category-alist
1077 (or (gnus-agent-read-file
1078 (nnheader-concat gnus-agent-directory "lib/categories"))
1079 (list (list 'default 'short nil nil)))))
1081 (defun gnus-category-write ()
1082 "Write the category alist."
1083 (setq gnus-category-predicate-cache nil
1084 gnus-category-group-cache nil)
1085 (nnheader-temp-write (nnheader-concat gnus-agent-directory "lib/categories")
1086 (prin1 gnus-category-alist (current-buffer))))
1088 (defun gnus-category-edit-predicate (category)
1089 "Edit the predicate for CATEGORY."
1090 (interactive (list (gnus-category-name)))
1091 (let ((info (assq category gnus-category-alist)))
1093 (cadr info) (format "Editing the predicate for category %s" category)
1094 `(lambda (predicate)
1095 (setf (cadr (assq ',category gnus-category-alist)) predicate)
1096 (gnus-category-write)
1097 (gnus-category-list)))))
1099 (defun gnus-category-edit-score (category)
1100 "Edit the score expression for CATEGORY."
1101 (interactive (list (gnus-category-name)))
1102 (let ((info (assq category gnus-category-alist)))
1105 (format "Editing the score expression for category %s" category)
1107 (setf (caddr (assq ',category gnus-category-alist)) groups)
1108 (gnus-category-write)
1109 (gnus-category-list)))))
1111 (defun gnus-category-edit-groups (category)
1112 "Edit the group list for CATEGORY."
1113 (interactive (list (gnus-category-name)))
1114 (let ((info (assq category gnus-category-alist)))
1116 (cadddr info) (format "Editing the group list for category %s" category)
1118 (setf (cadddr (assq ',category gnus-category-alist)) groups)
1119 (gnus-category-write)
1120 (gnus-category-list)))))
1122 (defun gnus-category-kill (category)
1123 "Kill the current category."
1124 (interactive (list (gnus-category-name)))
1125 (let ((info (assq category gnus-category-alist))
1126 (buffer-read-only nil))
1128 (gnus-category-write)
1129 (setq gnus-category-alist (delq info gnus-category-alist))))
1131 (defun gnus-category-copy (category to)
1132 "Copy the current category."
1133 (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
1134 (let ((info (assq category gnus-category-alist)))
1135 (push (list to (gnus-copy-sequence (cadr info))
1136 (gnus-copy-sequence (caddr info)) nil)
1137 gnus-category-alist)
1138 (gnus-category-write)
1139 (gnus-category-list)))
1141 (defun gnus-category-add (category)
1142 "Create a new category."
1143 (interactive "SCategory name: ")
1144 (when (assq category gnus-category-alist)
1145 (error "Category %s already exists" category))
1146 (push (list category 'true nil nil)
1147 gnus-category-alist)
1148 (gnus-category-write)
1149 (gnus-category-list))
1151 (defun gnus-category-list ()
1152 "List all categories."
1154 (gnus-category-prepare))
1156 (defun gnus-category-exit ()
1157 "Return to the group buffer."
1159 (kill-buffer (current-buffer))
1160 (gnus-configure-windows 'group t))
1162 ;; To avoid having 8-bit characters in the source file.
1163 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
1165 (defvar gnus-category-predicate-alist
1166 '((spam . gnus-agent-spam-p)
1167 (short . gnus-agent-short-p)
1168 (long . gnus-agent-long-p)
1169 (low . gnus-agent-low-scored-p)
1170 (high . gnus-agent-high-scored-p)
1171 (true . gnus-agent-true)
1172 (false . gnus-agent-false))
1173 "Mapping from short score predicate symbols to predicate functions.")
1175 (defun gnus-agent-spam-p ()
1176 "Say whether an article is spam or not."
1177 (unless gnus-agent-spam-hashtb
1178 (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
1179 (if (not (equal (mail-header-references gnus-headers) ""))
1181 (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
1183 (gnus-gethash string gnus-agent-spam-hashtb)
1184 (gnus-sethash string t gnus-agent-spam-hashtb)))))
1186 (defun gnus-agent-short-p ()
1187 "Say whether an article is short or not."
1188 (< (mail-header-lines gnus-headers) gnus-agent-short-article))
1190 (defun gnus-agent-long-p ()
1191 "Say whether an article is long or not."
1192 (> (mail-header-lines gnus-headers) gnus-agent-long-article))
1194 (defun gnus-agent-low-scored-p ()
1195 "Say whether an article has a low score or not."
1196 (< gnus-score gnus-agent-low-score))
1198 (defun gnus-agent-high-scored-p ()
1199 "Say whether an article has a high score or not."
1200 (> gnus-score gnus-agent-high-score))
1202 (defun gnus-category-make-function (cat)
1203 "Make a function from category CAT."
1204 `(lambda () ,(gnus-category-make-function-1 cat)))
1206 (defun gnus-agent-true ()
1210 (defun gnus-agent-false ()
1214 (defun gnus-category-make-function-1 (cat)
1215 "Make a function from category CAT."
1217 ;; Functions are just returned as is.
1219 (gnus-functionp cat))
1220 `(,(or (cdr (assq cat gnus-category-predicate-alist))
1222 ;; More complex category.
1225 ((memq (car cat) '(& and))
1227 ((memq (car cat) '(| or))
1229 ((memq (car cat) gnus-category-not)
1231 ,@(mapcar 'gnus-category-make-function-1 (cdr cat))))
1233 (error "Unknown category type: %s" cat))))
1235 (defun gnus-get-predicate (predicate)
1236 "Return the predicate for CATEGORY."
1237 (or (cdr (assoc predicate gnus-category-predicate-cache))
1238 (cdar (push (cons predicate
1239 (gnus-category-make-function predicate))
1240 gnus-category-predicate-cache))))
1242 (defun gnus-group-category (group)
1243 "Return the category GROUP belongs to."
1244 (unless gnus-category-group-cache
1245 (setq gnus-category-group-cache (gnus-make-hashtable 1000))
1246 (let ((cs gnus-category-alist)
1248 (while (setq cat (pop cs))
1249 (setq groups (cadddr cat))
1251 (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
1252 (or (gnus-gethash group gnus-category-group-cache)
1253 (assq 'default gnus-category-alist)))
1255 (defun gnus-agent-expire ()
1256 "Expire all old articles."
1258 (let ((methods gnus-agent-covered-methods)
1259 (day (- (gnus-time-to-day (current-time)) gnus-agent-expire-days))
1260 gnus-command-method sym group articles
1261 history overview file histories elem art nov-file low info
1262 unreads marked article)
1264 (setq overview (gnus-get-buffer-create " *expire overview*"))
1265 (while (setq gnus-command-method (pop methods))
1266 (let ((expiry-hashtb (gnus-make-hashtable 1023)))
1267 (gnus-agent-open-history)
1269 (setq gnus-agent-current-history
1270 (setq history (gnus-agent-history-buffer))))
1271 (goto-char (point-min))
1272 (when (> (buffer-size) 1)
1273 (goto-char (point-min))
1275 (skip-chars-forward "^\t")
1276 (if (> (read (current-buffer)) day)
1277 ;; New article; we don't expire it.
1279 ;; Old article. Schedule it for possible nuking.
1281 (setq sym (let ((obarray expiry-hashtb))
1282 (read (current-buffer))))
1284 (set sym (cons (cons (read (current-buffer)) (point))
1285 (symbol-value sym)))
1286 (set sym (list (cons (read (current-buffer)) (point)))))
1287 (skip-chars-forward " "))
1289 ;; We now have all articles that can possibly be expired.
1292 (setq group (symbol-name sym)
1293 articles (sort (symbol-value sym) 'car-less-than-car)
1294 low (car (gnus-active group))
1295 info (gnus-get-info group)
1296 unreads (ignore-errors (gnus-list-of-unread-articles group))
1297 marked (nconc (gnus-uncompress-range
1298 (cdr (assq 'tick (gnus-info-marks info))))
1299 (gnus-uncompress-range
1301 (gnus-info-marks info)))))
1302 nov-file (gnus-agent-article-name ".overview" group))
1303 (gnus-agent-load-alist group)
1304 (gnus-message 5 "Expiring articles in %s" group)
1305 (set-buffer overview)
1307 (when (file-exists-p nov-file)
1308 (insert-file-contents nov-file))
1309 (goto-char (point-min))
1311 (while (setq elem (pop articles))
1312 (setq article (car elem))
1313 (when (or (null low)
1315 gnus-agent-expire-all
1316 (and (not (memq article unreads))
1317 (not (memq article marked))))
1318 ;; Find and nuke the NOV line.
1319 (while (and (not (eobp))
1321 (setq art (read (current-buffer)))))
1324 (gnus-agent-article-name
1325 (number-to-string art) group))
1327 ;; Remove old NOV lines that have no articles.
1328 (gnus-delete-line)))
1333 ;; Nuke the article.
1334 (when (file-exists-p (setq file (gnus-agent-article-name
1335 (number-to-string article)
1338 ;; Schedule the history line for nuking.
1339 (push (cdr elem) histories)))
1340 (gnus-make-directory (file-name-directory nov-file))
1341 (write-region (point-min) (point-max) nov-file nil 'silent)
1342 ;; Delete the unwanted entries in the alist.
1343 (setq gnus-agent-article-alist
1344 (sort gnus-agent-article-alist 'car-less-than-car))
1345 (let* ((alist gnus-agent-article-alist)
1346 (prev (cons nil alist))
1349 (<= (caar alist) article))
1350 (if (or (not (cdar alist))
1352 (gnus-agent-article-name
1356 (setcdr prev (setq alist (cdr alist)))
1358 alist (cdr alist))))
1359 (setq gnus-agent-article-alist (cdr first))
1360 ;;; Mark all articles up to the first article
1361 ;;; in `gnus-article-alist' as read.
1362 (when (caar gnus-agent-article-alist)
1363 (setcar (nthcdr 2 info)
1366 (cons 1 (- (caar gnus-agent-article-alist) 1)))))
1368 (concat "(gnus-group-set-info '"
1369 (gnus-prin1-to-string info)
1371 (gnus-agent-save-alist group)))
1373 (set-buffer history)
1374 (setq histories (nreverse (sort histories '<)))
1376 (goto-char (pop histories))
1378 (gnus-agent-save-history)
1379 (gnus-agent-close-history))
1380 (gnus-message 4 "Expiry...done"))))))
1383 (defun gnus-agent-batch ()
1385 (let ((init-file-user "")
1386 (gnus-always-read-dribble-file t))
1388 (gnus-group-send-drafts)
1389 (gnus-agent-fetch-session))
1391 (provide 'gnus-agent)
1393 ;;; gnus-agent.el ends here