Revision: miles@gnu.org--gnu-2005/gnus--devo--0--patch-37
[gnus] / lisp / gnus-agent.el
1 ;;; gnus-agent.el --- unplugged support for Gnus
2 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; This file is part of GNU Emacs.
7
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)
11 ;; any later version.
12
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.
17
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.
22
23 ;;; Commentary:
24
25 ;;; Code:
26
27 (require 'gnus)
28 (require 'gnus-cache)
29 (require 'nnmail)
30 (require 'nnvirtual)
31 (require 'gnus-sum)
32 (require 'gnus-score)
33 (require 'gnus-srvr)
34 (require 'gnus-util)
35 (eval-when-compile
36   (if (featurep 'xemacs)
37       (require 'itimer)
38     (require 'timer))
39   (require 'cl))
40
41 (eval-and-compile
42   (autoload 'gnus-server-update-server "gnus-srvr")
43   (autoload 'gnus-agent-customize-category "gnus-cus")
44 )
45
46 (defcustom gnus-agent-directory (nnheader-concat gnus-directory "agent/")
47   "Where the Gnus agent will store its files."
48   :group 'gnus-agent
49   :type 'directory)
50
51 (defcustom gnus-agent-plugged-hook nil
52   "Hook run when plugging into the network."
53   :group 'gnus-agent
54   :type 'hook)
55
56 (defcustom gnus-agent-unplugged-hook nil
57   "Hook run when unplugging from the network."
58   :group 'gnus-agent
59   :type 'hook)
60
61 (defcustom gnus-agent-fetched-hook nil
62   "Hook run when finished fetching articles."
63   :version "22.1"
64   :group 'gnus-agent
65   :type 'hook)
66
67 (defcustom gnus-agent-handle-level gnus-level-subscribed
68   "Groups on levels higher than this variable will be ignored by the Agent."
69   :group 'gnus-agent
70   :type 'integer)
71
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'."
75   :group 'gnus-agent
76   :type '(number :tag "days"))
77
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."
81   :group 'gnus-agent
82   :type 'boolean)
83
84 (defcustom gnus-agent-group-mode-hook nil
85   "Hook run in Agent group minor modes."
86   :group 'gnus-agent
87   :type 'hook)
88
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))
92
93 (defcustom gnus-agent-summary-mode-hook nil
94   "Hook run in Agent summary minor modes."
95   :group 'gnus-agent
96   :type 'hook)
97
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))
101
102 (defcustom gnus-agent-server-mode-hook nil
103   "Hook run in Agent summary minor modes."
104   :group 'gnus-agent
105   :type 'hook)
106
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))
110
111 (defcustom gnus-agent-confirmation-function 'y-or-n-p
112   "Function to confirm when error happens."
113   :version "21.1"
114   :group 'gnus-agent
115   :type 'function)
116
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."
120   :version "21.1"
121   :type '(choice (const :tag "Always" t)
122                  (const :tag "Never" nil)
123                  (const :tag "Ask" ask))
124   :group 'gnus-agent)
125
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."
129   :version "21.3"
130   :type '(choice (const :tag "Always" t)
131                  (const :tag "Never" nil)
132                  (const :tag "Ask" ask))
133   :group 'gnus-agent)
134
135 (defcustom gnus-agent-mark-unread-after-downloaded t
136   "Indicate whether to mark articles unread after downloaded."
137   :version "21.1"
138   :type 'boolean
139   :group 'gnus-agent)
140
141 (defcustom gnus-agent-download-marks '(download)
142   "Marks for downloading."
143   :version "21.1"
144   :type '(repeat (symbol :tag "Mark"))
145   :group 'gnus-agent)
146
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."
155   :version "22.1"
156   :type 'boolean
157   :group 'gnus-agent)
158
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
162 this limit."
163   :version "22.1"
164   :group 'gnus-agent
165   :type 'integer)
166
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."
174   :version "22.1"
175   :group 'gnus-agent
176   :type '(radio (const :format "Enable " ENABLE)
177                 (const :format "Disable " DISABLE)))
178
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."
184   :version "22.1"
185   :type 'boolean
186   :group 'gnus-agent)
187
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'."
192   :version "22.1"
193   :type '(repeat symbol)
194   :group 'gnus-agent)
195
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."
200   :version "22.1"
201   :group 'gnus-agent
202   :type '(radio (const :format "Always" always)
203                 (const :format "Never" nil)
204                 (const :format "When plugged" t)))
205
206 (defcustom gnus-agent-prompt-send-queue nil
207   "If non-nil, `gnus-group-send-queue' will prompt if called when
208 unplugged."
209   :version "22.1"
210   :group 'gnus-agent
211   :type 'boolean)
212
213 ;;; Internal variables
214
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).
223 NOTES:
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)
239 (defvar gnus-agent-total-fetched-hashtb nil)
240 (defvar gnus-agent-inhibit-update-total-fetched-for nil)
241 (defvar gnus-agent-need-update-total-fetched-for nil)
242
243 ;; Dynamic variables
244 (defvar gnus-headers)
245 (defvar gnus-score)
246
247 ;;;
248 ;;; Setup
249 ;;;
250
251 (defun gnus-open-agent ()
252   (setq gnus-agent t)
253   (gnus-agent-read-servers)
254   (gnus-category-read)
255   (gnus-agent-create-buffer)
256   (add-hook 'gnus-group-mode-hook 'gnus-agent-mode)
257   (add-hook 'gnus-summary-mode-hook 'gnus-agent-mode)
258   (add-hook 'gnus-server-mode-hook 'gnus-agent-mode))
259
260 (defun gnus-agent-create-buffer ()
261   (if (gnus-buffer-live-p gnus-agent-overview-buffer)
262       t
263     (setq gnus-agent-overview-buffer
264           (gnus-get-buffer-create " *Gnus agent overview*"))
265     (with-current-buffer gnus-agent-overview-buffer
266       (mm-enable-multibyte))
267     nil))
268
269 (gnus-add-shutdown 'gnus-close-agent 'gnus)
270
271 (defun gnus-close-agent ()
272   (setq gnus-category-predicate-cache nil
273         gnus-category-group-cache nil
274         gnus-agent-spam-hashtb nil)
275   (gnus-kill-buffer gnus-agent-overview-buffer))
276
277 ;;;
278 ;;; Utility functions
279 ;;;
280
281 (defmacro gnus-agent-with-refreshed-group (group &rest body)
282   "Performs the body then updates the group's line in the group
283 buffer.  Automatically blocks multiple updates due to recursion."
284 `(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body)
285      (when (and gnus-agent-need-update-total-fetched-for
286                 (not gnus-agent-inhibit-update-total-fetched-for))
287         (save-excursion
288           (set-buffer gnus-group-buffer)
289           (setq gnus-agent-need-update-total-fetched-for nil)
290           (gnus-group-update-group ,group t)))))
291
292 (defun gnus-agent-read-file (file)
293   "Load FILE and do a `read' there."
294   (with-temp-buffer
295     (ignore-errors
296       (nnheader-insert-file-contents file)
297       (goto-char (point-min))
298       (read (current-buffer)))))
299
300 (defsubst gnus-agent-method ()
301   (concat (symbol-name (car gnus-command-method)) "/"
302           (if (equal (cadr gnus-command-method) "")
303               "unnamed"
304             (cadr gnus-command-method))))
305
306 (defsubst gnus-agent-directory ()
307   "The name of the Gnus agent directory."
308   (nnheader-concat gnus-agent-directory
309                    (nnheader-translate-file-chars (gnus-agent-method)) "/"))
310
311 (defun gnus-agent-lib-file (file)
312   "The full name of the Gnus agent library FILE."
313   (expand-file-name file
314                     (file-name-as-directory
315                      (expand-file-name "agent.lib" (gnus-agent-directory)))))
316
317 (defun gnus-agent-cat-set-property (category property value)
318   (if value
319       (setcdr (or (assq property category)
320               (let ((cell (cons property nil)))
321                     (setcdr category (cons cell (cdr category)))
322                     cell)) value)
323     (let ((category category))
324       (while (cond ((eq property (caadr category))
325                     (setcdr category (cddr category))
326                     nil)
327                    (t
328                     (setq category (cdr category)))))))
329   category)
330
331 (eval-when-compile
332   (defmacro gnus-agent-cat-defaccessor (name prop-name)
333     "Define accessor and setter methods for manipulating a list of the form
334 \(NAME (PROPERTY1 VALUE1) ... (PROPERTY_N VALUE_N)).
335 Given the call (gnus-agent-cat-defaccessor func PROPERTY1), the list may be
336 manipulated as follows:
337   (func LIST): Returns VALUE1
338   (setf (func LIST) NEW_VALUE1): Replaces VALUE1 with NEW_VALUE1."
339     `(progn (defmacro ,name (category)
340               (list (quote cdr) (list (quote assq)
341                                       (quote (quote ,prop-name)) category)))
342
343             (define-setf-method ,name (category)
344               (let* ((--category--temp-- (make-symbol "--category--"))
345                      (--value--temp-- (make-symbol "--value--")))
346                 (list (list --category--temp--) ; temporary-variables
347                       (list category)   ; value-forms
348                       (list --value--temp--) ; store-variables
349                       (let* ((category --category--temp--) ; store-form
350                              (value --value--temp--))
351                         (list (quote gnus-agent-cat-set-property)
352                               category
353                               (quote (quote ,prop-name))
354                               value))
355                       (list (quote ,name) --category--temp--) ; access-form
356                       )))))
357   )
358
359 (defmacro gnus-agent-cat-name (category)
360   `(car ,category))
361
362 (gnus-agent-cat-defaccessor
363  gnus-agent-cat-days-until-old             agent-days-until-old)
364 (gnus-agent-cat-defaccessor
365  gnus-agent-cat-enable-expiration          agent-enable-expiration)
366 (gnus-agent-cat-defaccessor
367  gnus-agent-cat-groups                     agent-groups)
368 (gnus-agent-cat-defaccessor
369  gnus-agent-cat-high-score                 agent-high-score)
370 (gnus-agent-cat-defaccessor
371  gnus-agent-cat-length-when-long           agent-length-when-long)
372 (gnus-agent-cat-defaccessor
373  gnus-agent-cat-length-when-short          agent-length-when-short)
374 (gnus-agent-cat-defaccessor
375  gnus-agent-cat-low-score                  agent-low-score)
376 (gnus-agent-cat-defaccessor
377  gnus-agent-cat-predicate                  agent-predicate)
378 (gnus-agent-cat-defaccessor
379  gnus-agent-cat-score-file                 agent-score-file)
380 (gnus-agent-cat-defaccessor
381  gnus-agent-cat-enable-undownloaded-faces agent-enable-undownloaded-faces)
382
383
384 ;; This form is equivalent to defsetf except that it calls make-symbol
385 ;; whereas defsetf calls gensym (Using gensym creates a run-time
386 ;; dependency on the CL library).
387
388 (eval-and-compile
389   (define-setf-method gnus-agent-cat-groups (category)
390     (let* ((--category--temp-- (make-symbol "--category--"))
391            (--groups--temp-- (make-symbol "--groups--")))
392       (list (list --category--temp--)
393             (list category)
394             (list --groups--temp--)
395             (let* ((category --category--temp--)
396                    (groups --groups--temp--))
397               (list (quote gnus-agent-set-cat-groups) category groups))
398             (list (quote gnus-agent-cat-groups) --category--temp--))))
399   )
400
401 (defun gnus-agent-set-cat-groups (category groups)
402   (unless (eq groups 'ignore)
403     (let ((new-g groups)
404           (old-g (gnus-agent-cat-groups category)))
405       (cond ((eq new-g old-g)
406              ;; gnus-agent-add-group is fiddling with the group
407              ;; list. Still, Im done.
408              nil
409              )
410             ((eq new-g (cdr old-g))
411              ;; gnus-agent-add-group is fiddling with the group list
412              (setcdr (or (assq 'agent-groups category)
413                          (let ((cell (cons 'agent-groups nil)))
414                            (setcdr category (cons cell (cdr category)))
415                            cell)) new-g))
416             (t
417              (let ((groups groups))
418                (while groups
419                  (let* ((group        (pop groups))
420                         (old-category (gnus-group-category group)))
421                    (if (eq category old-category)
422                        nil
423                      (setf (gnus-agent-cat-groups old-category)
424                            (delete group (gnus-agent-cat-groups
425                                           old-category))))))
426                ;; Purge cache as preceeding loop invalidated it.
427                (setq gnus-category-group-cache nil))
428
429              (setcdr (or (assq 'agent-groups category)
430                          (let ((cell (cons 'agent-groups nil)))
431                            (setcdr category (cons cell (cdr category)))
432                            cell)) groups))))))
433
434 (defsubst gnus-agent-cat-make (name &optional default-agent-predicate)
435   (list name `(agent-predicate . ,(or default-agent-predicate 'false))))
436
437 ;;; Fetching setup functions.
438
439 (defun gnus-agent-start-fetch ()
440   "Initialize data structures for efficient fetching."
441   (gnus-agent-create-buffer))
442
443 (defun gnus-agent-stop-fetch ()
444   "Save all data structures and clean up."
445   (setq gnus-agent-spam-hashtb nil)
446   (save-excursion
447     (set-buffer nntp-server-buffer)
448     (widen)))
449
450 (defmacro gnus-agent-with-fetch (&rest forms)
451   "Do FORMS safely."
452   `(unwind-protect
453        (let ((gnus-agent-fetching t))
454          (gnus-agent-start-fetch)
455          ,@forms)
456      (gnus-agent-stop-fetch)))
457
458 (put 'gnus-agent-with-fetch 'lisp-indent-function 0)
459 (put 'gnus-agent-with-fetch 'edebug-form-spec '(body))
460
461 (defmacro gnus-agent-append-to-list (tail value)
462   `(setq ,tail (setcdr ,tail (cons ,value nil))))
463
464 (defmacro gnus-agent-message (level &rest args)
465   `(if (<= ,level gnus-verbose)
466        (message ,@args)))
467
468 ;;;
469 ;;; Mode infestation
470 ;;;
471
472 (defvar gnus-agent-mode-hook nil
473   "Hook run when installing agent mode.")
474
475 (defvar gnus-agent-mode nil)
476 (defvar gnus-agent-mode-status '(gnus-agent-mode " Plugged"))
477
478 (defun gnus-agent-mode ()
479   "Minor mode for providing a agent support in Gnus buffers."
480   (let* ((buffer (progn (string-match "^gnus-\\(.*\\)-mode$"
481                                       (symbol-name major-mode))
482                         (match-string 1 (symbol-name major-mode))))
483          (mode (intern (format "gnus-agent-%s-mode" buffer))))
484     (set (make-local-variable 'gnus-agent-mode) t)
485     (set mode nil)
486     (set (make-local-variable mode) t)
487     ;; Set up the menu.
488     (when (gnus-visual-p 'agent-menu 'menu)
489       (funcall (intern (format "gnus-agent-%s-make-menu-bar" buffer))))
490     (unless (assq 'gnus-agent-mode minor-mode-alist)
491       (push gnus-agent-mode-status minor-mode-alist))
492     (unless (assq mode minor-mode-map-alist)
493       (push (cons mode (symbol-value (intern (format "gnus-agent-%s-mode-map"
494                                                      buffer))))
495             minor-mode-map-alist))
496     (when (eq major-mode 'gnus-group-mode)
497       (let ((init-plugged gnus-plugged)
498             (gnus-agent-go-online nil))
499         ;; g-a-t-p does nothing when gnus-plugged isn't changed.
500         ;; Therefore, make certain that the current value does not
501         ;; match the desired initial value.
502         (setq gnus-plugged :unknown)
503         (gnus-agent-toggle-plugged init-plugged)))
504     (gnus-run-hooks 'gnus-agent-mode-hook
505                     (intern (format "gnus-agent-%s-mode-hook" buffer)))))
506
507 (defvar gnus-agent-group-mode-map (make-sparse-keymap))
508 (gnus-define-keys gnus-agent-group-mode-map
509   "Ju" gnus-agent-fetch-groups
510   "Jc" gnus-enter-category-buffer
511   "Jj" gnus-agent-toggle-plugged
512   "Js" gnus-agent-fetch-session
513   "JY" gnus-agent-synchronize-flags
514   "JS" gnus-group-send-queue
515   "Ja" gnus-agent-add-group
516   "Jr" gnus-agent-remove-group
517   "Jo" gnus-agent-toggle-group-plugged)
518
519 (defun gnus-agent-group-make-menu-bar ()
520   (unless (boundp 'gnus-agent-group-menu)
521     (easy-menu-define
522      gnus-agent-group-menu gnus-agent-group-mode-map ""
523      '("Agent"
524        ["Toggle plugged" gnus-agent-toggle-plugged t]
525        ["Toggle group plugged" gnus-agent-toggle-group-plugged t]
526        ["List categories" gnus-enter-category-buffer t]
527        ["Add (current) group to category" gnus-agent-add-group t]
528        ["Remove (current) group from category" gnus-agent-remove-group t]
529        ["Send queue" gnus-group-send-queue gnus-plugged]
530        ("Fetch"
531         ["All" gnus-agent-fetch-session gnus-plugged]
532         ["Group" gnus-agent-fetch-group gnus-plugged])
533        ["Synchronize flags" gnus-agent-synchronize-flags t]
534        ))))
535
536 (defvar gnus-agent-summary-mode-map (make-sparse-keymap))
537 (gnus-define-keys gnus-agent-summary-mode-map
538   "Jj" gnus-agent-toggle-plugged
539   "Ju" gnus-agent-summary-fetch-group
540   "JS" gnus-agent-fetch-group
541   "Js" gnus-agent-summary-fetch-series
542   "J#" gnus-agent-mark-article
543   "J\M-#" gnus-agent-unmark-article
544   "@" gnus-agent-toggle-mark
545   "Jc" gnus-agent-catchup)
546
547 (defun gnus-agent-summary-make-menu-bar ()
548   (unless (boundp 'gnus-agent-summary-menu)
549     (easy-menu-define
550      gnus-agent-summary-menu gnus-agent-summary-mode-map ""
551      '("Agent"
552        ["Toggle plugged" gnus-agent-toggle-plugged t]
553        ["Mark as downloadable" gnus-agent-mark-article t]
554        ["Unmark as downloadable" gnus-agent-unmark-article t]
555        ["Toggle mark" gnus-agent-toggle-mark t]
556        ["Fetch downloadable" gnus-agent-summary-fetch-group t]
557        ["Catchup undownloaded" gnus-agent-catchup t]))))
558
559 (defvar gnus-agent-server-mode-map (make-sparse-keymap))
560 (gnus-define-keys gnus-agent-server-mode-map
561   "Jj" gnus-agent-toggle-plugged
562   "Ja" gnus-agent-add-server
563   "Jr" gnus-agent-remove-server)
564
565 (defun gnus-agent-server-make-menu-bar ()
566   (unless (boundp 'gnus-agent-server-menu)
567     (easy-menu-define
568      gnus-agent-server-menu gnus-agent-server-mode-map ""
569      '("Agent"
570        ["Toggle plugged" gnus-agent-toggle-plugged t]
571        ["Add" gnus-agent-add-server t]
572        ["Remove" gnus-agent-remove-server t]))))
573
574 (defun gnus-agent-make-mode-line-string (string mouse-button mouse-func)
575   (if (and (fboundp 'propertize)
576            (fboundp 'make-mode-line-mouse-map))
577       (propertize string 'local-map
578                   (make-mode-line-mouse-map mouse-button mouse-func))
579     string))
580
581 (defun gnus-agent-toggle-plugged (set-to)
582   "Toggle whether Gnus is unplugged or not."
583   (interactive (list (not gnus-plugged)))
584   (cond ((eq set-to gnus-plugged)
585          nil)
586         (set-to
587          (setq gnus-plugged set-to)
588          (gnus-run-hooks 'gnus-agent-plugged-hook)
589          (setcar (cdr gnus-agent-mode-status)
590                  (gnus-agent-make-mode-line-string " Plugged"
591                                                    'mouse-2
592                                                    'gnus-agent-toggle-plugged))
593          (gnus-agent-go-online gnus-agent-go-online)
594          (gnus-agent-possibly-synchronize-flags))
595         (t
596          (gnus-agent-close-connections)
597          (setq gnus-plugged set-to)
598          (gnus-run-hooks 'gnus-agent-unplugged-hook)
599          (setcar (cdr gnus-agent-mode-status)
600                  (gnus-agent-make-mode-line-string " Unplugged"
601                                                    'mouse-2
602                                                    'gnus-agent-toggle-plugged))))
603   (set-buffer-modified-p t))
604
605 (defmacro gnus-agent-while-plugged (&rest body)
606   `(let ((original-gnus-plugged gnus-plugged))
607     (unwind-protect
608         (progn (gnus-agent-toggle-plugged t)
609                ,@body)
610       (gnus-agent-toggle-plugged original-gnus-plugged))))
611
612 (put 'gnus-agent-while-plugged 'lisp-indent-function 0)
613 (put 'gnus-agent-while-plugged 'edebug-form-spec '(body))
614
615 (defun gnus-agent-close-connections ()
616   "Close all methods covered by the Gnus agent."
617   (let ((methods (gnus-agent-covered-methods)))
618     (while methods
619       (gnus-close-server (pop methods)))))
620
621 ;;;###autoload
622 (defun gnus-unplugged ()
623   "Start Gnus unplugged."
624   (interactive)
625   (setq gnus-plugged nil)
626   (gnus))
627
628 ;;;###autoload
629 (defun gnus-plugged ()
630   "Start Gnus plugged."
631   (interactive)
632   (setq gnus-plugged t)
633   (gnus))
634
635 ;;;###autoload
636 (defun gnus-slave-unplugged (&optional arg)
637   "Read news as a slave unplugged."
638   (interactive "P")
639   (setq gnus-plugged nil)
640   (gnus arg nil 'slave))
641
642 ;;;###autoload
643 (defun gnus-agentize ()
644   "Allow Gnus to be an offline newsreader.
645
646 The gnus-agentize function is now called internally by gnus when
647 gnus-agent is set.  If you wish to avoid calling gnus-agentize,
648 customize gnus-agent to nil.
649
650 This will modify the `gnus-setup-news-hook', and
651 `message-send-mail-real-function' variables, and install the Gnus agent
652 minor mode in all Gnus buffers."
653   (interactive)
654   (gnus-open-agent)
655   (add-hook 'gnus-setup-news-hook 'gnus-agent-queue-setup)
656   (unless gnus-agent-send-mail-function
657     (setq gnus-agent-send-mail-function
658           (or message-send-mail-real-function
659               (function (lambda () (funcall message-send-mail-function))))
660           message-send-mail-real-function 'gnus-agent-send-mail))
661
662   ;; If the servers file doesn't exist, auto-agentize some servers and
663   ;; save the servers file so this auto-agentizing isn't invoked
664   ;; again.
665   (unless (file-exists-p (nnheader-concat gnus-agent-directory "lib/servers"))
666     (gnus-message 3 "First time agent user, agentizing remote groups...")
667     (mapc
668      (lambda (server-or-method)
669        (let ((method (gnus-server-to-method server-or-method)))
670          (when (memq (car method)
671                      gnus-agent-auto-agentize-methods)
672            (push (gnus-method-to-server method)
673                  gnus-agent-covered-methods)
674            (setq gnus-agent-method-p-cache nil))))
675      (cons gnus-select-method gnus-secondary-select-methods))
676     (gnus-agent-write-servers)))
677
678 (defun gnus-agent-queue-setup (&optional group-name)
679   "Make sure the queue group exists.
680 Optional arg GROUP-NAME allows to specify another group."
681   (unless (gnus-gethash (format "nndraft:%s" (or group-name "queue"))
682                         gnus-newsrc-hashtb)
683     (gnus-request-create-group (or group-name "queue") '(nndraft ""))
684     (let ((gnus-level-default-subscribed 1))
685       (gnus-subscribe-group (format "nndraft:%s" (or group-name "queue"))
686                             nil '(nndraft "")))
687     (gnus-group-set-parameter
688      (format "nndraft:%s" (or group-name "queue"))
689      'gnus-dummy '((gnus-draft-mode)))))
690
691 (defun gnus-agent-send-mail ()
692   (if (or (not gnus-agent-queue-mail)
693           (and gnus-plugged (not (eq gnus-agent-queue-mail 'always))))
694       (funcall gnus-agent-send-mail-function)
695     (goto-char (point-min))
696     (re-search-forward
697      (concat "^" (regexp-quote mail-header-separator) "\n"))
698     (replace-match "\n")
699     (gnus-agent-insert-meta-information 'mail)
700     (gnus-request-accept-article "nndraft:queue" nil t t)))
701
702 (defun gnus-agent-insert-meta-information (type &optional method)
703   "Insert meta-information into the message that says how it's to be posted.
704 TYPE can be either `mail' or `news'.  If the latter, then METHOD can
705 be a select method."
706   (save-excursion
707     (message-remove-header gnus-agent-meta-information-header)
708     (goto-char (point-min))
709     (insert gnus-agent-meta-information-header ": "
710             (symbol-name type) " " (format "%S" method)
711             "\n")
712     (forward-char -1)
713     (while (search-backward "\n" nil t)
714       (replace-match "\\n" t t))))
715
716 (defun gnus-agent-restore-gcc ()
717   "Restore GCC field from saved header."
718   (save-excursion
719     (goto-char (point-min))
720     (while (re-search-forward
721             (concat "^" (regexp-quote gnus-agent-gcc-header) ":") nil t)
722       (replace-match "Gcc:" 'fixedcase))))
723
724 (defun gnus-agent-any-covered-gcc ()
725   (save-restriction
726     (message-narrow-to-headers)
727     (let* ((gcc (mail-fetch-field "gcc" nil t))
728            (methods (and gcc
729                          (mapcar 'gnus-inews-group-method
730                                  (message-unquote-tokens
731                                   (message-tokenize-header
732                                    gcc " ,")))))
733            covered)
734       (while (and (not covered) methods)
735         (setq covered (gnus-agent-method-p (car methods))
736               methods (cdr methods)))
737       covered)))
738
739 ;;;###autoload
740 (defun gnus-agent-possibly-save-gcc ()
741   "Save GCC if Gnus is unplugged."
742   (when (and (not gnus-plugged) (gnus-agent-any-covered-gcc))
743     (save-excursion
744       (goto-char (point-min))
745       (let ((case-fold-search t))
746         (while (re-search-forward "^gcc:" nil t)
747           (replace-match (concat gnus-agent-gcc-header ":") 'fixedcase))))))
748
749 (defun gnus-agent-possibly-do-gcc ()
750   "Do GCC if Gnus is plugged."
751   (when (or gnus-plugged (not (gnus-agent-any-covered-gcc)))
752     (gnus-inews-do-gcc)))
753
754 ;;;
755 ;;; Group mode commands
756 ;;;
757
758 (defun gnus-agent-fetch-groups (n)
759   "Put all new articles in the current groups into the Agent."
760   (interactive "P")
761   (unless gnus-plugged
762     (error "Groups can't be fetched when Gnus is unplugged"))
763   (gnus-group-iterate n 'gnus-agent-fetch-group))
764
765 (defun gnus-agent-fetch-group (&optional group)
766   "Put all new articles in GROUP into the Agent."
767   (interactive (list (gnus-group-group-name)))
768   (setq group (or group gnus-newsgroup-name))
769   (unless group
770     (error "No group on the current line"))
771
772   (gnus-agent-while-plugged
773     (let ((gnus-command-method (gnus-find-method-for-group group)))
774       (gnus-agent-with-fetch
775         (gnus-agent-fetch-group-1 group gnus-command-method)
776         (gnus-message 5 "Fetching %s...done" group)))))
777
778 (defun gnus-agent-add-group (category arg)
779   "Add the current group to an agent category."
780   (interactive
781    (list
782     (intern
783      (completing-read
784       "Add to category: "
785       (mapcar (lambda (cat) (list (symbol-name (car cat))))
786               gnus-category-alist)
787       nil t))
788     current-prefix-arg))
789   (let ((cat (assq category gnus-category-alist))
790         c groups)
791     (gnus-group-iterate arg
792       (lambda (group)
793         (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
794           (setf (gnus-agent-cat-groups c)
795                 (delete group (gnus-agent-cat-groups c))))
796         (push group groups)))
797     (setf (gnus-agent-cat-groups cat)
798           (nconc (gnus-agent-cat-groups cat) groups))
799     (gnus-category-write)))
800
801 (defun gnus-agent-remove-group (arg)
802   "Remove the current group from its agent category, if any."
803   (interactive "P")
804   (let (c)
805     (gnus-group-iterate arg
806       (lambda (group)
807         (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
808           (setf (gnus-agent-cat-groups c)
809                 (delete group (gnus-agent-cat-groups c))))))
810     (gnus-category-write)))
811
812 (defun gnus-agent-synchronize-flags ()
813   "Synchronize unplugged flags with servers."
814   (interactive)
815   (save-excursion
816     (dolist (gnus-command-method (gnus-agent-covered-methods))
817       (when (file-exists-p (gnus-agent-lib-file "flags"))
818         (gnus-agent-synchronize-flags-server gnus-command-method)))))
819
820 (defun gnus-agent-possibly-synchronize-flags ()
821   "Synchronize flags according to `gnus-agent-synchronize-flags'."
822   (interactive)
823   (save-excursion
824     (dolist (gnus-command-method (gnus-agent-covered-methods))
825       (when (and (file-exists-p (gnus-agent-lib-file "flags"))
826                  (not (eq (gnus-server-status gnus-command-method) 'offline)))
827         (gnus-agent-possibly-synchronize-flags-server gnus-command-method)))))
828
829 (defun gnus-agent-synchronize-flags-server (method)
830   "Synchronize flags set when unplugged for server."
831   (let ((gnus-command-method method)
832         (gnus-agent nil))
833     (when (file-exists-p (gnus-agent-lib-file "flags"))
834       (set-buffer (get-buffer-create " *Gnus Agent flag synchronize*"))
835       (erase-buffer)
836       (nnheader-insert-file-contents (gnus-agent-lib-file "flags"))
837       (cond ((null gnus-plugged)
838              (gnus-message
839               1 "You must be plugged to synchronize flags with server %s"
840               (nth 1 gnus-command-method)))
841             ((null (gnus-check-server gnus-command-method))
842              (gnus-message
843               1 "Couldn't open server %s" (nth 1 gnus-command-method)))
844             (t
845              (condition-case err
846                  (while t
847                    (let ((bgn (point)))
848                      (eval (read (current-buffer)))
849                      (delete-region bgn (point))))
850                (end-of-file
851                 (delete-file (gnus-agent-lib-file "flags")))
852                (error
853                 (let ((file (gnus-agent-lib-file "flags")))
854                   (write-region (point-min) (point-max)
855                                 (gnus-agent-lib-file "flags") nil 'silent)
856                   (error "Couldn't set flags from file %s due to %s"
857                          file (error-message-string err)))))))
858       (kill-buffer nil))))
859
860 (defun gnus-agent-possibly-synchronize-flags-server (method)
861   "Synchronize flags for server according to `gnus-agent-synchronize-flags'."
862   (when (or (and gnus-agent-synchronize-flags
863                  (not (eq gnus-agent-synchronize-flags 'ask)))
864             (and (eq gnus-agent-synchronize-flags 'ask)
865                  (gnus-y-or-n-p (format "Synchronize flags on server `%s'? "
866                                         (cadr method)))))
867     (gnus-agent-synchronize-flags-server method)))
868
869 ;;;###autoload
870 (defun gnus-agent-rename-group (old-group new-group)
871   "Rename fully-qualified OLD-GROUP as NEW-GROUP.  Always updates the agent, even when
872 disabled, as the old agent files would corrupt gnus when the agent was
873 next enabled. Depends upon the caller to determine whether group renaming is supported."
874   (let* ((old-command-method (gnus-find-method-for-group old-group))
875          (old-path           (directory-file-name
876                               (let (gnus-command-method old-command-method)
877                                 (gnus-agent-group-pathname old-group))))
878          (new-command-method (gnus-find-method-for-group new-group))
879          (new-path           (directory-file-name
880                               (let (gnus-command-method new-command-method)
881                                 (gnus-agent-group-pathname new-group)))))
882     (gnus-rename-file old-path new-path t)
883
884     (let* ((old-real-group (gnus-group-real-name old-group))
885            (new-real-group (gnus-group-real-name new-group))
886            (old-active (gnus-agent-get-group-info old-command-method old-real-group)))
887       (gnus-agent-save-group-info old-command-method old-real-group nil)
888       (gnus-agent-save-group-info new-command-method new-real-group old-active)
889
890       (let ((old-local (gnus-agent-get-local old-group
891                                              old-real-group old-command-method)))
892         (gnus-agent-set-local old-group
893                               nil nil
894                               old-real-group old-command-method)
895         (gnus-agent-set-local new-group
896                               (car old-local) (cdr old-local)
897                               new-real-group new-command-method)))))
898
899 ;;;###autoload
900 (defun gnus-agent-delete-group (group)
901   "Delete fully-qualified GROUP.  Always updates the agent, even when
902 disabled, as the old agent files would corrupt gnus when the agent was
903 next enabled. Depends upon the caller to determine whether group deletion is supported."
904   (let* ((command-method (gnus-find-method-for-group group))
905          (path           (directory-file-name
906                           (let (gnus-command-method command-method)
907                             (gnus-agent-group-pathname group)))))
908     (gnus-delete-directory path)
909
910     (let* ((real-group (gnus-group-real-name group)))
911       (gnus-agent-save-group-info command-method real-group nil)
912
913       (let ((local (gnus-agent-get-local group
914                                          real-group command-method)))
915         (gnus-agent-set-local group
916                               nil nil
917                               real-group command-method)))))
918
919 ;;;
920 ;;; Server mode commands
921 ;;;
922
923 (defun gnus-agent-add-server ()
924   "Enroll SERVER in the agent program."
925   (interactive)
926   (let* ((server       (gnus-server-server-name))
927          (named-server (gnus-server-named-server))
928          (method       (and server
929                             (gnus-server-get-method nil server))))
930     (unless server
931       (error "No server on the current line"))
932
933     (when (gnus-agent-method-p method)
934       (error "Server already in the agent program"))
935
936     (push named-server gnus-agent-covered-methods)
937
938     (setq gnus-agent-method-p-cache nil)
939     (gnus-server-update-server server)
940     (gnus-agent-write-servers)
941     (gnus-message 1 "Entered %s into the Agent" server)))
942
943 (defun gnus-agent-remove-server ()
944   "Remove SERVER from the agent program."
945   (interactive)
946   (let* ((server       (gnus-server-server-name))
947          (named-server (gnus-server-named-server)))
948     (unless server
949       (error "No server on the current line"))
950
951     (unless (member named-server gnus-agent-covered-methods)
952       (error "Server not in the agent program"))
953
954     (setq gnus-agent-covered-methods
955           (delete named-server gnus-agent-covered-methods)
956           gnus-agent-method-p-cache nil)
957
958     (gnus-server-update-server server)
959     (gnus-agent-write-servers)
960     (gnus-message 1 "Removed %s from the agent" server)))
961
962 (defun gnus-agent-read-servers ()
963   "Read the alist of covered servers."
964   (setq gnus-agent-covered-methods
965         (gnus-agent-read-file
966          (nnheader-concat gnus-agent-directory "lib/servers"))
967         gnus-agent-method-p-cache nil)
968
969   ;; I am called so early in start-up that I can not validate server
970   ;; names.  When that is the case, I skip the validation.  That is
971   ;; alright as the gnus startup code calls the validate methods
972   ;; directly.
973   (if gnus-server-alist
974       (gnus-agent-read-servers-validate)))
975
976 (defun gnus-agent-read-servers-validate ()
977   (mapcar (lambda (server-or-method)
978             (let* ((server (if (stringp server-or-method)
979                                server-or-method
980                              (gnus-method-to-server server-or-method)))
981                    (method (gnus-server-to-method server)))
982               (if method
983                   (unless (member server gnus-agent-covered-methods)
984                     (push server gnus-agent-covered-methods)
985                     (setq gnus-agent-method-p-cache nil))
986                 (gnus-message 1 "Ignoring disappeared server `%s'" server))))
987           (prog1 gnus-agent-covered-methods
988             (setq gnus-agent-covered-methods nil))))
989
990 (defun gnus-agent-read-servers-validate-native (native-method)
991   (setq gnus-agent-covered-methods
992         (mapcar (lambda (method)
993                   (if (or (not method)
994                           (equal method native-method))
995                       "native"
996                     method)) gnus-agent-covered-methods)))
997
998 (defun gnus-agent-write-servers ()
999   "Write the alist of covered servers."
1000   (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
1001   (let ((coding-system-for-write nnheader-file-coding-system)
1002         (file-name-coding-system nnmail-pathname-coding-system))
1003     (with-temp-file (nnheader-concat gnus-agent-directory "lib/servers")
1004       (prin1 gnus-agent-covered-methods
1005              (current-buffer)))))
1006
1007 ;;;
1008 ;;; Summary commands
1009 ;;;
1010
1011 (defun gnus-agent-mark-article (n &optional unmark)
1012   "Mark the next N articles as downloadable.
1013 If N is negative, mark backward instead.  If UNMARK is non-nil, remove
1014 the mark instead.  The difference between N and the actual number of
1015 articles marked is returned."
1016   (interactive "p")
1017   (let ((backward (< n 0))
1018         (n (abs n)))
1019     (while (and
1020             (> n 0)
1021             (progn
1022               (gnus-summary-set-agent-mark
1023                (gnus-summary-article-number) unmark)
1024               (zerop (gnus-summary-next-subject (if backward -1 1) nil t))))
1025       (setq n (1- n)))
1026     (when (/= 0 n)
1027       (gnus-message 7 "No more articles"))
1028     (gnus-summary-recenter)
1029     (gnus-summary-position-point)
1030     n))
1031
1032 (defun gnus-agent-unmark-article (n)
1033   "Remove the downloadable mark from the next N articles.
1034 If N is negative, unmark backward instead.  The difference between N and
1035 the actual number of articles unmarked is returned."
1036   (interactive "p")
1037   (gnus-agent-mark-article n t))
1038
1039 (defun gnus-agent-toggle-mark (n)
1040   "Toggle the downloadable mark from the next N articles.
1041 If N is negative, toggle backward instead.  The difference between N and
1042 the actual number of articles toggled is returned."
1043   (interactive "p")
1044   (gnus-agent-mark-article n 'toggle))
1045
1046 (defun gnus-summary-set-agent-mark (article &optional unmark)
1047   "Mark ARTICLE as downloadable.  If UNMARK is nil, article is marked.
1048 When UNMARK is t, the article is unmarked.  For any other value, the
1049 article's mark is toggled."
1050   (let ((unmark (cond ((eq nil unmark)
1051                        nil)
1052                       ((eq t unmark)
1053                        t)
1054                       (t
1055                        (memq article gnus-newsgroup-downloadable)))))
1056     (when (gnus-summary-goto-subject article nil t)
1057       (gnus-summary-update-mark
1058        (if unmark
1059            (progn
1060              (setq gnus-newsgroup-downloadable
1061                    (delq article gnus-newsgroup-downloadable))
1062              (gnus-article-mark article))
1063          (setq gnus-newsgroup-downloadable
1064                (gnus-add-to-sorted-list gnus-newsgroup-downloadable article))
1065          gnus-downloadable-mark)
1066        'unread))))
1067
1068 ;;;###autoload
1069 (defun gnus-agent-get-undownloaded-list ()
1070   "Construct list of articles that have not been downloaded."
1071   (let ((gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name)))
1072     (when (set (make-local-variable 'gnus-newsgroup-agentized)
1073                (gnus-agent-method-p gnus-command-method))
1074       (let* ((alist (gnus-agent-load-alist gnus-newsgroup-name))
1075              (headers (sort (mapcar (lambda (h)
1076                                       (mail-header-number h))
1077                                     gnus-newsgroup-headers) '<))
1078              (cached (and gnus-use-cache gnus-newsgroup-cached))
1079              (undownloaded (list nil))
1080              (tail-undownloaded undownloaded)
1081              (unfetched (list nil))
1082              (tail-unfetched unfetched))
1083         (while (and alist headers)
1084           (let ((a (caar alist))
1085                 (h (car headers)))
1086             (cond ((< a h)
1087                    ;; Ignore IDs in the alist that are not being
1088                    ;; displayed in the summary.
1089                    (setq alist (cdr alist)))
1090                   ((> a h)
1091                    ;; Headers that are not in the alist should be
1092                    ;; fictious (see nnagent-retrieve-headers); they
1093                    ;; imply that this article isn't in the agent.
1094                    (gnus-agent-append-to-list tail-undownloaded h)
1095                    (gnus-agent-append-to-list tail-unfetched    h)
1096                    (setq headers (cdr headers)))
1097                   ((cdar alist)
1098                    (setq alist (cdr alist))
1099                    (setq headers (cdr headers))
1100                    nil                  ; ignore already downloaded
1101                    )
1102                   (t
1103                    (setq alist (cdr alist))
1104                    (setq headers (cdr headers))
1105
1106                    ;; This article isn't in the agent.  Check to see
1107                    ;; if it is in the cache.  If it is, it's been
1108                    ;; downloaded.
1109                    (while (and cached (< (car cached) a))
1110                      (setq cached (cdr cached)))
1111                    (unless (equal a (car cached))
1112                      (gnus-agent-append-to-list tail-undownloaded a))))))
1113
1114         (while headers
1115           (let ((num (pop headers)))
1116             (gnus-agent-append-to-list tail-undownloaded num)
1117             (gnus-agent-append-to-list tail-unfetched    num)))
1118
1119         (setq gnus-newsgroup-undownloaded (cdr undownloaded)
1120               gnus-newsgroup-unfetched    (cdr unfetched))))))
1121
1122 (defun gnus-agent-catchup ()
1123   "Mark as read all unhandled articles.
1124 An article is unhandled if it is neither cached, nor downloaded, nor
1125 downloadable."
1126   (interactive)
1127   (save-excursion
1128     (let ((articles gnus-newsgroup-undownloaded))
1129       (when (or gnus-newsgroup-downloadable
1130                 gnus-newsgroup-cached)
1131         (setq articles (gnus-sorted-ndifference
1132                         (gnus-sorted-ndifference
1133                          (gnus-copy-sequence articles)
1134                          gnus-newsgroup-downloadable)
1135                         gnus-newsgroup-cached)))
1136
1137       (while articles
1138         (gnus-summary-mark-article
1139          (pop articles) gnus-catchup-mark)))
1140     (gnus-summary-position-point)))
1141
1142 (defun gnus-agent-summary-fetch-series ()
1143   (interactive)
1144   (when gnus-newsgroup-processable
1145     (setq gnus-newsgroup-downloadable
1146           (let* ((dl gnus-newsgroup-downloadable)
1147                  (gnus-newsgroup-downloadable
1148                   (sort (gnus-copy-sequence gnus-newsgroup-processable) '<))
1149                  (fetched-articles (gnus-agent-summary-fetch-group)))
1150             ;; The preceeding call to (gnus-agent-summary-fetch-group)
1151             ;; updated gnus-newsgroup-downloadable to remove each
1152             ;; article successfully fetched.
1153
1154             ;; For each article that I processed, remove its
1155             ;; processable mark IF the article is no longer
1156             ;; downloadable (i.e. it's already downloaded)
1157             (dolist (article gnus-newsgroup-processable)
1158               (unless (memq article gnus-newsgroup-downloadable)
1159                 (gnus-summary-remove-process-mark article)))
1160             (gnus-sorted-ndifference dl fetched-articles)))))
1161
1162 (defun gnus-agent-summary-fetch-group (&optional all)
1163   "Fetch the downloadable articles in the group.
1164 Optional arg ALL, if non-nil, means to fetch all articles."
1165   (interactive "P")
1166   (let ((articles
1167          (if all gnus-newsgroup-articles
1168            gnus-newsgroup-downloadable))
1169         (gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name))
1170         fetched-articles)
1171     (gnus-agent-while-plugged
1172       (unless articles
1173         (error "No articles to download"))
1174       (gnus-agent-with-fetch
1175         (setq gnus-newsgroup-undownloaded
1176               (gnus-sorted-ndifference
1177                gnus-newsgroup-undownloaded
1178                (setq fetched-articles
1179                      (gnus-agent-fetch-articles
1180                       gnus-newsgroup-name articles)))))
1181       (save-excursion
1182         (dolist (article articles)
1183           (let ((was-marked-downloadable
1184                  (memq article gnus-newsgroup-downloadable)))
1185             (cond (gnus-agent-mark-unread-after-downloaded
1186                    (setq gnus-newsgroup-downloadable
1187                          (delq article gnus-newsgroup-downloadable))
1188
1189                    (gnus-summary-mark-article article gnus-unread-mark))
1190                   (was-marked-downloadable
1191                    (gnus-summary-set-agent-mark article t)))
1192             (when (gnus-summary-goto-subject article nil t)
1193               (gnus-summary-update-download-mark article))))))
1194     fetched-articles))
1195
1196 (defun gnus-agent-fetch-selected-article ()
1197   "Fetch the current article as it is selected.
1198 This can be added to `gnus-select-article-hook' or
1199 `gnus-mark-article-hook'."
1200   (let ((gnus-command-method gnus-current-select-method))
1201     (when (and gnus-plugged (gnus-agent-method-p gnus-command-method))
1202       (when (gnus-agent-fetch-articles
1203              gnus-newsgroup-name
1204              (list gnus-current-article))
1205         (setq gnus-newsgroup-undownloaded
1206               (delq gnus-current-article gnus-newsgroup-undownloaded))
1207         (gnus-summary-update-download-mark gnus-current-article)))))
1208
1209 ;;;
1210 ;;; Internal functions
1211 ;;;
1212
1213 (defun gnus-agent-synchronize-group-flags (group actions server)
1214 "Update a plugged group by performing the indicated actions."
1215   (let* ((gnus-command-method (gnus-server-to-method server))
1216          (info
1217           ;; This initializer is required as gnus-request-set-mark
1218           ;; calls gnus-group-real-name to strip off the host name
1219           ;; before calling the backend.  Now that the backend is
1220           ;; trying to call gnus-request-set-mark, I have to
1221           ;; reconstruct the original group name.
1222           (or (gnus-get-info group)
1223               (gnus-get-info
1224                (setq group (gnus-group-full-name
1225                             group gnus-command-method))))))
1226     (gnus-request-set-mark group actions)
1227
1228     (when info
1229       (dolist (action actions)
1230         (let ((range (nth 0 action))
1231               (what  (nth 1 action))
1232               (marks (nth 2 action)))
1233           (dolist (mark marks)
1234             (cond ((eq mark 'read)
1235                    (gnus-info-set-read
1236                     info
1237                     (funcall (if (eq what 'add)
1238                                  'gnus-range-add
1239                                'gnus-remove-from-range)
1240                              (gnus-info-read info)
1241                              range))
1242                    (gnus-get-unread-articles-in-group
1243                     info
1244                     (gnus-active (gnus-info-group info))))
1245                   ((memq mark '(tick))
1246                    (let ((info-marks (assoc mark (gnus-info-marks info))))
1247                      (unless info-marks
1248                        (gnus-info-set-marks info (cons (setq info-marks (list mark)) (gnus-info-marks info))))
1249                      (setcdr info-marks (funcall (if (eq what 'add)
1250                                   'gnus-range-add
1251                                 'gnus-remove-from-range)
1252                               (cdr info-marks)
1253                               range)))))))))
1254     nil))
1255
1256 (defun gnus-agent-save-active (method)
1257   (when (gnus-agent-method-p method)
1258     (let* ((gnus-command-method method)
1259            (new (gnus-make-hashtable (count-lines (point-min) (point-max))))
1260            (file (gnus-agent-lib-file "active")))
1261       (gnus-active-to-gnus-format nil new)
1262       (gnus-agent-write-active file new)
1263       (erase-buffer)
1264       (nnheader-insert-file-contents file))))
1265
1266 (defun gnus-agent-write-active (file new)
1267     (gnus-make-directory (file-name-directory file))
1268     (let ((nnmail-active-file-coding-system gnus-agent-file-coding-system))
1269       ;; The hashtable contains real names of groups.  However, do NOT
1270       ;; add the foreign server prefix as gnus-active-to-gnus-format
1271       ;; will add it while reading the file.
1272       (gnus-write-active-file file new nil)))
1273
1274 ;;;###autoload
1275 (defun gnus-agent-possibly-alter-active (group active &optional info)
1276   "Possibly expand a group's active range to include articles
1277 downloaded into the agent."
1278   (let* ((gnus-command-method (or gnus-command-method
1279                                   (gnus-find-method-for-group group))))
1280     (when (gnus-agent-method-p gnus-command-method)
1281       (let* ((local (gnus-agent-get-local group))
1282              (active-min (or (car active) 0))
1283              (active-max (or (cdr active) 0))
1284              (agent-min (or (car local) active-min))
1285              (agent-max (or (cdr local) active-max)))
1286
1287         (when (< agent-min active-min)
1288           (setcar active agent-min))
1289
1290         (when (> agent-max active-max)
1291           (setcdr active agent-max))
1292
1293         (when (and info (< agent-max (- active-min 100)))
1294           ;; I'm expanding the active range by such a large amount
1295           ;; that there is a gap of more than 100 articles between the
1296           ;; last article known to the agent and the first article
1297           ;; currently available on the server.  This gap contains
1298           ;; articles that have been lost, mark them as read so that
1299           ;; gnus doesn't waste resources trying to fetch them.
1300
1301           ;; NOTE: I don't do this for smaller gaps (< 100) as I don't
1302           ;; want to modify the local file everytime someone restarts
1303           ;; gnus.  The small gap will cause a tiny performance hit
1304           ;; when gnus tries, and fails, to retrieve the articles.
1305           ;; Still that should be smaller than opening a buffer,
1306           ;; printing this list to the buffer, and then writing it to a
1307           ;; file.
1308
1309           (let ((read (gnus-info-read info)))
1310             (gnus-info-set-read
1311              info
1312              (gnus-range-add
1313               read
1314               (list (cons (1+ agent-max)
1315                           (1- active-min))))))
1316
1317           ;; Lie about the agent's local range for this group to
1318           ;; disable the set read each time this server is opened.
1319           ;; NOTE: Opening this group will restore the valid local
1320           ;; range but it will also expand the local range to
1321           ;; incompass the new active range.
1322           (gnus-agent-set-local group agent-min (1- active-min)))))))
1323
1324 (defun gnus-agent-save-group-info (method group active)
1325   "Update a single group's active range in the agent's copy of the server's active file."
1326   (when (gnus-agent-method-p method)
1327     (let* ((gnus-command-method (or method gnus-command-method))
1328            (coding-system-for-write nnheader-file-coding-system)
1329            (file-name-coding-system nnmail-pathname-coding-system)
1330            (file (gnus-agent-lib-file "active"))
1331            oactive-min oactive-max)
1332       (gnus-make-directory (file-name-directory file))
1333       (with-temp-file file
1334         ;; Emacs got problem to match non-ASCII group in multibyte buffer.
1335         (mm-disable-multibyte)
1336         (when (file-exists-p file)
1337           (nnheader-insert-file-contents file)
1338
1339           (goto-char (point-min))
1340           (when (re-search-forward
1341                  (concat "^" (regexp-quote group) " ") nil t)
1342             (save-excursion
1343               (setq oactive-max (read (current-buffer)) ;; max
1344                     oactive-min (read (current-buffer)))) ;; min
1345             (gnus-delete-line)))
1346         (when active
1347           (insert (format "%S %d %d y\n" (intern group)
1348                           (max (or oactive-max (cdr active)) (cdr active))
1349                           (min (or oactive-min (car active)) (car active))))
1350           (goto-char (point-max))
1351           (while (search-backward "\\." nil t)
1352             (delete-char 1)))))))
1353
1354 (defun gnus-agent-get-group-info (method group)
1355   "Get a single group's active range in the agent's copy of the server's active file."
1356   (when (gnus-agent-method-p method)
1357     (let* ((gnus-command-method (or method gnus-command-method))
1358            (coding-system-for-write nnheader-file-coding-system)
1359            (file-name-coding-system nnmail-pathname-coding-system)
1360            (file (gnus-agent-lib-file "active"))
1361            oactive-min oactive-max)
1362       (gnus-make-directory (file-name-directory file))
1363       (with-temp-buffer
1364         ;; Emacs got problem to match non-ASCII group in multibyte buffer.
1365         (mm-disable-multibyte)
1366         (when (file-exists-p file)
1367           (nnheader-insert-file-contents file)
1368
1369           (goto-char (point-min))
1370           (when (re-search-forward
1371                  (concat "^" (regexp-quote group) " ") nil t)
1372             (save-excursion
1373               (setq oactive-max (read (current-buffer)) ;; max
1374                     oactive-min (read (current-buffer))) ;; min
1375               (cons oactive-min oactive-max))))))))
1376
1377 (defun gnus-agent-group-path (group)
1378   "Translate GROUP into a file name."
1379
1380   ;; NOTE: This is what nnmail-group-pathname does as of Apr 2003.
1381   ;; The two methods must be kept synchronized, which is why
1382   ;; gnus-agent-group-pathname was added.
1383
1384   (setq group
1385         (nnheader-translate-file-chars
1386          (nnheader-replace-duplicate-chars-in-string
1387           (nnheader-replace-chars-in-string
1388            (gnus-group-real-name (gnus-group-decoded-name group))
1389            ?/ ?_)
1390           ?. ?_)))
1391   (if (or nnmail-use-long-file-names
1392           (file-directory-p (expand-file-name group (gnus-agent-directory))))
1393       group
1394     (mm-encode-coding-string
1395      (nnheader-replace-chars-in-string group ?. ?/)
1396      nnmail-pathname-coding-system)))
1397
1398 (defun gnus-agent-group-pathname (group)
1399   "Translate GROUP into a file name."
1400   ;; nnagent uses nnmail-group-pathname to read articles while
1401   ;; unplugged.  The agent must, therefore, use the same directory
1402   ;; while plugged.
1403   (let ((gnus-command-method (or gnus-command-method
1404                                  (gnus-find-method-for-group group))))
1405     (nnmail-group-pathname (gnus-group-real-name
1406                             (gnus-group-decoded-name group))
1407                            (gnus-agent-directory))))
1408
1409 (defun gnus-agent-get-function (method)
1410   (if (gnus-online method)
1411       (car method)
1412     (require 'nnagent)
1413     'nnagent))
1414
1415 (defun gnus-agent-covered-methods ()
1416   "Return the subset of methods that are covered by the agent."
1417   (delq nil (mapcar #'gnus-server-to-method gnus-agent-covered-methods)))
1418
1419 ;;; History functions
1420
1421 (defun gnus-agent-history-buffer ()
1422   (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
1423
1424 (defun gnus-agent-open-history ()
1425   (save-excursion
1426     (push (cons (gnus-agent-method)
1427                 (set-buffer (gnus-get-buffer-create
1428                              (format " *Gnus agent %s history*"
1429                                      (gnus-agent-method)))))
1430           gnus-agent-history-buffers)
1431     (mm-disable-multibyte) ;; everything is binary
1432     (erase-buffer)
1433     (insert "\n")
1434     (let ((file (gnus-agent-lib-file "history")))
1435       (when (file-exists-p file)
1436         (nnheader-insert-file-contents file))
1437       (set (make-local-variable 'gnus-agent-file-name) file))))
1438
1439 (defun gnus-agent-close-history ()
1440   (when (gnus-buffer-live-p gnus-agent-current-history)
1441     (kill-buffer gnus-agent-current-history)
1442     (setq gnus-agent-history-buffers
1443           (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
1444                 gnus-agent-history-buffers))))
1445
1446 ;;;
1447 ;;; Fetching
1448 ;;;
1449
1450 (defun gnus-agent-fetch-articles (group articles)
1451   "Fetch ARTICLES from GROUP and put them into the Agent."
1452   (when articles
1453     (gnus-agent-load-alist group)
1454     (let* ((alist   gnus-agent-article-alist)
1455            (headers (if (< (length articles) 2) nil gnus-newsgroup-headers))
1456            (selected-sets (list nil))
1457            (current-set-size 0)
1458            article
1459            header-number)
1460       ;; Check each article
1461       (while (setq article (pop articles))
1462         ;; Skip alist entries preceeding this article
1463         (while (> article (or (caar alist) (1+ article)))
1464           (setq alist (cdr alist)))
1465
1466         ;; Prune off articles that we have already fetched.
1467         (unless (and (eq article (caar alist))
1468                      (cdar alist))
1469           ;; Skip headers preceeding this article
1470           (while (> article
1471                     (setq header-number
1472                           (let* ((header (car headers)))
1473                             (if header
1474                                 (mail-header-number header)
1475                               (1+ article)))))
1476             (setq headers (cdr headers)))
1477
1478           ;; Add this article to the current set
1479           (setcar selected-sets (cons article (car selected-sets)))
1480
1481           ;; Update the set size, when the set is too large start a
1482           ;; new one.  I do this after adding the article as I want at
1483           ;; least one article in each set.
1484           (when (< gnus-agent-max-fetch-size
1485                    (setq current-set-size
1486                          (+ current-set-size
1487                             (if (= header-number article)
1488                                 (let ((char-size (mail-header-chars
1489                                                   (car headers))))
1490                                   (if (<= char-size 0)
1491                                       ;; The char size was missing/invalid,
1492                                       ;; assume a worst-case situation of
1493                                       ;; 65 char/line.  If the line count
1494                                       ;; is missing, arbitrarily assume a
1495                                       ;; size of 1000 characters.
1496                                     (max (* 65 (mail-header-lines
1497                                                 (car headers)))
1498                                          1000)
1499                                     char-size))
1500                               0))))
1501             (setcar selected-sets (nreverse (car selected-sets)))
1502             (setq selected-sets (cons nil selected-sets)
1503                   current-set-size 0))))
1504
1505       (when (or (cdr selected-sets) (car selected-sets))
1506         (let* ((fetched-articles (list nil))
1507                (tail-fetched-articles fetched-articles)
1508                (dir (gnus-agent-group-pathname group))
1509                (date (time-to-days (current-time)))
1510                (case-fold-search t)
1511                pos crosses id)
1512
1513           (setcar selected-sets (nreverse (car selected-sets)))
1514           (setq selected-sets (nreverse selected-sets))
1515
1516           (gnus-make-directory dir)
1517           (gnus-message 7 "Fetching articles for %s..." group)
1518
1519           (unwind-protect
1520               (while (setq articles (pop selected-sets))
1521                 ;; Fetch the articles from the backend.
1522                 (if (gnus-check-backend-function 'retrieve-articles group)
1523                     (setq pos (gnus-retrieve-articles articles group))
1524                   (with-temp-buffer
1525                     (let (article)
1526                       (while (setq article (pop articles))
1527                         (gnus-message 10 "Fetching article %s for %s..."
1528                                       article group)
1529                         (when (or
1530                                (gnus-backlog-request-article group article
1531                                                              nntp-server-buffer)
1532                                (gnus-request-article article group))
1533                           (goto-char (point-max))
1534                           (push (cons article (point)) pos)
1535                           (insert-buffer-substring nntp-server-buffer)))
1536                       (copy-to-buffer
1537                        nntp-server-buffer (point-min) (point-max))
1538                       (setq pos (nreverse pos)))))
1539                 ;; Then save these articles into the Agent.
1540                 (save-excursion
1541                   (set-buffer nntp-server-buffer)
1542                   (while pos
1543                     (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
1544                     (goto-char (point-min))
1545                     (unless (eobp) ;; Don't save empty articles.
1546                       (when (search-forward "\n\n" nil t)
1547                         (when (search-backward "\nXrefs: " nil t)
1548                           ;; Handle cross posting.
1549                           (goto-char (match-end 0)) ; move to end of header name
1550                           (skip-chars-forward "^ ") ; skip server name
1551                           (skip-chars-forward " ")
1552                           (setq crosses nil)
1553                           (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) *")
1554                             (push (cons (buffer-substring (match-beginning 1)
1555                                                           (match-end 1))
1556                                         (string-to-int
1557                                          (buffer-substring (match-beginning 2)
1558                                                            (match-end 2))))
1559                                   crosses)
1560                             (goto-char (match-end 0)))
1561                           (gnus-agent-crosspost crosses (caar pos) date)))
1562                       (goto-char (point-min))
1563                       (if (not (re-search-forward
1564                                 "^Message-ID: *<\\([^>\n]+\\)>" nil t))
1565                           (setq id "No-Message-ID-in-article")
1566                         (setq id (buffer-substring
1567                                   (match-beginning 1) (match-end 1))))
1568                       (let ((coding-system-for-write
1569                              gnus-agent-file-coding-system))
1570                         (write-region (point-min) (point-max)
1571                                       (concat dir (number-to-string (caar pos)))
1572                                       nil 'silent))
1573
1574                       (gnus-agent-append-to-list
1575                        tail-fetched-articles (caar pos)))
1576                     (widen)
1577                     (setq pos (cdr pos)))))
1578
1579             (gnus-agent-save-alist group (cdr fetched-articles) date)
1580             (gnus-agent-update-files-total-fetched-for group (cdr fetched-articles))
1581
1582             (gnus-message 7 ""))
1583           (cdr fetched-articles))))))
1584
1585 (defun gnus-agent-unfetch-articles (group articles)
1586   "Delete ARTICLES that were fetched from GROUP into the agent."
1587   (when articles
1588     (gnus-agent-with-refreshed-group 
1589      group
1590      (gnus-agent-load-alist group)
1591      (let* ((alist (cons nil gnus-agent-article-alist))
1592             (articles (sort articles #'<))
1593             (next-possibility alist)
1594             (delete-this (pop articles)))
1595        (while (and (cdr next-possibility) delete-this)
1596          (let ((have-this (caar (cdr next-possibility))))
1597            (cond ((< delete-this have-this)
1598                   (setq delete-this (pop articles)))
1599                  ((= delete-this have-this)
1600                   (let ((timestamp (cdar (cdr next-possibility))))
1601                     (when timestamp
1602                       (let* ((file-name (concat (gnus-agent-group-pathname group)
1603                                                 (number-to-string have-this)))
1604                              (size-file (float (or (and gnus-agent-total-fetched-hashtb
1605                                                         (nth 7 (file-attributes file-name)))
1606                                                    0))))
1607                         (delete-file file-name)
1608                         (gnus-agent-update-files-total-fetched-for group (- size-file)))))
1609
1610                   (setcdr next-possibility (cddr next-possibility)))
1611                  (t
1612                   (setq next-possibility (cdr next-possibility))))))
1613        (setq gnus-agent-article-alist (cdr alist))
1614        (gnus-agent-save-alist group)))))
1615
1616 (defun gnus-agent-crosspost (crosses article &optional date)
1617   (setq date (or date t))
1618
1619   (let (gnus-agent-article-alist group alist beg end)
1620     (save-excursion
1621       (set-buffer gnus-agent-overview-buffer)
1622       (when (nnheader-find-nov-line article)
1623         (forward-word 1)
1624         (setq beg (point))
1625         (setq end (progn (forward-line 1) (point)))))
1626     (while crosses
1627       (setq group (caar crosses))
1628       (unless (setq alist (assoc group gnus-agent-group-alist))
1629         (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
1630               gnus-agent-group-alist))
1631       (setcdr alist (cons (cons (cdar crosses) date) (cdr alist)))
1632       (save-excursion
1633         (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
1634                                                     group)))
1635         (when (= (point-max) (point-min))
1636           (push (cons group (current-buffer)) gnus-agent-buffer-alist)
1637           (ignore-errors
1638             (nnheader-insert-file-contents
1639              (gnus-agent-article-name ".overview" group))))
1640         (nnheader-find-nov-line (string-to-number (cdar crosses)))
1641         (insert (string-to-number (cdar crosses)))
1642         (insert-buffer-substring gnus-agent-overview-buffer beg end)
1643         (gnus-agent-check-overview-buffer))
1644       (setq crosses (cdr crosses)))))
1645
1646 (defun gnus-agent-backup-overview-buffer ()
1647   (when gnus-newsgroup-name
1648     (let ((root (gnus-agent-article-name ".overview" gnus-newsgroup-name))
1649           (cnt 0)
1650           name)
1651       (while (file-exists-p
1652               (setq name (concat root "~"
1653                                  (int-to-string (setq cnt (1+ cnt))) "~"))))
1654       (write-region (point-min) (point-max) name nil 'no-msg)
1655       (gnus-message 1 "Created backup copy of overview in %s." name)))
1656   t)
1657
1658 (defun gnus-agent-check-overview-buffer (&optional buffer)
1659   "Check the overview file given for sanity.
1660 In particular, checks that the file is sorted by article number
1661 and that there are no duplicates."
1662   (let ((prev-num -1)
1663         (backed-up nil))
1664     (save-excursion
1665       (when buffer
1666         (set-buffer buffer))
1667       (save-restriction
1668         (widen)
1669         (goto-char (point-min))
1670
1671         (while (< (point) (point-max))
1672           (let ((p (point))
1673                 (cur (condition-case nil
1674                          (read (current-buffer))
1675                        (error nil))))
1676             (cond
1677              ((or (not (integerp cur))
1678                   (not (eq (char-after) ?\t)))
1679               (or backed-up
1680                   (setq backed-up (gnus-agent-backup-overview-buffer)))
1681               (gnus-message 1
1682                             "Overview buffer contains garbage '%s'."
1683                             (buffer-substring
1684                              p (point-at-eol))))
1685              ((= cur prev-num)
1686               (or backed-up
1687                   (setq backed-up (gnus-agent-backup-overview-buffer)))
1688               (gnus-message 1
1689                             "Duplicate overview line for %d" cur)
1690               (delete-region p (progn (forward-line 1) (point))))
1691              ((< cur prev-num)
1692               (or backed-up
1693                   (setq backed-up (gnus-agent-backup-overview-buffer)))
1694               (gnus-message 1 "Overview buffer not sorted!")
1695               (sort-numeric-fields 1 (point-min) (point-max))
1696               (goto-char (point-min))
1697               (setq prev-num -1))
1698              (t
1699               (setq prev-num cur)))
1700             (forward-line 1)))))))
1701
1702 (defun gnus-agent-flush-cache ()
1703   (save-excursion
1704     (while gnus-agent-buffer-alist
1705       (set-buffer (cdar gnus-agent-buffer-alist))
1706       (let ((coding-system-for-write
1707              gnus-agent-file-coding-system))
1708         (write-region (point-min) (point-max)
1709                       (gnus-agent-article-name ".overview"
1710                                                (caar gnus-agent-buffer-alist))
1711                       nil 'silent))
1712       (setq gnus-agent-buffer-alist (cdr gnus-agent-buffer-alist)))
1713     (while gnus-agent-group-alist
1714       (with-temp-file (gnus-agent-article-name
1715                        ".agentview" (caar gnus-agent-group-alist))
1716         (princ (cdar gnus-agent-group-alist))
1717         (insert "\n")
1718         (princ 1 (current-buffer))
1719         (insert "\n"))
1720       (setq gnus-agent-group-alist (cdr gnus-agent-group-alist)))))
1721
1722 ;;;###autoload
1723 (defun gnus-agent-find-parameter (group symbol)
1724   "Search for GROUPs SYMBOL in the group's parameters, the group's
1725 topic parameters, the group's category, or the customizable
1726 variables.  Returns the first non-nil value found."
1727   (or (gnus-group-find-parameter group symbol t)
1728       (gnus-group-parameter-value (cdr (gnus-group-category group)) symbol t)
1729       (symbol-value
1730        (cdr
1731         (assq symbol
1732               '((agent-short-article . gnus-agent-short-article)
1733                 (agent-long-article . gnus-agent-long-article)
1734                 (agent-low-score . gnus-agent-low-score)
1735                 (agent-high-score . gnus-agent-high-score)
1736                 (agent-days-until-old . gnus-agent-expire-days)
1737                 (agent-enable-expiration
1738                  . gnus-agent-enable-expiration)
1739                 (agent-predicate . gnus-agent-predicate)))))))
1740
1741 (defun gnus-agent-fetch-headers (group &optional force)
1742   "Fetch interesting headers into the agent.  The group's overview
1743 file will be updated to include the headers while a list of available
1744 article numbers will be returned."
1745   (let* ((fetch-all (and gnus-agent-consider-all-articles
1746                          ;; Do not fetch all headers if the predicate
1747                          ;; implies that we only consider unread articles.
1748                          (not (gnus-predicate-implies-unread
1749                                (gnus-agent-find-parameter group
1750                                                           'agent-predicate)))))
1751          (articles (if fetch-all
1752                        (gnus-uncompress-range (gnus-active group))
1753                      (gnus-list-of-unread-articles group)))
1754          (gnus-decode-encoded-word-function 'identity)
1755          (file (gnus-agent-article-name ".overview" group)))
1756
1757     (unless fetch-all
1758       ;; Add articles with marks to the list of article headers we want to
1759       ;; fetch.  Don't fetch articles solely on the basis of a recent or seen
1760       ;; mark, but do fetch recent or seen articles if they have other, more
1761       ;; interesting marks.  (We have to fetch articles with boring marks
1762       ;; because otherwise the agent will remove their marks.)
1763       (dolist (arts (gnus-info-marks (gnus-get-info group)))
1764         (unless (memq (car arts) '(seen recent killed cache))
1765           (setq articles (gnus-range-add articles (cdr arts)))))
1766       (setq articles (sort (gnus-uncompress-sequence articles) '<)))
1767
1768     ;; At this point, I have the list of articles to consider for
1769     ;; fetching.  This is the list that I'll return to my caller. Some
1770     ;; of these articles may have already been fetched.  That's OK as
1771     ;; the fetch article code will filter those out.  Internally, I'll
1772     ;; filter this list to just those articles whose headers need to
1773     ;; be fetched.
1774     (let ((articles articles))
1775       ;; Remove known articles.
1776       (when (and (or gnus-agent-cache
1777                      (not gnus-plugged))
1778                  (gnus-agent-load-alist group))
1779         ;; Remove articles marked as downloaded.
1780         (if fetch-all
1781             ;; I want to fetch all headers in the active range.
1782             ;; Therefore, exclude only those headers that are in the
1783             ;; article alist.
1784             ;; NOTE: This is probably NOT what I want to do after
1785             ;; agent expiration in this group.
1786             (setq articles (gnus-agent-uncached-articles articles group))
1787
1788           ;; I want to only fetch those headers that have never been
1789           ;; fetched.  Therefore, exclude all headers that are, or
1790           ;; WERE, in the article alist.
1791           (let ((low (1+ (caar (last gnus-agent-article-alist))))
1792                 (high (cdr (gnus-active group))))
1793             ;; Low can be greater than High when the same group is
1794             ;; fetched twice in the same session {The first fetch will
1795             ;; fill the article alist such that (last
1796             ;; gnus-agent-article-alist) equals (cdr (gnus-active
1797             ;; group))}.  The addition of one(the 1+ above) then
1798             ;; forces Low to be greater than High.  When this happens,
1799             ;; gnus-list-range-intersection returns nil which
1800             ;; indicates that no headers need to be fetched. -- Kevin
1801             (setq articles (gnus-list-range-intersection
1802                             articles (list (cons low high)))))))
1803
1804       (gnus-message
1805        10 "gnus-agent-fetch-headers: undownloaded articles are '%s'"
1806        (gnus-compress-sequence articles t))
1807
1808       (save-excursion
1809         (set-buffer nntp-server-buffer)
1810
1811         (if articles
1812             (progn
1813               (gnus-message 7 "Fetching headers for %s..." group)
1814
1815               ;; Fetch them.
1816               (gnus-make-directory (nnheader-translate-file-chars
1817                                     (file-name-directory file) t))
1818
1819               (unless (eq 'nov (gnus-retrieve-headers articles group))
1820                 (nnvirtual-convert-headers))
1821               (gnus-agent-check-overview-buffer)
1822               ;; Move these headers to the overview buffer so that
1823               ;; gnus-agent-braid-nov can merge them with the contents
1824               ;; of FILE.
1825               (copy-to-buffer
1826                gnus-agent-overview-buffer (point-min) (point-max))
1827               ;; NOTE: Call g-a-brand-nov even when the file does not
1828               ;; exist.  As a minimum, it will validate the article
1829               ;; numbers already in the buffer.
1830               (gnus-agent-braid-nov group articles file)
1831               (let ((coding-system-for-write
1832                      gnus-agent-file-coding-system))
1833                 (gnus-agent-check-overview-buffer)
1834                 (write-region (point-min) (point-max) file nil 'silent))
1835               (gnus-agent-update-view-total-fetched-for group t)
1836               (gnus-agent-save-alist group articles nil)
1837               articles)
1838           (ignore-errors
1839             (erase-buffer)
1840             (nnheader-insert-file-contents file)))))
1841     articles))
1842
1843 (defsubst gnus-agent-read-article-number ()
1844   "Reads the article number at point.  Returns nil when a valid article number can not be read."
1845
1846   ;; It is unfortunite but the read function quietly overflows
1847   ;; integer.  As a result, I have to use string operations to test
1848   ;; for overflow BEFORE calling read.
1849   (when (looking-at "[0-9]+\t")
1850     (let ((len (- (match-end 0) (match-beginning 0))))
1851       (cond ((< len 9)
1852              (read (current-buffer)))
1853             ((= len 9)
1854              ;; Many 9 digit base-10 numbers can be represented in a 27-bit int
1855              ;; Back convert from int to string to ensure that this is one of them.
1856              (let* ((str1 (buffer-substring (match-beginning 0) (1- (match-end 0))))
1857                     (num (read (current-buffer)))
1858                     (str2 (int-to-string num)))
1859                (when (equal str1 str2)
1860                  num)))))))
1861
1862 (defsubst gnus-agent-copy-nov-line (article)
1863   "Copy the indicated ARTICLE from the overview buffer to the nntp server buffer."
1864   (let (art b e)
1865     (set-buffer gnus-agent-overview-buffer)
1866     (while (and (not (eobp))
1867                 (or (not (setq art (gnus-agent-read-article-number)))
1868                     (< art article)))
1869       (forward-line 1))
1870     (beginning-of-line)
1871     (if (or (eobp)
1872             (not (eq article art)))
1873         (set-buffer nntp-server-buffer)
1874       (setq b (point))
1875       (setq e (progn (forward-line 1) (point)))
1876       (set-buffer nntp-server-buffer)
1877       (insert-buffer-substring gnus-agent-overview-buffer b e))))
1878
1879 (defun gnus-agent-braid-nov (group articles file)
1880   "Merge agent overview data with given file.
1881 Takes unvalidated headers for ARTICLES from
1882 `gnus-agent-overview-buffer' and validated headers from the given
1883 FILE and places the combined valid headers into
1884 `nntp-server-buffer'.  This function can be used, when file
1885 doesn't exist, to valid the overview buffer."
1886   (let (start last)
1887     (set-buffer gnus-agent-overview-buffer)
1888     (goto-char (point-min))
1889     (set-buffer nntp-server-buffer)
1890     (erase-buffer)
1891     (when (file-exists-p file)
1892       (nnheader-insert-file-contents file))
1893     (goto-char (point-max))
1894     (forward-line -1)
1895
1896     (unless (or (= (point-min) (point-max))
1897                 (< (setq last (read (current-buffer))) (car articles)))
1898       ;; Old and new overlap -- We do it the hard way.
1899       (when (nnheader-find-nov-line (car articles))
1900         ;; Replacing existing NOV entry
1901         (delete-region (point) (progn (forward-line 1) (point))))
1902       (gnus-agent-copy-nov-line (pop articles))
1903
1904       (ignore-errors
1905        (while articles
1906          (while (let ((art (read (current-buffer))))
1907                   (cond ((< art (car articles))
1908                          (forward-line 1)
1909                          t)
1910                         ((= art (car articles))
1911                          (beginning-of-line)
1912                          (delete-region
1913                           (point) (progn (forward-line 1) (point)))
1914                          nil)
1915                         (t
1916                          (beginning-of-line)
1917                          nil))))
1918
1919          (gnus-agent-copy-nov-line (pop articles)))))
1920
1921     (goto-char (point-max))
1922
1923     ;; Append the remaining lines
1924     (when articles
1925       (when last
1926         (set-buffer gnus-agent-overview-buffer)
1927         (setq start (point))
1928         (set-buffer nntp-server-buffer))
1929
1930       (let ((p (point)))
1931         (insert-buffer-substring gnus-agent-overview-buffer start)
1932         (goto-char p))
1933
1934       (setq last (or last -134217728))
1935       (let (sort art)
1936         (while (not (eobp))
1937           (setq art (gnus-agent-read-article-number))
1938           (cond ((not art)
1939                  ;; Bad art num - delete this line
1940                  (beginning-of-line)
1941                  (delete-region (point) (progn (forward-line 1) (point))))
1942                 ((< art last)
1943                  ;; Art num out of order - enable sort
1944                  (setq sort t)
1945                  (forward-line 1))
1946                 (t
1947                  ;; Good art num
1948                  (setq last art)
1949                  (forward-line 1))))
1950         (when sort
1951           (sort-numeric-fields 1 (point-min) (point-max)))))))
1952
1953 ;; Keeps the compiler from warning about the free variable in
1954 ;; gnus-agent-read-agentview.
1955 (eval-when-compile
1956   (defvar gnus-agent-read-agentview))
1957
1958 (defun gnus-agent-load-alist (group)
1959   "Load the article-state alist for GROUP."
1960   ;; Bind free variable that's used in `gnus-agent-read-agentview'.
1961   (let ((gnus-agent-read-agentview group))
1962     (setq gnus-agent-article-alist
1963           (gnus-cache-file-contents
1964            (gnus-agent-article-name ".agentview" group)
1965            'gnus-agent-file-loading-cache
1966            'gnus-agent-read-agentview))))
1967
1968 ;; Save format may be either 1 or 2.  Two is the new, compressed
1969 ;; format that is still being tested.  Format 1 is uncompressed but
1970 ;; known to be reliable.
1971 (defconst gnus-agent-article-alist-save-format 2)
1972
1973 (defun gnus-agent-read-agentview (file)
1974   "Load FILE and do a `read' there."
1975   (with-temp-buffer
1976     (condition-case nil
1977       (progn
1978         (nnheader-insert-file-contents file)
1979         (goto-char (point-min))
1980         (let ((alist (read (current-buffer)))
1981               (version (condition-case nil (read (current-buffer))
1982                          (end-of-file 0)))
1983               changed-version)
1984
1985           (cond
1986            ((< version 2)
1987             (error "gnus-agent-read-agentview no longer supports version %d.  Stop gnus, manually evaluate gnus-agent-convert-to-compressed-agentview, then restart gnus." version))
1988            ((= version 0)
1989             (let ((inhibit-quit t)
1990                   entry)
1991               (gnus-agent-open-history)
1992               (set-buffer (gnus-agent-history-buffer))
1993               (goto-char (point-min))
1994               (while (not (eobp))
1995                 (if (and (looking-at
1996                           "[^\t\n]+\t\\([0-9]+\\)\t\\([^ \n]+\\) \\([0-9]+\\)")
1997                          (string= (match-string 2)
1998                                   gnus-agent-read-agentview)
1999                          (setq entry (assoc (string-to-number (match-string 3)) alist)))
2000                     (setcdr entry (string-to-number (match-string 1))))
2001                 (forward-line 1))
2002               (gnus-agent-close-history)
2003               (setq changed-version t)))
2004            ((= version 1)
2005             (setq changed-version (not (= 1 gnus-agent-article-alist-save-format))))
2006            ((= version 2)
2007             (let (uncomp)
2008               (mapcar
2009                (lambda (comp-list)
2010                  (let ((state (car comp-list))
2011                        (sequence (inline
2012                                    (gnus-uncompress-range
2013                                     (cdr comp-list)))))
2014                    (mapcar (lambda (article-id)
2015                              (setq uncomp (cons (cons article-id state) uncomp)))
2016                            sequence)))
2017                alist)
2018               (setq alist (sort uncomp 'car-less-than-car)))))
2019           (when changed-version
2020             (let ((gnus-agent-article-alist alist))
2021               (gnus-agent-save-alist gnus-agent-read-agentview)))
2022           alist))
2023       (file-error nil))))
2024
2025 (defun gnus-agent-save-alist (group &optional articles state)
2026   "Save the article-state alist for GROUP."
2027   (let* ((file-name-coding-system nnmail-pathname-coding-system)
2028          (prev (cons nil gnus-agent-article-alist))
2029          (all prev)
2030          print-level print-length item article)
2031     (while (setq article (pop articles))
2032       (while (and (cdr prev)
2033                   (< (caadr prev) article))
2034         (setq prev (cdr prev)))
2035       (cond
2036        ((not (cdr prev))
2037         (setcdr prev (list (cons article state))))
2038        ((> (caadr prev) article)
2039         (setcdr prev (cons (cons article state) (cdr prev))))
2040        ((= (caadr prev) article)
2041         (setcdr (cadr prev) state)))
2042       (setq prev (cdr prev)))
2043     (setq gnus-agent-article-alist (cdr all))
2044
2045     (gnus-agent-set-local group
2046                           (caar gnus-agent-article-alist)
2047                           (caar (last gnus-agent-article-alist)))
2048
2049     (gnus-make-directory (gnus-agent-article-name "" group))
2050     (with-temp-file (gnus-agent-article-name ".agentview" group)
2051       (cond ((eq gnus-agent-article-alist-save-format 1)
2052              (princ gnus-agent-article-alist (current-buffer)))
2053             ((eq gnus-agent-article-alist-save-format 2)
2054              (let ((compressed nil))
2055                (mapcar (lambda (pair)
2056                          (let* ((article-id (car pair))
2057                                 (day-of-download (cdr pair))
2058                                 (comp-list (assq day-of-download compressed)))
2059                            (if comp-list
2060                                (setcdr comp-list
2061                                        (cons article-id (cdr comp-list)))
2062                              (setq compressed
2063                                    (cons (list day-of-download article-id)
2064                                          compressed)))
2065                            nil)) gnus-agent-article-alist)
2066                (mapcar (lambda (comp-list)
2067                          (setcdr comp-list
2068                                  (gnus-compress-sequence
2069                                   (nreverse (cdr comp-list)))))
2070                        compressed)
2071                (princ compressed (current-buffer)))))
2072       (insert "\n")
2073       (princ gnus-agent-article-alist-save-format (current-buffer))
2074       (insert "\n"))
2075
2076     (gnus-agent-update-view-total-fetched-for group nil)))
2077
2078 (defvar gnus-agent-article-local nil)
2079 (defvar gnus-agent-file-loading-local nil)
2080
2081 (defun gnus-agent-load-local (&optional method)
2082   "Load the METHOD'S local file.  The local file contains min/max
2083 article counts for each of the method's subscribed groups."
2084   (let ((gnus-command-method (or method gnus-command-method)))
2085     (setq gnus-agent-article-local
2086           (gnus-cache-file-contents
2087            (gnus-agent-lib-file "local")
2088            'gnus-agent-file-loading-local
2089            'gnus-agent-read-and-cache-local))))
2090
2091 (defun gnus-agent-read-and-cache-local (file)
2092   "Load and read FILE then bind its contents to
2093 gnus-agent-article-local.  If that variable had `dirty' (also known as
2094 modified) original contents, they are first saved to their own file."
2095
2096   (if (and gnus-agent-article-local
2097            (symbol-value (intern "+dirty" gnus-agent-article-local)))
2098       (gnus-agent-save-local))
2099   (gnus-agent-read-local file))
2100
2101 (defun gnus-agent-read-local (file)
2102   "Load FILE and do a `read' there."
2103   (let ((my-obarray (gnus-make-hashtable (count-lines (point-min)
2104                                                       (point-max))))
2105         (line 1))
2106     (with-temp-buffer
2107       (condition-case nil
2108           (let ((nnheader-file-coding-system gnus-agent-file-coding-system))
2109             (nnheader-insert-file-contents file))
2110         (file-error))
2111
2112       (goto-char (point-min))
2113       ;; Skip any comments at the beginning of the file (the only place where they may appear)
2114       (while (= (following-char) ?\;)
2115         (forward-line 1)
2116         (setq line (1+ line)))
2117
2118       (while (not (eobp))
2119         (condition-case err
2120             (let (group
2121                   min
2122                   max
2123                   (cur (current-buffer)))
2124               (setq group (read cur)
2125                     min (read cur)
2126                     max (read cur))
2127
2128               (when (stringp group)
2129                 (setq group (intern group my-obarray)))
2130
2131               ;; NOTE: The '+ 0' ensure that min and max are both numerics.
2132               (set group (cons (+ 0 min) (+ 0 max))))
2133           (error
2134            (gnus-message 3 "Warning - invalid agent local: %s on line %d: "
2135                          file line (error-message-string err))))
2136         (forward-line 1)
2137         (setq line (1+ line))))
2138
2139     (set (intern "+dirty" my-obarray) nil)
2140     (set (intern "+method" my-obarray) gnus-command-method)
2141     my-obarray))
2142
2143 (defun gnus-agent-save-local (&optional force)
2144   "Save gnus-agent-article-local under it method's agent.lib directory."
2145   (let ((my-obarray gnus-agent-article-local))
2146     (when (and my-obarray
2147                (or force (symbol-value (intern "+dirty" my-obarray))))
2148       (let* ((gnus-command-method (symbol-value (intern "+method" my-obarray)))
2149              ;; NOTE: gnus-command-method is used within gnus-agent-lib-file.
2150              (dest (gnus-agent-lib-file "local")))
2151         (gnus-make-directory (gnus-agent-lib-file ""))
2152
2153         (let ((buffer-file-coding-system gnus-agent-file-coding-system))
2154           (with-temp-file dest
2155             (let ((gnus-command-method (symbol-value (intern "+method" my-obarray)))
2156                   (file-name-coding-system nnmail-pathname-coding-system)
2157                   print-level print-length item article
2158                   (standard-output (current-buffer)))
2159               (mapatoms (lambda (symbol)
2160                           (cond ((not (boundp symbol))
2161                                  nil)
2162                                 ((member (symbol-name symbol) '("+dirty" "+method"))
2163                                  nil)
2164                                 (t
2165                                  (prin1 symbol)
2166                                  (let ((range (symbol-value symbol)))
2167                                    (princ " ")
2168                                    (princ (car range))
2169                                    (princ " ")
2170                                    (princ (cdr range))
2171                                    (princ "\n")))))
2172                         my-obarray))))))))
2173
2174 (defun gnus-agent-get-local (group &optional gmane method)
2175   (let* ((gmane (or gmane (gnus-group-real-name group)))
2176          (gnus-command-method (or method (gnus-find-method-for-group group)))
2177          (local (gnus-agent-load-local))
2178          (symb (intern gmane local))
2179          (minmax (and (boundp symb) (symbol-value symb))))
2180     (unless minmax
2181       ;; Bind these so that gnus-agent-load-alist doesn't change the
2182       ;; current alist (i.e. gnus-agent-article-alist)
2183       (let* ((gnus-agent-article-alist gnus-agent-article-alist)
2184              (gnus-agent-file-loading-cache gnus-agent-file-loading-cache)
2185              (alist (gnus-agent-load-alist group)))
2186         (when alist
2187           (setq minmax
2188                 (cons (caar alist)
2189                       (caar (last alist))))
2190           (gnus-agent-set-local group (car minmax) (cdr minmax)
2191                                 gmane gnus-command-method local))))
2192     minmax))
2193
2194 (defun gnus-agent-set-local (group min max &optional gmane method local)
2195   (let* ((gmane (or gmane (gnus-group-real-name group)))
2196          (gnus-command-method (or method (gnus-find-method-for-group group)))
2197          (local (or local (gnus-agent-load-local)))
2198          (symb (intern gmane local))
2199          (minmax (and (boundp symb) (symbol-value symb))))
2200
2201     (if (cond ((and minmax
2202                     (or (not (eq min (car minmax)))
2203                         (not (eq max (cdr minmax)))))
2204                (setcar minmax min)
2205                (setcdr minmax max)
2206                t)
2207               (minmax
2208                nil)
2209               ((and min max)
2210                (set symb (cons min max))
2211                t)
2212               (t
2213                (unintern symb local)))
2214         (set (intern "+dirty" local) t))))
2215
2216 (defun gnus-agent-article-name (article group)
2217   (expand-file-name article
2218                     (file-name-as-directory
2219                      (gnus-agent-group-pathname group))))
2220
2221 (defun gnus-agent-batch-confirmation (msg)
2222   "Show error message and return t."
2223   (gnus-message 1 msg)
2224   t)
2225
2226 ;;;###autoload
2227 (defun gnus-agent-batch-fetch ()
2228   "Start Gnus and fetch session."
2229   (interactive)
2230   (gnus)
2231   (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
2232     (gnus-agent-fetch-session))
2233   (gnus-group-exit))
2234
2235 (defun gnus-agent-fetch-session ()
2236   "Fetch all articles and headers that are eligible for fetching."
2237   (interactive)
2238   (unless gnus-agent-covered-methods
2239     (error "No servers are covered by the Gnus agent"))
2240   (unless gnus-plugged
2241     (error "Can't fetch articles while Gnus is unplugged"))
2242   (let ((methods (gnus-agent-covered-methods))
2243         groups group gnus-command-method)
2244     (save-excursion
2245       (while methods
2246         (setq gnus-command-method (car methods))
2247         (when (and (or (gnus-server-opened gnus-command-method)
2248                        (gnus-open-server gnus-command-method))
2249                    (gnus-online gnus-command-method))
2250           (setq groups (gnus-groups-from-server (car methods)))
2251           (gnus-agent-with-fetch
2252             (while (setq group (pop groups))
2253               (when (<= (gnus-group-level group)
2254                         gnus-agent-handle-level)
2255                 (if (or debug-on-error debug-on-quit)
2256                     (gnus-agent-fetch-group-1
2257                      group gnus-command-method)
2258                   (condition-case err
2259                       (gnus-agent-fetch-group-1
2260                        group gnus-command-method)
2261                     (error
2262                      (unless (funcall gnus-agent-confirmation-function
2263                                       (format "Error %s while fetching session.  Should gnus continue? "
2264                                               (error-message-string err)))
2265                        (error "Cannot fetch articles into the Gnus agent")))
2266                     (quit
2267                      (gnus-agent-regenerate-group group)
2268                      (unless (funcall gnus-agent-confirmation-function
2269                                       (format
2270                                        "%s while fetching session.  Should gnus continue? "
2271                                        (error-message-string err)))
2272                        (signal 'quit
2273                                "Cannot fetch articles into the Gnus agent")))))))))
2274         (setq methods (cdr methods)))
2275       (gnus-run-hooks 'gnus-agent-fetched-hook)
2276       (gnus-message 6 "Finished fetching articles into the Gnus agent"))))
2277
2278 (defun gnus-agent-fetch-group-1 (group method)
2279   "Fetch GROUP."
2280   (let ((gnus-command-method method)
2281         (gnus-newsgroup-name group)
2282         (gnus-newsgroup-dependencies gnus-newsgroup-dependencies)
2283         (gnus-newsgroup-headers gnus-newsgroup-headers)
2284         (gnus-newsgroup-scored gnus-newsgroup-scored)
2285         (gnus-use-cache gnus-use-cache)
2286         (gnus-summary-expunge-below gnus-summary-expunge-below)
2287         (gnus-summary-mark-below gnus-summary-mark-below)
2288         (gnus-orphan-score gnus-orphan-score)
2289         ;; Maybe some other gnus-summary local variables should also
2290         ;; be put here.
2291
2292         gnus-headers
2293         gnus-score
2294         articles arts
2295         category predicate info marks score-param
2296         )
2297     (unless (gnus-check-group group)
2298       (error "Can't open server for %s" group))
2299
2300     ;; Fetch headers.
2301     (when (or gnus-newsgroup-active
2302               (gnus-active group)
2303               (gnus-activate-group group))
2304       (let ((marked-articles gnus-newsgroup-downloadable))
2305         ;; Identify the articles marked for download
2306         (unless gnus-newsgroup-active
2307           ;; The variable gnus-newsgroup-active was selected as I need
2308           ;; a gnus-summary local variable that is NOT bound to any
2309           ;; value (its global value should default to nil).
2310           (dolist (mark gnus-agent-download-marks)
2311             (let ((arts (cdr (assq mark (gnus-info-marks
2312                                          (setq info (gnus-get-info group)))))))
2313               (when arts
2314                 (setq marked-articles (nconc (gnus-uncompress-range arts)
2315                                              marked-articles))
2316                 ))))
2317         (setq marked-articles (sort marked-articles '<))
2318
2319         ;; Fetch any new articles from the server
2320         (setq articles (gnus-agent-fetch-headers group))
2321
2322         ;; Merge new articles with marked
2323         (setq articles (sort (append marked-articles articles) '<))
2324
2325         (when articles
2326           ;; Parse them and see which articles we want to fetch.
2327           (setq gnus-newsgroup-dependencies
2328                 (or gnus-newsgroup-dependencies
2329                     (make-vector (length articles) 0)))
2330           (setq gnus-newsgroup-headers
2331                 (or gnus-newsgroup-headers
2332                     (gnus-get-newsgroup-headers-xover articles nil nil
2333                                                       group)))
2334           ;; `gnus-agent-overview-buffer' may be killed for
2335           ;; timeout reason.  If so, recreate it.
2336           (gnus-agent-create-buffer)
2337
2338           ;; Figure out how to select articles in this group
2339           (setq category (gnus-group-category group))
2340
2341           (setq predicate
2342                 (gnus-get-predicate
2343                  (gnus-agent-find-parameter group 'agent-predicate)))
2344
2345           ;; If the selection predicate requires scoring, score each header
2346           (unless (memq predicate '(gnus-agent-true gnus-agent-false))
2347             (let ((score-param
2348                    (gnus-agent-find-parameter group 'agent-score-file)))
2349               ;; Translate score-param into real one
2350               (cond
2351                ((not score-param))
2352                ((eq score-param 'file)
2353                 (setq score-param (gnus-all-score-files group)))
2354                ((stringp (car score-param)))
2355                (t
2356                 (setq score-param (list (list score-param)))))
2357               (when score-param
2358                 (gnus-score-headers score-param))))
2359
2360           (unless (and (eq predicate 'gnus-agent-false)
2361                        (not marked-articles))
2362             (let ((arts (list nil)))
2363               (let ((arts-tail arts)
2364                     (alist (gnus-agent-load-alist group))
2365                     (marked-articles marked-articles)
2366                     (gnus-newsgroup-headers gnus-newsgroup-headers))
2367                 (while (setq gnus-headers (pop gnus-newsgroup-headers))
2368                   (let ((num (mail-header-number gnus-headers)))
2369                     ;; Determine if this article is already in the cache
2370                     (while (and alist
2371                                 (> num (caar alist)))
2372                       (setq alist (cdr alist)))
2373
2374                     (unless (and (eq num (caar alist))
2375                                  (cdar alist))
2376
2377                       ;; Determine if this article was marked for download.
2378                       (while (and marked-articles
2379                                   (> num (car marked-articles)))
2380                         (setq marked-articles
2381                               (cdr marked-articles)))
2382
2383                       ;; When this article is marked, or selected by the
2384                       ;; predicate, add it to the download list
2385                       (when (or (eq num (car marked-articles))
2386                                 (let ((gnus-score
2387                                        (or (cdr
2388                                             (assq num gnus-newsgroup-scored))
2389                                            gnus-summary-default-score))
2390                                       (gnus-agent-long-article
2391                                        (gnus-agent-find-parameter
2392                                         group 'agent-long-article))
2393                                       (gnus-agent-short-article
2394                                        (gnus-agent-find-parameter
2395                                         group 'agent-short-article))
2396                                       (gnus-agent-low-score
2397                                        (gnus-agent-find-parameter
2398                                         group 'agent-low-score))
2399                                       (gnus-agent-high-score
2400                                        (gnus-agent-find-parameter
2401                                         group 'agent-high-score))
2402                                       (gnus-agent-expire-days
2403                                        (gnus-agent-find-parameter
2404                                         group 'agent-days-until-old)))
2405                                   (funcall predicate)))
2406                         (gnus-agent-append-to-list arts-tail num))))))
2407
2408               (let (fetched-articles)
2409                 ;; Fetch all selected articles
2410                 (setq gnus-newsgroup-undownloaded
2411                       (gnus-sorted-ndifference
2412                        gnus-newsgroup-undownloaded
2413                        (setq fetched-articles
2414                              (if (cdr arts)
2415                                  (gnus-agent-fetch-articles group (cdr arts))
2416                                nil))))
2417
2418                 (let ((unfetched-articles
2419                        (gnus-sorted-ndifference (cdr arts) fetched-articles)))
2420                   (if gnus-newsgroup-active
2421                       ;; Update the summary buffer
2422                       (progn
2423                         (dolist (article marked-articles)
2424                           (gnus-summary-set-agent-mark article t))
2425                         (dolist (article fetched-articles)
2426                           (if gnus-agent-mark-unread-after-downloaded
2427                               (gnus-summary-mark-article
2428                                article gnus-unread-mark))
2429                           (when (gnus-summary-goto-subject article nil t)
2430                             (gnus-summary-update-download-mark article)))
2431                         (dolist (article unfetched-articles)
2432                           (gnus-summary-mark-article
2433                            article gnus-canceled-mark)))
2434
2435                     ;; Update the group buffer.
2436
2437                     ;; When some, or all, of the marked articles came
2438                     ;; from the download mark.  Remove that mark.  I
2439                     ;; didn't do this earlier as I only want to remove
2440                     ;; the marks after the fetch is completed.
2441
2442                     (dolist (mark gnus-agent-download-marks)
2443                       (when (eq mark 'download)
2444                         (let ((marked-arts
2445                                (assq mark (gnus-info-marks
2446                                            (setq info (gnus-get-info group))))))
2447                           (when (cdr marked-arts)
2448                             (setq marks
2449                                   (delq marked-arts (gnus-info-marks info)))
2450                             (gnus-info-set-marks info marks)))))
2451                     (let ((read (gnus-info-read
2452                                  (or info (setq info (gnus-get-info group))))))
2453                       (gnus-info-set-read
2454                        info (gnus-add-to-range read unfetched-articles)))
2455
2456                     (gnus-group-update-group group t)
2457                     (sit-for 0)
2458
2459                     (gnus-dribble-enter
2460                      (concat "(gnus-group-set-info '"
2461                              (gnus-prin1-to-string info)
2462                              ")"))))))))))))
2463
2464 ;;;
2465 ;;; Agent Category Mode
2466 ;;;
2467
2468 (defvar gnus-category-mode-hook nil
2469   "Hook run in `gnus-category-mode' buffers.")
2470
2471 (defvar gnus-category-line-format "     %(%20c%): %g\n"
2472   "Format of category lines.
2473
2474 Valid specifiers include:
2475 %c  Topic name (string)
2476 %g  The number of groups in the topic (integer)
2477
2478 General format specifiers can also be used.  See Info node
2479 `(gnus)Formatting Variables'.")
2480
2481 (defvar gnus-category-mode-line-format "Gnus: %%b"
2482   "The format specification for the category mode line.")
2483
2484 (defvar gnus-agent-predicate 'false
2485   "The selection predicate used when no other source is available.")
2486
2487 (defvar gnus-agent-short-article 100
2488   "Articles that have fewer lines than this are short.")
2489
2490 (defvar gnus-agent-long-article 200
2491   "Articles that have more lines than this are long.")
2492
2493 (defvar gnus-agent-low-score 0
2494   "Articles that have a score lower than this have a low score.")
2495
2496 (defvar gnus-agent-high-score 0
2497   "Articles that have a score higher than this have a high score.")
2498
2499
2500 ;;; Internal variables.
2501
2502 (defvar gnus-category-buffer "*Agent Category*")
2503
2504 (defvar gnus-category-line-format-alist
2505   `((?c gnus-tmp-name ?s)
2506     (?g gnus-tmp-groups ?d)))
2507
2508 (defvar gnus-category-mode-line-format-alist
2509   `((?u user-defined ?s)))
2510
2511 (defvar gnus-category-line-format-spec nil)
2512 (defvar gnus-category-mode-line-format-spec nil)
2513
2514 (defvar gnus-category-mode-map nil)
2515 (put 'gnus-category-mode 'mode-class 'special)
2516
2517 (unless gnus-category-mode-map
2518   (setq gnus-category-mode-map (make-sparse-keymap))
2519   (suppress-keymap gnus-category-mode-map)
2520
2521   (gnus-define-keys gnus-category-mode-map
2522     "q" gnus-category-exit
2523     "k" gnus-category-kill
2524     "c" gnus-category-copy
2525     "a" gnus-category-add
2526     "e" gnus-agent-customize-category
2527     "p" gnus-category-edit-predicate
2528     "g" gnus-category-edit-groups
2529     "s" gnus-category-edit-score
2530     "l" gnus-category-list
2531
2532     "\C-c\C-i" gnus-info-find-node
2533     "\C-c\C-b" gnus-bug))
2534
2535 (defvar gnus-category-menu-hook nil
2536   "*Hook run after the creation of the menu.")
2537
2538 (defun gnus-category-make-menu-bar ()
2539   (gnus-turn-off-edit-menu 'category)
2540   (unless (boundp 'gnus-category-menu)
2541     (easy-menu-define
2542      gnus-category-menu gnus-category-mode-map ""
2543      '("Categories"
2544        ["Add" gnus-category-add t]
2545        ["Kill" gnus-category-kill t]
2546        ["Copy" gnus-category-copy t]
2547        ["Edit category" gnus-agent-customize-category t]
2548        ["Edit predicate" gnus-category-edit-predicate t]
2549        ["Edit score" gnus-category-edit-score t]
2550        ["Edit groups" gnus-category-edit-groups t]
2551        ["Exit" gnus-category-exit t]))
2552
2553     (gnus-run-hooks 'gnus-category-menu-hook)))
2554
2555 (defun gnus-category-mode ()
2556   "Major mode for listing and editing agent categories.
2557
2558 All normal editing commands are switched off.
2559 \\<gnus-category-mode-map>
2560 For more in-depth information on this mode, read the manual
2561 \(`\\[gnus-info-find-node]').
2562
2563 The following commands are available:
2564
2565 \\{gnus-category-mode-map}"
2566   (interactive)
2567   (when (gnus-visual-p 'category-menu 'menu)
2568     (gnus-category-make-menu-bar))
2569   (kill-all-local-variables)
2570   (gnus-simplify-mode-line)
2571   (setq major-mode 'gnus-category-mode)
2572   (setq mode-name "Category")
2573   (gnus-set-default-directory)
2574   (setq mode-line-process nil)
2575   (use-local-map gnus-category-mode-map)
2576   (buffer-disable-undo)
2577   (setq truncate-lines t)
2578   (setq buffer-read-only t)
2579   (gnus-run-hooks 'gnus-category-mode-hook))
2580
2581 (defalias 'gnus-category-position-point 'gnus-goto-colon)
2582
2583 (defun gnus-category-insert-line (category)
2584   (let* ((gnus-tmp-name (format "%s" (car category)))
2585          (gnus-tmp-groups (length (gnus-agent-cat-groups category))))
2586     (beginning-of-line)
2587     (gnus-add-text-properties
2588      (point)
2589      (prog1 (1+ (point))
2590        ;; Insert the text.
2591        (eval gnus-category-line-format-spec))
2592      (list 'gnus-category gnus-tmp-name))))
2593
2594 (defun gnus-enter-category-buffer ()
2595   "Go to the Category buffer."
2596   (interactive)
2597   (gnus-category-setup-buffer)
2598   (gnus-configure-windows 'category)
2599   (gnus-category-prepare))
2600
2601 (defun gnus-category-setup-buffer ()
2602   (unless (get-buffer gnus-category-buffer)
2603     (save-excursion
2604       (set-buffer (gnus-get-buffer-create gnus-category-buffer))
2605       (gnus-category-mode))))
2606
2607 (defun gnus-category-prepare ()
2608   (gnus-set-format 'category-mode)
2609   (gnus-set-format 'category t)
2610   (let ((alist gnus-category-alist)
2611         (buffer-read-only nil))
2612     (erase-buffer)
2613     (while alist
2614       (gnus-category-insert-line (pop alist)))
2615     (goto-char (point-min))
2616     (gnus-category-position-point)))
2617
2618 (defun gnus-category-name ()
2619   (or (intern (get-text-property (point-at-bol) 'gnus-category))
2620       (error "No category on the current line")))
2621
2622 (defun gnus-category-read ()
2623   "Read the category alist."
2624   (setq gnus-category-alist
2625         (or
2626          (with-temp-buffer
2627            (ignore-errors
2628             (nnheader-insert-file-contents (nnheader-concat gnus-agent-directory "lib/categories"))
2629             (goto-char (point-min))
2630             ;; This code isn't temp, it will be needed so long as
2631             ;; anyone may be migrating from an older version.
2632
2633             ;; Once we're certain that people will not revert to an
2634             ;; earlier version, we can take out the old-list code in
2635             ;; gnus-category-write.
2636             (let* ((old-list (read (current-buffer)))
2637                    (new-list (ignore-errors (read (current-buffer)))))
2638               (if new-list
2639                   new-list
2640                 ;; Convert from a positional list to an alist.
2641                 (mapcar
2642                  (lambda (c)
2643                    (setcdr c
2644                            (delq nil
2645                                  (gnus-mapcar
2646                                   (lambda (valu symb)
2647                                     (if valu
2648                                         (cons symb valu)))
2649                                   (cdr c)
2650                                   '(agent-predicate agent-score-file agent-groups))))
2651                    c)
2652                  old-list)))))
2653          (list (gnus-agent-cat-make 'default 'short)))))
2654
2655 (defun gnus-category-write ()
2656   "Write the category alist."
2657   (setq gnus-category-predicate-cache nil
2658         gnus-category-group-cache nil)
2659   (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
2660   (with-temp-file (nnheader-concat gnus-agent-directory "lib/categories")
2661     ;; This prin1 is temporary.  It exists so that people can revert
2662     ;; to an earlier version of gnus-agent.
2663     (prin1 (mapcar (lambda (c)
2664               (list (car c)
2665                     (cdr (assoc 'agent-predicate c))
2666                     (cdr (assoc 'agent-score-file c))
2667                     (cdr (assoc 'agent-groups c))))
2668                    gnus-category-alist)
2669            (current-buffer))
2670     (newline)
2671     (prin1 gnus-category-alist (current-buffer))))
2672
2673 (defun gnus-category-edit-predicate (category)
2674   "Edit the predicate for CATEGORY."
2675   (interactive (list (gnus-category-name)))
2676   (let ((info (assq category gnus-category-alist)))
2677     (gnus-edit-form
2678      (gnus-agent-cat-predicate info)
2679      (format "Editing the select predicate for category %s" category)
2680      `(lambda (predicate)
2681         ;; Avoid run-time execution of setf form
2682         ;; (setf (gnus-agent-cat-predicate (assq ',category gnus-category-alist))
2683         ;;       predicate)
2684         ;; use its expansion instead:
2685         (gnus-agent-cat-set-property (assq ',category gnus-category-alist)
2686                                      'agent-predicate predicate)
2687
2688         (gnus-category-write)
2689         (gnus-category-list)))))
2690
2691 (defun gnus-category-edit-score (category)
2692   "Edit the score expression for CATEGORY."
2693   (interactive (list (gnus-category-name)))
2694   (let ((info (assq category gnus-category-alist)))
2695     (gnus-edit-form
2696      (gnus-agent-cat-score-file info)
2697      (format "Editing the score expression for category %s" category)
2698      `(lambda (score-file)
2699         ;; Avoid run-time execution of setf form
2700         ;; (setf (gnus-agent-cat-score-file (assq ',category gnus-category-alist))
2701         ;;       score-file)
2702         ;; use its expansion instead:
2703         (gnus-agent-cat-set-property (assq ',category gnus-category-alist)
2704                                      'agent-score-file score-file)
2705
2706         (gnus-category-write)
2707         (gnus-category-list)))))
2708
2709 (defun gnus-category-edit-groups (category)
2710   "Edit the group list for CATEGORY."
2711   (interactive (list (gnus-category-name)))
2712   (let ((info (assq category gnus-category-alist)))
2713     (gnus-edit-form
2714      (gnus-agent-cat-groups info)
2715      (format "Editing the group list for category %s" category)
2716      `(lambda (groups)
2717         ;; Avoid run-time execution of setf form
2718         ;; (setf (gnus-agent-cat-groups (assq ',category gnus-category-alist))
2719         ;;       groups)
2720         ;; use its expansion instead:
2721         (gnus-agent-set-cat-groups (assq ',category gnus-category-alist)
2722                                    groups)
2723
2724         (gnus-category-write)
2725         (gnus-category-list)))))
2726
2727 (defun gnus-category-kill (category)
2728   "Kill the current category."
2729   (interactive (list (gnus-category-name)))
2730   (let ((info (assq category gnus-category-alist))
2731         (buffer-read-only nil))
2732     (gnus-delete-line)
2733     (setq gnus-category-alist (delq info gnus-category-alist))
2734     (gnus-category-write)))
2735
2736 (defun gnus-category-copy (category to)
2737   "Copy the current category."
2738   (interactive (list (gnus-category-name) (intern (read-string "New name: "))))
2739   (let ((info (assq category gnus-category-alist)))
2740     (push (let ((newcat (gnus-copy-sequence info)))
2741             (setf (gnus-agent-cat-name newcat) to)
2742             (setf (gnus-agent-cat-groups newcat) nil)
2743             newcat)
2744           gnus-category-alist)
2745     (gnus-category-write)
2746     (gnus-category-list)))
2747
2748 (defun gnus-category-add (category)
2749   "Create a new category."
2750   (interactive "SCategory name: ")
2751   (when (assq category gnus-category-alist)
2752     (error "Category %s already exists" category))
2753   (push (gnus-agent-cat-make category)
2754         gnus-category-alist)
2755   (gnus-category-write)
2756   (gnus-category-list))
2757
2758 (defun gnus-category-list ()
2759   "List all categories."
2760   (interactive)
2761   (gnus-category-prepare))
2762
2763 (defun gnus-category-exit ()
2764   "Return to the group buffer."
2765   (interactive)
2766   (kill-buffer (current-buffer))
2767   (gnus-configure-windows 'group t))
2768
2769 ;; To avoid having 8-bit characters in the source file.
2770 (defvar gnus-category-not (list '! 'not (intern (format "%c" 172))))
2771
2772 (defvar gnus-category-predicate-alist
2773   '((spam . gnus-agent-spam-p)
2774     (short . gnus-agent-short-p)
2775     (long . gnus-agent-long-p)
2776     (low . gnus-agent-low-scored-p)
2777     (high . gnus-agent-high-scored-p)
2778     (read . gnus-agent-read-p)
2779     (true . gnus-agent-true)
2780     (false . gnus-agent-false))
2781   "Mapping from short score predicate symbols to predicate functions.")
2782
2783 (defun gnus-agent-spam-p ()
2784   "Say whether an article is spam or not."
2785   (unless gnus-agent-spam-hashtb
2786     (setq gnus-agent-spam-hashtb (gnus-make-hashtable 1000)))
2787   (if (not (equal (mail-header-references gnus-headers) ""))
2788       nil
2789     (let ((string (gnus-simplify-subject (mail-header-subject gnus-headers))))
2790       (prog1
2791           (gnus-gethash string gnus-agent-spam-hashtb)
2792         (gnus-sethash string t gnus-agent-spam-hashtb)))))
2793
2794 (defun gnus-agent-short-p ()
2795   "Say whether an article is short or not."
2796   (< (mail-header-lines gnus-headers) gnus-agent-short-article))
2797
2798 (defun gnus-agent-long-p ()
2799   "Say whether an article is long or not."
2800   (> (mail-header-lines gnus-headers) gnus-agent-long-article))
2801
2802 (defun gnus-agent-low-scored-p ()
2803   "Say whether an article has a low score or not."
2804   (< gnus-score gnus-agent-low-score))
2805
2806 (defun gnus-agent-high-scored-p ()
2807   "Say whether an article has a high score or not."
2808   (> gnus-score gnus-agent-high-score))
2809
2810 (defun gnus-agent-read-p ()
2811   "Say whether an article is read or not."
2812   (gnus-member-of-range (mail-header-number gnus-headers)
2813                         (gnus-info-read (gnus-get-info gnus-newsgroup-name))))
2814
2815 (defun gnus-category-make-function (predicate)
2816   "Make a function from PREDICATE."
2817   (let ((func (gnus-category-make-function-1 predicate)))
2818     (if (and (= (length func) 1)
2819              (symbolp (car func)))
2820         (car func)
2821       (gnus-byte-compile `(lambda () ,func)))))
2822
2823 (defun gnus-agent-true ()
2824   "Return t."
2825   t)
2826
2827 (defun gnus-agent-false ()
2828   "Return nil."
2829   nil)
2830
2831 (defun gnus-category-make-function-1 (predicate)
2832   "Make a function from PREDICATE."
2833   (cond
2834    ;; Functions are just returned as is.
2835    ((or (symbolp predicate)
2836         (functionp predicate))
2837     `(,(or (cdr (assq predicate gnus-category-predicate-alist))
2838            predicate)))
2839    ;; More complex predicate.
2840    ((consp predicate)
2841     `(,(cond
2842         ((memq (car predicate) '(& and))
2843          'and)
2844         ((memq (car predicate) '(| or))
2845          'or)
2846         ((memq (car predicate) gnus-category-not)
2847          'not))
2848       ,@(mapcar 'gnus-category-make-function-1 (cdr predicate))))
2849    (t
2850     (error "Unknown predicate type: %s" predicate))))
2851
2852 (defun gnus-get-predicate (predicate)
2853   "Return the function implementing PREDICATE."
2854   (or (cdr (assoc predicate gnus-category-predicate-cache))
2855       (let ((func (gnus-category-make-function predicate)))
2856         (setq gnus-category-predicate-cache
2857               (nconc gnus-category-predicate-cache
2858                      (list (cons predicate func))))
2859         func)))
2860
2861 (defun gnus-predicate-implies-unread (predicate)
2862   "Say whether PREDICATE implies unread articles only.
2863 It is okay to miss some cases, but there must be no false positives.
2864 That is, if this predicate returns true, then indeed the predicate must
2865 return only unread articles."
2866   (eq t (gnus-function-implies-unread-1
2867          (gnus-category-make-function-1 predicate))))
2868
2869 (defun gnus-function-implies-unread-1 (function)
2870   "Recursively evaluate a predicate function to determine whether it can select
2871 any read articles.  Returns t if the function is known to never
2872 return read articles, nil when it is known to always return read
2873 articles, and t_nil when the function may return both read and unread
2874 articles."
2875   (let ((func (car function))
2876         (args (mapcar 'gnus-function-implies-unread-1 (cdr function))))
2877     (cond ((eq func 'and)
2878            (cond ((memq t args) ; if any argument returns only unread articles
2879                   ;; then that argument constrains the result to only unread articles.
2880                   t)
2881                  ((memq 't_nil args) ; if any argument is indeterminate
2882                   ;; then the result is indeterminate
2883                   't_nil)))
2884           ((eq func 'or)
2885            (cond ((memq nil args) ; if any argument returns read articles
2886                   ;; then that argument ensures that the results includes read articles.
2887                   nil)
2888                  ((memq 't_nil args) ; if any argument is indeterminate
2889                   ;; then that argument ensures that the results are indeterminate
2890                   't_nil)
2891                  (t ; if all arguments return only unread articles
2892                   ;; then the result returns only unread articles
2893                   t)))
2894           ((eq func 'not)
2895            (cond ((eq (car args) 't_nil) ; if the argument is indeterminate
2896                   ; then the result is indeterminate
2897                   (car args))
2898                  (t ; otherwise
2899                   ; toggle the result to be the opposite of the argument
2900                   (not (car args)))))
2901           ((eq func 'gnus-agent-read-p)
2902            nil) ; The read predicate NEVER returns unread articles
2903           ((eq func 'gnus-agent-false)
2904            t) ; The false predicate returns t as the empty set excludes all read articles
2905           ((eq func 'gnus-agent-true)
2906            nil) ; The true predicate ALWAYS returns read articles
2907           ((catch 'found-match
2908              (let ((alist gnus-category-predicate-alist))
2909                (while alist
2910                  (if (eq func (cdar alist))
2911                      (throw 'found-match t)
2912                    (setq alist (cdr alist))))))
2913            't_nil) ; All other predicates return read and unread articles
2914           (t
2915            (error "Unknown predicate function: %s" function)))))
2916
2917 (defun gnus-group-category (group)
2918   "Return the category GROUP belongs to."
2919   (unless gnus-category-group-cache
2920     (setq gnus-category-group-cache (gnus-make-hashtable 1000))
2921     (let ((cs gnus-category-alist)
2922           groups cat)
2923       (while (setq cat (pop cs))
2924         (setq groups (gnus-agent-cat-groups cat))
2925         (while groups
2926           (gnus-sethash (pop groups) cat gnus-category-group-cache)))))
2927   (or (gnus-gethash group gnus-category-group-cache)
2928       (assq 'default gnus-category-alist)))
2929
2930 (defun gnus-agent-expire-group (group &optional articles force)
2931   "Expire all old articles in GROUP.
2932 If you want to force expiring of certain articles, this function can
2933 take ARTICLES, and FORCE parameters as well.
2934
2935 The articles on which the expiration process runs are selected as follows:
2936   if ARTICLES is null, all read and unmarked articles.
2937   if ARTICLES is t, all articles.
2938   if ARTICLES is a list, just those articles.
2939 FORCE is equivalent to setting the expiration predicates to true."
2940   (interactive
2941    (list (let ((def (or (gnus-group-group-name)
2942                         gnus-newsgroup-name)))
2943            (let ((select (read-string (if def
2944                                           (concat "Group Name ("
2945                                                   def "): ")
2946                                         "Group Name: "))))
2947              (if (and (equal "" select)
2948                       def)
2949                  def
2950                select)))))
2951
2952   (if (not group)
2953       (gnus-agent-expire articles group force)
2954     (let ( ;; Bind gnus-agent-expire-stats to enable tracking of
2955           ;; expiration statistics of this single group
2956           (gnus-agent-expire-stats (list 0 0 0.0)))
2957       (if (or (not (eq articles t))
2958               (yes-or-no-p
2959                (concat "Are you sure that you want to "
2960                        "expire all articles in " group ".")))
2961           (let ((gnus-command-method (gnus-find-method-for-group group))
2962                 (overview (gnus-get-buffer-create " *expire overview*"))
2963                 orig)
2964             (unwind-protect
2965                 (let ((active-file (gnus-agent-lib-file "active")))
2966                   (when (file-exists-p active-file)
2967                     (with-temp-buffer
2968                       (nnheader-insert-file-contents active-file)
2969                       (gnus-active-to-gnus-format
2970                        gnus-command-method
2971                        (setq orig (gnus-make-hashtable
2972                                    (count-lines (point-min) (point-max))))))
2973                     (save-excursion
2974                       (gnus-agent-expire-group-1
2975                        group overview (gnus-gethash-safe group orig)
2976                        articles force))))
2977               (kill-buffer overview))))
2978       (gnus-message 4 (gnus-agent-expire-done-message)))))
2979
2980 (defun gnus-agent-expire-group-1 (group overview active articles force)
2981   ;; Internal function - requires caller to have set
2982   ;; gnus-command-method, initialized overview buffer, and to have
2983   ;; provided a non-nil active
2984
2985   (let ((dir (gnus-agent-group-pathname group)))
2986     (gnus-agent-with-refreshed-group
2987      group
2988      (when (boundp 'gnus-agent-expire-current-dirs)
2989        (set 'gnus-agent-expire-current-dirs
2990             (cons dir
2991                   (symbol-value 'gnus-agent-expire-current-dirs))))
2992
2993      (if (and (not force)
2994               (eq 'DISABLE (gnus-agent-find-parameter group
2995                                                       'agent-enable-expiration)))
2996          (gnus-message 5 "Expiry skipping over %s" group)
2997        (gnus-message 5 "Expiring articles in %s" group)
2998        (gnus-agent-load-alist group)
2999        (let* ((bytes-freed 0)
3000               (size-files-deleted 0.0)
3001               (files-deleted 0)
3002               (nov-entries-deleted 0)
3003               (info (gnus-get-info group))
3004               (alist gnus-agent-article-alist)
3005               (day (- (time-to-days (current-time))
3006                       (gnus-agent-find-parameter group 'agent-days-until-old)))
3007               (specials (if (and alist
3008                                  (not force))
3009                             ;; This could be a bit of a problem.  I need to
3010                             ;; keep the last article to avoid refetching
3011                             ;; headers when using nntp in the backend.  At
3012                             ;; the same time, if someone uses a backend
3013                             ;; that supports article moving then I may have
3014                             ;; to remove the last article to complete the
3015                             ;; move.  Right now, I'm going to assume that
3016                             ;; FORCE overrides specials.
3017                             (list (caar (last alist)))))
3018               (unreads ;; Articles that are excluded from the
3019                ;; expiration process
3020                (cond (gnus-agent-expire-all
3021                       ;; All articles are marked read by global decree
3022                       nil)
3023                      ((eq articles t)
3024                       ;; All articles are marked read by function
3025                       ;; parameter
3026                       nil)
3027                      ((not articles)
3028                       ;; Unread articles are marked protected from
3029                       ;; expiration Don't call
3030                       ;; gnus-list-of-unread-articles as it returns
3031                       ;; articles that have not been fetched into the
3032                       ;; agent.
3033                       (ignore-errors
3034                         (gnus-agent-unread-articles group)))
3035                      (t
3036                       ;; All articles EXCEPT those named by the caller
3037                       ;; are protected from expiration
3038                       (gnus-sorted-difference
3039                        (gnus-uncompress-range
3040                         (cons (caar alist)
3041                               (caar (last alist))))
3042                        (sort articles '<)))))
3043               (marked ;; More articles that are excluded from the
3044                ;; expiration process
3045                (cond (gnus-agent-expire-all
3046                       ;; All articles are unmarked by global decree
3047                       nil)
3048                      ((eq articles t)
3049                       ;; All articles are unmarked by function
3050                       ;; parameter
3051                       nil)
3052                      (articles
3053                       ;; All articles may as well be unmarked as the
3054                       ;; unreads list already names the articles we are
3055                       ;; going to keep
3056                       nil)
3057                      (t
3058                       ;; Ticked and/or dormant articles are excluded
3059                       ;; from expiration
3060                       (nconc
3061                        (gnus-uncompress-range
3062                         (cdr (assq 'tick (gnus-info-marks info))))
3063                        (gnus-uncompress-range
3064                         (cdr (assq 'dormant
3065                                    (gnus-info-marks info))))))))
3066               (nov-file (concat dir ".overview"))
3067               (cnt 0)
3068               (completed -1)
3069               dlist
3070               type)
3071
3072          ;; The normal article alist contains elements that look like
3073          ;; (article# .  fetch_date) I need to combine other
3074          ;; information with this list.  For example, a flag indicating
3075          ;; that a particular article MUST BE KEPT.  To do this, I'm
3076          ;; going to transform the elements to look like (article#
3077          ;; fetch_date keep_flag NOV_entry_marker) Later, I'll reverse
3078          ;; the process to generate the expired article alist.
3079
3080          ;; Convert the alist elements to (article# fetch_date nil
3081          ;; nil).
3082          (setq dlist (mapcar (lambda (e)
3083                                (list (car e) (cdr e) nil nil)) alist))
3084
3085          ;; Convert the keep lists to elements that look like (article#
3086          ;; nil keep_flag nil) then append it to the expanded dlist
3087          ;; These statements are sorted by ascending precidence of the
3088          ;; keep_flag.
3089          (setq dlist (nconc dlist
3090                             (mapcar (lambda (e)
3091                                       (list e nil 'unread  nil))
3092                                     unreads)))
3093          (setq dlist (nconc dlist
3094                             (mapcar (lambda (e)
3095                                       (list e nil 'marked  nil))
3096                                     marked)))
3097          (setq dlist (nconc dlist
3098                             (mapcar (lambda (e)
3099                                       (list e nil 'special nil))
3100                                     specials)))
3101
3102          (set-buffer overview)
3103          (erase-buffer)
3104          (buffer-disable-undo)
3105          (when (file-exists-p nov-file)
3106            (gnus-message 7 "gnus-agent-expire: Loading overview...")
3107            (nnheader-insert-file-contents nov-file)
3108            (goto-char (point-min))
3109
3110            (let (p)
3111              (while (< (setq p (point)) (point-max))
3112                (condition-case nil
3113                    ;; If I successfully read an integer (the plus zero
3114                    ;; ensures a numeric type), prepend a marker entry
3115                    ;; to the list
3116                    (push (list (+ 0 (read (current-buffer))) nil nil
3117                                (set-marker (make-marker) p))
3118                          dlist)
3119                  (error
3120                   (gnus-message 1 "gnus-agent-expire: read error \
3121 occurred when reading expression at %s in %s.  Skipping to next \
3122 line." (point) nov-file)))
3123                ;; Whether I succeeded, or failed, it doesn't matter.
3124                ;; Move to the next line then try again.
3125                (forward-line 1)))
3126
3127            (gnus-message
3128             7 "gnus-agent-expire: Loading overview... Done"))
3129          (set-buffer-modified-p nil)
3130
3131          ;; At this point, all of the information is in dlist.  The
3132          ;; only problem is that much of it is spread across multiple
3133          ;; entries.  Sort then MERGE!!
3134          (gnus-message 7 "gnus-agent-expire: Sorting entries... ")
3135          ;; If two entries have the same article-number then sort by
3136          ;; ascending keep_flag.
3137          (let ((special 0)
3138                (marked 1)
3139                (unread 2))
3140            (setq dlist
3141                  (sort dlist
3142                        (lambda (a b)
3143                          (cond ((< (nth 0 a) (nth 0 b))
3144                                 t)
3145                                ((> (nth 0 a) (nth 0 b))
3146                                 nil)
3147                                (t
3148                                 (let ((a (or (symbol-value (nth 2 a))
3149                                              3))
3150                                       (b (or (symbol-value (nth 2 b))
3151                                              3)))
3152                                   (<= a b))))))))
3153          (gnus-message 7 "gnus-agent-expire: Sorting entries... Done")
3154          (gnus-message 7 "gnus-agent-expire: Merging entries... ")
3155          (let ((dlist dlist))
3156            (while (cdr dlist)           ; I'm not at the end-of-list
3157              (if (eq (caar dlist) (caadr dlist))
3158                  (let ((first (cdr (car dlist)))
3159                        (secnd (cdr (cadr dlist))))
3160                    (setcar first (or (car first)
3161                                      (car secnd))) ; fetch_date
3162                    (setq first (cdr first)
3163                          secnd (cdr secnd))
3164                    (setcar first (or (car first)
3165                                      (car secnd))) ; Keep_flag
3166                    (setq first (cdr first)
3167                          secnd (cdr secnd))
3168                    (setcar first (or (car first)
3169                                      (car secnd))) ; NOV_entry_marker
3170
3171                    (setcdr dlist (cddr dlist)))
3172                (setq dlist (cdr dlist)))))
3173          (gnus-message 7 "gnus-agent-expire: Merging entries... Done")
3174
3175          (let* ((len (float (length dlist)))
3176                 (alist (list nil))
3177                 (tail-alist alist))
3178            (while dlist
3179              (let ((new-completed (truncate (* 100.0
3180                                                (/ (setq cnt (1+ cnt))
3181                                                   len))))
3182                    message-log-max)
3183                (when (> new-completed completed)
3184                  (setq completed new-completed)
3185                  (gnus-message 7 "%3d%% completed..."  completed)))
3186              (let* ((entry          (car dlist))
3187                     (article-number (nth 0 entry))
3188                     (fetch-date     (nth 1 entry))
3189                     (keep           (nth 2 entry))
3190                     (marker         (nth 3 entry)))
3191
3192                (cond
3193                 ;; Kept articles are unread, marked, or special.
3194                 (keep
3195                  (gnus-agent-message 10
3196                                      "gnus-agent-expire: %s:%d: Kept %s article%s."
3197                                      group article-number keep (if fetch-date " and file" ""))
3198                  (when fetch-date
3199                    (unless (file-exists-p
3200                             (concat dir (number-to-string
3201                                          article-number)))
3202                      (setf (nth 1 entry) nil)
3203                      (gnus-agent-message 3 "gnus-agent-expire cleared \
3204 download flag on %s:%d as the cached article file is missing."
3205                                          group (caar dlist)))
3206                    (unless marker
3207                      (gnus-message 1 "gnus-agent-expire detected a \
3208 missing NOV entry.  Run gnus-agent-regenerate-group to restore it.")))
3209                  (gnus-agent-append-to-list
3210                   tail-alist
3211                   (cons article-number fetch-date)))
3212
3213                 ;; The following articles are READ, UNMARKED, and
3214                 ;; ORDINARY.  See if they can be EXPIRED!!!
3215                 ((setq type
3216                        (cond
3217                         ((not (integerp fetch-date))
3218                          'read) ;; never fetched article (may expire
3219                         ;; right now)
3220                         ((not (file-exists-p
3221                                (concat dir (number-to-string
3222                                             article-number))))
3223                          (setf (nth 1 entry) nil)
3224                          'externally-expired) ;; Can't find the cached
3225                         ;; article.  Handle case
3226                         ;; as though this article
3227                         ;; was never fetched.
3228
3229                         ;; We now have the arrival day, so we see
3230                         ;; whether it's old enough to be expired.
3231                         ((< fetch-date day)
3232                          'expired)
3233                         (force
3234                          'forced)))
3235
3236                  ;; I found some reason to expire this entry.
3237
3238                  (let ((actions nil))
3239                    (when (memq type '(forced expired))
3240                      (ignore-errors     ; Just being paranoid.
3241                        (let* ((file-name (nnheader-concat dir (number-to-string
3242                                                                article-number)))
3243                               (size (float (nth 7 (file-attributes file-name)))))
3244                          (incf bytes-freed size)
3245                          (incf size-files-deleted size)
3246                          (incf files-deleted)
3247                          (delete-file file-name))
3248                        (push "expired cached article" actions))
3249                      (setf (nth 1 entry) nil)
3250                      )
3251
3252                    (when marker
3253                      (push "NOV entry removed" actions)
3254                      (goto-char marker)
3255
3256                      (incf nov-entries-deleted)
3257
3258                      (let ((from (point-at-bol))
3259                            (to (progn (forward-line 1) (point))))
3260                        (incf bytes-freed (- to from))
3261                        (delete-region from to)))
3262
3263                    ;; If considering all articles is set, I can only
3264                    ;; expire article IDs that are no longer in the
3265                    ;; active range (That is, articles that preceed the
3266                    ;; first article in the new alist).
3267                    (if (and gnus-agent-consider-all-articles
3268                             (>= article-number (car active)))
3269                        ;; I have to keep this ID in the alist
3270                        (gnus-agent-append-to-list
3271                         tail-alist (cons article-number fetch-date))
3272                      (push (format "Removed %s article number from \
3273 article alist" type) actions))
3274
3275                    (when actions
3276                      (gnus-agent-message 8 "gnus-agent-expire: %s:%d: %s"
3277                                          group article-number
3278                                          (mapconcat 'identity actions ", ")))))
3279                 (t
3280                  (gnus-agent-message
3281                   10 "gnus-agent-expire: %s:%d: Article kept as \
3282 expiration tests failed." group article-number)
3283                  (gnus-agent-append-to-list
3284                   tail-alist (cons article-number fetch-date)))
3285                 )
3286
3287                ;; Clean up markers as I want to recycle this buffer
3288                ;; over several groups.
3289                (when marker
3290                  (set-marker marker nil))
3291
3292                (setq dlist (cdr dlist))))
3293
3294            (setq alist (cdr alist))
3295
3296            (let ((inhibit-quit t))
3297              (unless (equal alist gnus-agent-article-alist)
3298                (setq gnus-agent-article-alist alist)
3299                (gnus-agent-save-alist group))
3300
3301              (when (buffer-modified-p)
3302                (let ((coding-system-for-write
3303                       gnus-agent-file-coding-system))
3304                  (gnus-make-directory dir)
3305                  (write-region (point-min) (point-max) nov-file nil
3306                                'silent)
3307                  ;; clear the modified flag as that I'm not confused by
3308                  ;; its status on the next pass through this routine.
3309                  (set-buffer-modified-p nil)
3310                  (gnus-agent-update-view-total-fetched-for group t)))
3311
3312              (when (eq articles t)
3313                (gnus-summary-update-info))))
3314
3315          (when (boundp 'gnus-agent-expire-stats)
3316            (let ((stats (symbol-value 'gnus-agent-expire-stats)))
3317              (incf (nth 2 stats) bytes-freed)
3318              (incf (nth 1 stats) files-deleted)
3319              (incf (nth 0 stats) nov-entries-deleted)))
3320
3321          (gnus-agent-update-files-total-fetched-for group (- size-files-deleted)))))))
3322
3323 (defun gnus-agent-expire (&optional articles group force)
3324   "Expire all old articles.
3325 If you want to force expiring of certain articles, this function can
3326 take ARTICLES, GROUP and FORCE parameters as well.
3327
3328 The articles on which the expiration process runs are selected as follows:
3329   if ARTICLES is null, all read and unmarked articles.
3330   if ARTICLES is t, all articles.
3331   if ARTICLES is a list, just those articles.
3332 Setting GROUP will limit expiration to that group.
3333 FORCE is equivalent to setting the expiration predicates to true."
3334   (interactive)
3335
3336   (if group
3337       (gnus-agent-expire-group group articles force)
3338     (if (or (not (eq articles t))
3339             (yes-or-no-p "Are you sure that you want to expire all \
3340 articles in every agentized group."))
3341         (let ((methods (gnus-agent-covered-methods))
3342               ;; Bind gnus-agent-expire-current-dirs to enable tracking
3343               ;; of agent directories.
3344               (gnus-agent-expire-current-dirs nil)
3345               ;; Bind gnus-agent-expire-stats to enable tracking of
3346               ;; expiration statistics across all groups
3347               (gnus-agent-expire-stats (list 0 0 0.0))
3348               gnus-command-method overview orig)
3349           (setq overview (gnus-get-buffer-create " *expire overview*"))
3350           (unwind-protect
3351               (while (setq gnus-command-method (pop methods))
3352                 (let ((active-file (gnus-agent-lib-file "active")))
3353                   (when (file-exists-p active-file)
3354                     (with-temp-buffer
3355                       (nnheader-insert-file-contents active-file)
3356                       (gnus-active-to-gnus-format
3357                        gnus-command-method
3358                        (setq orig (gnus-make-hashtable
3359                                    (count-lines (point-min) (point-max))))))
3360                     (dolist (expiring-group (gnus-groups-from-server
3361                                              gnus-command-method))
3362                       (let* ((active
3363                               (gnus-gethash-safe expiring-group orig)))
3364
3365                         (when active
3366                           (save-excursion
3367                             (gnus-agent-expire-group-1
3368                              expiring-group overview active articles force))))))))
3369             (kill-buffer overview))
3370           (gnus-agent-expire-unagentized-dirs)
3371           (gnus-message 4 (gnus-agent-expire-done-message))))))
3372
3373 (defun gnus-agent-expire-done-message ()
3374   (if (and (> gnus-verbose 4)
3375            (boundp 'gnus-agent-expire-stats))
3376       (let* ((stats (symbol-value 'gnus-agent-expire-stats))
3377              (size (nth 2 stats))
3378             (units '(B KB MB GB)))
3379         (while (and (> size 1024.0)
3380                     (cdr units))
3381           (setq size (/ size 1024.0)
3382                 units (cdr units)))
3383
3384         (format "Expiry recovered %d NOV entries, deleted %d files,\
3385  and freed %f %s."
3386                 (nth 0 stats)
3387                 (nth 1 stats)
3388                 size (car units)))
3389     "Expiry...done"))
3390
3391 (defun gnus-agent-expire-unagentized-dirs ()
3392   (when (and gnus-agent-expire-unagentized-dirs
3393              (boundp 'gnus-agent-expire-current-dirs))
3394     (let* ((keep (gnus-make-hashtable))
3395            ;; Formally bind gnus-agent-expire-current-dirs so that the
3396            ;; compiler will not complain about free references.
3397            (gnus-agent-expire-current-dirs
3398             (symbol-value 'gnus-agent-expire-current-dirs))
3399            dir)
3400
3401       (gnus-sethash gnus-agent-directory t keep)
3402       (while gnus-agent-expire-current-dirs
3403         (setq dir (pop gnus-agent-expire-current-dirs))
3404         (when (and (stringp dir)
3405                    (file-directory-p dir))
3406           (while (not (gnus-gethash dir keep))
3407             (gnus-sethash dir t keep)
3408             (setq dir (file-name-directory (directory-file-name dir))))))
3409
3410       (let* (to-remove
3411              checker
3412              (checker
3413               (function
3414                (lambda (d)
3415                  "Given a directory, check it and its subdirectories for
3416               membership in the keep hash.  If it isn't found, add
3417               it to to-remove."
3418                  (let ((files (directory-files d))
3419                        file)
3420                    (while (setq file (pop files))
3421                      (cond ((equal file ".") ; Ignore self
3422                             nil)
3423                            ((equal file "..") ; Ignore parent
3424                             nil)
3425                            ((equal file ".overview")
3426                             ;; Directory must contain .overview to be
3427                             ;; agent's cache of a group.
3428                             (let ((d (file-name-as-directory d))
3429                                   r)
3430                               ;; Search ancestor's for last directory NOT
3431                               ;; found in keep hash.
3432                               (while (not (gnus-gethash
3433                                            (setq d (file-name-directory d)) keep))
3434                                 (setq r d
3435                                       d (directory-file-name d)))
3436                               ;; if ANY ancestor was NOT in keep hash and
3437                               ;; it it's already in to-remove, add it to
3438                               ;; to-remove.
3439                               (if (and r
3440                                        (not (member r to-remove)))
3441                                   (push r to-remove))))
3442                            ((file-directory-p (setq file (nnheader-concat d file)))
3443                             (funcall checker file)))))))))
3444         (funcall checker (expand-file-name gnus-agent-directory))
3445
3446         (when (and to-remove
3447                    (or gnus-expert-user
3448                        (gnus-y-or-n-p
3449                         "gnus-agent-expire has identified local directories that are\
3450  not currently required by any agentized group.  Do you wish to consider\
3451  deleting them?")))
3452           (while to-remove
3453             (let ((dir (pop to-remove)))
3454               (if (gnus-y-or-n-p (format "Delete %s? " dir))
3455                   (let* (delete-recursive
3456                          (delete-recursive
3457                           (function
3458                            (lambda (f-or-d)
3459                              (ignore-errors
3460                                (if (file-directory-p f-or-d)
3461                                    (condition-case nil
3462                                        (delete-directory f-or-d)
3463                                      (file-error
3464                                       (mapcar (lambda (f)
3465                                                 (or (member f '("." ".."))
3466                                                     (funcall delete-recursive
3467                                                              (nnheader-concat
3468                                                               f-or-d f))))
3469                                               (directory-files f-or-d))
3470                                       (delete-directory f-or-d)))
3471                                  (delete-file f-or-d)))))))
3472                     (funcall delete-recursive dir))))))))))
3473
3474 ;;;###autoload
3475 (defun gnus-agent-batch ()
3476   "Start Gnus, send queue and fetch session."
3477   (interactive)
3478   (let ((init-file-user "")
3479         (gnus-always-read-dribble-file t))
3480     (gnus))
3481   (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
3482     (gnus-group-send-queue)
3483     (gnus-agent-fetch-session)))
3484
3485 (defun gnus-agent-unread-articles (group)
3486   (let* ((read (gnus-info-read (gnus-get-info group)))
3487          (known (gnus-agent-load-alist group))
3488          (unread (list nil))
3489          (tail-unread unread))
3490     (while (and known read)
3491       (let ((candidate (car (pop known))))
3492         (while (let* ((range (car read))
3493                       (min   (if (numberp range) range (car range)))
3494                       (max   (if (numberp range) range (cdr range))))
3495                  (cond ((or (not min)
3496                             (< candidate min))
3497                         (gnus-agent-append-to-list tail-unread candidate)
3498                         nil)
3499                        ((> candidate max)
3500                         (setq read (cdr read))
3501                         ;; return t so that I always loop one more
3502                         ;; time.  If I just iterated off the end of
3503                         ;; read, min will become nil and the current
3504                         ;; candidate will be added to the unread list.
3505                         t))))))
3506     (while known
3507       (gnus-agent-append-to-list tail-unread (car (pop known))))
3508     (cdr unread)))
3509
3510 (defun gnus-agent-uncached-articles (articles group &optional cached-header)
3511   "Restrict ARTICLES to numbers already fetched.
3512 Returns a sublist of ARTICLES that excludes those article ids in GROUP
3513 that have already been fetched.
3514 If CACHED-HEADER is nil, articles are only excluded if the article itself
3515 has been fetched."
3516
3517   ;; Logically equivalent to: (gnus-sorted-difference articles (mapcar
3518   ;; 'car gnus-agent-article-alist))
3519
3520   ;; Functionally, I don't need to construct a temp list using mapcar.
3521
3522   (if (and (or gnus-agent-cache (not gnus-plugged))
3523            (gnus-agent-load-alist group))
3524     (let* ((ref gnus-agent-article-alist)
3525            (arts articles)
3526            (uncached (list nil))
3527            (tail-uncached uncached))
3528       (while (and ref arts)
3529         (let ((v1 (car arts))
3530               (v2 (caar ref)))
3531           (cond ((< v1 v2) ; v1 does not appear in the reference list
3532                  (gnus-agent-append-to-list tail-uncached v1)
3533                  (setq arts (cdr arts)))
3534                 ((= v1 v2)
3535                  (unless (or cached-header (cdar ref)) ; v1 is already cached
3536                    (gnus-agent-append-to-list tail-uncached v1))
3537                  (setq arts (cdr arts))
3538                  (setq ref (cdr ref)))
3539                 (t ; reference article (v2) preceeds the list being filtered
3540                  (setq ref (cdr ref))))))
3541       (while arts
3542         (gnus-agent-append-to-list tail-uncached (pop arts)))
3543       (cdr uncached))
3544     ;; if gnus-agent-load-alist fails, no articles are cached.
3545     articles))
3546
3547 (defun gnus-agent-retrieve-headers (articles group &optional fetch-old)
3548   (save-excursion
3549     (gnus-agent-create-buffer)
3550     (let ((gnus-decode-encoded-word-function 'identity)
3551           (file (gnus-agent-article-name ".overview" group))
3552           cached-articles uncached-articles)
3553       (gnus-make-directory (nnheader-translate-file-chars
3554                             (file-name-directory file) t))
3555
3556       ;; Populate temp buffer with known headers
3557       (when (file-exists-p file)
3558         (with-current-buffer gnus-agent-overview-buffer
3559           (erase-buffer)
3560           (let ((nnheader-file-coding-system
3561                  gnus-agent-file-coding-system))
3562             (nnheader-insert-nov-file file (car articles)))))
3563
3564       (if (setq uncached-articles (gnus-agent-uncached-articles articles group
3565                                                                 t))
3566           (progn
3567             ;; Populate nntp-server-buffer with uncached headers
3568             (set-buffer nntp-server-buffer)
3569             (erase-buffer)
3570             (cond ((not (eq 'nov (let (gnus-agent) ; Turn off agent
3571                                    (gnus-retrieve-headers
3572                                     uncached-articles group fetch-old))))
3573                    (nnvirtual-convert-headers))
3574                   ((eq 'nntp (car gnus-current-select-method))
3575                    ;; The author of gnus-get-newsgroup-headers-xover
3576                    ;; reports that the XOVER command is commonly
3577                    ;; unreliable. The problem is that recently
3578                    ;; posted articles may not be entered into the
3579                    ;; NOV database in time to respond to my XOVER
3580                    ;; query.
3581                    ;;
3582                    ;; I'm going to use his assumption that the NOV
3583                    ;; database is updated in order of ascending
3584                    ;; article ID.  Therefore, a response containing
3585                    ;; article ID N implies that all articles from 1
3586                    ;; to N-1 are up-to-date.  Therefore, missing
3587                    ;; articles in that range have expired.
3588
3589                    (set-buffer nntp-server-buffer)
3590                    (let* ((fetched-articles (list nil))
3591                           (tail-fetched-articles fetched-articles)
3592                           (min (cond ((numberp fetch-old)
3593                                       (max 1 (- (car articles) fetch-old)))
3594                                      (fetch-old
3595                                       1)
3596                                      (t
3597                                       (car articles))))
3598                           (max (car (last articles))))
3599
3600                      ;; Get the list of articles that were fetched
3601                      (goto-char (point-min))
3602                      (let ((pm (point-max))
3603                            art)
3604                        (while (< (point) pm)
3605                          (when (setq art (gnus-agent-read-article-number))
3606                            (gnus-agent-append-to-list tail-fetched-articles art))
3607                          (forward-line 1)))
3608
3609                      ;; Clip this list to the headers that will
3610                      ;; actually be returned
3611                      (setq fetched-articles (gnus-list-range-intersection
3612                                              (cdr fetched-articles)
3613                                              (cons min max)))
3614
3615                      ;; Clip the uncached articles list to exclude
3616                      ;; IDs after the last FETCHED header.  The
3617                      ;; excluded IDs may be fetchable using HEAD.
3618                      (if (car tail-fetched-articles)
3619                          (setq uncached-articles
3620                                (gnus-list-range-intersection
3621                                 uncached-articles
3622                                 (cons (car uncached-articles)
3623                                       (car tail-fetched-articles)))))
3624
3625                      ;; Create the list of articles that were
3626                      ;; "successfully" fetched.  Success, in this
3627                      ;; case, means that the ID should not be
3628                      ;; fetched again.  In the case of an expired
3629                      ;; article, the header will not be fetched.
3630                      (setq uncached-articles
3631                            (gnus-sorted-nunion fetched-articles
3632                                                uncached-articles))
3633                      )))
3634
3635             ;; Erase the temp buffer
3636             (set-buffer gnus-agent-overview-buffer)
3637             (erase-buffer)
3638
3639             ;; Copy the nntp-server-buffer to the temp buffer
3640             (set-buffer nntp-server-buffer)
3641             (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
3642
3643             ;; Merge the temp buffer with the known headers (found on
3644             ;; disk in FILE) into the nntp-server-buffer
3645             (when uncached-articles
3646               (gnus-agent-braid-nov group uncached-articles file))
3647
3648             ;; Save the new set of known headers to FILE
3649             (set-buffer nntp-server-buffer)
3650             (let ((coding-system-for-write
3651                    gnus-agent-file-coding-system))
3652               (gnus-agent-check-overview-buffer)
3653               (write-region (point-min) (point-max) file nil 'silent))
3654
3655             (gnus-agent-update-view-total-fetched-for group t)
3656
3657             ;; Update the group's article alist to include the newly
3658             ;; fetched articles.
3659             (gnus-agent-load-alist group)
3660             (gnus-agent-save-alist group uncached-articles nil)
3661             )
3662
3663         ;; Copy the temp buffer to the nntp-server-buffer
3664         (set-buffer nntp-server-buffer)
3665         (erase-buffer)
3666         (insert-buffer-substring gnus-agent-overview-buffer)))
3667
3668     (if (and fetch-old
3669              (not (numberp fetch-old)))
3670         t                               ; Don't remove anything.
3671       (nnheader-nov-delete-outside-range
3672        (if fetch-old (max 1 (- (car articles) fetch-old))
3673          (car articles))
3674        (car (last articles)))
3675       t)
3676
3677     'nov))
3678
3679 (defun gnus-agent-request-article (article group)
3680   "Retrieve ARTICLE in GROUP from the agent cache."
3681   (when (and gnus-agent
3682              (or gnus-agent-cache
3683                  (not gnus-plugged))
3684              (numberp article))
3685     (let* ((gnus-command-method (gnus-find-method-for-group group))
3686            (file (gnus-agent-article-name (number-to-string article) group))
3687            (buffer-read-only nil))
3688       (when (and (file-exists-p file)
3689                  (> (nth 7 (file-attributes file)) 0))
3690         (erase-buffer)
3691         (gnus-kill-all-overlays)
3692         (let ((coding-system-for-read gnus-cache-coding-system))
3693           (insert-file-contents file))
3694         t))))
3695
3696 (defun gnus-agent-regenerate-group (group &optional reread)
3697   "Regenerate GROUP.
3698 If REREAD is t, all articles in the .overview are marked as unread.
3699 If REREAD is a list, the specified articles will be marked as unread.
3700 In addition, their NOV entries in .overview will be refreshed using
3701 the articles' current headers.
3702 If REREAD is not nil, downloaded articles are marked as unread."
3703   (interactive
3704    (list (let ((def (or (gnus-group-group-name)
3705                         gnus-newsgroup-name)))
3706            (let ((select (read-string (if def
3707                                           (concat "Group Name ("
3708                                                   def "): ")
3709                                         "Group Name: "))))
3710              (if (and (equal "" select)
3711                       def)
3712                  def
3713                select)))
3714          (catch 'mark
3715            (while (let (c
3716                         (cursor-in-echo-area t)
3717                         (echo-keystrokes 0))
3718                     (message "Mark as unread: (n)one / (a)ll / all (d)ownloaded articles? (n) ")
3719                     (setq c (read-char-exclusive))
3720
3721                     (cond ((or (eq c ?\r) (eq c ?n) (eq c ?N))
3722                            (throw 'mark nil))
3723                           ((or (eq c ?a) (eq c ?A))
3724                            (throw 'mark t))
3725                           ((or (eq c ?d) (eq c ?D))
3726                            (throw 'mark 'some)))
3727                     (gnus-message 3 "Ignoring unexpected input")
3728                     (sit-for 1)
3729                     t)))))
3730   (when group
3731     (gnus-message 5 "Regenerating in %s" group)
3732     (let* ((gnus-command-method (or gnus-command-method
3733                                     (gnus-find-method-for-group group)))
3734            (file (gnus-agent-article-name ".overview" group))
3735            (dir (file-name-directory file))
3736            point
3737            (downloaded (if (file-exists-p dir)
3738                            (sort (mapcar (lambda (name) (string-to-int name))
3739                                          (directory-files dir nil "^[0-9]+$" t))
3740                                  '>)
3741                          (progn (gnus-make-directory dir) nil)))
3742            dl nov-arts
3743            alist header
3744            regenerated)
3745
3746       (mm-with-unibyte-buffer
3747         (if (file-exists-p file)
3748             (let ((nnheader-file-coding-system
3749                    gnus-agent-file-coding-system))
3750               (nnheader-insert-file-contents file)))
3751         (set-buffer-modified-p nil)
3752
3753         ;; Load the article IDs found in the overview file.  As a
3754         ;; side-effect, validate the file contents.
3755         (let ((load t))
3756           (while load
3757             (setq load nil)
3758             (goto-char (point-min))
3759             (while (< (point) (point-max))
3760               (cond ((and (looking-at "[0-9]+\t")
3761                           (<= (- (match-end 0) (match-beginning 0)) 9))
3762                      (push (read (current-buffer)) nov-arts)
3763                      (forward-line 1)
3764                      (let ((l1 (car nov-arts))
3765                            (l2 (cadr nov-arts)))
3766                        (cond ((and (listp reread) (memq l1 reread))
3767                               (gnus-delete-line)
3768                               (setq nov-arts (cdr nov-arts))
3769                               (gnus-message 4 "gnus-agent-regenerate-group: NOV\
3770 entry of article %s deleted." l1))
3771                              ((not l2)
3772                               nil)
3773                              ((< l1 l2)
3774                               (gnus-message 3 "gnus-agent-regenerate-group: NOV\
3775  entries are NOT in ascending order.")
3776                               ;; Don't sort now as I haven't verified
3777                               ;; that every line begins with a number
3778                               (setq load t))
3779                              ((= l1 l2)
3780                               (forward-line -1)
3781                               (gnus-message 4 "gnus-agent-regenerate-group: NOV\
3782  entries contained duplicate of article %s.      Duplicate deleted." l1)
3783                               (gnus-delete-line)
3784                               (setq nov-arts (cdr nov-arts))))))
3785                     (t
3786                      (gnus-message 1 "gnus-agent-regenerate-group: NOV\
3787  entries contained line that did not begin with an article number.  Deleted\
3788  line.")
3789                      (gnus-delete-line))))
3790             (when load
3791               (gnus-message 5 "gnus-agent-regenerate-group: Sorting NOV\
3792  entries into ascending order.")
3793               (sort-numeric-fields 1 (point-min) (point-max))
3794               (setq nov-arts nil))))
3795         (gnus-agent-check-overview-buffer)
3796
3797         ;; Construct a new article alist whose nodes match every header
3798         ;; in the .overview file.  As a side-effect, missing headers are
3799         ;; reconstructed from the downloaded article file.
3800         (while (or downloaded nov-arts)
3801           (cond ((and downloaded
3802                       (or (not nov-arts)
3803                           (> (car downloaded) (car nov-arts))))
3804                  ;; This entry is missing from the overview file
3805                  (gnus-message 3 "Regenerating NOV %s %d..." group
3806                                (car downloaded))
3807                  (let ((file (concat dir (number-to-string (car downloaded)))))
3808                    (mm-with-unibyte-buffer
3809                      (nnheader-insert-file-contents file)
3810                      (nnheader-remove-body)
3811                      (setq header (nnheader-parse-naked-head)))
3812                    (mail-header-set-number header (car downloaded))
3813                    (if nov-arts
3814                        (let ((key (concat "^" (int-to-string (car nov-arts))
3815                                           "\t")))
3816                          (or (re-search-backward key nil t)
3817                              (re-search-forward key))
3818                          (forward-line 1))
3819                      (goto-char (point-min)))
3820                    (nnheader-insert-nov header))
3821                  (setq nov-arts (cons (car downloaded) nov-arts)))
3822                 ((eq (car downloaded) (car nov-arts))
3823                  ;; This entry in the overview has been downloaded
3824                  (push (cons (car downloaded)
3825                              (time-to-days
3826                               (nth 5 (file-attributes
3827                                       (concat dir (number-to-string
3828                                                    (car downloaded))))))) alist)
3829                  (setq downloaded (cdr downloaded))
3830                  (setq nov-arts (cdr nov-arts)))
3831                 (t
3832                  ;; This entry in the overview has not been downloaded
3833                  (push (cons (car nov-arts) nil) alist)
3834                  (setq nov-arts (cdr nov-arts)))))
3835
3836         ;; When gnus-agent-consider-all-articles is set,
3837         ;; gnus-agent-regenerate-group should NOT remove article IDs from
3838         ;; the alist.  Those IDs serve as markers to indicate that an
3839         ;; attempt has been made to fetch that article's header.
3840
3841         ;; When gnus-agent-consider-all-articles is NOT set,
3842         ;; gnus-agent-regenerate-group can remove the article ID of every
3843         ;; article (with the exception of the last ID in the list - it's
3844         ;; special) that no longer appears in the overview.  In this
3845         ;; situtation, the last article ID in the list implies that it,
3846         ;; and every article ID preceeding it, have been fetched from the
3847         ;; server.
3848
3849         (if gnus-agent-consider-all-articles
3850             ;; Restore all article IDs that were not found in the overview file.
3851             (let* ((n (cons nil alist))
3852                    (merged n)
3853                    (o (gnus-agent-load-alist group)))
3854               (while o
3855                 (let ((nID (caadr n))
3856                       (oID (caar o)))
3857                   (cond ((not nID)
3858                          (setq n (setcdr n (list (list oID))))
3859                          (setq o (cdr o)))
3860                         ((< oID nID)
3861                          (setcdr n (cons (list oID) (cdr n)))
3862                          (setq o (cdr o)))
3863                         ((= oID nID)
3864                          (setq o (cdr o))
3865                          (setq n (cdr n)))
3866                         (t
3867                          (setq n (cdr n))))))
3868               (setq alist (cdr merged)))
3869           ;; Restore the last article ID if it is not already in the new alist
3870           (let ((n (last alist))
3871                 (o (last (gnus-agent-load-alist group))))
3872             (cond ((not o)
3873                    nil)
3874                   ((not n)
3875                    (push (cons (caar o) nil) alist))
3876                   ((< (caar n) (caar o))
3877                    (setcdr n (list (car o)))))))
3878
3879         (let ((inhibit-quit t))
3880           (if (setq regenerated (buffer-modified-p))
3881               (let ((coding-system-for-write gnus-agent-file-coding-system))
3882                 (write-region (point-min) (point-max) file nil 'silent)))
3883
3884           (setq regenerated (or regenerated
3885                                 (and reread gnus-agent-article-alist)
3886                                 (not (equal alist gnus-agent-article-alist))))
3887
3888 <<<<<<< TREE
3889           (setq gnus-agent-article-alist alist)
3890
3891           (when regenerated
3892             (gnus-agent-save-alist group)
3893        
3894             ;; I have to alter the group's active range NOW as
3895             ;; gnus-make-ascending-articles-unread will use it to
3896             ;; recalculate the number of unread articles in the group
3897
3898             (let ((group (gnus-group-real-name group))
3899                   (group-active (or (gnus-active group)
3900                                     (gnus-activate-group group))))
3901               (gnus-agent-possibly-alter-active group group-active)))))
3902
3903       (when (and reread gnus-agent-article-alist)
3904         (gnus-make-ascending-articles-unread
3905          group
3906          (if (listp reread)
3907              reread
3908            (delq nil (mapcar (function (lambda (c)
3909                                          (cond ((eq reread t)
3910                                                 (car c))
3911                                                ((cdr c)
3912                                                 (car c)))))
3913                              gnus-agent-article-alist))))
3914 =======
3915             (when regenerated
3916               (gnus-agent-save-alist group)
3917
3918               ;; I have to alter the group's active range NOW as
3919               ;; gnus-make-ascending-articles-unread will use it to
3920               ;; recalculate the number of unread articles in the group
3921
3922               (let ((group (gnus-group-real-name group))
3923                     (group-active (or (gnus-active group)
3924                                       (gnus-activate-group group))))
3925                 (gnus-agent-possibly-alter-active group group-active)))))
3926
3927         (when (and reread gnus-agent-article-alist)
3928           (gnus-make-ascending-articles-unread
3929            group
3930            (if (listp reread)
3931                reread
3932              (delq nil (mapcar (function (lambda (c)
3933                                            (cond ((eq reread t)
3934                                                   (car c))
3935                                                  ((cdr c)
3936                                                   (car c)))))
3937                                gnus-agent-article-alist))))
3938 >>>>>>> MERGE-SOURCE
3939
3940         (when regenerated
3941           (gnus-agent-update-files-total-fetched-for group nil)))
3942
3943       (gnus-message 5 "")
3944       regenerated)))
3945
3946 ;;;###autoload
3947 (defun gnus-agent-regenerate (&optional clean reread)
3948   "Regenerate all agent covered files.
3949 If CLEAN, obsolete (ignore)."
3950   (interactive "P")
3951   (let (regenerated)
3952     (gnus-message 4 "Regenerating Gnus agent files...")
3953     (dolist (gnus-command-method (gnus-agent-covered-methods))
3954         (dolist (group (gnus-groups-from-server gnus-command-method))
3955           (setq regenerated (or (gnus-agent-regenerate-group group reread)
3956                                 regenerated))))
3957     (gnus-message 4 "Regenerating Gnus agent files...done")
3958
3959     regenerated))
3960
3961 (defun gnus-agent-go-online (&optional force)
3962   "Switch servers into online status."
3963   (interactive (list t))
3964   (dolist (server gnus-opened-servers)
3965     (when (eq (nth 1 server) 'offline)
3966       (if (if (eq force 'ask)
3967               (gnus-y-or-n-p
3968                (format "Switch %s:%s into online status? "
3969                        (caar server) (cadar server)))
3970             force)
3971           (setcar (nthcdr 1 server) 'close)))))
3972
3973 (defun gnus-agent-toggle-group-plugged (group)
3974   "Toggle the status of the server of the current group."
3975   (interactive (list (gnus-group-group-name)))
3976   (let* ((method (gnus-find-method-for-group group))
3977          (status (cadr (assoc method gnus-opened-servers))))
3978     (if (eq status 'offline)
3979         (gnus-server-set-status method 'closed)
3980       (gnus-close-server method)
3981       (gnus-server-set-status method 'offline))
3982     (message "Turn %s:%s from %s to %s." (car method) (cadr method)
3983              (if (eq status 'offline) 'offline 'online)
3984              (if (eq status 'offline) 'online 'offline))))
3985
3986 (defun gnus-agent-group-covered-p (group)
3987   (gnus-agent-method-p (gnus-group-method group)))
3988
3989 ;; Added to support XEmacs
3990 (eval-and-compile
3991   (unless (fboundp 'directory-files-and-attributes)
3992     (defun directory-files-and-attributes (directory
3993                                            &optional full match nosort)
3994       (let (result)
3995         (dolist (file (directory-files directory full match nosort))
3996           (push (cons file (file-attributes file)) result))
3997         (nreverse result)))))
3998
3999 (defun gnus-agent-update-files-total-fetched-for 
4000   (group delta &optional method path)
4001   "Update, or set, the total disk space used by the articles that the
4002 agent has fetched."
4003   (when gnus-agent-total-fetched-hashtb
4004     (gnus-agent-with-refreshed-group
4005      group
4006      ;; if null, gnus-agent-group-pathname will calc method.
4007      (let* ((gnus-command-method method) 
4008             (path (or path (gnus-agent-group-pathname group)))
4009             (entry (or (gnus-gethash path gnus-agent-total-fetched-hashtb)
4010                        (gnus-sethash path (make-list 3 0) 
4011                                      gnus-agent-total-fetched-hashtb))))
4012        (when (listp delta)
4013          (if delta
4014              (let ((sum 0.0)
4015                    file)
4016                (while (setq file (pop delta))
4017                  (incf sum (float (or (nth 7 (file-attributes 
4018                                               (nnheader-concat 
4019                                                path 
4020                                                (if (numberp file)
4021                                                    (number-to-string file)
4022                                                  file)))) 0))))
4023                (setq delta sum))
4024            (let ((sum 0.0)
4025                  (info (directory-files-and-attributes path nil "^-?[0-9]+$" t))
4026                  file)
4027              (while (setq file (pop info))
4028                (incf sum (float (or (nth 8 file) 0))))
4029              (setq delta sum))))
4030
4031        (setq gnus-agent-need-update-total-fetched-for t)
4032        (incf (nth 2 entry) delta)))))
4033
4034 (defun gnus-agent-update-view-total-fetched-for 
4035   (group agent-over &optional method path)
4036   "Update, or set, the total disk space used by the .agentview and
4037 .overview files.  These files are calculated separately as they can be
4038 modified."
4039   (when gnus-agent-total-fetched-hashtb
4040     (gnus-agent-with-refreshed-group
4041      group
4042      ;; if null, gnus-agent-group-pathname will calc method.
4043      (let* ((gnus-command-method method) 
4044             (path (or path (gnus-agent-group-pathname group)))
4045             (entry (or (gnus-gethash path gnus-agent-total-fetched-hashtb)
4046                        (gnus-sethash path (make-list 3 0) 
4047                                      gnus-agent-total-fetched-hashtb)))
4048             (size (or (nth 7 (file-attributes 
4049                               (nnheader-concat
4050                                path (if agent-over 
4051                                         ".overview"
4052                                       ".agentview"))))
4053                       0)))
4054        (setq gnus-agent-need-update-total-fetched-for t)
4055        (setf (nth (if agent-over 1 0) entry) size)))))
4056
4057 (defun gnus-agent-total-fetched-for (group &optional method no-inhibit)
4058   "Get the total disk space used by the specified GROUP."
4059   (unless gnus-agent-total-fetched-hashtb
4060     (setq gnus-agent-total-fetched-hashtb (gnus-make-hashtable 1024)))
4061
4062   ;; if null, gnus-agent-group-pathname will calc method.
4063   (let* ((gnus-command-method method) 
4064          (path (gnus-agent-group-pathname group))
4065          (entry (gnus-gethash path gnus-agent-total-fetched-hashtb)))
4066     (if entry
4067         (apply '+ entry)
4068       (let ((gnus-agent-inhibit-update-total-fetched-for (not no-inhibit)))
4069         (+ 
4070          (gnus-agent-update-view-total-fetched-for  group nil method path)
4071          (gnus-agent-update-view-total-fetched-for  group t   method path)
4072          (gnus-agent-update-files-total-fetched-for group nil method path))))))
4073
4074 (provide 'gnus-agent)
4075
4076 ;;; arch-tag: b0ba4afc-5229-4cee-ad25-9956daa4e91e
4077 ;;; gnus-agent.el ends here