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