1 ;;; gnus-agent.el --- unplugged support for Gnus
2 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
36 (if (featurep 'xemacs)
42 (autoload 'gnus-server-update-server "gnus-srvr")
43 (autoload 'gnus-agent-customize-category "gnus-cus")
46 (defcustom gnus-agent-directory (nnheader-concat gnus-directory "agent/")
47 "Where the Gnus agent will store its files."
51 (defcustom gnus-agent-plugged-hook nil
52 "Hook run when plugging into the network."
56 (defcustom gnus-agent-unplugged-hook nil
57 "Hook run when unplugging from the network."
61 (defcustom gnus-agent-fetched-hook nil
62 "Hook run when finished fetching articles."
67 (defcustom gnus-agent-handle-level gnus-level-subscribed
68 "Groups on levels higher than this variable will be ignored by the Agent."
72 (defcustom gnus-agent-expire-days 7
73 "Read articles older than this will be expired.
74 If you wish to disable Agent expiring, see `gnus-agent-enable-expiration'."
76 :type '(number :tag "days"))
78 (defcustom gnus-agent-expire-all nil
79 "If non-nil, also expire unread, ticked and dormant articles.
80 If nil, only read articles will be expired."
84 (defcustom gnus-agent-group-mode-hook nil
85 "Hook run in Agent group minor modes."
89 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
90 (when (featurep 'xemacs)
91 (add-hook 'gnus-agent-group-mode-hook 'gnus-xmas-agent-group-menu-add))
93 (defcustom gnus-agent-summary-mode-hook nil
94 "Hook run in Agent summary minor modes."
98 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
99 (when (featurep 'xemacs)
100 (add-hook 'gnus-agent-summary-mode-hook 'gnus-xmas-agent-summary-menu-add))
102 (defcustom gnus-agent-server-mode-hook nil
103 "Hook run in Agent summary minor modes."
107 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
108 (when (featurep 'xemacs)
109 (add-hook 'gnus-agent-server-mode-hook 'gnus-xmas-agent-server-menu-add))
111 (defcustom gnus-agent-confirmation-function 'y-or-n-p
112 "Function to confirm when error happens."
117 (defcustom gnus-agent-synchronize-flags nil
118 "Indicate if flags are synchronized when you plug in.
119 If this is `ask' the hook will query the user."
121 :type '(choice (const :tag "Always" t)
122 (const :tag "Never" nil)
123 (const :tag "Ask" ask))
126 (defcustom gnus-agent-go-online 'ask
127 "Indicate if offline servers go online when you plug in.
128 If this is `ask' the hook will query the user."
130 :type '(choice (const :tag "Always" t)
131 (const :tag "Never" nil)
132 (const :tag "Ask" ask))
135 (defcustom gnus-agent-mark-unread-after-downloaded t
136 "Indicate whether to mark articles unread after downloaded."
141 (defcustom gnus-agent-download-marks '(download)
142 "Marks for downloading."
144 :type '(repeat (symbol :tag "Mark"))
147 (defcustom gnus-agent-consider-all-articles nil
148 "When non-nil, the agent will let the agent predicate decide
149 whether articles need to be downloaded or not, for all articles. When
150 nil, the default, the agent will only let the predicate decide
151 whether unread articles are downloaded or not. If you enable this,
152 groups with large active ranges may open slower and you may also want
153 to look into the agent expiry settings to block the expiration of
154 read articles as they would just be downloaded again."
159 (defcustom gnus-agent-max-fetch-size 10000000 ;; 10 Mb
160 "Chunk size for `gnus-agent-fetch-session'.
161 The function will split its article fetches into chunks smaller than
167 (defcustom gnus-agent-enable-expiration 'ENABLE
168 "The default expiration state for each group.
169 When set to ENABLE, the default, `gnus-agent-expire' will expire old
170 contents from a group's local storage. This value may be overridden
171 to disable expiration in specific categories, topics, and groups. Of
172 course, you could change gnus-agent-enable-expiration to DISABLE then
173 enable expiration per categories, topics, and groups."
176 :type '(radio (const :format "Enable " ENABLE)
177 (const :format "Disable " DISABLE)))
179 (defcustom gnus-agent-expire-unagentized-dirs t
180 "*Whether expiration should expire in unagentized directories.
181 Have gnus-agent-expire scan the directories under
182 \(gnus-agent-directory) for groups that are no longer agentized.
183 When found, offer to remove them."
188 (defcustom gnus-agent-auto-agentize-methods '(nntp nnimap)
189 "Initially, all servers from these methods are agentized.
190 The user may remove or add servers using the Server buffer.
191 See Info node `(gnus)Server Buffer'."
193 :type '(repeat symbol)
196 (defcustom gnus-agent-queue-mail t
197 "Whether and when outgoing mail should be queued by the agent.
198 When `always', always queue outgoing mail. When nil, never
199 queue. Otherwise, queue if and only if unplugged."
202 :type '(radio (const :format "Always" always)
203 (const :format "Never" nil)
204 (const :format "When plugged" t)))
206 (defcustom gnus-agent-prompt-send-queue nil
207 "If non-nil, `gnus-group-send-queue' will prompt if called when
213 ;;; Internal variables
215 (defvar gnus-agent-history-buffers nil)
216 (defvar gnus-agent-buffer-alist nil)
217 (defvar gnus-agent-article-alist nil
218 "An assoc list identifying the articles whose headers have been fetched.
219 If successfully fetched, these headers will be stored in the group's overview
220 file. The key of each assoc pair is the article ID, the value of each assoc
221 pair is a flag indicating whether the identified article has been downloaded
222 \(gnus-agent-fetch-articles sets the value to the day of the download).
224 1) The last element of this list can not be expired as some
225 routines (for example, get-agent-fetch-headers) use the last
226 value to track which articles have had their headers retrieved.
227 2) The function `gnus-agent-regenerate' may destructively modify the value.")
228 (defvar gnus-agent-group-alist nil)
229 (defvar gnus-category-alist nil)
230 (defvar gnus-agent-current-history nil)
231 (defvar gnus-agent-overview-buffer nil)
232 (defvar gnus-category-predicate-cache nil)
233 (defvar gnus-category-group-cache nil)
234 (defvar gnus-agent-spam-hashtb nil)
235 (defvar gnus-agent-file-name nil)
236 (defvar gnus-agent-send-mail-function nil)
237 (defvar gnus-agent-file-coding-system 'raw-text)
238 (defvar gnus-agent-file-loading-cache nil)
241 (defvar gnus-headers)
248 (defun gnus-open-agent ()
250 (gnus-agent-read-servers)
252 (gnus-agent-create-buffer)
253 (add-hook 'gnus-group-mode-hook 'gnus-agent-mode)
254 (add-hook 'gnus-summary-mode-hook 'gnus-agent-mode)
255 (add-hook 'gnus-server-mode-hook 'gnus-agent-mode))
257 (defun gnus-agent-create-buffer ()
258 (if (gnus-buffer-live-p gnus-agent-overview-buffer)
260 (setq gnus-agent-overview-buffer
261 (gnus-get-buffer-create " *Gnus agent overview*"))
262 (with-current-buffer gnus-agent-overview-buffer
263 (mm-enable-multibyte))
266 (gnus-add-shutdown 'gnus-close-agent 'gnus)
268 (defun gnus-close-agent ()
269 (setq gnus-category-predicate-cache nil
270 gnus-category-group-cache nil
271 gnus-agent-spam-hashtb nil)
272 (gnus-kill-buffer gnus-agent-overview-buffer))
275 ;;; Utility functions
278 (defun gnus-agent-read-file (file)
279 "Load FILE and do a `read' there."
282 (nnheader-insert-file-contents file)
283 (goto-char (point-min))
284 (read (current-buffer)))))
286 (defsubst gnus-agent-method ()
287 (concat (symbol-name (car gnus-command-method)) "/"
288 (if (equal (cadr gnus-command-method) "")
290 (cadr gnus-command-method))))
292 (defsubst gnus-agent-directory ()
293 "The name of the Gnus agent directory."
294 (nnheader-concat gnus-agent-directory
295 (nnheader-translate-file-chars (gnus-agent-method)) "/"))
297 (defun gnus-agent-lib-file (file)
298 "The full name of the Gnus agent library FILE."
299 (expand-file-name file
300 (file-name-as-directory
301 (expand-file-name "agent.lib" (gnus-agent-directory)))))
303 (defun gnus-agent-cat-set-property (category property value)
305 (setcdr (or (assq property category)
306 (let ((cell (cons property nil)))
307 (setcdr category (cons cell (cdr category)))
309 (let ((category category))
310 (while (cond ((eq property (caadr category))
311 (setcdr category (cddr category))
314 (setq category (cdr category)))))))
318 (defmacro gnus-agent-cat-defaccessor (name prop-name)
319 "Define accessor and setter methods for manipulating a list of the form
320 \(NAME (PROPERTY1 VALUE1) ... (PROPERTY_N VALUE_N)).
321 Given the call (gnus-agent-cat-defaccessor func PROPERTY1), the list may be
322 manipulated as follows:
323 (func LIST): Returns VALUE1
324 (setf (func LIST) NEW_VALUE1): Replaces VALUE1 with NEW_VALUE1."
325 `(progn (defmacro ,name (category)
326 (list (quote cdr) (list (quote assq)
327 (quote (quote ,prop-name)) category)))
329 (define-setf-method ,name (category)
330 (let* ((--category--temp-- (make-symbol "--category--"))
331 (--value--temp-- (make-symbol "--value--")))
332 (list (list --category--temp--) ; temporary-variables
333 (list category) ; value-forms
334 (list --value--temp--) ; store-variables
335 (let* ((category --category--temp--) ; store-form
336 (value --value--temp--))
337 (list (quote gnus-agent-cat-set-property)
339 (quote (quote ,prop-name))
341 (list (quote ,name) --category--temp--) ; access-form
345 (defmacro gnus-agent-cat-name (category)
348 (gnus-agent-cat-defaccessor
349 gnus-agent-cat-days-until-old agent-days-until-old)
350 (gnus-agent-cat-defaccessor
351 gnus-agent-cat-enable-expiration agent-enable-expiration)
352 (gnus-agent-cat-defaccessor
353 gnus-agent-cat-groups agent-groups)
354 (gnus-agent-cat-defaccessor
355 gnus-agent-cat-high-score agent-high-score)
356 (gnus-agent-cat-defaccessor
357 gnus-agent-cat-length-when-long agent-length-when-long)
358 (gnus-agent-cat-defaccessor
359 gnus-agent-cat-length-when-short agent-length-when-short)
360 (gnus-agent-cat-defaccessor
361 gnus-agent-cat-low-score agent-low-score)
362 (gnus-agent-cat-defaccessor
363 gnus-agent-cat-predicate agent-predicate)
364 (gnus-agent-cat-defaccessor
365 gnus-agent-cat-score-file agent-score-file)
366 (gnus-agent-cat-defaccessor
367 gnus-agent-cat-enable-undownloaded-faces agent-enable-undownloaded-faces)
370 ;; This form is equivalent to defsetf except that it calls make-symbol
371 ;; whereas defsetf calls gensym (Using gensym creates a run-time
372 ;; dependency on the CL library).
375 (define-setf-method gnus-agent-cat-groups (category)
376 (let* ((--category--temp-- (make-symbol "--category--"))
377 (--groups--temp-- (make-symbol "--groups--")))
378 (list (list --category--temp--)
380 (list --groups--temp--)
381 (let* ((category --category--temp--)
382 (groups --groups--temp--))
383 (list (quote gnus-agent-set-cat-groups) category groups))
384 (list (quote gnus-agent-cat-groups) --category--temp--))))
387 (defun gnus-agent-set-cat-groups (category groups)
388 (unless (eq groups 'ignore)
390 (old-g (gnus-agent-cat-groups category)))
391 (cond ((eq new-g old-g)
392 ;; gnus-agent-add-group is fiddling with the group
393 ;; list. Still, Im done.
396 ((eq new-g (cdr old-g))
397 ;; gnus-agent-add-group is fiddling with the group list
398 (setcdr (or (assq 'agent-groups category)
399 (let ((cell (cons 'agent-groups nil)))
400 (setcdr category (cons cell (cdr category)))
403 (let ((groups groups))
405 (let* ((group (pop groups))
406 (old-category (gnus-group-category group)))
407 (if (eq category old-category)
409 (setf (gnus-agent-cat-groups old-category)
410 (delete group (gnus-agent-cat-groups
412 ;; Purge cache as preceeding loop invalidated it.
413 (setq gnus-category-group-cache nil))
415 (setcdr (or (assq 'agent-groups category)
416 (let ((cell (cons 'agent-groups nil)))
417 (setcdr category (cons cell (cdr category)))
420 (defsubst gnus-agent-cat-make (name &optional default-agent-predicate)
421 (list name `(agent-predicate . ,(or default-agent-predicate 'false))))
423 ;;; Fetching setup functions.
425 (defun gnus-agent-start-fetch ()
426 "Initialize data structures for efficient fetching."
427 (gnus-agent-create-buffer))
429 (defun gnus-agent-stop-fetch ()
430 "Save all data structures and clean up."
431 (setq gnus-agent-spam-hashtb nil)
433 (set-buffer nntp-server-buffer)
436 (defmacro gnus-agent-with-fetch (&rest forms)
439 (let ((gnus-agent-fetching t))
440 (gnus-agent-start-fetch)
442 (gnus-agent-stop-fetch)))
444 (put 'gnus-agent-with-fetch 'lisp-indent-function 0)
445 (put 'gnus-agent-with-fetch 'edebug-form-spec '(body))
447 (defmacro gnus-agent-append-to-list (tail value)
448 `(setq ,tail (setcdr ,tail (cons ,value nil))))
450 (defmacro gnus-agent-message (level &rest args)
451 `(if (<= ,level gnus-verbose)
458 (defvar gnus-agent-mode-hook nil
459 "Hook run when installing agent mode.")
461 (defvar gnus-agent-mode nil)
462 (defvar gnus-agent-mode-status '(gnus-agent-mode " Plugged"))
464 (defun gnus-agent-mode ()
465 "Minor mode for providing a agent support in Gnus buffers."
466 (let* ((buffer (progn (string-match "^gnus-\\(.*\\)-mode$"
467 (symbol-name major-mode))
468 (match-string 1 (symbol-name major-mode))))
469 (mode (intern (format "gnus-agent-%s-mode" buffer))))
470 (set (make-local-variable 'gnus-agent-mode) t)
472 (set (make-local-variable mode) t)
474 (when (gnus-visual-p 'agent-menu 'menu)
475 (funcall (intern (format "gnus-agent-%s-make-menu-bar" buffer))))
476 (unless (assq 'gnus-agent-mode minor-mode-alist)
477 (push gnus-agent-mode-status minor-mode-alist))
478 (unless (assq mode minor-mode-map-alist)
479 (push (cons mode (symbol-value (intern (format "gnus-agent-%s-mode-map"
481 minor-mode-map-alist))
482 (when (eq major-mode 'gnus-group-mode)
483 (let ((init-plugged gnus-plugged)
484 (gnus-agent-go-online nil))
485 ;; g-a-t-p does nothing when gnus-plugged isn't changed.
486 ;; Therefore, make certain that the current value does not
487 ;; match the desired initial value.
488 (setq gnus-plugged :unknown)
489 (gnus-agent-toggle-plugged init-plugged)))
490 (gnus-run-hooks 'gnus-agent-mode-hook
491 (intern (format "gnus-agent-%s-mode-hook" buffer)))))
493 (defvar gnus-agent-group-mode-map (make-sparse-keymap))
494 (gnus-define-keys gnus-agent-group-mode-map
495 "Ju" gnus-agent-fetch-groups
496 "Jc" gnus-enter-category-buffer
497 "Jj" gnus-agent-toggle-plugged
498 "Js" gnus-agent-fetch-session
499 "JY" gnus-agent-synchronize-flags
500 "JS" gnus-group-send-queue
501 "Ja" gnus-agent-add-group
502 "Jr" gnus-agent-remove-group
503 "Jo" gnus-agent-toggle-group-plugged)
505 (defun gnus-agent-group-make-menu-bar ()
506 (unless (boundp 'gnus-agent-group-menu)
508 gnus-agent-group-menu gnus-agent-group-mode-map ""
510 ["Toggle plugged" gnus-agent-toggle-plugged t]
511 ["Toggle group plugged" gnus-agent-toggle-group-plugged t]
512 ["List categories" gnus-enter-category-buffer t]
513 ["Add (current) group to category" gnus-agent-add-group t]
514 ["Remove (current) group from category" gnus-agent-remove-group t]
515 ["Send queue" gnus-group-send-queue gnus-plugged]
517 ["All" gnus-agent-fetch-session gnus-plugged]
518 ["Group" gnus-agent-fetch-group gnus-plugged])
519 ["Synchronize flags" gnus-agent-synchronize-flags t]
522 (defvar gnus-agent-summary-mode-map (make-sparse-keymap))
523 (gnus-define-keys gnus-agent-summary-mode-map
524 "Jj" gnus-agent-toggle-plugged
525 "Ju" gnus-agent-summary-fetch-group
526 "JS" gnus-agent-fetch-group
527 "Js" gnus-agent-summary-fetch-series
528 "J#" gnus-agent-mark-article
529 "J\M-#" gnus-agent-unmark-article
530 "@" gnus-agent-toggle-mark
531 "Jc" gnus-agent-catchup)
533 (defun gnus-agent-summary-make-menu-bar ()
534 (unless (boundp 'gnus-agent-summary-menu)
536 gnus-agent-summary-menu gnus-agent-summary-mode-map ""
538 ["Toggle plugged" gnus-agent-toggle-plugged t]
539 ["Mark as downloadable" gnus-agent-mark-article t]
540 ["Unmark as downloadable" gnus-agent-unmark-article t]
541 ["Toggle mark" gnus-agent-toggle-mark t]
542 ["Fetch downloadable" gnus-agent-summary-fetch-group t]
543 ["Catchup undownloaded" gnus-agent-catchup t]))))
545 (defvar gnus-agent-server-mode-map (make-sparse-keymap))
546 (gnus-define-keys gnus-agent-server-mode-map
547 "Jj" gnus-agent-toggle-plugged
548 "Ja" gnus-agent-add-server
549 "Jr" gnus-agent-remove-server)
551 (defun gnus-agent-server-make-menu-bar ()
552 (unless (boundp 'gnus-agent-server-menu)
554 gnus-agent-server-menu gnus-agent-server-mode-map ""
556 ["Toggle plugged" gnus-agent-toggle-plugged t]
557 ["Add" gnus-agent-add-server t]
558 ["Remove" gnus-agent-remove-server t]))))
560 (defun gnus-agent-make-mode-line-string (string mouse-button mouse-func)
561 (if (and (fboundp 'propertize)
562 (fboundp 'make-mode-line-mouse-map))
563 (propertize string 'local-map
564 (make-mode-line-mouse-map mouse-button mouse-func)
565 'mouse-face 'mode-line-highlight)
568 (defun gnus-agent-toggle-plugged (set-to)
569 "Toggle whether Gnus is unplugged or not."
570 (interactive (list (not gnus-plugged)))
571 (cond ((eq set-to gnus-plugged)
574 (setq gnus-plugged set-to)
575 (gnus-run-hooks 'gnus-agent-plugged-hook)
576 (setcar (cdr gnus-agent-mode-status)
577 (gnus-agent-make-mode-line-string " Plugged"
579 'gnus-agent-toggle-plugged))
580 (gnus-agent-go-online gnus-agent-go-online)
581 (gnus-agent-possibly-synchronize-flags))
583 (gnus-agent-close-connections)
584 (setq gnus-plugged set-to)
585 (gnus-run-hooks 'gnus-agent-unplugged-hook)
586 (setcar (cdr gnus-agent-mode-status)
587 (gnus-agent-make-mode-line-string " Unplugged"
589 'gnus-agent-toggle-plugged))))
590 (set-buffer-modified-p t))
592 (defmacro gnus-agent-while-plugged (&rest body)
593 `(let ((original-gnus-plugged gnus-plugged))
595 (progn (gnus-agent-toggle-plugged t)
597 (gnus-agent-toggle-plugged original-gnus-plugged))))
599 (put 'gnus-agent-while-plugged 'lisp-indent-function 0)
600 (put 'gnus-agent-while-plugged 'edebug-form-spec '(body))
602 (defun gnus-agent-close-connections ()
603 "Close all methods covered by the Gnus agent."
604 (let ((methods (gnus-agent-covered-methods)))
606 (gnus-close-server (pop methods)))))
609 (defun gnus-unplugged ()
610 "Start Gnus unplugged."
612 (setq gnus-plugged nil)
616 (defun gnus-plugged ()
617 "Start Gnus plugged."
619 (setq gnus-plugged t)
623 (defun gnus-slave-unplugged (&optional arg)
624 "Read news as a slave unplugged."
626 (setq gnus-plugged nil)
627 (gnus arg nil 'slave))
630 (defun gnus-agentize ()
631 "Allow Gnus to be an offline newsreader.
633 The gnus-agentize function is now called internally by gnus when
634 gnus-agent is set. If you wish to avoid calling gnus-agentize,
635 customize gnus-agent to nil.
637 This will modify the `gnus-setup-news-hook', and
638 `message-send-mail-real-function' variables, and install the Gnus agent
639 minor mode in all Gnus buffers."
642 (add-hook 'gnus-setup-news-hook 'gnus-agent-queue-setup)
643 (unless gnus-agent-send-mail-function
644 (setq gnus-agent-send-mail-function
645 (or message-send-mail-real-function
646 (function (lambda () (funcall message-send-mail-function))))
647 message-send-mail-real-function 'gnus-agent-send-mail))
649 ;; If the servers file doesn't exist, auto-agentize some servers and
650 ;; save the servers file so this auto-agentizing isn't invoked
652 (unless (file-exists-p (nnheader-concat gnus-agent-directory "lib/servers"))
653 (gnus-message 3 "First time agent user, agentizing remote groups...")
655 (lambda (server-or-method)
656 (let ((method (gnus-server-to-method server-or-method)))
657 (when (memq (car method)
658 gnus-agent-auto-agentize-methods)
659 (push (gnus-method-to-server method)
660 gnus-agent-covered-methods)
661 (setq gnus-agent-method-p-cache nil))))
662 (cons gnus-select-method gnus-secondary-select-methods))
663 (gnus-agent-write-servers)))
665 (defun gnus-agent-queue-setup (&optional group-name)
666 "Make sure the queue group exists.
667 Optional arg GROUP-NAME allows to specify another group."
668 (unless (gnus-gethash (format "nndraft:%s" (or group-name "queue"))
670 (gnus-request-create-group (or group-name "queue") '(nndraft ""))
671 (let ((gnus-level-default-subscribed 1))
672 (gnus-subscribe-group (format "nndraft:%s" (or group-name "queue"))
674 (gnus-group-set-parameter
675 (format "nndraft:%s" (or group-name "queue"))
676 'gnus-dummy '((gnus-draft-mode)))))
678 (defun gnus-agent-send-mail ()
679 (if (or (not gnus-agent-queue-mail)
680 (and gnus-plugged (not (eq gnus-agent-queue-mail 'always))))
681 (funcall gnus-agent-send-mail-function)
682 (goto-char (point-min))
684 (concat "^" (regexp-quote mail-header-separator) "\n"))
686 (gnus-agent-insert-meta-information 'mail)
687 (gnus-request-accept-article "nndraft:queue" nil t t)))
689 (defun gnus-agent-insert-meta-information (type &optional method)
690 "Insert meta-information into the message that says how it's to be posted.
691 TYPE can be either `mail' or `news'. If the latter, then METHOD can
694 (message-remove-header gnus-agent-meta-information-header)
695 (goto-char (point-min))
696 (insert gnus-agent-meta-information-header ": "
697 (symbol-name type) " " (format "%S" method)
700 (while (search-backward "\n" nil t)
701 (replace-match "\\n" t t))))
703 (defun gnus-agent-restore-gcc ()
704 "Restore GCC field from saved header."
706 (goto-char (point-min))
707 (while (re-search-forward
708 (concat "^" (regexp-quote gnus-agent-gcc-header) ":") nil t)
709 (replace-match "Gcc:" 'fixedcase))))
711 (defun gnus-agent-any-covered-gcc ()
713 (message-narrow-to-headers)
714 (let* ((gcc (mail-fetch-field "gcc" nil t))
716 (mapcar 'gnus-inews-group-method
717 (message-unquote-tokens
718 (message-tokenize-header
721 (while (and (not covered) methods)
722 (setq covered (gnus-agent-method-p (car methods))
723 methods (cdr methods)))
727 (defun gnus-agent-possibly-save-gcc ()
728 "Save GCC if Gnus is unplugged."
729 (when (and (not gnus-plugged) (gnus-agent-any-covered-gcc))
731 (goto-char (point-min))
732 (let ((case-fold-search t))
733 (while (re-search-forward "^gcc:" nil t)
734 (replace-match (concat gnus-agent-gcc-header ":") 'fixedcase))))))
736 (defun gnus-agent-possibly-do-gcc ()
737 "Do GCC if Gnus is plugged."
738 (when (or gnus-plugged (not (gnus-agent-any-covered-gcc)))
739 (gnus-inews-do-gcc)))
742 ;;; Group mode commands
745 (defun gnus-agent-fetch-groups (n)
746 "Put all new articles in the current groups into the Agent."
749 (error "Groups can't be fetched when Gnus is unplugged"))
750 (gnus-group-iterate n 'gnus-agent-fetch-group))
752 (defun gnus-agent-fetch-group (&optional group)
753 "Put all new articles in GROUP into the Agent."
754 (interactive (list (gnus-group-group-name)))
755 (setq group (or group gnus-newsgroup-name))
757 (error "No group on the current line"))
759 (gnus-agent-while-plugged
760 (let ((gnus-command-method (gnus-find-method-for-group group)))
761 (gnus-agent-with-fetch
762 (gnus-agent-fetch-group-1 group gnus-command-method)
763 (gnus-message 5 "Fetching %s...done" group)))))
765 (defun gnus-agent-add-group (category arg)
766 "Add the current group to an agent category."
772 (mapcar (lambda (cat) (list (symbol-name (car cat))))
776 (let ((cat (assq category gnus-category-alist))
778 (gnus-group-iterate arg
780 (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
781 (setf (gnus-agent-cat-groups c)
782 (delete group (gnus-agent-cat-groups c))))
783 (push group groups)))
784 (setf (gnus-agent-cat-groups cat)
785 (nconc (gnus-agent-cat-groups cat) groups))
786 (gnus-category-write)))
788 (defun gnus-agent-remove-group (arg)
789 "Remove the current group from its agent category, if any."
792 (gnus-group-iterate arg
794 (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
795 (setf (gnus-agent-cat-groups c)
796 (delete group (gnus-agent-cat-groups c))))))
797 (gnus-category-write)))
799 (defun gnus-agent-synchronize-flags ()
800 "Synchronize unplugged flags with servers."
803 (dolist (gnus-command-method (gnus-agent-covered-methods))
804 (when (file-exists-p (gnus-agent-lib-file "flags"))
805 (gnus-agent-synchronize-flags-server gnus-command-method)))))
807 (defun gnus-agent-possibly-synchronize-flags ()
808 "Synchronize flags according to `gnus-agent-synchronize-flags'."
811 (dolist (gnus-command-method (gnus-agent-covered-methods))
812 (when (and (file-exists-p (gnus-agent-lib-file "flags"))
813 (not (eq (gnus-server-status gnus-command-method) 'offline)))
814 (gnus-agent-possibly-synchronize-flags-server gnus-command-method)))))
816 (defun gnus-agent-synchronize-flags-server (method)
817 "Synchronize flags set when unplugged for server."
818 (let ((gnus-command-method method)
820 (when (file-exists-p (gnus-agent-lib-file "flags"))
821 (set-buffer (get-buffer-create " *Gnus Agent flag synchronize*"))
823 (nnheader-insert-file-contents (gnus-agent-lib-file "flags"))
824 (cond ((null gnus-plugged)
826 1 "You must be plugged to synchronize flags with server %s"
827 (nth 1 gnus-command-method)))
828 ((null (gnus-check-server gnus-command-method))
830 1 "Couldn't open server %s" (nth 1 gnus-command-method)))
835 (eval (read (current-buffer)))
836 (delete-region bgn (point))))
838 (delete-file (gnus-agent-lib-file "flags")))
840 (let ((file (gnus-agent-lib-file "flags")))
841 (write-region (point-min) (point-max)
842 (gnus-agent-lib-file "flags") nil 'silent)
843 (error "Couldn't set flags from file %s due to %s"
844 file (error-message-string err)))))))
847 (defun gnus-agent-possibly-synchronize-flags-server (method)
848 "Synchronize flags for server according to `gnus-agent-synchronize-flags'."
849 (when (or (and gnus-agent-synchronize-flags
850 (not (eq gnus-agent-synchronize-flags 'ask)))
851 (and (eq gnus-agent-synchronize-flags 'ask)
852 (gnus-y-or-n-p (format "Synchronize flags on server `%s'? "
854 (gnus-agent-synchronize-flags-server method)))
857 (defun gnus-agent-rename-group (old-group new-group)
858 "Rename fully-qualified OLD-GROUP as NEW-GROUP. Always updates the agent, even when
859 disabled, as the old agent files would corrupt gnus when the agent was
860 next enabled. Depends upon the caller to determine whether group renaming is supported."
861 (let* ((old-command-method (gnus-find-method-for-group old-group))
862 (old-path (directory-file-name
863 (let (gnus-command-method old-command-method)
864 (gnus-agent-group-pathname old-group))))
865 (new-command-method (gnus-find-method-for-group new-group))
866 (new-path (directory-file-name
867 (let (gnus-command-method new-command-method)
868 (gnus-agent-group-pathname new-group)))))
869 (gnus-rename-file old-path new-path t)
871 (let* ((old-real-group (gnus-group-real-name old-group))
872 (new-real-group (gnus-group-real-name new-group))
873 (old-active (gnus-agent-get-group-info old-command-method old-real-group)))
874 (gnus-agent-save-group-info old-command-method old-real-group nil)
875 (gnus-agent-save-group-info new-command-method new-real-group old-active)
877 (let ((old-local (gnus-agent-get-local old-group
878 old-real-group old-command-method)))
879 (gnus-agent-set-local old-group
881 old-real-group old-command-method)
882 (gnus-agent-set-local new-group
883 (car old-local) (cdr old-local)
884 new-real-group new-command-method)))))
887 (defun gnus-agent-delete-group (group)
888 "Delete fully-qualified GROUP. Always updates the agent, even when
889 disabled, as the old agent files would corrupt gnus when the agent was
890 next enabled. Depends upon the caller to determine whether group deletion is supported."
891 (let* ((command-method (gnus-find-method-for-group group))
892 (path (directory-file-name
893 (let (gnus-command-method command-method)
894 (gnus-agent-group-pathname group)))))
895 (gnus-delete-directory path)
897 (let* ((real-group (gnus-group-real-name group)))
898 (gnus-agent-save-group-info command-method real-group nil)
900 (let ((local (gnus-agent-get-local group
901 real-group command-method)))
902 (gnus-agent-set-local group
904 real-group command-method)))))
907 ;;; Server mode commands
910 (defun gnus-agent-add-server ()
911 "Enroll SERVER in the agent program."
913 (let* ((server (gnus-server-server-name))
914 (named-server (gnus-server-named-server))
916 (gnus-server-get-method nil server))))
918 (error "No server on the current line"))
920 (when (gnus-agent-method-p method)
921 (error "Server already in the agent program"))
923 (push named-server gnus-agent-covered-methods)
925 (setq gnus-agent-method-p-cache nil)
926 (gnus-server-update-server server)
927 (gnus-agent-write-servers)
928 (gnus-message 1 "Entered %s into the Agent" server)))
930 (defun gnus-agent-remove-server ()
931 "Remove SERVER from the agent program."
933 (let* ((server (gnus-server-server-name))
934 (named-server (gnus-server-named-server)))
936 (error "No server on the current line"))
938 (unless (member named-server gnus-agent-covered-methods)
939 (error "Server not in the agent program"))
941 (setq gnus-agent-covered-methods
942 (delete named-server gnus-agent-covered-methods)
943 gnus-agent-method-p-cache nil)
945 (gnus-server-update-server server)
946 (gnus-agent-write-servers)
947 (gnus-message 1 "Removed %s from the agent" server)))
949 (defun gnus-agent-read-servers ()
950 "Read the alist of covered servers."
951 (setq gnus-agent-covered-methods
952 (gnus-agent-read-file
953 (nnheader-concat gnus-agent-directory "lib/servers"))
954 gnus-agent-method-p-cache nil)
956 ;; I am called so early in start-up that I can not validate server
957 ;; names. When that is the case, I skip the validation. That is
958 ;; alright as the gnus startup code calls the validate methods
960 (if gnus-server-alist
961 (gnus-agent-read-servers-validate)))
963 (defun gnus-agent-read-servers-validate ()
964 (mapcar (lambda (server-or-method)
965 (let* ((server (if (stringp server-or-method)
967 (gnus-method-to-server server-or-method)))
968 (method (gnus-server-to-method server)))
970 (unless (member server gnus-agent-covered-methods)
971 (push server gnus-agent-covered-methods)
972 (setq gnus-agent-method-p-cache nil))
973 (gnus-message 1 "Ignoring disappeared server `%s'" server))))
974 (prog1 gnus-agent-covered-methods
975 (setq gnus-agent-covered-methods nil))))
977 (defun gnus-agent-read-servers-validate-native (native-method)
978 (setq gnus-agent-covered-methods
979 (mapcar (lambda (method)
981 (equal method native-method))
983 method)) gnus-agent-covered-methods)))
985 (defun gnus-agent-write-servers ()
986 "Write the alist of covered servers."
987 (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
988 (let ((coding-system-for-write nnheader-file-coding-system)
989 (file-name-coding-system nnmail-pathname-coding-system))
990 (with-temp-file (nnheader-concat gnus-agent-directory "lib/servers")
991 (prin1 gnus-agent-covered-methods
998 (defun gnus-agent-mark-article (n &optional unmark)
999 "Mark the next N articles as downloadable.
1000 If N is negative, mark backward instead. If UNMARK is non-nil, remove
1001 the mark instead. The difference between N and the actual number of
1002 articles marked is returned."
1004 (let ((backward (< n 0))
1009 (gnus-summary-set-agent-mark
1010 (gnus-summary-article-number) unmark)
1011 (zerop (gnus-summary-next-subject (if backward -1 1) nil t))))
1014 (gnus-message 7 "No more articles"))
1015 (gnus-summary-recenter)
1016 (gnus-summary-position-point)
1019 (defun gnus-agent-unmark-article (n)
1020 "Remove the downloadable mark from the next N articles.
1021 If N is negative, unmark backward instead. The difference between N and
1022 the actual number of articles unmarked is returned."
1024 (gnus-agent-mark-article n t))
1026 (defun gnus-agent-toggle-mark (n)
1027 "Toggle the downloadable mark from the next N articles.
1028 If N is negative, toggle backward instead. The difference between N and
1029 the actual number of articles toggled is returned."
1031 (gnus-agent-mark-article n 'toggle))
1033 (defun gnus-summary-set-agent-mark (article &optional unmark)
1034 "Mark ARTICLE as downloadable. If UNMARK is nil, article is marked.
1035 When UNMARK is t, the article is unmarked. For any other value, the
1036 article's mark is toggled."
1037 (let ((unmark (cond ((eq nil unmark)
1042 (memq article gnus-newsgroup-downloadable)))))
1043 (when (gnus-summary-goto-subject article nil t)
1044 (gnus-summary-update-mark
1047 (setq gnus-newsgroup-downloadable
1048 (delq article gnus-newsgroup-downloadable))
1049 (gnus-article-mark article))
1050 (setq gnus-newsgroup-downloadable
1051 (gnus-add-to-sorted-list gnus-newsgroup-downloadable article))
1052 gnus-downloadable-mark)
1056 (defun gnus-agent-get-undownloaded-list ()
1057 "Construct list of articles that have not been downloaded."
1058 (let ((gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name)))
1059 (when (set (make-local-variable 'gnus-newsgroup-agentized)
1060 (gnus-agent-method-p gnus-command-method))
1061 (let* ((alist (gnus-agent-load-alist gnus-newsgroup-name))
1062 (headers (sort (mapcar (lambda (h)
1063 (mail-header-number h))
1064 gnus-newsgroup-headers) '<))
1065 (cached (and gnus-use-cache gnus-newsgroup-cached))
1066 (undownloaded (list nil))
1067 (tail-undownloaded undownloaded)
1068 (unfetched (list nil))
1069 (tail-unfetched unfetched))
1070 (while (and alist headers)
1071 (let ((a (caar alist))
1074 ;; Ignore IDs in the alist that are not being
1075 ;; displayed in the summary.
1076 (setq alist (cdr alist)))
1078 ;; Headers that are not in the alist should be
1079 ;; fictious (see nnagent-retrieve-headers); they
1080 ;; imply that this article isn't in the agent.
1081 (gnus-agent-append-to-list tail-undownloaded h)
1082 (gnus-agent-append-to-list tail-unfetched h)
1083 (setq headers (cdr headers)))
1085 (setq alist (cdr alist))
1086 (setq headers (cdr headers))
1087 nil ; ignore already downloaded
1090 (setq alist (cdr alist))
1091 (setq headers (cdr headers))
1093 ;; This article isn't in the agent. Check to see
1094 ;; if it is in the cache. If it is, it's been
1096 (while (and cached (< (car cached) a))
1097 (setq cached (cdr cached)))
1098 (unless (equal a (car cached))
1099 (gnus-agent-append-to-list tail-undownloaded a))))))
1102 (let ((num (pop headers)))
1103 (gnus-agent-append-to-list tail-undownloaded num)
1104 (gnus-agent-append-to-list tail-unfetched num)))
1106 (setq gnus-newsgroup-undownloaded (cdr undownloaded)
1107 gnus-newsgroup-unfetched (cdr unfetched))))))
1109 (defun gnus-agent-catchup ()
1110 "Mark as read all unhandled articles.
1111 An article is unhandled if it is neither cached, nor downloaded, nor
1115 (let ((articles gnus-newsgroup-undownloaded))
1116 (when (or gnus-newsgroup-downloadable
1117 gnus-newsgroup-cached)
1118 (setq articles (gnus-sorted-ndifference
1119 (gnus-sorted-ndifference
1120 (gnus-copy-sequence articles)
1121 gnus-newsgroup-downloadable)
1122 gnus-newsgroup-cached)))
1125 (gnus-summary-mark-article
1126 (pop articles) gnus-catchup-mark)))
1127 (gnus-summary-position-point)))
1129 (defun gnus-agent-summary-fetch-series ()
1131 (when gnus-newsgroup-processable
1132 (setq gnus-newsgroup-downloadable
1133 (let* ((dl gnus-newsgroup-downloadable)
1134 (gnus-newsgroup-downloadable
1135 (sort (gnus-copy-sequence gnus-newsgroup-processable) '<))
1136 (fetched-articles (gnus-agent-summary-fetch-group)))
1137 ;; The preceeding call to (gnus-agent-summary-fetch-group)
1138 ;; updated gnus-newsgroup-downloadable to remove each
1139 ;; article successfully fetched.
1141 ;; For each article that I processed, remove its
1142 ;; processable mark IF the article is no longer
1143 ;; downloadable (i.e. it's already downloaded)
1144 (dolist (article gnus-newsgroup-processable)
1145 (unless (memq article gnus-newsgroup-downloadable)
1146 (gnus-summary-remove-process-mark article)))
1147 (gnus-sorted-ndifference dl fetched-articles)))))
1149 (defun gnus-agent-summary-fetch-group (&optional all)
1150 "Fetch the downloadable articles in the group.
1151 Optional arg ALL, if non-nil, means to fetch all articles."
1154 (if all gnus-newsgroup-articles
1155 gnus-newsgroup-downloadable))
1156 (gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name))
1158 (gnus-agent-while-plugged
1160 (error "No articles to download"))
1161 (gnus-agent-with-fetch
1162 (setq gnus-newsgroup-undownloaded
1163 (gnus-sorted-ndifference
1164 gnus-newsgroup-undownloaded
1165 (setq fetched-articles
1166 (gnus-agent-fetch-articles
1167 gnus-newsgroup-name articles)))))
1169 (dolist (article articles)
1170 (let ((was-marked-downloadable
1171 (memq article gnus-newsgroup-downloadable)))
1172 (cond (gnus-agent-mark-unread-after-downloaded
1173 (setq gnus-newsgroup-downloadable
1174 (delq article gnus-newsgroup-downloadable))
1176 (gnus-summary-mark-article article gnus-unread-mark))
1177 (was-marked-downloadable
1178 (gnus-summary-set-agent-mark article t)))
1179 (when (gnus-summary-goto-subject article nil t)
1180 (gnus-summary-update-download-mark article))))))
1183 (defun gnus-agent-fetch-selected-article ()
1184 "Fetch the current article as it is selected.
1185 This can be added to `gnus-select-article-hook' or
1186 `gnus-mark-article-hook'."
1187 (let ((gnus-command-method gnus-current-select-method))
1188 (when (and gnus-plugged (gnus-agent-method-p gnus-command-method))
1189 (when (gnus-agent-fetch-articles
1191 (list gnus-current-article))
1192 (setq gnus-newsgroup-undownloaded
1193 (delq gnus-current-article gnus-newsgroup-undownloaded))
1194 (gnus-summary-update-download-mark gnus-current-article)))))
1197 ;;; Internal functions
1200 (defun gnus-agent-synchronize-group-flags (group actions server)
1201 "Update a plugged group by performing the indicated actions."
1202 (let* ((gnus-command-method (gnus-server-to-method server))
1204 ;; This initializer is required as gnus-request-set-mark
1205 ;; calls gnus-group-real-name to strip off the host name
1206 ;; before calling the backend. Now that the backend is
1207 ;; trying to call gnus-request-set-mark, I have to
1208 ;; reconstruct the original group name.
1209 (or (gnus-get-info group)
1211 (setq group (gnus-group-full-name
1212 group gnus-command-method))))))
1213 (gnus-request-set-mark group actions)
1216 (dolist (action actions)
1217 (let ((range (nth 0 action))
1218 (what (nth 1 action))
1219 (marks (nth 2 action)))
1220 (dolist (mark marks)
1221 (cond ((eq mark 'read)
1224 (funcall (if (eq what 'add)
1226 'gnus-remove-from-range)
1227 (gnus-info-read info)
1229 (gnus-get-unread-articles-in-group
1231 (gnus-active (gnus-info-group info))))
1232 ((memq mark '(tick))
1233 (let ((info-marks (assoc mark (gnus-info-marks info))))
1235 (gnus-info-set-marks info (cons (setq info-marks (list mark)) (gnus-info-marks info))))
1236 (setcdr info-marks (funcall (if (eq what 'add)
1238 'gnus-remove-from-range)
1243 (defun gnus-agent-save-active (method)
1244 (when (gnus-agent-method-p method)
1245 (let* ((gnus-command-method method)
1246 (new (gnus-make-hashtable (count-lines (point-min) (point-max))))
1247 (file (gnus-agent-lib-file "active")))
1248 (gnus-active-to-gnus-format nil new)
1249 (gnus-agent-write-active file new)
1251 (nnheader-insert-file-contents file))))
1253 (defun gnus-agent-write-active (file new)
1254 (gnus-make-directory (file-name-directory file))
1255 (let ((nnmail-active-file-coding-system gnus-agent-file-coding-system))
1256 ;; The hashtable contains real names of groups. However, do NOT
1257 ;; add the foreign server prefix as gnus-active-to-gnus-format
1258 ;; will add it while reading the file.
1259 (gnus-write-active-file file new nil)))
1262 (defun gnus-agent-possibly-alter-active (group active &optional info)
1263 "Possibly expand a group's active range to include articles
1264 downloaded into the agent."
1265 (let* ((gnus-command-method (or gnus-command-method
1266 (gnus-find-method-for-group group))))
1267 (when (gnus-agent-method-p gnus-command-method)
1268 (let* ((local (gnus-agent-get-local group))
1269 (active-min (or (car active) 0))
1270 (active-max (or (cdr active) 0))
1271 (agent-min (or (car local) active-min))
1272 (agent-max (or (cdr local) active-max)))
1274 (when (< agent-min active-min)
1275 (setcar active agent-min))
1277 (when (> agent-max active-max)
1278 (setcdr active agent-max))
1280 (when (and info (< agent-max (- active-min 100)))
1281 ;; I'm expanding the active range by such a large amount
1282 ;; that there is a gap of more than 100 articles between the
1283 ;; last article known to the agent and the first article
1284 ;; currently available on the server. This gap contains
1285 ;; articles that have been lost, mark them as read so that
1286 ;; gnus doesn't waste resources trying to fetch them.
1288 ;; NOTE: I don't do this for smaller gaps (< 100) as I don't
1289 ;; want to modify the local file everytime someone restarts
1290 ;; gnus. The small gap will cause a tiny performance hit
1291 ;; when gnus tries, and fails, to retrieve the articles.
1292 ;; Still that should be smaller than opening a buffer,
1293 ;; printing this list to the buffer, and then writing it to a
1296 (let ((read (gnus-info-read info)))
1301 (list (cons (1+ agent-max)
1302 (1- active-min))))))
1304 ;; Lie about the agent's local range for this group to
1305 ;; disable the set read each time this server is opened.
1306 ;; NOTE: Opening this group will restore the valid local
1307 ;; range but it will also expand the local range to
1308 ;; incompass the new active range.
1309 (gnus-agent-set-local group agent-min (1- active-min)))))))
1311 (defun gnus-agent-save-group-info (method group active)
1312 "Update a single group's active range in the agent's copy of the server's active file."
1313 (when (gnus-agent-method-p method)
1314 (let* ((gnus-command-method (or method gnus-command-method))
1315 (coding-system-for-write nnheader-file-coding-system)
1316 (file-name-coding-system nnmail-pathname-coding-system)
1317 (file (gnus-agent-lib-file "active"))
1318 oactive-min oactive-max)
1319 (gnus-make-directory (file-name-directory file))
1320 (with-temp-file file
1321 ;; Emacs got problem to match non-ASCII group in multibyte buffer.
1322 (mm-disable-multibyte)
1323 (when (file-exists-p file)
1324 (nnheader-insert-file-contents file)
1326 (goto-char (point-min))
1327 (when (re-search-forward
1328 (concat "^" (regexp-quote group) " ") nil t)
1330 (setq oactive-max (read (current-buffer)) ;; max
1331 oactive-min (read (current-buffer)))) ;; min
1332 (gnus-delete-line)))
1334 (insert (format "%S %d %d y\n" (intern group)
1335 (max (or oactive-max (cdr active)) (cdr active))
1336 (min (or oactive-min (car active)) (car active))))
1337 (goto-char (point-max))
1338 (while (search-backward "\\." nil t)
1339 (delete-char 1)))))))
1341 (defun gnus-agent-get-group-info (method group)
1342 "Get a single group's active range in the agent's copy of the server's active file."
1343 (when (gnus-agent-method-p method)
1344 (let* ((gnus-command-method (or method gnus-command-method))
1345 (coding-system-for-write nnheader-file-coding-system)
1346 (file-name-coding-system nnmail-pathname-coding-system)
1347 (file (gnus-agent-lib-file "active"))
1348 oactive-min oactive-max)
1349 (gnus-make-directory (file-name-directory file))
1351 ;; Emacs got problem to match non-ASCII group in multibyte buffer.
1352 (mm-disable-multibyte)
1353 (when (file-exists-p file)
1354 (nnheader-insert-file-contents file)
1356 (goto-char (point-min))
1357 (when (re-search-forward
1358 (concat "^" (regexp-quote group) " ") nil t)
1360 (setq oactive-max (read (current-buffer)) ;; max
1361 oactive-min (read (current-buffer))) ;; min
1362 (cons oactive-min oactive-max))))))))
1364 (defun gnus-agent-group-path (group)
1365 "Translate GROUP into a file name."
1367 ;; NOTE: This is what nnmail-group-pathname does as of Apr 2003.
1368 ;; The two methods must be kept synchronized, which is why
1369 ;; gnus-agent-group-pathname was added.
1372 (nnheader-translate-file-chars
1373 (nnheader-replace-duplicate-chars-in-string
1374 (nnheader-replace-chars-in-string
1375 (gnus-group-real-name (gnus-group-decoded-name group))
1378 (if (or nnmail-use-long-file-names
1379 (file-directory-p (expand-file-name group (gnus-agent-directory))))
1381 (mm-encode-coding-string
1382 (nnheader-replace-chars-in-string group ?. ?/)
1383 nnmail-pathname-coding-system)))
1385 (defun gnus-agent-group-pathname (group)
1386 "Translate GROUP into a file name."
1387 ;; nnagent uses nnmail-group-pathname to read articles while
1388 ;; unplugged. The agent must, therefore, use the same directory
1390 (let ((gnus-command-method (or gnus-command-method
1391 (gnus-find-method-for-group group))))
1392 (nnmail-group-pathname (gnus-group-real-name
1393 (gnus-group-decoded-name group))
1394 (gnus-agent-directory))))
1396 (defun gnus-agent-get-function (method)
1397 (if (gnus-online method)
1402 (defun gnus-agent-covered-methods ()
1403 "Return the subset of methods that are covered by the agent."
1404 (delq nil (mapcar #'gnus-server-to-method gnus-agent-covered-methods)))
1406 ;;; History functions
1408 (defun gnus-agent-history-buffer ()
1409 (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
1411 (defun gnus-agent-open-history ()
1413 (push (cons (gnus-agent-method)
1414 (set-buffer (gnus-get-buffer-create
1415 (format " *Gnus agent %s history*"
1416 (gnus-agent-method)))))
1417 gnus-agent-history-buffers)
1418 (mm-disable-multibyte) ;; everything is binary
1421 (let ((file (gnus-agent-lib-file "history")))
1422 (when (file-exists-p file)
1423 (nnheader-insert-file-contents file))
1424 (set (make-local-variable 'gnus-agent-file-name) file))))
1426 (defun gnus-agent-close-history ()
1427 (when (gnus-buffer-live-p gnus-agent-current-history)
1428 (kill-buffer gnus-agent-current-history)
1429 (setq gnus-agent-history-buffers
1430 (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
1431 gnus-agent-history-buffers))))
1437 (defun gnus-agent-fetch-articles (group articles)
1438 "Fetch ARTICLES from GROUP and put them into the Agent."
1440 (gnus-agent-load-alist group)
1441 (let* ((alist gnus-agent-article-alist)
1442 (headers (if (< (length articles) 2) nil gnus-newsgroup-headers))
1443 (selected-sets (list nil))
1444 (current-set-size 0)
1447 ;; Check each article
1448 (while (setq article (pop articles))
1449 ;; Skip alist entries preceeding this article
1450 (while (> article (or (caar alist) (1+ article)))
1451 (setq alist (cdr alist)))
1453 ;; Prune off articles that we have already fetched.
1454 (unless (and (eq article (caar alist))
1456 ;; Skip headers preceeding this article
1459 (let* ((header (car headers)))
1461 (mail-header-number header)
1463 (setq headers (cdr headers)))
1465 ;; Add this article to the current set
1466 (setcar selected-sets (cons article (car selected-sets)))
1468 ;; Update the set size, when the set is too large start a
1469 ;; new one. I do this after adding the article as I want at
1470 ;; least one article in each set.
1471 (when (< gnus-agent-max-fetch-size
1472 (setq current-set-size
1474 (if (= header-number article)
1475 (let ((char-size (mail-header-chars
1477 (if (<= char-size 0)
1478 ;; The char size was missing/invalid,
1479 ;; assume a worst-case situation of
1480 ;; 65 char/line. If the line count
1481 ;; is missing, arbitrarily assume a
1482 ;; size of 1000 characters.
1483 (max (* 65 (mail-header-lines
1488 (setcar selected-sets (nreverse (car selected-sets)))
1489 (setq selected-sets (cons nil selected-sets)
1490 current-set-size 0))))
1492 (when (or (cdr selected-sets) (car selected-sets))
1493 (let* ((fetched-articles (list nil))
1494 (tail-fetched-articles fetched-articles)
1495 (dir (gnus-agent-group-pathname group))
1496 (date (time-to-days (current-time)))
1497 (case-fold-search t)
1500 (setcar selected-sets (nreverse (car selected-sets)))
1501 (setq selected-sets (nreverse selected-sets))
1503 (gnus-make-directory dir)
1504 (gnus-message 7 "Fetching articles for %s..." group)
1507 (while (setq articles (pop selected-sets))
1508 ;; Fetch the articles from the backend.
1509 (if (gnus-check-backend-function 'retrieve-articles group)
1510 (setq pos (gnus-retrieve-articles articles group))
1513 (while (setq article (pop articles))
1514 (gnus-message 10 "Fetching article %s for %s..."
1517 (gnus-backlog-request-article group article
1519 (gnus-request-article article group))
1520 (goto-char (point-max))
1521 (push (cons article (point)) pos)
1522 (insert-buffer-substring nntp-server-buffer)))
1524 nntp-server-buffer (point-min) (point-max))
1525 (setq pos (nreverse pos)))))
1526 ;; Then save these articles into the Agent.
1528 (set-buffer nntp-server-buffer)
1530 (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
1531 (goto-char (point-min))
1532 (unless (eobp) ;; Don't save empty articles.
1533 (when (search-forward "\n\n" nil t)
1534 (when (search-backward "\nXrefs: " nil t)
1535 ;; Handle cross posting.
1536 (goto-char (match-end 0)) ; move to end of header name
1537 (skip-chars-forward "^ ") ; skip server name
1538 (skip-chars-forward " ")
1540 (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) *")
1541 (push (cons (buffer-substring (match-beginning 1)
1544 (buffer-substring (match-beginning 2)
1547 (goto-char (match-end 0)))
1548 (gnus-agent-crosspost crosses (caar pos) date)))
1549 (goto-char (point-min))
1550 (if (not (re-search-forward
1551 "^Message-ID: *<\\([^>\n]+\\)>" nil t))
1552 (setq id "No-Message-ID-in-article")
1553 (setq id (buffer-substring
1554 (match-beginning 1) (match-end 1))))
1555 (let ((coding-system-for-write
1556 gnus-agent-file-coding-system))
1557 (write-region (point-min) (point-max)
1558 (concat dir (number-to-string (caar pos)))
1561 (gnus-agent-append-to-list
1562 tail-fetched-articles (caar pos)))
1564 (setq pos (cdr pos)))))
1566 (gnus-agent-save-alist group (cdr fetched-articles) date)
1567 (gnus-message 7 ""))
1568 (cdr fetched-articles))))))
1570 (defun gnus-agent-unfetch-articles (group articles)
1571 "Delete ARTICLES that were fetched from GROUP into the agent."
1573 (gnus-agent-load-alist group)
1574 (let* ((alist (cons nil gnus-agent-article-alist))
1575 (articles (sort articles #'<))
1576 (next-possibility alist)
1577 (delete-this (pop articles)))
1578 (while (and (cdr next-possibility) delete-this)
1579 (let ((have-this (caar (cdr next-possibility))))
1580 (cond ((< delete-this have-this)
1581 (setq delete-this (pop articles)))
1582 ((= delete-this have-this)
1583 (let ((timestamp (cdar (cdr next-possibility))))
1585 (let* ((file-name (concat (gnus-agent-group-pathname group)
1586 (number-to-string have-this))))
1587 (delete-file file-name))))
1589 (setcdr next-possibility (cddr next-possibility)))
1591 (setq next-possibility (cdr next-possibility))))))
1592 (setq gnus-agent-article-alist (cdr alist))
1593 (gnus-agent-save-alist group))))
1595 (defun gnus-agent-crosspost (crosses article &optional date)
1596 (setq date (or date t))
1598 (let (gnus-agent-article-alist group alist beg end)
1600 (set-buffer gnus-agent-overview-buffer)
1601 (when (nnheader-find-nov-line article)
1604 (setq end (progn (forward-line 1) (point)))))
1606 (setq group (caar crosses))
1607 (unless (setq alist (assoc group gnus-agent-group-alist))
1608 (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
1609 gnus-agent-group-alist))
1610 (setcdr alist (cons (cons (cdar crosses) date) (cdr alist)))
1612 (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
1614 (when (= (point-max) (point-min))
1615 (push (cons group (current-buffer)) gnus-agent-buffer-alist)
1617 (nnheader-insert-file-contents
1618 (gnus-agent-article-name ".overview" group))))
1619 (nnheader-find-nov-line (string-to-number (cdar crosses)))
1620 (insert (string-to-number (cdar crosses)))
1621 (insert-buffer-substring gnus-agent-overview-buffer beg end)
1622 (gnus-agent-check-overview-buffer))
1623 (setq crosses (cdr crosses)))))
1625 (defun gnus-agent-backup-overview-buffer ()
1626 (when gnus-newsgroup-name
1627 (let ((root (gnus-agent-article-name ".overview" gnus-newsgroup-name))
1630 (while (file-exists-p
1631 (setq name (concat root "~"
1632 (int-to-string (setq cnt (1+ cnt))) "~"))))
1633 (write-region (point-min) (point-max) name nil 'no-msg)
1634 (gnus-message 1 "Created backup copy of overview in %s." name)))
1637 (defun gnus-agent-check-overview-buffer (&optional buffer)
1638 "Check the overview file given for sanity.
1639 In particular, checks that the file is sorted by article number
1640 and that there are no duplicates."
1645 (set-buffer buffer))
1648 (goto-char (point-min))
1650 (while (< (point) (point-max))
1652 (cur (condition-case nil
1653 (read (current-buffer))
1656 ((or (not (integerp cur))
1657 (not (eq (char-after) ?\t)))
1659 (setq backed-up (gnus-agent-backup-overview-buffer)))
1661 "Overview buffer contains garbage '%s'."
1663 p (gnus-point-at-eol))))
1666 (setq backed-up (gnus-agent-backup-overview-buffer)))
1668 "Duplicate overview line for %d" cur)
1669 (delete-region p (progn (forward-line 1) (point))))
1672 (setq backed-up (gnus-agent-backup-overview-buffer)))
1673 (gnus-message 1 "Overview buffer not sorted!")
1674 (sort-numeric-fields 1 (point-min) (point-max))
1675 (goto-char (point-min))
1678 (setq prev-num cur)))
1679 (forward-line 1)))))))
1681 (defun gnus-agent-flush-cache ()
1683 (while gnus-agent-buffer-alist
1684 (set-buffer (cdar gnus-agent-buffer-alist))
1685 (let ((coding-system-for-write
1686 gnus-agent-file-coding-system))
1687 (write-region (point-min) (point-max)
1688 (gnus-agent-article-name ".overview"
1689 (caar gnus-agent-buffer-alist))
1691 (setq gnus-agent-buffer-alist (cdr gnus-agent-buffer-alist)))
1692 (while gnus-agent-group-alist
1693 (with-temp-file (gnus-agent-article-name
1694 ".agentview" (caar gnus-agent-group-alist))
1695 (princ (cdar gnus-agent-group-alist))
1697 (princ 1 (current-buffer))
1699 (setq gnus-agent-group-alist (cdr gnus-agent-group-alist)))))
1702 (defun gnus-agent-find-parameter (group symbol)
1703 "Search for GROUPs SYMBOL in the group's parameters, the group's
1704 topic parameters, the group's category, or the customizable
1705 variables. Returns the first non-nil value found."
1706 (or (gnus-group-find-parameter group symbol t)
1707 (gnus-group-parameter-value (cdr (gnus-group-category group)) symbol t)
1711 '((agent-short-article . gnus-agent-short-article)
1712 (agent-long-article . gnus-agent-long-article)
1713 (agent-low-score . gnus-agent-low-score)
1714 (agent-high-score . gnus-agent-high-score)
1715 (agent-days-until-old . gnus-agent-expire-days)
1716 (agent-enable-expiration
1717 . gnus-agent-enable-expiration)
1718 (agent-predicate . gnus-agent-predicate)))))))
1720 (defun gnus-agent-fetch-headers (group &optional force)
1721 "Fetch interesting headers into the agent. The group's overview
1722 file will be updated to include the headers while a list of available
1723 article numbers will be returned."
1724 (let* ((fetch-all (and gnus-agent-consider-all-articles
1725 ;; Do not fetch all headers if the predicate
1726 ;; implies that we only consider unread articles.
1727 (not (gnus-predicate-implies-unread
1728 (gnus-agent-find-parameter group
1729 'agent-predicate)))))
1730 (articles (if fetch-all
1731 (gnus-uncompress-range (gnus-active group))
1732 (gnus-list-of-unread-articles group)))
1733 (gnus-decode-encoded-word-function 'identity)
1734 (file (gnus-agent-article-name ".overview" group)))
1737 ;; Add articles with marks to the list of article headers we want to
1738 ;; fetch. Don't fetch articles solely on the basis of a recent or seen
1739 ;; mark, but do fetch recent or seen articles if they have other, more
1740 ;; interesting marks. (We have to fetch articles with boring marks
1741 ;; because otherwise the agent will remove their marks.)
1742 (dolist (arts (gnus-info-marks (gnus-get-info group)))
1743 (unless (memq (car arts) '(seen recent killed cache))
1744 (setq articles (gnus-range-add articles (cdr arts)))))
1745 (setq articles (sort (gnus-uncompress-sequence articles) '<)))
1747 ;; At this point, I have the list of articles to consider for
1748 ;; fetching. This is the list that I'll return to my caller. Some
1749 ;; of these articles may have already been fetched. That's OK as
1750 ;; the fetch article code will filter those out. Internally, I'll
1751 ;; filter this list to just those articles whose headers need to
1753 (let ((articles articles))
1754 ;; Remove known articles.
1755 (when (and (or gnus-agent-cache
1757 (gnus-agent-load-alist group))
1758 ;; Remove articles marked as downloaded.
1760 ;; I want to fetch all headers in the active range.
1761 ;; Therefore, exclude only those headers that are in the
1763 ;; NOTE: This is probably NOT what I want to do after
1764 ;; agent expiration in this group.
1765 (setq articles (gnus-agent-uncached-articles articles group))
1767 ;; I want to only fetch those headers that have never been
1768 ;; fetched. Therefore, exclude all headers that are, or
1769 ;; WERE, in the article alist.
1770 (let ((low (1+ (caar (last gnus-agent-article-alist))))
1771 (high (cdr (gnus-active group))))
1772 ;; Low can be greater than High when the same group is
1773 ;; fetched twice in the same session {The first fetch will
1774 ;; fill the article alist such that (last
1775 ;; gnus-agent-article-alist) equals (cdr (gnus-active
1776 ;; group))}. The addition of one(the 1+ above) then
1777 ;; forces Low to be greater than High. When this happens,
1778 ;; gnus-list-range-intersection returns nil which
1779 ;; indicates that no headers need to be fetched. -- Kevin
1780 (setq articles (gnus-list-range-intersection
1781 articles (list (cons low high)))))))
1784 10 "gnus-agent-fetch-headers: undownloaded articles are '%s'"
1785 (gnus-compress-sequence articles t))
1788 (set-buffer nntp-server-buffer)
1792 (gnus-message 7 "Fetching headers for %s..." group)
1795 (gnus-make-directory (nnheader-translate-file-chars
1796 (file-name-directory file) t))
1798 (unless (eq 'nov (gnus-retrieve-headers articles group))
1799 (nnvirtual-convert-headers))
1800 (gnus-agent-check-overview-buffer)
1801 ;; Move these headers to the overview buffer so that
1802 ;; gnus-agent-braid-nov can merge them with the contents
1805 gnus-agent-overview-buffer (point-min) (point-max))
1806 ;; NOTE: Call g-a-brand-nov even when the file does not
1807 ;; exist. As a minimum, it will validate the article
1808 ;; numbers already in the buffer.
1809 (gnus-agent-braid-nov group articles file)
1810 (let ((coding-system-for-write
1811 gnus-agent-file-coding-system))
1812 (gnus-agent-check-overview-buffer)
1813 (write-region (point-min) (point-max) file nil 'silent))
1814 (gnus-agent-save-alist group articles nil)
1818 (nnheader-insert-file-contents file)))))
1821 (defsubst gnus-agent-read-article-number ()
1822 "Reads the article number at point. Returns nil when a valid article number can not be read."
1824 ;; It is unfortunite but the read function quietly overflows
1825 ;; integer. As a result, I have to use string operations to test
1826 ;; for overflow BEFORE calling read.
1827 (when (looking-at "[0-9]+\t")
1828 (let ((len (- (match-end 0) (match-beginning 0))))
1830 (read (current-buffer)))
1832 ;; Many 9 digit base-10 numbers can be represented in a 27-bit int
1833 ;; Back convert from int to string to ensure that this is one of them.
1834 (let* ((str1 (buffer-substring (match-beginning 0) (1- (match-end 0))))
1835 (num (read (current-buffer)))
1836 (str2 (int-to-string num)))
1837 (when (equal str1 str2)
1840 (defsubst gnus-agent-copy-nov-line (article)
1841 "Copy the indicated ARTICLE from the overview buffer to the nntp server buffer."
1843 (set-buffer gnus-agent-overview-buffer)
1844 (while (and (not (eobp))
1845 (or (not (setq art (gnus-agent-read-article-number)))
1850 (not (eq article art)))
1851 (set-buffer nntp-server-buffer)
1853 (setq e (progn (forward-line 1) (point)))
1854 (set-buffer nntp-server-buffer)
1855 (insert-buffer-substring gnus-agent-overview-buffer b e))))
1857 (defun gnus-agent-braid-nov (group articles file)
1858 "Merge agent overview data with given file.
1859 Takes unvalidated headers for ARTICLES from
1860 `gnus-agent-overview-buffer' and validated headers from the given
1861 FILE and places the combined valid headers into
1862 `nntp-server-buffer'. This function can be used, when file
1863 doesn't exist, to valid the overview buffer."
1865 (set-buffer gnus-agent-overview-buffer)
1866 (goto-char (point-min))
1867 (set-buffer nntp-server-buffer)
1869 (when (file-exists-p file)
1870 (nnheader-insert-file-contents file))
1871 (goto-char (point-max))
1874 (unless (or (= (point-min) (point-max))
1875 (< (setq last (read (current-buffer))) (car articles)))
1876 ;; Old and new overlap -- We do it the hard way.
1877 (when (nnheader-find-nov-line (car articles))
1878 ;; Replacing existing NOV entry
1879 (delete-region (point) (progn (forward-line 1) (point))))
1880 (gnus-agent-copy-nov-line (pop articles))
1884 (while (let ((art (read (current-buffer))))
1885 (cond ((< art (car articles))
1888 ((= art (car articles))
1891 (point) (progn (forward-line 1) (point)))
1897 (gnus-agent-copy-nov-line (pop articles)))))
1899 (goto-char (point-max))
1901 ;; Append the remaining lines
1904 (set-buffer gnus-agent-overview-buffer)
1905 (setq start (point))
1906 (set-buffer nntp-server-buffer))
1909 (insert-buffer-substring gnus-agent-overview-buffer start)
1912 (setq last (or last -134217728))
1915 (setq art (gnus-agent-read-article-number))
1917 ;; Bad art num - delete this line
1919 (delete-region (point) (progn (forward-line 1) (point))))
1921 ;; Art num out of order - enable sort
1929 (sort-numeric-fields 1 (point-min) (point-max)))))))
1931 ;; Keeps the compiler from warning about the free variable in
1932 ;; gnus-agent-read-agentview.
1934 (defvar gnus-agent-read-agentview))
1936 (defun gnus-agent-load-alist (group)
1937 "Load the article-state alist for GROUP."
1938 ;; Bind free variable that's used in `gnus-agent-read-agentview'.
1939 (let ((gnus-agent-read-agentview group))
1940 (setq gnus-agent-article-alist
1941 (gnus-cache-file-contents
1942 (gnus-agent-article-name ".agentview" group)
1943 'gnus-agent-file-loading-cache
1944 'gnus-agent-read-agentview))))
1946 ;; Save format may be either 1 or 2. Two is the new, compressed
1947 ;; format that is still being tested. Format 1 is uncompressed but
1948 ;; known to be reliable.
1949 (defconst gnus-agent-article-alist-save-format 2)
1951 (defun gnus-agent-read-agentview (file)
1952 "Load FILE and do a `read' there."
1956 (nnheader-insert-file-contents file)
1957 (goto-char (point-min))
1958 (let ((alist (read (current-buffer)))
1959 (version (condition-case nil (read (current-buffer))
1965 (error "gnus-agent-read-agentview no longer supports version %d. Stop gnus, manually evaluate gnus-agent-convert-to-compressed-agentview, then restart gnus." version))
1967 (let ((inhibit-quit t)
1969 (gnus-agent-open-history)
1970 (set-buffer (gnus-agent-history-buffer))
1971 (goto-char (point-min))
1973 (if (and (looking-at
1974 "[^\t\n]+\t\\([0-9]+\\)\t\\([^ \n]+\\) \\([0-9]+\\)")
1975 (string= (match-string 2)
1976 gnus-agent-read-agentview)
1977 (setq entry (assoc (string-to-number (match-string 3)) alist)))
1978 (setcdr entry (string-to-number (match-string 1))))
1980 (gnus-agent-close-history)
1981 (setq changed-version t)))
1983 (setq changed-version (not (= 1 gnus-agent-article-alist-save-format))))
1988 (let ((state (car comp-list))
1990 (gnus-uncompress-range
1992 (mapcar (lambda (article-id)
1993 (setq uncomp (cons (cons article-id state) uncomp)))
1996 (setq alist (sort uncomp 'car-less-than-car)))))
1997 (when changed-version
1998 (let ((gnus-agent-article-alist alist))
1999 (gnus-agent-save-alist gnus-agent-read-agentview)))
2003 (defun gnus-agent-save-alist (group &optional articles state)
2004 "Save the article-state alist for GROUP."
2005 (let* ((file-name-coding-system nnmail-pathname-coding-system)
2006 (prev (cons nil gnus-agent-article-alist))
2008 print-level print-length item article)
2009 (while (setq article (pop articles))
2010 (while (and (cdr prev)
2011 (< (caadr prev) article))
2012 (setq prev (cdr prev)))
2015 (setcdr prev (list (cons article state))))
2016 ((> (caadr prev) article)
2017 (setcdr prev (cons (cons article state) (cdr prev))))
2018 ((= (caadr prev) article)
2019 (setcdr (cadr prev) state)))
2020 (setq prev (cdr prev)))
2021 (setq gnus-agent-article-alist (cdr all))
2023 (gnus-agent-set-local group
2024 (caar gnus-agent-article-alist)
2025 (caar (last gnus-agent-article-alist)))
2027 (gnus-make-directory (gnus-agent-article-name "" group))
2028 (with-temp-file (gnus-agent-article-name ".agentview" group)
2029 (cond ((eq gnus-agent-article-alist-save-format 1)
2030 (princ gnus-agent-article-alist (current-buffer)))
2031 ((eq gnus-agent-article-alist-save-format 2)
2032 (let ((compressed nil))
2033 (mapcar (lambda (pair)
2034 (let* ((article-id (car pair))
2035 (day-of-download (cdr pair))
2036 (comp-list (assq day-of-download compressed)))
2039 (cons article-id (cdr comp-list)))
2041 (cons (list day-of-download article-id)
2043 nil)) gnus-agent-article-alist)
2044 (mapcar (lambda (comp-list)
2046 (gnus-compress-sequence
2047 (nreverse (cdr comp-list)))))
2049 (princ compressed (current-buffer)))))
2051 (princ gnus-agent-article-alist-save-format (current-buffer))
2054 (defvar gnus-agent-article-local nil)
2055 (defvar gnus-agent-file-loading-local nil)
2057 (defun gnus-agent-load-local (&optional method)
2058 "Load the METHOD'S local file. The local file contains min/max
2059 article counts for each of the method's subscribed groups."
2060 (let ((gnus-command-method (or method gnus-command-method)))
2061 (setq gnus-agent-article-local
2062 (gnus-cache-file-contents
2063 (gnus-agent-lib-file "local")
2064 'gnus-agent-file-loading-local
2065 'gnus-agent-read-and-cache-local))))
2067 (defun gnus-agent-read-and-cache-local (file)
2068 "Load and read FILE then bind its contents to
2069 gnus-agent-article-local. If that variable had `dirty' (also known as
2070 modified) original contents, they are first saved to their own file."
2072 (if (and gnus-agent-article-local
2073 (symbol-value (intern "+dirty" gnus-agent-article-local)))
2074 (gnus-agent-save-local))
2075 (gnus-agent-read-local file))
2077 (defun gnus-agent-read-local (file)
2078 "Load FILE and do a `read' there."
2079 (let ((my-obarray (gnus-make-hashtable (count-lines (point-min)
2084 (let ((nnheader-file-coding-system gnus-agent-file-coding-system))
2085 (nnheader-insert-file-contents file))
2088 (goto-char (point-min))
2089 ;; Skip any comments at the beginning of the file (the only place where they may appear)
2090 (while (= (following-char) ?\;)
2092 (setq line (1+ line)))
2099 (cur (current-buffer)))
2100 (setq group (read cur)
2104 (when (stringp group)
2105 (setq group (intern group my-obarray)))
2107 ;; NOTE: The '+ 0' ensure that min and max are both numerics.
2108 (set group (cons (+ 0 min) (+ 0 max))))
2110 (gnus-message 3 "Warning - invalid agent local: %s on line %d: "
2111 file line (error-message-string err))))
2113 (setq line (1+ line))))
2115 (set (intern "+dirty" my-obarray) nil)
2116 (set (intern "+method" my-obarray) gnus-command-method)
2119 (defun gnus-agent-save-local (&optional force)
2120 "Save gnus-agent-article-local under it method's agent.lib directory."
2121 (let ((my-obarray gnus-agent-article-local))
2122 (when (and my-obarray
2123 (or force (symbol-value (intern "+dirty" my-obarray))))
2124 (let* ((gnus-command-method (symbol-value (intern "+method" my-obarray)))
2125 ;; NOTE: gnus-command-method is used within gnus-agent-lib-file.
2126 (dest (gnus-agent-lib-file "local")))
2127 (gnus-make-directory (gnus-agent-lib-file ""))
2129 (let ((buffer-file-coding-system gnus-agent-file-coding-system))
2130 (with-temp-file dest
2131 (let ((gnus-command-method (symbol-value (intern "+method" my-obarray)))
2132 (file-name-coding-system nnmail-pathname-coding-system)
2133 print-level print-length item article
2134 (standard-output (current-buffer)))
2135 (mapatoms (lambda (symbol)
2136 (cond ((not (boundp symbol))
2138 ((member (symbol-name symbol) '("+dirty" "+method"))
2142 (let ((range (symbol-value symbol)))
2150 (defun gnus-agent-get-local (group &optional gmane method)
2151 (let* ((gmane (or gmane (gnus-group-real-name group)))
2152 (gnus-command-method (or method (gnus-find-method-for-group group)))
2153 (local (gnus-agent-load-local))
2154 (symb (intern gmane local))
2155 (minmax (and (boundp symb) (symbol-value symb))))
2157 ;; Bind these so that gnus-agent-load-alist doesn't change the
2158 ;; current alist (i.e. gnus-agent-article-alist)
2159 (let* ((gnus-agent-article-alist gnus-agent-article-alist)
2160 (gnus-agent-file-loading-cache gnus-agent-file-loading-cache)
2161 (alist (gnus-agent-load-alist group)))
2165 (caar (last alist))))
2166 (gnus-agent-set-local group (car minmax) (cdr minmax)
2167 gmane gnus-command-method local))))
2170 (defun gnus-agent-set-local (group min max &optional gmane method local)
2171 (let* ((gmane (or gmane (gnus-group-real-name group)))
2172 (gnus-command-method (or method (gnus-find-method-for-group group)))
2173 (local (or local (gnus-agent-load-local)))
2174 (symb (intern gmane local))
2175 (minmax (and (boundp symb) (symbol-value symb))))
2177 (if (cond ((and minmax
2178 (or (not (eq min (car minmax)))
2179 (not (eq max (cdr minmax)))))
2186 (set symb (cons min max))
2189 (unintern symb local)))
2190 (set (intern "+dirty" local) t))))
2192 (defun gnus-agent-article-name (article group)
2193 (expand-file-name article
2194 (file-name-as-directory
2195 (gnus-agent-group-pathname group))))
2197 (defun gnus-agent-batch-confirmation (msg)
2198 "Show error message and return t."
2199 (gnus-message 1 msg)
2203 (defun gnus-agent-batch-fetch ()
2204 "Start Gnus and fetch session."
2207 (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
2208 (gnus-agent-fetch-session))
2211 (defun gnus-agent-fetch-session ()
2212 "Fetch all articles and headers that are eligible for fetching."
2214 (unless gnus-agent-covered-methods
2215 (error "No servers are covered by the Gnus agent"))
2216 (unless gnus-plugged
2217 (error "Can't fetch articles while Gnus is unplugged"))
2218 (let ((methods (gnus-agent-covered-methods))
2219 groups group gnus-command-method)
2222 (setq gnus-command-method (car methods))
2223 (when (and (or (gnus-server-opened gnus-command-method)
2224 (gnus-open-server gnus-command-method))
2225 (gnus-online gnus-command-method))
2226 (setq groups (gnus-groups-from-server (car methods)))
2227 (gnus-agent-with-fetch
2228 (while (setq group (pop groups))
2229 (when (<= (gnus-group-level group)
2230 gnus-agent-handle-level)
2231 (if (or debug-on-error debug-on-quit)
2232 (gnus-agent-fetch-group-1
2233 group gnus-command-method)
2235 (gnus-agent-fetch-group-1
2236 group gnus-command-method)
2238 (unless (funcall gnus-agent-confirmation-function
2239 (format "Error %s while fetching session. Should gnus continue? "
2240 (error-message-string err)))
2241 (error "Cannot fetch articles into the Gnus agent")))
2243 (gnus-agent-regenerate-group group)
2244 (unless (funcall gnus-agent-confirmation-function
2246 "%s while fetching session. Should gnus continue? "
2247 (error-message-string err)))
2249 "Cannot fetch articles into the Gnus agent")))))))))
2250 (setq methods (cdr methods)))
2251 (gnus-run-hooks 'gnus-agent-fetched-hook)
2252 (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
2254 (defun gnus-agent-fetch-group-1 (group method)
2256 (let ((gnus-command-method method)
2257 (gnus-newsgroup-name group)
2258 (gnus-newsgroup-dependencies gnus-newsgroup-dependencies)
2259 (gnus-newsgroup-headers gnus-newsgroup-headers)
2260 (gnus-newsgroup-scored gnus-newsgroup-scored)
2261 (gnus-use-cache gnus-use-cache)
2262 (gnus-summary-expunge-below gnus-summary-expunge-below)
2263 (gnus-summary-mark-below gnus-summary-mark-below)
2264 (gnus-orphan-score gnus-orphan-score)
2265 ;; Maybe some other gnus-summary local variables should also
2271 category predicate info marks score-param
2273 (unless (gnus-check-group group)
2274 (error "Can't open server for %s" group))
2277 (when (or gnus-newsgroup-active
2279 (gnus-activate-group group))
2280 (let ((marked-articles gnus-newsgroup-downloadable))
2281 ;; Identify the articles marked for download
2282 (unless gnus-newsgroup-active
2283 ;; The variable gnus-newsgroup-active was selected as I need
2284 ;; a gnus-summary local variable that is NOT bound to any
2285 ;; value (its global value should default to nil).
2286 (dolist (mark gnus-agent-download-marks)
2287 (let ((arts (cdr (assq mark (gnus-info-marks
2288 (setq info (gnus-get-info group)))))))
2290 (setq marked-articles (nconc (gnus-uncompress-range arts)
2293 (setq marked-articles (sort marked-articles '<))
2295 ;; Fetch any new articles from the server
2296 (setq articles (gnus-agent-fetch-headers group))
2298 ;; Merge new articles with marked
2299 (setq articles (sort (append marked-articles articles) '<))
2302 ;; Parse them and see which articles we want to fetch.
2303 (setq gnus-newsgroup-dependencies
2304 (or gnus-newsgroup-dependencies
2305 (make-vector (length articles) 0)))
2306 (setq gnus-newsgroup-headers
2307 (or gnus-newsgroup-headers
2308 (gnus-get-newsgroup-headers-xover articles nil nil
2310 ;; `gnus-agent-overview-buffer' may be killed for
2311 ;; timeout reason. If so, recreate it.
2312 (gnus-agent-create-buffer)
2314 ;; Figure out how to select articles in this group
2315 (setq category (gnus-group-category group))
2319 (gnus-agent-find-parameter group 'agent-predicate)))
2321 ;; If the selection predicate requires scoring, score each header
2322 (unless (memq predicate '(gnus-agent-true gnus-agent-false))
2324 (gnus-agent-find-parameter group 'agent-score-file)))
2325 ;; Translate score-param into real one
2328 ((eq score-param 'file)
2329 (setq score-param (gnus-all-score-files group)))
2330 ((stringp (car score-param)))
2332 (setq score-param (list (list score-param)))))
2334 (gnus-score-headers score-param))))
2336 (unless (and (eq predicate 'gnus-agent-false)
2337 (not marked-articles))
2338 (let ((arts (list nil)))
2339 (let ((arts-tail arts)
2340 (alist (gnus-agent-load-alist group))
2341 (marked-articles marked-articles)
2342 (gnus-newsgroup-headers gnus-newsgroup-headers))
2343 (while (setq gnus-headers (pop gnus-newsgroup-headers))
2344 (let ((num (mail-header-number gnus-headers)))
2345 ;; Determine if this article is already in the cache
2347 (> num (caar alist)))
2348 (setq alist (cdr alist)))
2350 (unless (and (eq num (caar alist))
2353 ;; Determine if this article was marked for download.
2354 (while (and marked-articles
2355 (> num (car marked-articles)))
2356 (setq marked-articles
2357 (cdr marked-articles)))
2359 ;; When this article is marked, or selected by the
2360 ;; predicate, add it to the download list
2361 (when (or (eq num (car marked-articles))
2364 (assq num gnus-newsgroup-scored))
2365 gnus-summary-default-score))
2366 (gnus-agent-long-article
2367 (gnus-agent-find-parameter
2368 group 'agent-long-article))
2369 (gnus-agent-short-article
2370 (gnus-agent-find-parameter
2371 group 'agent-short-article))
2372 (gnus-agent-low-score
2373 (gnus-agent-find-parameter
2374 group 'agent-low-score))
2375 (gnus-agent-high-score
2376 (gnus-agent-find-parameter
2377 group 'agent-high-score))
2378 (gnus-agent-expire-days
2379 (gnus-agent-find-parameter
2380 group 'agent-days-until-old)))
2381 (funcall predicate)))
2382 (gnus-agent-append-to-list arts-tail num))))))
2384 (let (fetched-articles)
2385 ;; Fetch all selected articles
2386 (setq gnus-newsgroup-undownloaded
2387 (gnus-sorted-ndifference
2388 gnus-newsgroup-undownloaded
2389 (setq fetched-articles
2391 (gnus-agent-fetch-articles group (cdr arts))
2394 (let ((unfetched-articles
2395 (gnus-sorted-ndifference (cdr arts) fetched-articles)))
2396 (if gnus-newsgroup-active
2397 ;; Update the summary buffer
2399 (dolist (article marked-articles)
2400 (gnus-summary-set-agent-mark article t))
2401 (dolist (article fetched-articles)
2402 (if gnus-agent-mark-unread-after-downloaded
2403 (gnus-summary-mark-article
2404 article gnus-unread-mark))
2405 (when (gnus-summary-goto-subject article nil t)
2406 (gnus-summary-update-download-mark article)))
2407 (dolist (article unfetched-articles)
2408 (gnus-summary-mark-article
2409 article gnus-canceled-mark)))
2411 ;; Update the group buffer.
2413 ;; When some, or all, of the marked articles came
2414 ;; from the download mark. Remove that mark. I
2415 ;; didn't do this earlier as I only want to remove
2416 ;; the marks after the fetch is completed.
2418 (dolist (mark gnus-agent-download-marks)
2419 (when (eq mark 'download)
2421 (assq mark (gnus-info-marks
2422 (setq info (gnus-get-info group))))))
2423 (when (cdr marked-arts)
2425 (delq marked-arts (gnus-info-marks info)))
2426 (gnus-info-set-marks info marks)))))
2427 (let ((read (gnus-info-read
2428 (or info (setq info (gnus-get-info group))))))
2430 info (gnus-add-to-range read unfetched-articles)))
2432 (gnus-group-update-group group t)
2436 (concat "(gnus-group-set-info '"
2437 (gnus-prin1-to-string info)
2441 ;;; Agent Category Mode
2444 (defvar gnus-category-mode-hook nil
2445 "Hook run in `gnus-category-mode' buffers.")
2447 (defvar gnus-category-line-format " %(%20c%): %g\n"
2448 "Format of category lines.
2450 Valid specifiers include:
2451 %c Topic name (string)
2452 %g The number of groups in the topic (integer)
2454 General format specifiers can also be used. See Info node
2455 `(gnus)Formatting Variables'.")
2457 (defvar gnus-category-mode-line-format "Gnus: %%b"
2458 "The format specification for the category mode line.")
2460 (defvar gnus-agent-predicate 'false
2461 "The selection predicate used when no other source is available.")
2463 (defvar gnus-agent-short-article 100
2464 "Articles that have fewer lines than this are short.")
2466 (defvar gnus-agent-long-article 200
2467 "Articles that have more lines than this are long.")
2469 (defvar gnus-agent-low-score 0
2470 "Articles that have a score lower than this have a low score.")
2472 (defvar gnus-agent-high-score 0
2473 "Articles that have a score higher than this have a high score.")
2476 ;;; Internal variables.
2478 (defvar gnus-category-buffer "*Agent Category*")
2480 (defvar gnus-category-line-format-alist
2481 `((?c gnus-tmp-name ?s)
2482 (?g gnus-tmp-groups ?d)))
2484 (defvar gnus-category-mode-line-format-alist
2485 `((?u user-defined ?s)))
2487 (defvar gnus-category-line-format-spec nil)
2488 (defvar gnus-category-mode-line-format-spec nil)
2490 (defvar gnus-category-mode-map nil)
2491 (put 'gnus-category-mode 'mode-class 'special)
2493 (unless gnus-category-mode-map
2494 (setq gnus-category-mode-map (make-sparse-keymap))
2495 (suppress-keymap gnus-category-mode-map)
2497 (gnus-define-keys gnus-category-mode-map
2498 "q" gnus-category-exit
2499 "k" gnus-category-kill
2500 "c" gnus-category-copy
2501 "a" gnus-category-add
2502 "e" gnus-agent-customize-category
2503 "p" gnus-category-edit-predicate
2504 "g" gnus-category-edit-groups
2505 "s" gnus-category-edit-score
2506 "l" gnus-category-list
2508 "\C-c\C-i" gnus-info-find-node
2509 "\C-c\C-b" gnus-bug))
2511 (defvar gnus-category-menu-hook nil
2512 "*Hook run after the creation of the menu.")
2514 (defun gnus-category-make-menu-bar ()
2515 (gnus-turn-off-edit-menu 'category)
2516 (unless (boundp 'gnus-category-menu)
2518 gnus-category-menu gnus-category-mode-map ""
2520 ["Add" gnus-category-add t]
2521 ["Kill" gnus-category-kill t]
2522 ["Copy" gnus-category-copy t]
2523 ["Edit category" gnus-agent-customize-category t]
2524 ["Edit predicate" gnus-category-edit-predicate t]
2525 ["Edit score" gnus-category-edit-score t]
2526 ["Edit groups" gnus-category-edit-groups t]
2527 ["Exit" gnus-category-exit t]))
2529 (gnus-run-hooks 'gnus-category-menu-hook)))
2531 (defun gnus-category-mode ()
2532 "Major mode for listing and editing agent categories.
2534 All normal editing commands are switched off.
2535 \\<gnus-category-mode-map>
2536 For more in-depth information on this mode, read the manual
2537 \(`\\[gnus-info-find-node]').
2539 The following commands are available:
2541 \\{gnus-category-mode-map}"
2543 (when (gnus-visual-p 'category-menu 'menu)
2544 (gnus-category-make-menu-bar))
2545 (kill-all-local-variables)
2546 (gnus-simplify-mode-line)
2547 (setq major-mode 'gnus-category-mode)
2548 (setq mode-name "Category")
2549 (gnus-set-default-directory)
2550 (setq mode-line-process nil)
2551 (use-local-map gnus-category-mode-map)
2552 (buffer-disable-undo)
2553 (setq truncate-lines t)
2554 (setq buffer-read-only t)
2555 (gnus-run-mode-hooks 'gnus-category-mode-hook))
2557 (defalias 'gnus-category-position-point 'gnus-goto-colon)
2559 (defun gnus-category-insert-line (category)
2560 (let* ((gnus-tmp-name (format "%s" (car category)))
2561 (gnus-tmp-groups (length (gnus-agent-cat-groups category))))
2563 (gnus-add-text-properties
2567 (eval gnus-category-line-format-spec))
2568 (list 'gnus-category gnus-tmp-name))))
2570 (defun gnus-enter-category-buffer ()
2571 "Go to the Category buffer."
2573 (gnus-category-setup-buffer)
2574 (gnus-configure-windows 'category)
2575 (gnus-category-prepare))
2577 (defun gnus-category-setup-buffer ()
2578 (unless (get-buffer gnus-category-buffer)
2580 (set-buffer (gnus-get-buffer-create gnus-category-buffer))
2581 (gnus-category-mode))))
2583 (defun gnus-category-prepare ()
2584 (gnus-set-format 'category-mode)
2585 (gnus-set-format 'category t)
2586 (let ((alist gnus-category-alist)
2587 (buffer-read-only nil))
2590 (gnus-category-insert-line (pop alist)))
2591 (goto-char (point-min))
2592 (gnus-category-position-point)))
2594 (defun gnus-category-name ()
2595 (or (intern (get-text-property (gnus-point-at-bol) 'gnus-category))
2596 (error "No category on the current line")))
2598 (defun gnus-category-read ()
2599 "Read the category alist."
2600 (setq gnus-category-alist
2604 (nnheader-insert-file-contents (nnheader-concat gnus-agent-directory "lib/categories"))
2605 (goto-char (point-min))
2606 ;; This code isn't temp, it will be needed so long as
2607 ;; anyone may be migrating from an older version.
2609 ;; Once we're certain that people will not revert to an
2610 ;; earlier version, we can take out the old-list code in
2611 ;; gnus-category-write.
2612 (let* ((old-list (read (current-buffer)))
2613 (new-list (ignore-errors (read (current-buffer)))))
2616 ;; Convert from a positional list to an alist.
2626 '(agent-predicate agent-score-file agent-groups))))
2629 (list (gnus-agent-cat-make 'default 'short)))))
2631 (defun gnus-category-write ()
2632 "Write the category alist."
2633 (setq gnus-category-predicate-cache nil
2634 gnus-category-group-cache nil)
2635 (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
2636 (with-temp-file (nnheader-concat gnus-agent-directory "lib/categories")
2637 ;; This prin1 is temporary. It exists so that people can revert
2638 ;; to an earlier version of gnus-agent.
2639 (prin1 (mapcar (lambda (c)
2641 (cdr (assoc 'agent-predicate c))
2642 (cdr (assoc 'agent-score-file c))
2643 (cdr (assoc 'agent-groups c))))
2644 gnus-category-alist)
2647 (prin1 gnus-category-alist (current-buffer))))
2649 (defun gnus-category-edit-predicate (category)
2650 "Edit the predicate for CATEGORY."
2651 (interactive (list (gnus-category-name)))
2652 (let ((info (assq category gnus-category-alist)))
2654 (gnus-agent-cat-predicate info)
2655 (format "Editing the select predicate for category %s" category)
2656 `(lambda (predicate)
2657 ;; Avoid run-time execution of setf form
2658 ;; (setf (gnus-agent-cat-predicate (assq ',category gnus-category-alist))
2660 ;; use its expansion instead:
2661 (gnus-agent-cat-set-property (assq ',category gnus-category-alist)
2662 'agent-predicate predicate)
2664 (gnus-category-write)
2665 (gnus-category-list)))))
2667 (defun gnus-category-edit-score (category)
2668 "Edit the score expression for CATEGORY."
2669 (interactive (list (gnus-category-name)))
2670 (let ((info (assq category gnus-category-alist)))
2672 (gnus-agent-cat-score-file info)
2673 (format "Editing the score expression for category %s" category)
2674 `(lambda (score-file)
2675 ;; Avoid run-time execution of setf form
2676 ;; (setf (gnus-agent-cat-score-file (assq ',category gnus-category-alist))
2678 ;; use its expansion instead:
2679 (gnus-agent-cat-set-property (assq ',category gnus-category-alist)
2680 'agent-score-file score-file)
2682 (gnus-category-write)
2683 (gnus-category-list)))))
2685 (defun gnus-category-edit-groups (category)
2686 "Edit the group list for CATEGORY."
2687 (interactive (list (gnus-category-name)))
2688 (let ((info (assq category gnus-category-alist)))
2690 (gnus-agent-cat-groups info)
2691 (format "Editing the group list for category %s" category)
2693 ;; Avoid run-time execution of setf form
2694 ;; (setf (gnus-agent-cat-groups (assq ',category gnus-category-alist))
2696 ;; use its expansion instead:
2697 (gnus-agent-set-cat-groups (assq ',category gnus-category-alist)
2700 (gnus-category-write)
2701 (gnus-category-list)))))
2703 (defun gnus-category-kill (category)
2704 "Kill the current category."
2705 (interactive (list (gnus-category-name)))
2706 (let ((info (assq category gnus-category-alist))
2707 (buffer-read-only nil))
2709 (setq gnus-category-alist (delq info gnus-category-alist))
2710 (gnus-category-write)))
2712 (defun gnus-category-copy (category to)
2713 "Copy the current category."
2714 (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
2715 (let ((info (assq category gnus-category-alist)))
2716 (push (let ((newcat (gnus-copy-sequence info)))
2717 (setf (gnus-agent-cat-name newcat) to)
2718 (setf (gnus-agent-cat-groups newcat) nil)
2720 gnus-category-alist)
2721 (gnus-category-write)
2722 (gnus-category-list)))
2724 (defun gnus-category-add (category)
2725 "Create a new category."
2726 (interactive "SCategory name: ")
2727 (when (assq category gnus-category-alist)
2728 (error "Category %s already exists" category))
2729 (push (gnus-agent-cat-make category)
2730 gnus-category-alist)
2731 (gnus-category-write)
2732 (gnus-category-list))
2734 (defun gnus-category-list ()
2735 "List all categories."
2737 (gnus-category-prepare))
2739 (defun gnus-category-exit ()
2740 "Return to the group buffer."
2742 (kill-buffer (current-buffer))
2743 (gnus-configure-windows 'group t))
2745 ;; To avoid having 8-bit characters in the source file.
2746 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
2748 (defvar gnus-category-predicate-alist
2749 '((spam . gnus-agent-spam-p)
2750 (short . gnus-agent-short-p)
2751 (long . gnus-agent-long-p)
2752 (low . gnus-agent-low-scored-p)
2753 (high . gnus-agent-high-scored-p)
2754 (read . gnus-agent-read-p)
2755 (true . gnus-agent-true)
2756 (false . gnus-agent-false))
2757 "Mapping from short score predicate symbols to predicate functions.")
2759 (defun gnus-agent-spam-p ()
2760 "Say whether an article is spam or not."
2761 (unless gnus-agent-spam-hashtb
2762 (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
2763 (if (not (equal (mail-header-references gnus-headers) ""))
2765 (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
2767 (gnus-gethash string gnus-agent-spam-hashtb)
2768 (gnus-sethash string t gnus-agent-spam-hashtb)))))
2770 (defun gnus-agent-short-p ()
2771 "Say whether an article is short or not."
2772 (< (mail-header-lines gnus-headers) gnus-agent-short-article))
2774 (defun gnus-agent-long-p ()
2775 "Say whether an article is long or not."
2776 (> (mail-header-lines gnus-headers) gnus-agent-long-article))
2778 (defun gnus-agent-low-scored-p ()
2779 "Say whether an article has a low score or not."
2780 (< gnus-score gnus-agent-low-score))
2782 (defun gnus-agent-high-scored-p ()
2783 "Say whether an article has a high score or not."
2784 (> gnus-score gnus-agent-high-score))
2786 (defun gnus-agent-read-p ()
2787 "Say whether an article is read or not."
2788 (gnus-member-of-range (mail-header-number gnus-headers)
2789 (gnus-info-read (gnus-get-info gnus-newsgroup-name))))
2791 (defun gnus-category-make-function (predicate)
2792 "Make a function from PREDICATE."
2793 (let ((func (gnus-category-make-function-1 predicate)))
2794 (if (and (= (length func) 1)
2795 (symbolp (car func)))
2797 (gnus-byte-compile `(lambda () ,func)))))
2799 (defun gnus-agent-true ()
2803 (defun gnus-agent-false ()
2807 (defun gnus-category-make-function-1 (predicate)
2808 "Make a function from PREDICATE."
2810 ;; Functions are just returned as is.
2811 ((or (symbolp predicate)
2812 (functionp predicate))
2813 `(,(or (cdr (assq predicate gnus-category-predicate-alist))
2815 ;; More complex predicate.
2818 ((memq (car predicate) '(& and))
2820 ((memq (car predicate) '(| or))
2822 ((memq (car predicate) gnus-category-not)
2824 ,@(mapcar 'gnus-category-make-function-1 (cdr predicate))))
2826 (error "Unknown predicate type: %s" predicate))))
2828 (defun gnus-get-predicate (predicate)
2829 "Return the function implementing PREDICATE."
2830 (or (cdr (assoc predicate gnus-category-predicate-cache))
2831 (let ((func (gnus-category-make-function predicate)))
2832 (setq gnus-category-predicate-cache
2833 (nconc gnus-category-predicate-cache
2834 (list (cons predicate func))))
2837 (defun gnus-predicate-implies-unread (predicate)
2838 "Say whether PREDICATE implies unread articles only.
2839 It is okay to miss some cases, but there must be no false positives.
2840 That is, if this predicate returns true, then indeed the predicate must
2841 return only unread articles."
2842 (eq t (gnus-function-implies-unread-1
2843 (gnus-category-make-function-1 predicate))))
2845 (defun gnus-function-implies-unread-1 (function)
2846 "Recursively evaluate a predicate function to determine whether it can select
2847 any read articles. Returns t if the function is known to never
2848 return read articles, nil when it is known to always return read
2849 articles, and t_nil when the function may return both read and unread
2851 (let ((func (car function))
2852 (args (mapcar 'gnus-function-implies-unread-1 (cdr function))))
2853 (cond ((eq func 'and)
2854 (cond ((memq t args) ; if any argument returns only unread articles
2855 ;; then that argument constrains the result to only unread articles.
2857 ((memq 't_nil args) ; if any argument is indeterminate
2858 ;; then the result is indeterminate
2861 (cond ((memq nil args) ; if any argument returns read articles
2862 ;; then that argument ensures that the results includes read articles.
2864 ((memq 't_nil args) ; if any argument is indeterminate
2865 ;; then that argument ensures that the results are indeterminate
2867 (t ; if all arguments return only unread articles
2868 ;; then the result returns only unread articles
2871 (cond ((eq (car args) 't_nil) ; if the argument is indeterminate
2872 ; then the result is indeterminate
2875 ; toggle the result to be the opposite of the argument
2877 ((eq func 'gnus-agent-read-p)
2878 nil) ; The read predicate NEVER returns unread articles
2879 ((eq func 'gnus-agent-false)
2880 t) ; The false predicate returns t as the empty set excludes all read articles
2881 ((eq func 'gnus-agent-true)
2882 nil) ; The true predicate ALWAYS returns read articles
2883 ((catch 'found-match
2884 (let ((alist gnus-category-predicate-alist))
2886 (if (eq func (cdar alist))
2887 (throw 'found-match t)
2888 (setq alist (cdr alist))))))
2889 't_nil) ; All other predicates return read and unread articles
2891 (error "Unknown predicate function: %s" function)))))
2893 (defun gnus-group-category (group)
2894 "Return the category GROUP belongs to."
2895 (unless gnus-category-group-cache
2896 (setq gnus-category-group-cache (gnus-make-hashtable 1000))
2897 (let ((cs gnus-category-alist)
2899 (while (setq cat (pop cs))
2900 (setq groups (gnus-agent-cat-groups cat))
2902 (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
2903 (or (gnus-gethash group gnus-category-group-cache)
2904 (assq 'default gnus-category-alist)))
2906 (defun gnus-agent-expire-group (group &optional articles force)
2907 "Expire all old articles in GROUP.
2908 If you want to force expiring of certain articles, this function can
2909 take ARTICLES, and FORCE parameters as well.
2911 The articles on which the expiration process runs are selected as follows:
2912 if ARTICLES is null, all read and unmarked articles.
2913 if ARTICLES is t, all articles.
2914 if ARTICLES is a list, just those articles.
2915 FORCE is equivalent to setting the expiration predicates to true."
2917 (list (let ((def (or (gnus-group-group-name)
2918 gnus-newsgroup-name)))
2919 (let ((select (read-string (if def
2920 (concat "Group Name ("
2923 (if (and (equal "" select)
2929 (gnus-agent-expire articles group force)
2930 (let ( ;; Bind gnus-agent-expire-stats to enable tracking of
2931 ;; expiration statistics of this single group
2932 (gnus-agent-expire-stats (list 0 0 0.0)))
2933 (if (or (not (eq articles t))
2935 (concat "Are you sure that you want to "
2936 "expire all articles in " group ".")))
2937 (let ((gnus-command-method (gnus-find-method-for-group group))
2938 (overview (gnus-get-buffer-create " *expire overview*"))
2941 (let ((active-file (gnus-agent-lib-file "active")))
2942 (when (file-exists-p active-file)
2944 (nnheader-insert-file-contents active-file)
2945 (gnus-active-to-gnus-format
2947 (setq orig (gnus-make-hashtable
2948 (count-lines (point-min) (point-max))))))
2950 (gnus-agent-expire-group-1
2951 group overview (gnus-gethash-safe group orig)
2953 (kill-buffer overview))))
2954 (gnus-message 4 (gnus-agent-expire-done-message)))))
2956 (defun gnus-agent-expire-group-1 (group overview active articles force)
2957 ;; Internal function - requires caller to have set
2958 ;; gnus-command-method, initialized overview buffer, and to have
2959 ;; provided a non-nil active
2961 (let ((dir (gnus-agent-group-pathname group)))
2962 (when (boundp 'gnus-agent-expire-current-dirs)
2963 (set 'gnus-agent-expire-current-dirs
2965 (symbol-value 'gnus-agent-expire-current-dirs))))
2967 (if (and (not force)
2968 (eq 'DISABLE (gnus-agent-find-parameter group
2969 'agent-enable-expiration)))
2970 (gnus-message 5 "Expiry skipping over %s" group)
2971 (gnus-message 5 "Expiring articles in %s" group)
2972 (gnus-agent-load-alist group)
2973 (let* ((bytes-freed 0)
2975 (nov-entries-deleted 0)
2976 (info (gnus-get-info group))
2977 (alist gnus-agent-article-alist)
2978 (day (- (time-to-days (current-time))
2979 (gnus-agent-find-parameter group 'agent-days-until-old)))
2980 (specials (if (and alist
2982 ;; This could be a bit of a problem. I need to
2983 ;; keep the last article to avoid refetching
2984 ;; headers when using nntp in the backend. At
2985 ;; the same time, if someone uses a backend
2986 ;; that supports article moving then I may have
2987 ;; to remove the last article to complete the
2988 ;; move. Right now, I'm going to assume that
2989 ;; FORCE overrides specials.
2990 (list (caar (last alist)))))
2991 (unreads ;; Articles that are excluded from the
2992 ;; expiration process
2993 (cond (gnus-agent-expire-all
2994 ;; All articles are marked read by global decree
2997 ;; All articles are marked read by function
3001 ;; Unread articles are marked protected from
3002 ;; expiration Don't call
3003 ;; gnus-list-of-unread-articles as it returns
3004 ;; articles that have not been fetched into the
3007 (gnus-agent-unread-articles group)))
3009 ;; All articles EXCEPT those named by the caller
3010 ;; are protected from expiration
3011 (gnus-sorted-difference
3012 (gnus-uncompress-range
3014 (caar (last alist))))
3015 (sort articles '<)))))
3016 (marked ;; More articles that are excluded from the
3017 ;; expiration process
3018 (cond (gnus-agent-expire-all
3019 ;; All articles are unmarked by global decree
3022 ;; All articles are unmarked by function
3026 ;; All articles may as well be unmarked as the
3027 ;; unreads list already names the articles we are
3031 ;; Ticked and/or dormant articles are excluded
3034 (gnus-uncompress-range
3035 (cdr (assq 'tick (gnus-info-marks info))))
3036 (gnus-uncompress-range
3038 (gnus-info-marks info))))))))
3039 (nov-file (concat dir ".overview"))
3045 ;; The normal article alist contains elements that look like
3046 ;; (article# . fetch_date) I need to combine other
3047 ;; information with this list. For example, a flag indicating
3048 ;; that a particular article MUST BE KEPT. To do this, I'm
3049 ;; going to transform the elements to look like (article#
3050 ;; fetch_date keep_flag NOV_entry_marker) Later, I'll reverse
3051 ;; the process to generate the expired article alist.
3053 ;; Convert the alist elements to (article# fetch_date nil
3055 (setq dlist (mapcar (lambda (e)
3056 (list (car e) (cdr e) nil nil)) alist))
3058 ;; Convert the keep lists to elements that look like (article#
3059 ;; nil keep_flag nil) then append it to the expanded dlist
3060 ;; These statements are sorted by ascending precidence of the
3062 (setq dlist (nconc dlist
3064 (list e nil 'unread nil))
3066 (setq dlist (nconc dlist
3068 (list e nil 'marked nil))
3070 (setq dlist (nconc dlist
3072 (list e nil 'special nil))
3075 (set-buffer overview)
3077 (buffer-disable-undo)
3078 (when (file-exists-p nov-file)
3079 (gnus-message 7 "gnus-agent-expire: Loading overview...")
3080 (nnheader-insert-file-contents nov-file)
3081 (goto-char (point-min))
3084 (while (< (setq p (point)) (point-max))
3086 ;; If I successfully read an integer (the plus zero
3087 ;; ensures a numeric type), prepend a marker entry
3089 (push (list (+ 0 (read (current-buffer))) nil nil
3090 (set-marker (make-marker) p))
3093 (gnus-message 1 "gnus-agent-expire: read error \
3094 occurred when reading expression at %s in %s. Skipping to next \
3095 line." (point) nov-file)))
3096 ;; Whether I succeeded, or failed, it doesn't matter.
3097 ;; Move to the next line then try again.
3101 7 "gnus-agent-expire: Loading overview... Done"))
3102 (set-buffer-modified-p nil)
3104 ;; At this point, all of the information is in dlist. The
3105 ;; only problem is that much of it is spread across multiple
3106 ;; entries. Sort then MERGE!!
3107 (gnus-message 7 "gnus-agent-expire: Sorting entries... ")
3108 ;; If two entries have the same article-number then sort by
3109 ;; ascending keep_flag.
3116 (cond ((< (nth 0 a) (nth 0 b))
3118 ((> (nth 0 a) (nth 0 b))
3121 (let ((a (or (symbol-value (nth 2 a))
3123 (b (or (symbol-value (nth 2 b))
3126 (gnus-message 7 "gnus-agent-expire: Sorting entries... Done")
3127 (gnus-message 7 "gnus-agent-expire: Merging entries... ")
3128 (let ((dlist dlist))
3129 (while (cdr dlist) ; I'm not at the end-of-list
3130 (if (eq (caar dlist) (caadr dlist))
3131 (let ((first (cdr (car dlist)))
3132 (secnd (cdr (cadr dlist))))
3133 (setcar first (or (car first)
3134 (car secnd))) ; fetch_date
3135 (setq first (cdr first)
3137 (setcar first (or (car first)
3138 (car secnd))) ; Keep_flag
3139 (setq first (cdr first)
3141 (setcar first (or (car first)
3142 (car secnd))) ; NOV_entry_marker
3144 (setcdr dlist (cddr dlist)))
3145 (setq dlist (cdr dlist)))))
3146 (gnus-message 7 "gnus-agent-expire: Merging entries... Done")
3148 (let* ((len (float (length dlist)))
3152 (let ((new-completed (truncate (* 100.0
3153 (/ (setq cnt (1+ cnt))
3156 (when (> new-completed completed)
3157 (setq completed new-completed)
3158 (gnus-message 7 "%3d%% completed..." completed)))
3159 (let* ((entry (car dlist))
3160 (article-number (nth 0 entry))
3161 (fetch-date (nth 1 entry))
3162 (keep (nth 2 entry))
3163 (marker (nth 3 entry)))
3166 ;; Kept articles are unread, marked, or special.
3168 (gnus-agent-message 10
3169 "gnus-agent-expire: %s:%d: Kept %s article%s."
3170 group article-number keep (if fetch-date " and file" ""))
3172 (unless (file-exists-p
3173 (concat dir (number-to-string
3175 (setf (nth 1 entry) nil)
3176 (gnus-agent-message 3 "gnus-agent-expire cleared \
3177 download flag on %s:%d as the cached article file is missing."
3178 group (caar dlist)))
3180 (gnus-message 1 "gnus-agent-expire detected a \
3181 missing NOV entry. Run gnus-agent-regenerate-group to restore it.")))
3182 (gnus-agent-append-to-list
3184 (cons article-number fetch-date)))
3186 ;; The following articles are READ, UNMARKED, and
3187 ;; ORDINARY. See if they can be EXPIRED!!!
3190 ((not (integerp fetch-date))
3191 'read) ;; never fetched article (may expire
3193 ((not (file-exists-p
3194 (concat dir (number-to-string
3196 (setf (nth 1 entry) nil)
3197 'externally-expired) ;; Can't find the cached
3198 ;; article. Handle case
3199 ;; as though this article
3200 ;; was never fetched.
3202 ;; We now have the arrival day, so we see
3203 ;; whether it's old enough to be expired.
3209 ;; I found some reason to expire this entry.
3211 (let ((actions nil))
3212 (when (memq type '(forced expired))
3213 (ignore-errors ; Just being paranoid.
3214 (let* ((file-name (nnheader-concat dir (number-to-string
3216 (size (float (nth 7 (file-attributes file-name)))))
3217 (incf bytes-freed size)
3218 (incf files-deleted)
3219 (delete-file file-name))
3220 (push "expired cached article" actions))
3221 (setf (nth 1 entry) nil)
3225 (push "NOV entry removed" actions)
3228 (incf nov-entries-deleted)
3230 (let ((from (gnus-point-at-bol))
3231 (to (progn (forward-line 1) (point))))
3232 (incf bytes-freed (- to from))
3233 (delete-region from to)))
3235 ;; If considering all articles is set, I can only
3236 ;; expire article IDs that are no longer in the
3237 ;; active range (That is, articles that preceed the
3238 ;; first article in the new alist).
3239 (if (and gnus-agent-consider-all-articles
3240 (>= article-number (car active)))
3241 ;; I have to keep this ID in the alist
3242 (gnus-agent-append-to-list
3243 tail-alist (cons article-number fetch-date))
3244 (push (format "Removed %s article number from \
3245 article alist" type) actions))
3248 (gnus-agent-message 8 "gnus-agent-expire: %s:%d: %s"
3249 group article-number
3250 (mapconcat 'identity actions ", ")))))
3253 10 "gnus-agent-expire: %s:%d: Article kept as \
3254 expiration tests failed." group article-number)
3255 (gnus-agent-append-to-list
3256 tail-alist (cons article-number fetch-date)))
3259 ;; Clean up markers as I want to recycle this buffer
3260 ;; over several groups.
3262 (set-marker marker nil))
3264 (setq dlist (cdr dlist))))
3266 (setq alist (cdr alist))
3268 (let ((inhibit-quit t))
3269 (unless (equal alist gnus-agent-article-alist)
3270 (setq gnus-agent-article-alist alist)
3271 (gnus-agent-save-alist group))
3273 (when (buffer-modified-p)
3274 (let ((coding-system-for-write
3275 gnus-agent-file-coding-system))
3276 (gnus-make-directory dir)
3277 (write-region (point-min) (point-max) nov-file nil
3279 ;; clear the modified flag as that I'm not confused by
3280 ;; its status on the next pass through this routine.
3281 (set-buffer-modified-p nil)))
3283 (when (eq articles t)
3284 (gnus-summary-update-info))))
3286 (when (boundp 'gnus-agent-expire-stats)
3287 (let ((stats (symbol-value 'gnus-agent-expire-stats)))
3288 (incf (nth 2 stats) bytes-freed)
3289 (incf (nth 1 stats) files-deleted)
3290 (incf (nth 0 stats) nov-entries-deleted)))
3293 (defun gnus-agent-expire (&optional articles group force)
3294 "Expire all old articles.
3295 If you want to force expiring of certain articles, this function can
3296 take ARTICLES, GROUP and FORCE parameters as well.
3298 The articles on which the expiration process runs are selected as follows:
3299 if ARTICLES is null, all read and unmarked articles.
3300 if ARTICLES is t, all articles.
3301 if ARTICLES is a list, just those articles.
3302 Setting GROUP will limit expiration to that group.
3303 FORCE is equivalent to setting the expiration predicates to true."
3307 (gnus-agent-expire-group group articles force)
3308 (if (or (not (eq articles t))
3309 (yes-or-no-p "Are you sure that you want to expire all \
3310 articles in every agentized group."))
3311 (let ((methods (gnus-agent-covered-methods))
3312 ;; Bind gnus-agent-expire-current-dirs to enable tracking
3313 ;; of agent directories.
3314 (gnus-agent-expire-current-dirs nil)
3315 ;; Bind gnus-agent-expire-stats to enable tracking of
3316 ;; expiration statistics across all groups
3317 (gnus-agent-expire-stats (list 0 0 0.0))
3318 gnus-command-method overview orig)
3319 (setq overview (gnus-get-buffer-create " *expire overview*"))
3321 (while (setq gnus-command-method (pop methods))
3322 (let ((active-file (gnus-agent-lib-file "active")))
3323 (when (file-exists-p active-file)
3325 (nnheader-insert-file-contents active-file)
3326 (gnus-active-to-gnus-format
3328 (setq orig (gnus-make-hashtable
3329 (count-lines (point-min) (point-max))))))
3330 (dolist (expiring-group (gnus-groups-from-server
3331 gnus-command-method))
3333 (gnus-gethash-safe expiring-group orig)))
3337 (gnus-agent-expire-group-1
3338 expiring-group overview active articles force))))))))
3339 (kill-buffer overview))
3340 (gnus-agent-expire-unagentized-dirs)
3341 (gnus-message 4 (gnus-agent-expire-done-message))))))
3343 (defun gnus-agent-expire-done-message ()
3344 (if (and (> gnus-verbose 4)
3345 (boundp 'gnus-agent-expire-stats))
3346 (let* ((stats (symbol-value 'gnus-agent-expire-stats))
3347 (size (nth 2 stats))
3348 (units '(B KB MB GB)))
3349 (while (and (> size 1024.0)
3351 (setq size (/ size 1024.0)
3354 (format "Expiry recovered %d NOV entries, deleted %d files,\
3361 (defun gnus-agent-expire-unagentized-dirs ()
3362 (when (and gnus-agent-expire-unagentized-dirs
3363 (boundp 'gnus-agent-expire-current-dirs))
3364 (let* ((keep (gnus-make-hashtable))
3365 ;; Formally bind gnus-agent-expire-current-dirs so that the
3366 ;; compiler will not complain about free references.
3367 (gnus-agent-expire-current-dirs
3368 (symbol-value 'gnus-agent-expire-current-dirs))
3371 (gnus-sethash gnus-agent-directory t keep)
3372 (while gnus-agent-expire-current-dirs
3373 (setq dir (pop gnus-agent-expire-current-dirs))
3374 (when (and (stringp dir)
3375 (file-directory-p dir))
3376 (while (not (gnus-gethash dir keep))
3377 (gnus-sethash dir t keep)
3378 (setq dir (file-name-directory (directory-file-name dir))))))
3385 "Given a directory, check it and its subdirectories for
3386 membership in the keep hash. If it isn't found, add
3388 (let ((files (directory-files d))
3390 (while (setq file (pop files))
3391 (cond ((equal file ".") ; Ignore self
3393 ((equal file "..") ; Ignore parent
3395 ((equal file ".overview")
3396 ;; Directory must contain .overview to be
3397 ;; agent's cache of a group.
3398 (let ((d (file-name-as-directory d))
3400 ;; Search ancestor's for last directory NOT
3401 ;; found in keep hash.
3402 (while (not (gnus-gethash
3403 (setq d (file-name-directory d)) keep))
3405 d (directory-file-name d)))
3406 ;; if ANY ancestor was NOT in keep hash and
3407 ;; it it's already in to-remove, add it to
3410 (not (member r to-remove)))
3411 (push r to-remove))))
3412 ((file-directory-p (setq file (nnheader-concat d file)))
3413 (funcall checker file)))))))))
3414 (funcall checker (expand-file-name gnus-agent-directory))
3416 (when (and to-remove
3417 (or gnus-expert-user
3419 "gnus-agent-expire has identified local directories that are\
3420 not currently required by any agentized group. Do you wish to consider\
3423 (let ((dir (pop to-remove)))
3424 (if (gnus-y-or-n-p (format "Delete %s? " dir))
3425 (let* (delete-recursive
3430 (if (file-directory-p f-or-d)
3432 (delete-directory f-or-d)
3435 (or (member f '("." ".."))
3436 (funcall delete-recursive
3439 (directory-files f-or-d))
3440 (delete-directory f-or-d)))
3441 (delete-file f-or-d)))))))
3442 (funcall delete-recursive dir))))))))))
3445 (defun gnus-agent-batch ()
3446 "Start Gnus, send queue and fetch session."
3448 (let ((init-file-user "")
3449 (gnus-always-read-dribble-file t))
3451 (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
3452 (gnus-group-send-queue)
3453 (gnus-agent-fetch-session)))
3455 (defun gnus-agent-unread-articles (group)
3456 (let* ((read (gnus-info-read (gnus-get-info group)))
3457 (known (gnus-agent-load-alist group))
3459 (tail-unread unread))
3460 (while (and known read)
3461 (let ((candidate (car (pop known))))
3462 (while (let* ((range (car read))
3463 (min (if (numberp range) range (car range)))
3464 (max (if (numberp range) range (cdr range))))
3465 (cond ((or (not min)
3467 (gnus-agent-append-to-list tail-unread candidate)
3470 (setq read (cdr read))
3471 ;; return t so that I always loop one more
3472 ;; time. If I just iterated off the end of
3473 ;; read, min will become nil and the current
3474 ;; candidate will be added to the unread list.
3477 (gnus-agent-append-to-list tail-unread (car (pop known))))
3480 (defun gnus-agent-uncached-articles (articles group &optional cached-header)
3481 "Restrict ARTICLES to numbers already fetched.
3482 Returns a sublist of ARTICLES that excludes those article ids in GROUP
3483 that have already been fetched.
3484 If CACHED-HEADER is nil, articles are only excluded if the article itself
3487 ;; Logically equivalent to: (gnus-sorted-difference articles (mapcar
3488 ;; 'car gnus-agent-article-alist))
3490 ;; Functionally, I don't need to construct a temp list using mapcar.
3492 (if (and (or gnus-agent-cache (not gnus-plugged))
3493 (gnus-agent-load-alist group))
3494 (let* ((ref gnus-agent-article-alist)
3496 (uncached (list nil))
3497 (tail-uncached uncached))
3498 (while (and ref arts)
3499 (let ((v1 (car arts))
3501 (cond ((< v1 v2) ; v1 does not appear in the reference list
3502 (gnus-agent-append-to-list tail-uncached v1)
3503 (setq arts (cdr arts)))
3505 (unless (or cached-header (cdar ref)) ; v1 is already cached
3506 (gnus-agent-append-to-list tail-uncached v1))
3507 (setq arts (cdr arts))
3508 (setq ref (cdr ref)))
3509 (t ; reference article (v2) preceeds the list being filtered
3510 (setq ref (cdr ref))))))
3512 (gnus-agent-append-to-list tail-uncached (pop arts)))
3514 ;; if gnus-agent-load-alist fails, no articles are cached.
3517 (defun gnus-agent-retrieve-headers (articles group &optional fetch-old)
3519 (gnus-agent-create-buffer)
3520 (let ((gnus-decode-encoded-word-function 'identity)
3521 (file (gnus-agent-article-name ".overview" group))
3522 cached-articles uncached-articles)
3523 (gnus-make-directory (nnheader-translate-file-chars
3524 (file-name-directory file) t))
3526 ;; Populate temp buffer with known headers
3527 (when (file-exists-p file)
3528 (with-current-buffer gnus-agent-overview-buffer
3530 (let ((nnheader-file-coding-system
3531 gnus-agent-file-coding-system))
3532 (nnheader-insert-nov-file file (car articles)))))
3534 (if (setq uncached-articles (gnus-agent-uncached-articles articles group
3537 ;; Populate nntp-server-buffer with uncached headers
3538 (set-buffer nntp-server-buffer)
3540 (cond ((not (eq 'nov (let (gnus-agent) ; Turn off agent
3541 (gnus-retrieve-headers
3542 uncached-articles group fetch-old))))
3543 (nnvirtual-convert-headers))
3544 ((eq 'nntp (car gnus-current-select-method))
3545 ;; The author of gnus-get-newsgroup-headers-xover
3546 ;; reports that the XOVER command is commonly
3547 ;; unreliable. The problem is that recently
3548 ;; posted articles may not be entered into the
3549 ;; NOV database in time to respond to my XOVER
3552 ;; I'm going to use his assumption that the NOV
3553 ;; database is updated in order of ascending
3554 ;; article ID. Therefore, a response containing
3555 ;; article ID N implies that all articles from 1
3556 ;; to N-1 are up-to-date. Therefore, missing
3557 ;; articles in that range have expired.
3559 (set-buffer nntp-server-buffer)
3560 (let* ((fetched-articles (list nil))
3561 (tail-fetched-articles fetched-articles)
3562 (min (cond ((numberp fetch-old)
3563 (max 1 (- (car articles) fetch-old)))
3568 (max (car (last articles))))
3570 ;; Get the list of articles that were fetched
3571 (goto-char (point-min))
3572 (let ((pm (point-max))
3574 (while (< (point) pm)
3575 (when (setq art (gnus-agent-read-article-number))
3576 (gnus-agent-append-to-list tail-fetched-articles art))
3579 ;; Clip this list to the headers that will
3580 ;; actually be returned
3581 (setq fetched-articles (gnus-list-range-intersection
3582 (cdr fetched-articles)
3585 ;; Clip the uncached articles list to exclude
3586 ;; IDs after the last FETCHED header. The
3587 ;; excluded IDs may be fetchable using HEAD.
3588 (if (car tail-fetched-articles)
3589 (setq uncached-articles
3590 (gnus-list-range-intersection
3592 (cons (car uncached-articles)
3593 (car tail-fetched-articles)))))
3595 ;; Create the list of articles that were
3596 ;; "successfully" fetched. Success, in this
3597 ;; case, means that the ID should not be
3598 ;; fetched again. In the case of an expired
3599 ;; article, the header will not be fetched.
3600 (setq uncached-articles
3601 (gnus-sorted-nunion fetched-articles
3605 ;; Erase the temp buffer
3606 (set-buffer gnus-agent-overview-buffer)
3609 ;; Copy the nntp-server-buffer to the temp buffer
3610 (set-buffer nntp-server-buffer)
3611 (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
3613 ;; Merge the temp buffer with the known headers (found on
3614 ;; disk in FILE) into the nntp-server-buffer
3615 (when uncached-articles
3616 (gnus-agent-braid-nov group uncached-articles file))
3618 ;; Save the new set of known headers to FILE
3619 (set-buffer nntp-server-buffer)
3620 (let ((coding-system-for-write
3621 gnus-agent-file-coding-system))
3622 (gnus-agent-check-overview-buffer)
3623 (write-region (point-min) (point-max) file nil 'silent))
3625 ;; Update the group's article alist to include the newly
3626 ;; fetched articles.
3627 (gnus-agent-load-alist group)
3628 (gnus-agent-save-alist group uncached-articles nil)
3631 ;; Copy the temp buffer to the nntp-server-buffer
3632 (set-buffer nntp-server-buffer)
3634 (insert-buffer-substring gnus-agent-overview-buffer)))
3637 (not (numberp fetch-old)))
3638 t ; Don't remove anything.
3639 (nnheader-nov-delete-outside-range
3640 (if fetch-old (max 1 (- (car articles) fetch-old))
3642 (car (last articles)))
3647 (defun gnus-agent-request-article (article group)
3648 "Retrieve ARTICLE in GROUP from the agent cache."
3649 (when (and gnus-agent
3650 (or gnus-agent-cache
3653 (let* ((gnus-command-method (gnus-find-method-for-group group))
3654 (file (gnus-agent-article-name (number-to-string article) group))
3655 (buffer-read-only nil))
3656 (when (and (file-exists-p file)
3657 (> (nth 7 (file-attributes file)) 0))
3659 (gnus-kill-all-overlays)
3660 (let ((coding-system-for-read gnus-cache-coding-system))
3661 (insert-file-contents file))
3664 (defun gnus-agent-regenerate-group (group &optional reread)
3666 If REREAD is t, all articles in the .overview are marked as unread.
3667 If REREAD is a list, the specified articles will be marked as unread.
3668 In addition, their NOV entries in .overview will be refreshed using
3669 the articles' current headers.
3670 If REREAD is not nil, downloaded articles are marked as unread."
3672 (list (let ((def (or (gnus-group-group-name)
3673 gnus-newsgroup-name)))
3674 (let ((select (read-string (if def
3675 (concat "Group Name ("
3678 (if (and (equal "" select)
3684 (cursor-in-echo-area t)
3685 (echo-keystrokes 0))
3686 (message "Mark as unread: (n)one / (a)ll / all (d)ownloaded articles? (n) ")
3687 (setq c (read-char-exclusive))
3689 (cond ((or (eq c ?\r) (eq c ?n) (eq c ?N))
3691 ((or (eq c ?a) (eq c ?A))
3693 ((or (eq c ?d) (eq c ?D))
3694 (throw 'mark 'some)))
3695 (gnus-message 3 "Ignoring unexpected input")
3699 (gnus-message 5 "Regenerating in %s" group)
3700 (let* ((gnus-command-method (or gnus-command-method
3701 (gnus-find-method-for-group group)))
3702 (file (gnus-agent-article-name ".overview" group))
3703 (dir (file-name-directory file))
3705 (downloaded (if (file-exists-p dir)
3706 (sort (mapcar (lambda (name) (string-to-number name))
3707 (directory-files dir nil "^[0-9]+$" t))
3709 (progn (gnus-make-directory dir) nil)))
3714 (mm-with-unibyte-buffer
3715 (if (file-exists-p file)
3716 (let ((nnheader-file-coding-system
3717 gnus-agent-file-coding-system))
3718 (nnheader-insert-file-contents file)))
3719 (set-buffer-modified-p nil)
3721 ;; Load the article IDs found in the overview file. As a
3722 ;; side-effect, validate the file contents.
3726 (goto-char (point-min))
3727 (while (< (point) (point-max))
3728 (cond ((and (looking-at "[0-9]+\t")
3729 (<= (- (match-end 0) (match-beginning 0)) 9))
3730 (push (read (current-buffer)) nov-arts)
3732 (let ((l1 (car nov-arts))
3733 (l2 (cadr nov-arts)))
3734 (cond ((and (listp reread) (memq l1 reread))
3736 (setq nov-arts (cdr nov-arts))
3737 (gnus-message 4 "gnus-agent-regenerate-group: NOV\
3738 entry of article %s deleted." l1))
3742 (gnus-message 3 "gnus-agent-regenerate-group: NOV\
3743 entries are NOT in ascending order.")
3744 ;; Don't sort now as I haven't verified
3745 ;; that every line begins with a number
3749 (gnus-message 4 "gnus-agent-regenerate-group: NOV\
3750 entries contained duplicate of article %s. Duplicate deleted." l1)
3752 (setq nov-arts (cdr nov-arts))))))
3754 (gnus-message 1 "gnus-agent-regenerate-group: NOV\
3755 entries contained line that did not begin with an article number. Deleted\
3757 (gnus-delete-line))))
3759 (gnus-message 5 "gnus-agent-regenerate-group: Sorting NOV\
3760 entries into ascending order.")
3761 (sort-numeric-fields 1 (point-min) (point-max))
3762 (setq nov-arts nil))))
3763 (gnus-agent-check-overview-buffer)
3765 ;; Construct a new article alist whose nodes match every header
3766 ;; in the .overview file. As a side-effect, missing headers are
3767 ;; reconstructed from the downloaded article file.
3768 (while (or downloaded nov-arts)
3769 (cond ((and downloaded
3771 (> (car downloaded) (car nov-arts))))
3772 ;; This entry is missing from the overview file
3773 (gnus-message 3 "Regenerating NOV %s %d..." group
3775 (let ((file (concat dir (number-to-string (car downloaded)))))
3776 (mm-with-unibyte-buffer
3777 (nnheader-insert-file-contents file)
3778 (nnheader-remove-body)
3779 (setq header (nnheader-parse-naked-head)))
3780 (mail-header-set-number header (car downloaded))
3782 (let ((key (concat "^" (int-to-string (car nov-arts))
3784 (or (re-search-backward key nil t)
3785 (re-search-forward key))
3787 (goto-char (point-min)))
3788 (nnheader-insert-nov header))
3789 (setq nov-arts (cons (car downloaded) nov-arts)))
3790 ((eq (car downloaded) (car nov-arts))
3791 ;; This entry in the overview has been downloaded
3792 (push (cons (car downloaded)
3794 (nth 5 (file-attributes
3795 (concat dir (number-to-string
3796 (car downloaded))))))) alist)
3797 (setq downloaded (cdr downloaded))
3798 (setq nov-arts (cdr nov-arts)))
3800 ;; This entry in the overview has not been downloaded
3801 (push (cons (car nov-arts) nil) alist)
3802 (setq nov-arts (cdr nov-arts)))))
3804 ;; When gnus-agent-consider-all-articles is set,
3805 ;; gnus-agent-regenerate-group should NOT remove article IDs from
3806 ;; the alist. Those IDs serve as markers to indicate that an
3807 ;; attempt has been made to fetch that article's header.
3809 ;; When gnus-agent-consider-all-articles is NOT set,
3810 ;; gnus-agent-regenerate-group can remove the article ID of every
3811 ;; article (with the exception of the last ID in the list - it's
3812 ;; special) that no longer appears in the overview. In this
3813 ;; situtation, the last article ID in the list implies that it,
3814 ;; and every article ID preceeding it, have been fetched from the
3817 (if gnus-agent-consider-all-articles
3818 ;; Restore all article IDs that were not found in the overview file.
3819 (let* ((n (cons nil alist))
3821 (o (gnus-agent-load-alist group)))
3823 (let ((nID (caadr n))
3826 (setq n (setcdr n (list (list oID))))
3829 (setcdr n (cons (list oID) (cdr n)))
3835 (setq n (cdr n))))))
3836 (setq alist (cdr merged)))
3837 ;; Restore the last article ID if it is not already in the new alist
3838 (let ((n (last alist))
3839 (o (last (gnus-agent-load-alist group))))
3843 (push (cons (caar o) nil) alist))
3844 ((< (caar n) (caar o))
3845 (setcdr n (list (car o)))))))
3847 (let ((inhibit-quit t))
3848 (if (setq regenerated (buffer-modified-p))
3849 (let ((coding-system-for-write gnus-agent-file-coding-system))
3850 (write-region (point-min) (point-max) file nil 'silent)))
3852 (setq regenerated (or regenerated
3853 (and reread gnus-agent-article-alist)
3854 (not (equal alist gnus-agent-article-alist))))
3856 (setq gnus-agent-article-alist alist)
3859 (gnus-agent-save-alist group)
3861 ;; I have to alter the group's active range NOW as
3862 ;; gnus-make-ascending-articles-unread will use it to
3863 ;; recalculate the number of unread articles in the group
3865 (let ((group (gnus-group-real-name group))
3866 (group-active (or (gnus-active group)
3867 (gnus-activate-group group))))
3868 (gnus-agent-possibly-alter-active group group-active)))))
3870 (when (and reread gnus-agent-article-alist)
3871 (gnus-make-ascending-articles-unread
3875 (delq nil (mapcar (function (lambda (c)
3876 (cond ((eq reread t)
3880 gnus-agent-article-alist))))
3882 (when (gnus-buffer-live-p gnus-group-buffer)
3883 (gnus-group-update-group group t)))
3889 (defun gnus-agent-regenerate (&optional clean reread)
3890 "Regenerate all agent covered files.
3891 If CLEAN, obsolete (ignore)."
3894 (gnus-message 4 "Regenerating Gnus agent files...")
3895 (dolist (gnus-command-method (gnus-agent-covered-methods))
3896 (dolist (group (gnus-groups-from-server gnus-command-method))
3897 (setq regenerated (or (gnus-agent-regenerate-group group reread)
3899 (gnus-message 4 "Regenerating Gnus agent files...done")
3903 (defun gnus-agent-go-online (&optional force)
3904 "Switch servers into online status."
3905 (interactive (list t))
3906 (dolist (server gnus-opened-servers)
3907 (when (eq (nth 1 server) 'offline)
3908 (if (if (eq force 'ask)
3910 (format "Switch %s:%s into online status? "
3911 (caar server) (cadar server)))
3913 (setcar (nthcdr 1 server) 'close)))))
3915 (defun gnus-agent-toggle-group-plugged (group)
3916 "Toggle the status of the server of the current group."
3917 (interactive (list (gnus-group-group-name)))
3918 (let* ((method (gnus-find-method-for-group group))
3919 (status (cadr (assoc method gnus-opened-servers))))
3920 (if (eq status 'offline)
3921 (gnus-server-set-status method 'closed)
3922 (gnus-close-server method)
3923 (gnus-server-set-status method 'offline))
3924 (message "Turn %s:%s from %s to %s." (car method) (cadr method)
3925 (if (eq status 'offline) 'offline 'online)
3926 (if (eq status 'offline) 'online 'offline))))
3928 (defun gnus-agent-group-covered-p (group)
3929 (gnus-agent-method-p (gnus-group-method group)))
3931 (provide 'gnus-agent)
3933 ;;; arch-tag: b0ba4afc-5229-4cee-ad25-9956daa4e91e
3934 ;;; gnus-agent.el ends here