HCoop / bpt / emacs.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
nnmh.el (nnmh-request-list-1): Output active lines also for empty directories. This...
[bpt/emacs.git] / lisp / gnus / gnus-agent.el
CommitLineData
df80b09f 1;;; gnus-agent.el --- unplugged support for Gnus
e84b4b86 2
8abf1b22 3;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
114f9c96 4;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
df80b09f
LMI		 5
6;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7;; This file is part of GNU Emacs.
8
5e809f55 9;; GNU Emacs is free software: you can redistribute it and/or modify
df80b09f 10;; it under the terms of the GNU General Public License as published by
5e809f55
GM		 11;; the Free Software Foundation, either version 3 of the License, or
12;; (at your option) any later version.
df80b09f
LMI		 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
5e809f55 20;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
df80b09f
LMI		 21
22;;; Commentary:
23
24;;; Code:
25
26(require 'gnus)
27(require 'gnus-cache)
23f87bed 28(require 'nnmail)
df80b09f
LMI		 29(require 'nnvirtual)
30(require 'gnus-sum)
03f20b47 31(require 'gnus-score)
23f87bed
MB		 32(require 'gnus-srvr)
33(require 'gnus-util)
16409b0b 34(eval-when-compile
03f20b47
DL		 35 (if (featurep 'xemacs)
36 (require 'itimer)
37 (require 'timer))
38 (require 'cl))
df80b09f 39
8abf1b22
GM		 40(autoload 'gnus-server-update-server "gnus-srvr")
41(autoload 'gnus-agent-customize-category "gnus-cus")
23f87bed 42
df80b09f
LMI		 43(defcustom gnus-agent-directory (nnheader-concat gnus-directory "agent/")
44 "Where the Gnus agent will store its files."
45 :group 'gnus-agent
46 :type 'directory)
47
48(defcustom gnus-agent-plugged-hook nil
49 "Hook run when plugging into the network."
50 :group 'gnus-agent
51 :type 'hook)
52
53(defcustom gnus-agent-unplugged-hook nil
54 "Hook run when unplugging from the network."
55 :group 'gnus-agent
56 :type 'hook)
57
23f87bed
MB		 58(defcustom gnus-agent-fetched-hook nil
59 "Hook run when finished fetching articles."
bf247b6e 60 :version "22.1"
23f87bed
MB		 61 :group 'gnus-agent
62 :type 'hook)
63
df80b09f
LMI		 64(defcustom gnus-agent-handle-level gnus-level-subscribed
65 "Groups on levels higher than this variable will be ignored by the Agent."
66 :group 'gnus-agent
67 :type 'integer)
68
69(defcustom gnus-agent-expire-days 7
23f87bed
MB		 70 "Read articles older than this will be expired.
71If you wish to disable Agent expiring, see `gnus-agent-enable-expiration'."
df80b09f 72 :group 'gnus-agent
23f87bed 73 :type '(number :tag "days"))
df80b09f
LMI		 74
75(defcustom gnus-agent-expire-all nil
76 "If non-nil, also expire unread, ticked and dormant articles.
77If nil, only read articles will be expired."
78 :group 'gnus-agent
79 :type 'boolean)
80
81(defcustom gnus-agent-group-mode-hook nil
82 "Hook run in Agent group minor modes."
83 :group 'gnus-agent
84 :type 'hook)
85
23f87bed
MB		 86;; Extracted from gnus-xmas-redefine in order to preserve user settings
87(when (featurep 'xemacs)
88 (add-hook 'gnus-agent-group-mode-hook 'gnus-xmas-agent-group-menu-add))
89
df80b09f
LMI		 90(defcustom gnus-agent-summary-mode-hook nil
91 "Hook run in Agent summary minor modes."
92 :group 'gnus-agent
93 :type 'hook)
94
23f87bed
MB		 95;; Extracted from gnus-xmas-redefine in order to preserve user settings
96(when (featurep 'xemacs)
97 (add-hook 'gnus-agent-summary-mode-hook 'gnus-xmas-agent-summary-menu-add))
98
df80b09f
LMI		 99(defcustom gnus-agent-server-mode-hook nil
100 "Hook run in Agent summary minor modes."
101 :group 'gnus-agent
102 :type 'hook)
103
23f87bed
MB		 104;; Extracted from gnus-xmas-redefine in order to preserve user settings
105(when (featurep 'xemacs)
106 (add-hook 'gnus-agent-server-mode-hook 'gnus-xmas-agent-server-menu-add))
107
16409b0b
GM		 108(defcustom gnus-agent-confirmation-function 'y-or-n-p
109 "Function to confirm when error happens."
850846fd 110 :version "21.1"
16409b0b
GM		 111 :group 'gnus-agent
112 :type 'function)
df80b09f 113
01c52d31 114(defcustom gnus-agent-synchronize-flags nil
03f20b47
DL		 115 "Indicate if flags are synchronized when you plug in.
116If this is `ask' the hook will query the user."
5fae1cae
MB		 117 ;; If the default switches to something else than nil, then the function
118 ;; should be fixed not be exceedingly slow. See 2005-09-20 ChangeLog entry.
850846fd 119 :version "21.1"
03f20b47
DL		 120 :type '(choice (const :tag "Always" t)
121 (const :tag "Never" nil)
122 (const :tag "Ask" ask))
123 :group 'gnus-agent)
124
23f87bed
MB		 125(defcustom gnus-agent-go-online 'ask
126 "Indicate if offline servers go online when you plug in.
127If this is `ask' the hook will query the user."
a08b59c9 128 :version "21.3"
23f87bed
MB		 129 :type '(choice (const :tag "Always" t)
130 (const :tag "Never" nil)
131 (const :tag "Ask" ask))
132 :group 'gnus-agent)
133
134(defcustom gnus-agent-mark-unread-after-downloaded t
135 "Indicate whether to mark articles unread after downloaded."
136 :version "21.1"
137 :type 'boolean
138 :group 'gnus-agent)
139
140(defcustom gnus-agent-download-marks '(download)
141 "Marks for downloading."
142 :version "21.1"
143 :type '(repeat (symbol :tag "Mark"))
144 :group 'gnus-agent)
145
146(defcustom gnus-agent-consider-all-articles nil
147 "When non-nil, the agent will let the agent predicate decide
148whether articles need to be downloaded or not, for all articles. When
149nil, the default, the agent will only let the predicate decide
150whether unread articles are downloaded or not. If you enable this,
151groups with large active ranges may open slower and you may also want
152to look into the agent expiry settings to block the expiration of
153read articles as they would just be downloaded again."
bf247b6e 154 :version "22.1"
23f87bed
MB		 155 :type 'boolean
156 :group 'gnus-agent)
157
158(defcustom gnus-agent-max-fetch-size 10000000 ;; 10 Mb
159 "Chunk size for `gnus-agent-fetch-session'.
160The function will split its article fetches into chunks smaller than
161this limit."
bf247b6e 162 :version "22.1"
23f87bed
MB		 163 :group 'gnus-agent
164 :type 'integer)
165
166(defcustom gnus-agent-enable-expiration 'ENABLE
167 "The default expiration state for each group.
168When set to ENABLE, the default, `gnus-agent-expire' will expire old
169contents from a group's local storage. This value may be overridden
170to disable expiration in specific categories, topics, and groups. Of
171course, you could change gnus-agent-enable-expiration to DISABLE then
172enable expiration per categories, topics, and groups."
bf247b6e 173 :version "22.1"
23f87bed
MB		 174 :group 'gnus-agent
175 :type '(radio (const :format "Enable " ENABLE)
176 (const :format "Disable " DISABLE)))
177
178(defcustom gnus-agent-expire-unagentized-dirs t
179 "*Whether expiration should expire in unagentized directories.
180Have gnus-agent-expire scan the directories under
181\(gnus-agent-directory) for groups that are no longer agentized.
182When found, offer to remove them."
bf247b6e 183 :version "22.1"
23f87bed
MB		 184 :type 'boolean
185 :group 'gnus-agent)
186
10e91ca9 187(defcustom gnus-agent-auto-agentize-methods '(nntp)
23f87bed
MB		 188 "Initially, all servers from these methods are agentized.
189The user may remove or add servers using the Server buffer.
190See Info node `(gnus)Server Buffer'."
bf247b6e 191 :version "22.1"
23f87bed
MB		 192 :type '(repeat symbol)
193 :group 'gnus-agent)
194
195(defcustom gnus-agent-queue-mail t
196 "Whether and when outgoing mail should be queued by the agent.
197When `always', always queue outgoing mail. When nil, never
198queue. Otherwise, queue if and only if unplugged."
bf247b6e 199 :version "22.1"
23f87bed
MB		 200 :group 'gnus-agent
201 :type '(radio (const :format "Always" always)
202 (const :format "Never" nil)
f5e92214 203 (const :format "When unplugged" t)))
23f87bed
MB		 204
205(defcustom gnus-agent-prompt-send-queue nil
206 "If non-nil, `gnus-group-send-queue' will prompt if called when
207unplugged."
bf247b6e 208 :version "22.1"
23f87bed
MB		 209 :group 'gnus-agent
210 :type 'boolean)
211
58090a8d 212(defcustom gnus-agent-article-alist-save-format 1
3031d8b0
MB		 213 "Indicates whether to use compression(2), versus no
214compression(1), when writing agentview files. The compressed
215files do save space but load times are 6-7 times higher. A group
216must be opened then closed for the agentview to be updated using
217the new format."
218 ;; Wouldn't symbols instead numbers be nicer? --rsteib
58090a8d
MB		 219 :version "22.1"
220 :group 'gnus-agent
221 :type '(radio (const :format "Compressed" 2)
222 (const :format "Uncompressed" 1)))
223
16409b0b 224;;; Internal variables
df80b09f
LMI		 225
226(defvar gnus-agent-history-buffers nil)
227(defvar gnus-agent-buffer-alist nil)
23f87bed 228(defvar gnus-agent-article-alist nil
bf247b6e 229 "An assoc list identifying the articles whose headers have been fetched.
23f87bed
MB		 230If successfully fetched, these headers will be stored in the group's overview
231file. The key of each assoc pair is the article ID, the value of each assoc
232pair is a flag indicating whether the identified article has been downloaded
233\(gnus-agent-fetch-articles sets the value to the day of the download).
234NOTES:
bf247b6e 2351) The last element of this list can not be expired as some
23f87bed
MB		 236 routines (for example, get-agent-fetch-headers) use the last
237 value to track which articles have had their headers retrieved.
2382) The function `gnus-agent-regenerate' may destructively modify the value.")
df80b09f 239(defvar gnus-agent-group-alist nil)
df80b09f
LMI		 240(defvar gnus-category-alist nil)
241(defvar gnus-agent-current-history nil)
242(defvar gnus-agent-overview-buffer nil)
243(defvar gnus-category-predicate-cache nil)
244(defvar gnus-category-group-cache nil)
245(defvar gnus-agent-spam-hashtb nil)
246(defvar gnus-agent-file-name nil)
247(defvar gnus-agent-send-mail-function nil)
16409b0b 248(defvar gnus-agent-file-coding-system 'raw-text)
23f87bed 249(defvar gnus-agent-file-loading-cache nil)
01c52d31
MB		 250(defvar gnus-agent-total-fetched-hashtb nil)
251(defvar gnus-agent-inhibit-update-total-fetched-for nil)
252(defvar gnus-agent-need-update-total-fetched-for nil)
16409b0b 253
df80b09f
LMI		 254;; Dynamic variables
255(defvar gnus-headers)
256(defvar gnus-score)
257
01c52d31
MB		 258;; Added to support XEmacs
259(eval-and-compile
260 (unless (fboundp 'directory-files-and-attributes)
261 (defun directory-files-and-attributes (directory
262 &optional full match nosort)
263 (let (result)
264 (dolist (file (directory-files directory full match nosort))
265 (push (cons file (file-attributes file)) result))
266 (nreverse result)))))
267
df80b09f
LMI		 268;;;
269;;; Setup
270;;;
271
272(defun gnus-open-agent ()
273 (setq gnus-agent t)
274 (gnus-agent-read-servers)
275 (gnus-category-read)
16409b0b 276 (gnus-agent-create-buffer)
df80b09f
LMI		 277 (add-hook 'gnus-group-mode-hook 'gnus-agent-mode)
278 (add-hook 'gnus-summary-mode-hook 'gnus-agent-mode)
279 (add-hook 'gnus-server-mode-hook 'gnus-agent-mode))
280
16409b0b
GM		 281(defun gnus-agent-create-buffer ()
282 (if (gnus-buffer-live-p gnus-agent-overview-buffer)
283 t
284 (setq gnus-agent-overview-buffer
285 (gnus-get-buffer-create " *Gnus agent overview*"))
286 (with-current-buffer gnus-agent-overview-buffer
287 (mm-enable-multibyte))
288 nil))
289
df80b09f
LMI		 290(gnus-add-shutdown 'gnus-close-agent 'gnus)
291
292(defun gnus-close-agent ()
23f87bed 293 (setq gnus-category-predicate-cache nil
df80b09f
LMI		 294 gnus-category-group-cache nil
295 gnus-agent-spam-hashtb nil)
296 (gnus-kill-buffer gnus-agent-overview-buffer))
297
298;;;
299;;; Utility functions
300;;;
301
01c52d31
MB		 302(defmacro gnus-agent-with-refreshed-group (group &rest body)
303 "Performs the body then updates the group's line in the group
304buffer. Automatically blocks multiple updates due to recursion."
305`(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body)
306 (when (and gnus-agent-need-update-total-fetched-for
307 (not gnus-agent-inhibit-update-total-fetched-for))
308 (save-excursion
309 (set-buffer gnus-group-buffer)
310 (setq gnus-agent-need-update-total-fetched-for nil)
311 (gnus-group-update-group ,group t)))))
312
df80b09f
LMI		 313(defun gnus-agent-read-file (file)
314 "Load FILE and do a `read' there."
16409b0b 315 (with-temp-buffer
df80b09f
LMI		 316 (ignore-errors
317 (nnheader-insert-file-contents file)
318 (goto-char (point-min))
319 (read (current-buffer)))))
320
321(defsubst gnus-agent-method ()
322 (concat (symbol-name (car gnus-command-method)) "/"
323 (if (equal (cadr gnus-command-method) "")
324 "unnamed"
325 (cadr gnus-command-method))))
326
327(defsubst gnus-agent-directory ()
35ef97a5 328 "The name of the Gnus agent directory."
df80b09f
LMI		 329 (nnheader-concat gnus-agent-directory
330 (nnheader-translate-file-chars (gnus-agent-method)) "/"))
331
332(defun gnus-agent-lib-file (file)
35ef97a5 333 "The full name of the Gnus agent library FILE."
850846fd
DL		 334 (expand-file-name file
335 (file-name-as-directory
336 (expand-file-name "agent.lib" (gnus-agent-directory)))))
df80b09f 337
23f87bed
MB		 338(defun gnus-agent-cat-set-property (category property value)
339 (if value
340 (setcdr (or (assq property category)
341 (let ((cell (cons property nil)))
342 (setcdr category (cons cell (cdr category)))
343 cell)) value)
344 (let ((category category))
345 (while (cond ((eq property (caadr category))
346 (setcdr category (cddr category))
347 nil)
348 (t
349 (setq category (cdr category)))))))
350 category)
351
352(eval-when-compile
353 (defmacro gnus-agent-cat-defaccessor (name prop-name)
354 "Define accessor and setter methods for manipulating a list of the form
355\(NAME (PROPERTY1 VALUE1) ... (PROPERTY_N VALUE_N)).
356Given the call (gnus-agent-cat-defaccessor func PROPERTY1), the list may be
357manipulated as follows:
358 (func LIST): Returns VALUE1
359 (setf (func LIST) NEW_VALUE1): Replaces VALUE1 with NEW_VALUE1."
360 `(progn (defmacro ,name (category)
361 (list (quote cdr) (list (quote assq)
362 (quote (quote ,prop-name)) category)))
363
364 (define-setf-method ,name (category)
365 (let* ((--category--temp-- (make-symbol "--category--"))
366 (--value--temp-- (make-symbol "--value--")))
367 (list (list --category--temp--) ; temporary-variables
01c52d31
MB		 368 (list category) ; value-forms
369 (list --value--temp--) ; store-variables
23f87bed
MB		 370 (let* ((category --category--temp--) ; store-form
371 (value --value--temp--))
372 (list (quote gnus-agent-cat-set-property)
373 category
374 (quote (quote ,prop-name))
375 value))
376 (list (quote ,name) --category--temp--) ; access-form
377 )))))
378 )
379
380(defmacro gnus-agent-cat-name (category)
381 `(car ,category))
382
383(gnus-agent-cat-defaccessor
384 gnus-agent-cat-days-until-old agent-days-until-old)
385(gnus-agent-cat-defaccessor
386 gnus-agent-cat-enable-expiration agent-enable-expiration)
387(gnus-agent-cat-defaccessor
388 gnus-agent-cat-groups agent-groups)
389(gnus-agent-cat-defaccessor
390 gnus-agent-cat-high-score agent-high-score)
391(gnus-agent-cat-defaccessor
58090a8d 392 gnus-agent-cat-length-when-long agent-long-article)
23f87bed 393(gnus-agent-cat-defaccessor
58090a8d 394 gnus-agent-cat-length-when-short agent-short-article)
23f87bed
MB		 395(gnus-agent-cat-defaccessor
396 gnus-agent-cat-low-score agent-low-score)
397(gnus-agent-cat-defaccessor
398 gnus-agent-cat-predicate agent-predicate)
399(gnus-agent-cat-defaccessor
58090a8d 400 gnus-agent-cat-score-file agent-score)
23f87bed 401(gnus-agent-cat-defaccessor
58090a8d 402 gnus-agent-cat-enable-undownloaded-faces agent-enable-undownloaded-faces)
23f87bed 403
54506618
MB		 404
405;; This form is equivalent to defsetf except that it calls make-symbol
406;; whereas defsetf calls gensym (Using gensym creates a run-time
407;; dependency on the CL library).
408
23f87bed 409(eval-and-compile
54506618
MB		 410 (define-setf-method gnus-agent-cat-groups (category)
411 (let* ((--category--temp-- (make-symbol "--category--"))
412 (--groups--temp-- (make-symbol "--groups--")))
413 (list (list --category--temp--)
414 (list category)
415 (list --groups--temp--)
416 (let* ((category --category--temp--)
417 (groups --groups--temp--))
418 (list (quote gnus-agent-set-cat-groups) category groups))
419 (list (quote gnus-agent-cat-groups) --category--temp--))))
420 )
23f87bed
MB		 421
422(defun gnus-agent-set-cat-groups (category groups)
423 (unless (eq groups 'ignore)
424 (let ((new-g groups)
425 (old-g (gnus-agent-cat-groups category)))
426 (cond ((eq new-g old-g)
427 ;; gnus-agent-add-group is fiddling with the group
428 ;; list. Still, Im done.
429 nil
430 )
431 ((eq new-g (cdr old-g))
432 ;; gnus-agent-add-group is fiddling with the group list
433 (setcdr (or (assq 'agent-groups category)
434 (let ((cell (cons 'agent-groups nil)))
435 (setcdr category (cons cell (cdr category)))
436 cell)) new-g))
437 (t
438 (let ((groups groups))
439 (while groups
440 (let* ((group (pop groups))
441 (old-category (gnus-group-category group)))
442 (if (eq category old-category)
443 nil
444 (setf (gnus-agent-cat-groups old-category)
445 (delete group (gnus-agent-cat-groups
446 old-category))))))
447 ;; Purge cache as preceeding loop invalidated it.
448 (setq gnus-category-group-cache nil))
449
450 (setcdr (or (assq 'agent-groups category)
451 (let ((cell (cons 'agent-groups nil)))
452 (setcdr category (cons cell (cdr category)))
453 cell)) groups))))))
454
455(defsubst gnus-agent-cat-make (name &optional default-agent-predicate)
456 (list name `(agent-predicate . ,(or default-agent-predicate 'false))))
457
01c52d31
MB		 458(defun gnus-agent-read-group ()
459 "Read a group name in the minibuffer, with completion."
460 (let ((def (or (gnus-group-group-name) gnus-newsgroup-name)))
461 (when def
462 (setq def (gnus-group-decoded-name def)))
463 (gnus-group-completing-read (if def
464 (concat "Group Name (" def "): ")
465 "Group Name: ")
466 nil nil t nil nil def)))
467
df80b09f
LMI		 468;;; Fetching setup functions.
469
470(defun gnus-agent-start-fetch ()
471 "Initialize data structures for efficient fetching."
16409b0b 472 (gnus-agent-create-buffer))
df80b09f
LMI		 473
474(defun gnus-agent-stop-fetch ()
475 "Save all data structures and clean up."
df80b09f
LMI		 476 (setq gnus-agent-spam-hashtb nil)
477 (save-excursion
478 (set-buffer nntp-server-buffer)
479 (widen)))
480
481(defmacro gnus-agent-with-fetch (&rest forms)
482 "Do FORMS safely."
483 `(unwind-protect
03f20b47 484 (let ((gnus-agent-fetching t))
df80b09f
LMI		 485 (gnus-agent-start-fetch)
486 ,@forms)
487 (gnus-agent-stop-fetch)))
488
489(put 'gnus-agent-with-fetch 'lisp-indent-function 0)
490(put 'gnus-agent-with-fetch 'edebug-form-spec '(body))
491
23f87bed
MB		 492(defmacro gnus-agent-append-to-list (tail value)
493 `(setq ,tail (setcdr ,tail (cons ,value nil))))
494
495(defmacro gnus-agent-message (level &rest args)
496 `(if (<= ,level gnus-verbose)
497 (message ,@args)))
498
df80b09f
LMI		 499;;;
500;;; Mode infestation
501;;;
502
503(defvar gnus-agent-mode-hook nil
504 "Hook run when installing agent mode.")
505
506(defvar gnus-agent-mode nil)
507(defvar gnus-agent-mode-status '(gnus-agent-mode " Plugged"))
508
509(defun gnus-agent-mode ()
510 "Minor mode for providing a agent support in Gnus buffers."
511 (let* ((buffer (progn (string-match "^gnus-\\(.*\\)-mode$"
512 (symbol-name major-mode))
513 (match-string 1 (symbol-name major-mode))))
514 (mode (intern (format "gnus-agent-%s-mode" buffer))))
515 (set (make-local-variable 'gnus-agent-mode) t)
516 (set mode nil)
517 (set (make-local-variable mode) t)
518 ;; Set up the menu.
519 (when (gnus-visual-p 'agent-menu 'menu)
520 (funcall (intern (format "gnus-agent-%s-make-menu-bar" buffer))))
521 (unless (assq 'gnus-agent-mode minor-mode-alist)
522 (push gnus-agent-mode-status minor-mode-alist))
523 (unless (assq mode minor-mode-map-alist)
524 (push (cons mode (symbol-value (intern (format "gnus-agent-%s-mode-map"
525 buffer))))
526 minor-mode-map-alist))
527 (when (eq major-mode 'gnus-group-mode)
23f87bed
MB		 528 (let ((init-plugged gnus-plugged)
529 (gnus-agent-go-online nil))
530 ;; g-a-t-p does nothing when gnus-plugged isn't changed.
531 ;; Therefore, make certain that the current value does not
532 ;; match the desired initial value.
533 (setq gnus-plugged :unknown)
534 (gnus-agent-toggle-plugged init-plugged)))
df80b09f
LMI		 535 (gnus-run-hooks 'gnus-agent-mode-hook
536 (intern (format "gnus-agent-%s-mode-hook" buffer)))))
537
538(defvar gnus-agent-group-mode-map (make-sparse-keymap))
539(gnus-define-keys gnus-agent-group-mode-map
540 "Ju" gnus-agent-fetch-groups
541 "Jc" gnus-enter-category-buffer
542 "Jj" gnus-agent-toggle-plugged
543 "Js" gnus-agent-fetch-session
03f20b47 544 "JY" gnus-agent-synchronize-flags
23f87bed 545 "JS" gnus-group-send-queue
16409b0b 546 "Ja" gnus-agent-add-group
23f87bed
MB		 547 "Jr" gnus-agent-remove-group
548 "Jo" gnus-agent-toggle-group-plugged)
df80b09f
LMI		 549
550(defun gnus-agent-group-make-menu-bar ()
551 (unless (boundp 'gnus-agent-group-menu)
552 (easy-menu-define
553 gnus-agent-group-menu gnus-agent-group-mode-map ""
554 '("Agent"
555 ["Toggle plugged" gnus-agent-toggle-plugged t]
23f87bed 556 ["Toggle group plugged" gnus-agent-toggle-group-plugged t]
df80b09f 557 ["List categories" gnus-enter-category-buffer t]
23f87bed
MB		 558 ["Add (current) group to category" gnus-agent-add-group t]
559 ["Remove (current) group from category" gnus-agent-remove-group t]
560 ["Send queue" gnus-group-send-queue gnus-plugged]
df80b09f
LMI		 561 ("Fetch"
562 ["All" gnus-agent-fetch-session gnus-plugged]
23f87bed
MB		 563 ["Group" gnus-agent-fetch-group gnus-plugged])
564 ["Synchronize flags" gnus-agent-synchronize-flags t]
565 ))))
df80b09f
LMI		 566
567(defvar gnus-agent-summary-mode-map (make-sparse-keymap))
568(gnus-define-keys gnus-agent-summary-mode-map
569 "Jj" gnus-agent-toggle-plugged
23f87bed
MB		 570 "Ju" gnus-agent-summary-fetch-group
571 "JS" gnus-agent-fetch-group
572 "Js" gnus-agent-summary-fetch-series
df80b09f
LMI		 573 "J#" gnus-agent-mark-article
574 "J\M-#" gnus-agent-unmark-article
575 "@" gnus-agent-toggle-mark
576 "Jc" gnus-agent-catchup)
577
578(defun gnus-agent-summary-make-menu-bar ()
579 (unless (boundp 'gnus-agent-summary-menu)
580 (easy-menu-define
581 gnus-agent-summary-menu gnus-agent-summary-mode-map ""
582 '("Agent"
583 ["Toggle plugged" gnus-agent-toggle-plugged t]
584 ["Mark as downloadable" gnus-agent-mark-article t]
585 ["Unmark as downloadable" gnus-agent-unmark-article t]
586 ["Toggle mark" gnus-agent-toggle-mark t]
23f87bed 587 ["Fetch downloadable" gnus-agent-summary-fetch-group t]
df80b09f
LMI		 588 ["Catchup undownloaded" gnus-agent-catchup t]))))
589
590(defvar gnus-agent-server-mode-map (make-sparse-keymap))
591(gnus-define-keys gnus-agent-server-mode-map
592 "Jj" gnus-agent-toggle-plugged
593 "Ja" gnus-agent-add-server
594 "Jr" gnus-agent-remove-server)
595
596(defun gnus-agent-server-make-menu-bar ()
597 (unless (boundp 'gnus-agent-server-menu)
598 (easy-menu-define
599 gnus-agent-server-menu gnus-agent-server-mode-map ""
600 '("Agent"
601 ["Toggle plugged" gnus-agent-toggle-plugged t]
602 ["Add" gnus-agent-add-server t]
603 ["Remove" gnus-agent-remove-server t]))))
604
23f87bed
MB		 605(defun gnus-agent-make-mode-line-string (string mouse-button mouse-func)
606 (if (and (fboundp 'propertize)
607 (fboundp 'make-mode-line-mouse-map))
608 (propertize string 'local-map
27a0c0bc 609 (make-mode-line-mouse-map mouse-button mouse-func)
b90a6149
MB		 610 'mouse-face
611 (cond ((and (featurep 'xemacs)
612 ;; XEmacs' `facep' only checks for a face
613 ;; object, not for a face name, so it's useless
614 ;; to check with `facep'.
615 (find-face 'modeline))
616 'modeline)
617 ((facep 'mode-line-highlight) ;; Emacs 22
618 'mode-line-highlight)
619 ((facep 'mode-line) ;; Emacs 21
620 'mode-line)) )
23f87bed
MB		 621 string))
622
623(defun gnus-agent-toggle-plugged (set-to)
df80b09f
LMI		 624 "Toggle whether Gnus is unplugged or not."
625 (interactive (list (not gnus-plugged)))
23f87bed
MB		 626 (cond ((eq set-to gnus-plugged)
627 nil)
628 (set-to
629 (setq gnus-plugged set-to)
630 (gnus-run-hooks 'gnus-agent-plugged-hook)
631 (setcar (cdr gnus-agent-mode-status)
632 (gnus-agent-make-mode-line-string " Plugged"
633 'mouse-2
634 'gnus-agent-toggle-plugged))
b890d447 635 (gnus-agent-go-online gnus-agent-go-online))
23f87bed
MB		 636 (t
637 (gnus-agent-close-connections)
638 (setq gnus-plugged set-to)
639 (gnus-run-hooks 'gnus-agent-unplugged-hook)
640 (setcar (cdr gnus-agent-mode-status)
641 (gnus-agent-make-mode-line-string " Unplugged"
642 'mouse-2
643 'gnus-agent-toggle-plugged))))
df80b09f
LMI		 644 (set-buffer-modified-p t))
645
23f87bed
MB		 646(defmacro gnus-agent-while-plugged (&rest body)
647 `(let ((original-gnus-plugged gnus-plugged))
648 (unwind-protect
649 (progn (gnus-agent-toggle-plugged t)
650 ,@body)
651 (gnus-agent-toggle-plugged original-gnus-plugged))))
652
653(put 'gnus-agent-while-plugged 'lisp-indent-function 0)
654(put 'gnus-agent-while-plugged 'edebug-form-spec '(body))
655
df80b09f
LMI		 656(defun gnus-agent-close-connections ()
657 "Close all methods covered by the Gnus agent."
23f87bed 658 (let ((methods (gnus-agent-covered-methods)))
df80b09f
LMI		 659 (while methods
660 (gnus-close-server (pop methods)))))
661
662;;;###autoload
663(defun gnus-unplugged ()
664 "Start Gnus unplugged."
665 (interactive)
666 (setq gnus-plugged nil)
667 (gnus))
668
669;;;###autoload
670(defun gnus-plugged ()
671 "Start Gnus plugged."
672 (interactive)
673 (setq gnus-plugged t)
674 (gnus))
675
23f87bed
MB		 676;;;###autoload
677(defun gnus-slave-unplugged (&optional arg)
678 "Read news as a slave unplugged."
679 (interactive "P")
680 (setq gnus-plugged nil)
681 (gnus arg nil 'slave))
682
df80b09f
LMI		 683;;;###autoload
684(defun gnus-agentize ()
685 "Allow Gnus to be an offline newsreader.
df80b09f 686
23f87bed
MB		 687The gnus-agentize function is now called internally by gnus when
688gnus-agent is set. If you wish to avoid calling gnus-agentize,
689customize gnus-agent to nil.
df80b09f 690
23f87bed
MB		 691This will modify the `gnus-setup-news-hook', and
692`message-send-mail-real-function' variables, and install the Gnus agent
693minor mode in all Gnus buffers."
df80b09f
LMI		 694 (interactive)
695 (gnus-open-agent)
696 (add-hook 'gnus-setup-news-hook 'gnus-agent-queue-setup)
697 (unless gnus-agent-send-mail-function
23f87bed
MB		 698 (setq gnus-agent-send-mail-function
699 (or message-send-mail-real-function
54506618 700 (function (lambda () (funcall message-send-mail-function))))
23f87bed
MB		 701 message-send-mail-real-function 'gnus-agent-send-mail))
702
703 ;; If the servers file doesn't exist, auto-agentize some servers and
704 ;; save the servers file so this auto-agentizing isn't invoked
705 ;; again.
706 (unless (file-exists-p (nnheader-concat gnus-agent-directory "lib/servers"))
707 (gnus-message 3 "First time agent user, agentizing remote groups...")
708 (mapc
709 (lambda (server-or-method)
710 (let ((method (gnus-server-to-method server-or-method)))
711 (when (memq (car method)
712 gnus-agent-auto-agentize-methods)
713 (push (gnus-method-to-server method)
714 gnus-agent-covered-methods)
715 (setq gnus-agent-method-p-cache nil))))
716 (cons gnus-select-method gnus-secondary-select-methods))
717 (gnus-agent-write-servers)))
718
719(defun gnus-agent-queue-setup (&optional group-name)
720 "Make sure the queue group exists.
721Optional arg GROUP-NAME allows to specify another group."
722 (unless (gnus-gethash (format "nndraft:%s" (or group-name "queue"))
723 gnus-newsrc-hashtb)
724 (gnus-request-create-group (or group-name "queue") '(nndraft ""))
df80b09f 725 (let ((gnus-level-default-subscribed 1))
23f87bed
MB		 726 (gnus-subscribe-group (format "nndraft:%s" (or group-name "queue"))
727 nil '(nndraft "")))
df80b09f 728 (gnus-group-set-parameter
23f87bed
MB		 729 (format "nndraft:%s" (or group-name "queue"))
730 'gnus-dummy '((gnus-draft-mode)))))
df80b09f
LMI		 731
732(defun gnus-agent-send-mail ()
23f87bed
MB		 733 (if (or (not gnus-agent-queue-mail)
734 (and gnus-plugged (not (eq gnus-agent-queue-mail 'always))))
df80b09f
LMI		 735 (funcall gnus-agent-send-mail-function)
736 (goto-char (point-min))
737 (re-search-forward
738 (concat "^" (regexp-quote mail-header-separator) "\n"))
739 (replace-match "\n")
740 (gnus-agent-insert-meta-information 'mail)
16409b0b 741 (gnus-request-accept-article "nndraft:queue" nil t t)))
df80b09f
LMI		 742
743(defun gnus-agent-insert-meta-information (type &optional method)
744 "Insert meta-information into the message that says how it's to be posted.
23f87bed 745TYPE can be either `mail' or `news'. If the latter, then METHOD can
df80b09f
LMI		 746be a select method."
747 (save-excursion
748 (message-remove-header gnus-agent-meta-information-header)
749 (goto-char (point-min))
750 (insert gnus-agent-meta-information-header ": "
751 (symbol-name type) " " (format "%S" method)
752 "\n")
753 (forward-char -1)
754 (while (search-backward "\n" nil t)
755 (replace-match "\\n" t t))))
756
03f20b47
DL		 757(defun gnus-agent-restore-gcc ()
758 "Restore GCC field from saved header."
759 (save-excursion
760 (goto-char (point-min))
23f87bed
MB		 761 (while (re-search-forward
762 (concat "^" (regexp-quote gnus-agent-gcc-header) ":") nil t)
03f20b47
DL		 763 (replace-match "Gcc:" 'fixedcase))))
764
765(defun gnus-agent-any-covered-gcc ()
766 (save-restriction
767 (message-narrow-to-headers)
768 (let* ((gcc (mail-fetch-field "gcc" nil t))
a1506d29 769 (methods (and gcc
03f20b47
DL		 770 (mapcar 'gnus-inews-group-method
771 (message-unquote-tokens
a1506d29 772 (message-tokenize-header
03f20b47
DL		 773 gcc " ,")))))
774 covered)
775 (while (and (not covered) methods)
23f87bed 776 (setq covered (gnus-agent-method-p (car methods))
03f20b47
DL		 777 methods (cdr methods)))
778 covered)))
779
23f87bed 780;;;###autoload
03f20b47
DL		 781(defun gnus-agent-possibly-save-gcc ()
782 "Save GCC if Gnus is unplugged."
783 (when (and (not gnus-plugged) (gnus-agent-any-covered-gcc))
784 (save-excursion
785 (goto-char (point-min))
786 (let ((case-fold-search t))
787 (while (re-search-forward "^gcc:" nil t)
788 (replace-match (concat gnus-agent-gcc-header ":") 'fixedcase))))))
789
790(defun gnus-agent-possibly-do-gcc ()
791 "Do GCC if Gnus is plugged."
792 (when (or gnus-plugged (not (gnus-agent-any-covered-gcc)))
793 (gnus-inews-do-gcc)))
794
df80b09f
LMI		 795;;;
796;;; Group mode commands
797;;;
798
799(defun gnus-agent-fetch-groups (n)
800 "Put all new articles in the current groups into the Agent."
801 (interactive "P")
16409b0b
GM		 802 (unless gnus-plugged
803 (error "Groups can't be fetched when Gnus is unplugged"))
df80b09f
LMI		 804 (gnus-group-iterate n 'gnus-agent-fetch-group))
805
23f87bed 806(defun gnus-agent-fetch-group (&optional group)
df80b09f
LMI		 807 "Put all new articles in GROUP into the Agent."
808 (interactive (list (gnus-group-group-name)))
23f87bed 809 (setq group (or group gnus-newsgroup-name))
df80b09f
LMI		 810 (unless group
811 (error "No group on the current line"))
23f87bed
MB		 812
813 (gnus-agent-while-plugged
814 (let ((gnus-command-method (gnus-find-method-for-group group)))
815 (gnus-agent-with-fetch
816 (gnus-agent-fetch-group-1 group gnus-command-method)
817 (gnus-message 5 "Fetching %s...done" group)))))
df80b09f
LMI		 818
819(defun gnus-agent-add-group (category arg)
820 "Add the current group to an agent category."
821 (interactive
822 (list
823 (intern
824 (completing-read
825 "Add to category: "
826 (mapcar (lambda (cat) (list (symbol-name (car cat))))
827 gnus-category-alist)
828 nil t))
829 current-prefix-arg))
830 (let ((cat (assq category gnus-category-alist))
831 c groups)
832 (gnus-group-iterate arg
833 (lambda (group)
23f87bed
MB		 834 (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
835 (setf (gnus-agent-cat-groups c)
836 (delete group (gnus-agent-cat-groups c))))
df80b09f 837 (push group groups)))
23f87bed
MB		 838 (setf (gnus-agent-cat-groups cat)
839 (nconc (gnus-agent-cat-groups cat) groups))
df80b09f
LMI		 840 (gnus-category-write)))
841
16409b0b
GM		 842(defun gnus-agent-remove-group (arg)
843 "Remove the current group from its agent category, if any."
844 (interactive "P")
845 (let (c)
846 (gnus-group-iterate arg
847 (lambda (group)
23f87bed
MB		 848 (when (gnus-agent-cat-groups (setq c (gnus-group-category group)))
849 (setf (gnus-agent-cat-groups c)
850 (delete group (gnus-agent-cat-groups c))))))
16409b0b
GM		 851 (gnus-category-write)))
852
03f20b47
DL		 853(defun gnus-agent-synchronize-flags ()
854 "Synchronize unplugged flags with servers."
855 (interactive)
856 (save-excursion
23f87bed 857 (dolist (gnus-command-method (gnus-agent-covered-methods))
03f20b47
DL		 858 (when (file-exists-p (gnus-agent-lib-file "flags"))
859 (gnus-agent-synchronize-flags-server gnus-command-method)))))
860
861(defun gnus-agent-possibly-synchronize-flags ()
862 "Synchronize flags according to `gnus-agent-synchronize-flags'."
16409b0b
GM		 863 (interactive)
864 (save-excursion
23f87bed 865 (dolist (gnus-command-method (gnus-agent-covered-methods))
b890d447 866 (when (eq (gnus-server-status gnus-command-method) 'ok)
03f20b47
DL		 867 (gnus-agent-possibly-synchronize-flags-server gnus-command-method)))))
868
869(defun gnus-agent-synchronize-flags-server (method)
870 "Synchronize flags set when unplugged for server."
54506618
MB		 871 (let ((gnus-command-method method)
872 (gnus-agent nil))
03f20b47
DL		 873 (when (file-exists-p (gnus-agent-lib-file "flags"))
874 (set-buffer (get-buffer-create " *Gnus Agent flag synchronize*"))
875 (erase-buffer)
876 (nnheader-insert-file-contents (gnus-agent-lib-file "flags"))
54506618 877 (cond ((null gnus-plugged)
bf247b6e
KS		 878 (gnus-message
879 1 "You must be plugged to synchronize flags with server %s"
54506618
MB		 880 (nth 1 gnus-command-method)))
881 ((null (gnus-check-server gnus-command-method))
bf247b6e 882 (gnus-message
54506618
MB		 883 1 "Couldn't open server %s" (nth 1 gnus-command-method)))
884 (t
885 (condition-case err
886 (while t
887 (let ((bgn (point)))
888 (eval (read (current-buffer)))
889 (delete-region bgn (point))))
890 (end-of-file
891 (delete-file (gnus-agent-lib-file "flags")))
892 (error
893 (let ((file (gnus-agent-lib-file "flags")))
894 (write-region (point-min) (point-max)
895 (gnus-agent-lib-file "flags") nil 'silent)
896 (error "Couldn't set flags from file %s due to %s"
897 file (error-message-string err)))))))
03f20b47
DL		 898 (kill-buffer nil))))
899
900(defun gnus-agent-possibly-synchronize-flags-server (method)
901 "Synchronize flags for server according to `gnus-agent-synchronize-flags'."
b890d447
MB		 902 (when (and (file-exists-p (gnus-agent-lib-file "flags"))
903 (or (and gnus-agent-synchronize-flags
904 (not (eq gnus-agent-synchronize-flags 'ask)))
905 (and (eq gnus-agent-synchronize-flags 'ask)
906 (gnus-y-or-n-p
907 (format "Synchronize flags on server `%s'? "
908 (cadr method))))))
03f20b47 909 (gnus-agent-synchronize-flags-server method)))
16409b0b 910
54506618
MB		 911;;;###autoload
912(defun gnus-agent-rename-group (old-group new-group)
58090a8d
MB		 913 "Rename fully-qualified OLD-GROUP as NEW-GROUP.
914Always updates the agent, even when disabled, as the old agent
915files would corrupt gnus when the agent was next enabled.
916Depends upon the caller to determine whether group renaming is
917supported."
54506618
MB		 918 (let* ((old-command-method (gnus-find-method-for-group old-group))
919 (old-path (directory-file-name
920 (let (gnus-command-method old-command-method)
921 (gnus-agent-group-pathname old-group))))
922 (new-command-method (gnus-find-method-for-group new-group))
923 (new-path (directory-file-name
924 (let (gnus-command-method new-command-method)
01c52d31
MB		 925 (gnus-agent-group-pathname new-group))))
926 (file-name-coding-system nnmail-pathname-coding-system))
54506618
MB		 927 (gnus-rename-file old-path new-path t)
928
929 (let* ((old-real-group (gnus-group-real-name old-group))
930 (new-real-group (gnus-group-real-name new-group))
931 (old-active (gnus-agent-get-group-info old-command-method old-real-group)))
932 (gnus-agent-save-group-info old-command-method old-real-group nil)
933 (gnus-agent-save-group-info new-command-method new-real-group old-active)
934
bf247b6e 935 (let ((old-local (gnus-agent-get-local old-group
54506618
MB		 936 old-real-group old-command-method)))
937 (gnus-agent-set-local old-group
938 nil nil
939 old-real-group old-command-method)
940 (gnus-agent-set-local new-group
941 (car old-local) (cdr old-local)
942 new-real-group new-command-method)))))
943
944;;;###autoload
945(defun gnus-agent-delete-group (group)
58090a8d
MB		 946 "Delete fully-qualified GROUP.
947Always updates the agent, even when disabled, as the old agent
948files would corrupt gnus when the agent was next enabled.
949Depends upon the caller to determine whether group deletion is
950supported."
54506618
MB		 951 (let* ((command-method (gnus-find-method-for-group group))
952 (path (directory-file-name
953 (let (gnus-command-method command-method)
01c52d31
MB		 954 (gnus-agent-group-pathname group))))
955 (file-name-coding-system nnmail-pathname-coding-system))
aa0a8561 956 (gnus-delete-directory path)
54506618
MB		 957
958 (let* ((real-group (gnus-group-real-name group)))
959 (gnus-agent-save-group-info command-method real-group nil)
960
bf247b6e 961 (let ((local (gnus-agent-get-local group
54506618
MB		 962 real-group command-method)))
963 (gnus-agent-set-local group
964 nil nil
965 real-group command-method)))))
966
df80b09f
LMI		 967;;;
968;;; Server mode commands
969;;;
970
23f87bed 971(defun gnus-agent-add-server ()
df80b09f 972 "Enroll SERVER in the agent program."
23f87bed
MB		 973 (interactive)
974 (let* ((server (gnus-server-server-name))
975 (named-server (gnus-server-named-server))
976 (method (and server
977 (gnus-server-get-method nil server))))
978 (unless server
979 (error "No server on the current line"))
980
981 (when (gnus-agent-method-p method)
df80b09f 982 (error "Server already in the agent program"))
23f87bed
MB		 983
984 (push named-server gnus-agent-covered-methods)
985
986 (setq gnus-agent-method-p-cache nil)
987 (gnus-server-update-server server)
df80b09f 988 (gnus-agent-write-servers)
23f87bed 989 (gnus-message 1 "Entered %s into the Agent" server)))
df80b09f 990
23f87bed 991(defun gnus-agent-remove-server ()
df80b09f 992 "Remove SERVER from the agent program."
23f87bed
MB		 993 (interactive)
994 (let* ((server (gnus-server-server-name))
995 (named-server (gnus-server-named-server)))
996 (unless server
997 (error "No server on the current line"))
998
999 (unless (member named-server gnus-agent-covered-methods)
df80b09f 1000 (error "Server not in the agent program"))
23f87bed 1001
bf247b6e 1002 (setq gnus-agent-covered-methods
23f87bed
MB		 1003 (delete named-server gnus-agent-covered-methods)
1004 gnus-agent-method-p-cache nil)
1005
1006 (gnus-server-update-server server)
df80b09f 1007 (gnus-agent-write-servers)
23f87bed 1008 (gnus-message 1 "Removed %s from the agent" server)))
df80b09f
LMI		 1009
1010(defun gnus-agent-read-servers ()
1011 "Read the alist of covered servers."
bf247b6e 1012 (setq gnus-agent-covered-methods
23f87bed
MB		 1013 (gnus-agent-read-file
1014 (nnheader-concat gnus-agent-directory "lib/servers"))
1015 gnus-agent-method-p-cache nil)
1016
1017 ;; I am called so early in start-up that I can not validate server
1018 ;; names. When that is the case, I skip the validation. That is
1019 ;; alright as the gnus startup code calls the validate methods
1020 ;; directly.
1021 (if gnus-server-alist
1022 (gnus-agent-read-servers-validate)))
1023
1024(defun gnus-agent-read-servers-validate ()
1025 (mapcar (lambda (server-or-method)
1026 (let* ((server (if (stringp server-or-method)
1027 server-or-method
1028 (gnus-method-to-server server-or-method)))
1029 (method (gnus-server-to-method server)))
1030 (if method
1031 (unless (member server gnus-agent-covered-methods)
1032 (push server gnus-agent-covered-methods)
1033 (setq gnus-agent-method-p-cache nil))
1034 (gnus-message 1 "Ignoring disappeared server `%s'" server))))
1035 (prog1 gnus-agent-covered-methods
1036 (setq gnus-agent-covered-methods nil))))
1037
1038(defun gnus-agent-read-servers-validate-native (native-method)
df80b09f 1039 (setq gnus-agent-covered-methods
23f87bed
MB		 1040 (mapcar (lambda (method)
1041 (if (or (not method)
1042 (equal method native-method))
1043 "native"
1044 method)) gnus-agent-covered-methods)))
df80b09f
LMI		 1045
1046(defun gnus-agent-write-servers ()
1047 "Write the alist of covered servers."
16409b0b
GM		 1048 (gnus-make-directory (nnheader-concat gnus-agent-directory "lib"))
1049 (let ((coding-system-for-write nnheader-file-coding-system)
1050 (file-name-coding-system nnmail-pathname-coding-system))
1051 (with-temp-file (nnheader-concat gnus-agent-directory "lib/servers")
23f87bed
MB		 1052 (prin1 gnus-agent-covered-methods
1053 (current-buffer)))))
df80b09f
LMI		 1054
1055;;;
1056;;; Summary commands
1057;;;
1058
1059(defun gnus-agent-mark-article (n &optional unmark)
1060 "Mark the next N articles as downloadable.
1061If N is negative, mark backward instead. If UNMARK is non-nil, remove
1062the mark instead. The difference between N and the actual number of
1063articles marked is returned."
1064 (interactive "p")
1065 (let ((backward (< n 0))
1066 (n (abs n)))
1067 (while (and
1068 (> n 0)
1069 (progn
1070 (gnus-summary-set-agent-mark
1071 (gnus-summary-article-number) unmark)
1072 (zerop (gnus-summary-next-subject (if backward -1 1) nil t))))
1073 (setq n (1- n)))
1074 (when (/= 0 n)
1075 (gnus-message 7 "No more articles"))
1076 (gnus-summary-recenter)
1077 (gnus-summary-position-point)
1078 n))
1079
1080(defun gnus-agent-unmark-article (n)
1081 "Remove the downloadable mark from the next N articles.
1082If N is negative, unmark backward instead. The difference between N and
1083the actual number of articles unmarked is returned."
1084 (interactive "p")
1085 (gnus-agent-mark-article n t))
1086
1087(defun gnus-agent-toggle-mark (n)
1088 "Toggle the downloadable mark from the next N articles.
1089If N is negative, toggle backward instead. The difference between N and
1090the actual number of articles toggled is returned."
1091 (interactive "p")
1092 (gnus-agent-mark-article n 'toggle))
1093
1094(defun gnus-summary-set-agent-mark (article &optional unmark)
23f87bed
MB		 1095 "Mark ARTICLE as downloadable. If UNMARK is nil, article is marked.
1096When UNMARK is t, the article is unmarked. For any other value, the
1097article's mark is toggled."
1098 (let ((unmark (cond ((eq nil unmark)
1099 nil)
1100 ((eq t unmark)
1101 t)
1102 (t
1103 (memq article gnus-newsgroup-downloadable)))))
1104 (when (gnus-summary-goto-subject article nil t)
1105 (gnus-summary-update-mark
1106 (if unmark
1107 (progn
1108 (setq gnus-newsgroup-downloadable
1109 (delq article gnus-newsgroup-downloadable))
1110 (gnus-article-mark article))
1111 (setq gnus-newsgroup-downloadable
1112 (gnus-add-to-sorted-list gnus-newsgroup-downloadable article))
1113 gnus-downloadable-mark)
1114 'unread))))
df80b09f 1115
54506618 1116;;;###autoload
df80b09f 1117(defun gnus-agent-get-undownloaded-list ()
23f87bed 1118 "Construct list of articles that have not been downloaded."
df80b09f 1119 (let ((gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name)))
23f87bed
MB		 1120 (when (set (make-local-variable 'gnus-newsgroup-agentized)
1121 (gnus-agent-method-p gnus-command-method))
1122 (let* ((alist (gnus-agent-load-alist gnus-newsgroup-name))
1123 (headers (sort (mapcar (lambda (h)
1124 (mail-header-number h))
1125 gnus-newsgroup-headers) '<))
1126 (cached (and gnus-use-cache gnus-newsgroup-cached))
1127 (undownloaded (list nil))
1128 (tail-undownloaded undownloaded)
1129 (unfetched (list nil))
1130 (tail-unfetched unfetched))
1131 (while (and alist headers)
1132 (let ((a (caar alist))
1133 (h (car headers)))
1134 (cond ((< a h)
1135 ;; Ignore IDs in the alist that are not being
1136 ;; displayed in the summary.
1137 (setq alist (cdr alist)))
1138 ((> a h)
1139 ;; Headers that are not in the alist should be
1140 ;; fictious (see nnagent-retrieve-headers); they
1141 ;; imply that this article isn't in the agent.
1142 (gnus-agent-append-to-list tail-undownloaded h)
1143 (gnus-agent-append-to-list tail-unfetched h)
bf247b6e 1144 (setq headers (cdr headers)))
23f87bed
MB		 1145 ((cdar alist)
1146 (setq alist (cdr alist))
1147 (setq headers (cdr headers))
1148 nil ; ignore already downloaded
1149 )
1150 (t
1151 (setq alist (cdr alist))
1152 (setq headers (cdr headers))
bf247b6e 1153
23f87bed
MB		 1154 ;; This article isn't in the agent. Check to see
1155 ;; if it is in the cache. If it is, it's been
1156 ;; downloaded.
1157 (while (and cached (< (car cached) a))
1158 (setq cached (cdr cached)))
1159 (unless (equal a (car cached))
1160 (gnus-agent-append-to-list tail-undownloaded a))))))
1161
1162 (while headers
1163 (let ((num (pop headers)))
1164 (gnus-agent-append-to-list tail-undownloaded num)
1165 (gnus-agent-append-to-list tail-unfetched num)))
1166
1167 (setq gnus-newsgroup-undownloaded (cdr undownloaded)
1168 gnus-newsgroup-unfetched (cdr unfetched))))))
df80b09f
LMI		 1169
1170(defun gnus-agent-catchup ()
23f87bed
MB		 1171 "Mark as read all unhandled articles.
1172An article is unhandled if it is neither cached, nor downloaded, nor
1173downloadable."
df80b09f
LMI		 1174 (interactive)
1175 (save-excursion
23f87bed
MB		 1176 (let ((articles gnus-newsgroup-undownloaded))
1177 (when (or gnus-newsgroup-downloadable
1178 gnus-newsgroup-cached)
1179 (setq articles (gnus-sorted-ndifference
1180 (gnus-sorted-ndifference
1181 (gnus-copy-sequence articles)
1182 gnus-newsgroup-downloadable)
1183 gnus-newsgroup-cached)))
1184
1185 (while articles
1186 (gnus-summary-mark-article
1187 (pop articles) gnus-catchup-mark)))
1188 (gnus-summary-position-point)))
1189
1190(defun gnus-agent-summary-fetch-series ()
1191 (interactive)
1192 (when gnus-newsgroup-processable
1193 (setq gnus-newsgroup-downloadable
1194 (let* ((dl gnus-newsgroup-downloadable)
58090a8d
MB		 1195 (processable (sort (gnus-copy-sequence gnus-newsgroup-processable) '<))
1196 (gnus-newsgroup-downloadable processable))
1197 (gnus-agent-summary-fetch-group)
23f87bed 1198
58090a8d
MB		 1199 ;; For each article that I processed that is no longer
1200 ;; undownloaded, remove its processable mark.
1201
655591a7 1202 (mapc #'gnus-summary-remove-process-mark
58090a8d
MB		 1203 (gnus-sorted-ndifference gnus-newsgroup-processable gnus-newsgroup-undownloaded))
1204
1205 ;; The preceeding call to (gnus-agent-summary-fetch-group)
1206 ;; updated the temporary gnus-newsgroup-downloadable to
1207 ;; remove each article successfully fetched. Now, I
1208 ;; update the real gnus-newsgroup-downloadable to only
1209 ;; include undownloaded articles.
1210 (gnus-sorted-ndifference dl (gnus-sorted-ndifference processable gnus-newsgroup-undownloaded))))))
23f87bed
MB		 1211
1212(defun gnus-agent-summary-fetch-group (&optional all)
1213 "Fetch the downloadable articles in the group.
1214Optional arg ALL, if non-nil, means to fetch all articles."
1215 (interactive "P")
1216 (let ((articles
1217 (if all gnus-newsgroup-articles
1218 gnus-newsgroup-downloadable))
1219 (gnus-command-method (gnus-find-method-for-group gnus-newsgroup-name))
1220 fetched-articles)
1221 (gnus-agent-while-plugged
1222 (unless articles
1223 (error "No articles to download"))
1224 (gnus-agent-with-fetch
1225 (setq gnus-newsgroup-undownloaded
1226 (gnus-sorted-ndifference
1227 gnus-newsgroup-undownloaded
1228 (setq fetched-articles
1229 (gnus-agent-fetch-articles
1230 gnus-newsgroup-name articles)))))
1231 (save-excursion
1232 (dolist (article articles)
bf247b6e 1233 (let ((was-marked-downloadable
23f87bed
MB		 1234 (memq article gnus-newsgroup-downloadable)))
1235 (cond (gnus-agent-mark-unread-after-downloaded
1236 (setq gnus-newsgroup-downloadable
1237 (delq article gnus-newsgroup-downloadable))
1238
1239 (gnus-summary-mark-article article gnus-unread-mark))
1240 (was-marked-downloadable
1241 (gnus-summary-set-agent-mark article t)))
1242 (when (gnus-summary-goto-subject article nil t)
1243 (gnus-summary-update-download-mark article))))))
1244 fetched-articles))
1245
1246(defun gnus-agent-fetch-selected-article ()
1247 "Fetch the current article as it is selected.
1248This can be added to `gnus-select-article-hook' or
1249`gnus-mark-article-hook'."
1250 (let ((gnus-command-method gnus-current-select-method))
1251 (when (and gnus-plugged (gnus-agent-method-p gnus-command-method))
1252 (when (gnus-agent-fetch-articles
1253 gnus-newsgroup-name
1254 (list gnus-current-article))
1255 (setq gnus-newsgroup-undownloaded
1256 (delq gnus-current-article gnus-newsgroup-undownloaded))
1257 (gnus-summary-update-download-mark gnus-current-article)))))
df80b09f
LMI		 1258
1259;;;
1260;;; Internal functions
1261;;;
1262
54506618
MB		 1263(defun gnus-agent-synchronize-group-flags (group actions server)
1264"Update a plugged group by performing the indicated actions."
1265 (let* ((gnus-command-method (gnus-server-to-method server))
1266 (info
1267 ;; This initializer is required as gnus-request-set-mark
1268 ;; calls gnus-group-real-name to strip off the host name
1269 ;; before calling the backend. Now that the backend is
1270 ;; trying to call gnus-request-set-mark, I have to
1271 ;; reconstruct the original group name.
1272 (or (gnus-get-info group)
bf247b6e
KS		 1273 (gnus-get-info
1274 (setq group (gnus-group-full-name
54506618
MB		 1275 group gnus-command-method))))))
1276 (gnus-request-set-mark group actions)
1277
1278 (when info
1279 (dolist (action actions)
1280 (let ((range (nth 0 action))
1281 (what (nth 1 action))
1282 (marks (nth 2 action)))
1283 (dolist (mark marks)
1284 (cond ((eq mark 'read)
bf247b6e 1285 (gnus-info-set-read
54506618
MB		 1286 info
1287 (funcall (if (eq what 'add)
1288 'gnus-range-add
1289 'gnus-remove-from-range)
1290 (gnus-info-read info)
1291 range))
bf247b6e 1292 (gnus-get-unread-articles-in-group
54506618
MB		 1293 info
1294 (gnus-active (gnus-info-group info))))
1295 ((memq mark '(tick))
1296 (let ((info-marks (assoc mark (gnus-info-marks info))))
1297 (unless info-marks
1298 (gnus-info-set-marks info (cons (setq info-marks (list mark)) (gnus-info-marks info))))
1299 (setcdr info-marks (funcall (if (eq what 'add)
1300 'gnus-range-add
1301 'gnus-remove-from-range)
1302 (cdr info-marks)
58090a8d
MB		 1303 range))))))))
1304
1305 ;;Marks can be synchronized at any time by simply toggling from
1306 ;;unplugged to plugged. If that is what is happening right now, make
1307 ;;sure that the group buffer is up to date.
1308 (when (gnus-buffer-live-p gnus-group-buffer)
1309 (gnus-group-update-group group t)))
54506618
MB		 1310 nil))
1311
df80b09f
LMI		 1312(defun gnus-agent-save-active (method)
1313 (when (gnus-agent-method-p method)
1314 (let* ((gnus-command-method method)
16409b0b 1315 (new (gnus-make-hashtable (count-lines (point-min) (point-max))))
df80b09f 1316 (file (gnus-agent-lib-file "active")))
23f87bed 1317 (gnus-active-to-gnus-format nil new)
16409b0b
GM		 1318 (gnus-agent-write-active file new)
1319 (erase-buffer)
01c52d31
MB		 1320 (let ((nnheader-file-coding-system gnus-agent-file-coding-system))
1321 (nnheader-insert-file-contents file)))))
16409b0b
GM		 1322
1323(defun gnus-agent-write-active (file new)
df80b09f 1324 (gnus-make-directory (file-name-directory file))
23f87bed
MB		 1325 (let ((nnmail-active-file-coding-system gnus-agent-file-coding-system))
1326 ;; The hashtable contains real names of groups. However, do NOT
1327 ;; add the foreign server prefix as gnus-active-to-gnus-format
1328 ;; will add it while reading the file.
1329 (gnus-write-active-file file new nil)))
1330
54506618 1331;;;###autoload
23f87bed
MB		 1332(defun gnus-agent-possibly-alter-active (group active &optional info)
1333 "Possibly expand a group's active range to include articles
1334downloaded into the agent."
1335 (let* ((gnus-command-method (or gnus-command-method
1336 (gnus-find-method-for-group group))))
1337 (when (gnus-agent-method-p gnus-command-method)
1338 (let* ((local (gnus-agent-get-local group))
1339 (active-min (or (car active) 0))
1340 (active-max (or (cdr active) 0))
1341 (agent-min (or (car local) active-min))
1342 (agent-max (or (cdr local) active-max)))
1343
1344 (when (< agent-min active-min)
1345 (setcar active agent-min))
1346
1347 (when (> agent-max active-max)
1348 (setcdr active agent-max))
1349
1350 (when (and info (< agent-max (- active-min 100)))
1351 ;; I'm expanding the active range by such a large amount
1352 ;; that there is a gap of more than 100 articles between the
1353 ;; last article known to the agent and the first article
1354 ;; currently available on the server. This gap contains
1355 ;; articles that have been lost, mark them as read so that
1356 ;; gnus doesn't waste resources trying to fetch them.
1357
1358 ;; NOTE: I don't do this for smaller gaps (< 100) as I don't
1359 ;; want to modify the local file everytime someone restarts
1360 ;; gnus. The small gap will cause a tiny performance hit
1361 ;; when gnus tries, and fails, to retrieve the articles.
1362 ;; Still that should be smaller than opening a buffer,
1363 ;; printing this list to the buffer, and then writing it to a
1364 ;; file.
1365
1366 (let ((read (gnus-info-read info)))
bf247b6e
KS		 1367 (gnus-info-set-read
1368 info
1369 (gnus-range-add
1370 read
1371 (list (cons (1+ agent-max)
23f87bed
MB		 1372 (1- active-min))))))
1373
1374 ;; Lie about the agent's local range for this group to
1375 ;; disable the set read each time this server is opened.
1376 ;; NOTE: Opening this group will restore the valid local
1377 ;; range but it will also expand the local range to
1378 ;; incompass the new active range.
1379 (gnus-agent-set-local group agent-min (1- active-min)))))))
df80b09f
LMI		 1380
1381(defun gnus-agent-save-group-info (method group active)
23f87bed 1382 "Update a single group's active range in the agent's copy of the server's active file."
df80b09f 1383 (when (gnus-agent-method-p method)
54506618 1384 (let* ((gnus-command-method (or method gnus-command-method))
16409b0b
GM		 1385 (coding-system-for-write nnheader-file-coding-system)
1386 (file-name-coding-system nnmail-pathname-coding-system)
1387 (file (gnus-agent-lib-file "active"))
23f87bed 1388 oactive-min oactive-max)
df80b09f 1389 (gnus-make-directory (file-name-directory file))
16409b0b
GM		 1390 (with-temp-file file
1391 ;; Emacs got problem to match non-ASCII group in multibyte buffer.
a1506d29 1392 (mm-disable-multibyte)
df80b09f 1393 (when (file-exists-p file)
23f87bed
MB		 1394 (nnheader-insert-file-contents file)
1395
1396 (goto-char (point-min))
1397 (when (re-search-forward
1398 (concat "^" (regexp-quote group) " ") nil t)
1399 (save-excursion
58090a8d 1400 (setq oactive-max (read (current-buffer)) ;; max
23f87bed
MB		 1401 oactive-min (read (current-buffer)))) ;; min
1402 (gnus-delete-line)))
54506618
MB		 1403 (when active
1404 (insert (format "%S %d %d y\n" (intern group)
1405 (max (or oactive-max (cdr active)) (cdr active))
1406 (min (or oactive-min (car active)) (car active))))
1407 (goto-char (point-max))
1408 (while (search-backward "\\." nil t)
1409 (delete-char 1)))))))
1410
1411(defun gnus-agent-get-group-info (method group)
1412 "Get a single group's active range in the agent's copy of the server's active file."
1413 (when (gnus-agent-method-p method)
1414 (let* ((gnus-command-method (or method gnus-command-method))
1415 (coding-system-for-write nnheader-file-coding-system)
1416 (file-name-coding-system nnmail-pathname-coding-system)
1417 (file (gnus-agent-lib-file "active"))
1418 oactive-min oactive-max)
1419 (gnus-make-directory (file-name-directory file))
1420 (with-temp-buffer
1421 ;; Emacs got problem to match non-ASCII group in multibyte buffer.
1422 (mm-disable-multibyte)
1423 (when (file-exists-p file)
1424 (nnheader-insert-file-contents file)
1425
1426 (goto-char (point-min))
1427 (when (re-search-forward
1428 (concat "^" (regexp-quote group) " ") nil t)
1429 (save-excursion
1430 (setq oactive-max (read (current-buffer)) ;; max
1431 oactive-min (read (current-buffer))) ;; min
1432 (cons oactive-min oactive-max))))))))
df80b09f 1433
01c52d31
MB		 1434(defvar gnus-agent-decoded-group-names nil
1435 "Alist of non-ASCII group names and decoded ones.")
1436
1437(defun gnus-agent-decoded-group-name (group)
1438 "Return a decoded group name of GROUP."
1439 (or (cdr (assoc group gnus-agent-decoded-group-names))
1440 (if (string-match "[^\000-\177]" group)
1441 (let ((decoded (gnus-group-decoded-name group)))
1442 (push (cons group decoded) gnus-agent-decoded-group-names)
1443 decoded)
1444 group)))
1445
df80b09f 1446(defun gnus-agent-group-path (group)
35ef97a5 1447 "Translate GROUP into a file name."
23f87bed
MB		 1448
1449 ;; NOTE: This is what nnmail-group-pathname does as of Apr 2003.
1450 ;; The two methods must be kept synchronized, which is why
1451 ;; gnus-agent-group-pathname was added.
1452
1453 (setq group
1454 (nnheader-translate-file-chars
1455 (nnheader-replace-duplicate-chars-in-string
bf247b6e 1456 (nnheader-replace-chars-in-string
01c52d31 1457 (gnus-group-real-name (gnus-agent-decoded-group-name group))
23f87bed
MB		 1458 ?/ ?_)
1459 ?. ?_)))
1460 (if (or nnmail-use-long-file-names
1461 (file-directory-p (expand-file-name group (gnus-agent-directory))))
1462 group
01c52d31 1463 (nnheader-replace-chars-in-string group ?. ?/)))
23f87bed
MB		 1464
1465(defun gnus-agent-group-pathname (group)
1466 "Translate GROUP into a file name."
1467 ;; nnagent uses nnmail-group-pathname to read articles while
1468 ;; unplugged. The agent must, therefore, use the same directory
1469 ;; while plugged.
01c52d31
MB		 1470 (nnmail-group-pathname
1471 (gnus-group-real-name (gnus-agent-decoded-group-name group))
1472 (if gnus-command-method
1473 (gnus-agent-directory)
1474 (let ((gnus-command-method (gnus-find-method-for-group group)))
1475 (gnus-agent-directory)))))
df80b09f
LMI		 1476
1477(defun gnus-agent-get-function (method)
23f87bed
MB		 1478 (if (gnus-online method)
1479 (car method)
1480 (require 'nnagent)
1481 'nnagent))
1482
1483(defun gnus-agent-covered-methods ()
1484 "Return the subset of methods that are covered by the agent."
1485 (delq nil (mapcar #'gnus-server-to-method gnus-agent-covered-methods)))
df80b09f
LMI		 1486
1487;;; History functions
1488
1489(defun gnus-agent-history-buffer ()
1490 (cdr (assoc (gnus-agent-method) gnus-agent-history-buffers)))
1491
1492(defun gnus-agent-open-history ()
1493 (save-excursion
1494 (push (cons (gnus-agent-method)
1495 (set-buffer (gnus-get-buffer-create
1496 (format " *Gnus agent %s history*"
1497 (gnus-agent-method)))))
1498 gnus-agent-history-buffers)
16409b0b 1499 (mm-disable-multibyte) ;; everything is binary
df80b09f
LMI		 1500 (erase-buffer)
1501 (insert "\n")
1502 (let ((file (gnus-agent-lib-file "history")))
1503 (when (file-exists-p file)
16409b0b 1504 (nnheader-insert-file-contents file))
df80b09f
LMI		 1505 (set (make-local-variable 'gnus-agent-file-name) file))))
1506
df80b09f
LMI		 1507(defun gnus-agent-close-history ()
1508 (when (gnus-buffer-live-p gnus-agent-current-history)
1509 (kill-buffer gnus-agent-current-history)
1510 (setq gnus-agent-history-buffers
1511 (delq (assoc (gnus-agent-method) gnus-agent-history-buffers)
1512 gnus-agent-history-buffers))))
1513
df80b09f
LMI		 1514;;;
1515;;; Fetching
1516;;;
1517
1518(defun gnus-agent-fetch-articles (group articles)
1519 "Fetch ARTICLES from GROUP and put them into the Agent."
1520 (when articles
23f87bed
MB		 1521 (gnus-agent-load-alist group)
1522 (let* ((alist gnus-agent-article-alist)
1523 (headers (if (< (length articles) 2) nil gnus-newsgroup-headers))
1524 (selected-sets (list nil))
1525 (current-set-size 0)
1526 article
1527 header-number)
1528 ;; Check each article
1529 (while (setq article (pop articles))
1530 ;; Skip alist entries preceeding this article
1531 (while (> article (or (caar alist) (1+ article)))
1532 (setq alist (cdr alist)))
1533
1534 ;; Prune off articles that we have already fetched.
1535 (unless (and (eq article (caar alist))
1536 (cdar alist))
1537 ;; Skip headers preceeding this article
bf247b6e 1538 (while (> article
23f87bed
MB		 1539 (setq header-number
1540 (let* ((header (car headers)))
1541 (if header
1542 (mail-header-number header)
1543 (1+ article)))))
1544 (setq headers (cdr headers)))
1545
1546 ;; Add this article to the current set
1547 (setcar selected-sets (cons article (car selected-sets)))
1548
1549 ;; Update the set size, when the set is too large start a
1550 ;; new one. I do this after adding the article as I want at
1551 ;; least one article in each set.
1552 (when (< gnus-agent-max-fetch-size
1553 (setq current-set-size
1554 (+ current-set-size
1555 (if (= header-number article)
1556 (let ((char-size (mail-header-chars
1557 (car headers))))
1558 (if (<= char-size 0)
1559 ;; The char size was missing/invalid,
1560 ;; assume a worst-case situation of
1561 ;; 65 char/line. If the line count
1562 ;; is missing, arbitrarily assume a
1563 ;; size of 1000 characters.
1564 (max (* 65 (mail-header-lines
1565 (car headers)))
1566 1000)
1567 char-size))
1568 0))))
1569 (setcar selected-sets (nreverse (car selected-sets)))
1570 (setq selected-sets (cons nil selected-sets)
1571 current-set-size 0))))
1572
1573 (when (or (cdr selected-sets) (car selected-sets))
1574 (let* ((fetched-articles (list nil))
1575 (tail-fetched-articles fetched-articles)
1576 (dir (gnus-agent-group-pathname group))
1577 (date (time-to-days (current-time)))
1578 (case-fold-search t)
01c52d31
MB		 1579 pos crosses id
1580 (file-name-coding-system nnmail-pathname-coding-system))
23f87bed
MB		 1581
1582 (setcar selected-sets (nreverse (car selected-sets)))
1583 (setq selected-sets (nreverse selected-sets))
1584
1585 (gnus-make-directory dir)
ec7995fa
KY		 1586 (gnus-message 7 "Fetching articles for %s..."
1587 (gnus-agent-decoded-group-name group))
23f87bed
MB		 1588
1589 (unwind-protect
1590 (while (setq articles (pop selected-sets))
1591 ;; Fetch the articles from the backend.
1592 (if (gnus-check-backend-function 'retrieve-articles group)
1593 (setq pos (gnus-retrieve-articles articles group))
1594 (with-temp-buffer
1595 (let (article)
1596 (while (setq article (pop articles))
1597 (gnus-message 10 "Fetching article %s for %s..."
ec7995fa
KY		 1598 article
1599 (gnus-agent-decoded-group-name group))
23f87bed
MB		 1600 (when (or
1601 (gnus-backlog-request-article group article
1602 nntp-server-buffer)
1603 (gnus-request-article article group))
1604 (goto-char (point-max))
1605 (push (cons article (point)) pos)
1606 (insert-buffer-substring nntp-server-buffer)))
1607 (copy-to-buffer
1608 nntp-server-buffer (point-min) (point-max))
1609 (setq pos (nreverse pos)))))
1610 ;; Then save these articles into the Agent.
1611 (save-excursion
1612 (set-buffer nntp-server-buffer)
1613 (while pos
1614 (narrow-to-region (cdar pos) (or (cdadr pos) (point-max)))
1615 (goto-char (point-min))
1616 (unless (eobp) ;; Don't save empty articles.
1617 (when (search-forward "\n\n" nil t)
1618 (when (search-backward "\nXrefs: " nil t)
1619 ;; Handle cross posting.
1620 (goto-char (match-end 0)) ; move to end of header name
1621 (skip-chars-forward "^ ") ; skip server name
1622 (skip-chars-forward " ")
1623 (setq crosses nil)
1624 (while (looking-at "\\([^: \n]+\\):\\([0-9]+\\) *")
1625 (push (cons (buffer-substring (match-beginning 1)
1626 (match-end 1))
e9bd5782 1627 (string-to-number
23f87bed
MB		 1628 (buffer-substring (match-beginning 2)
1629 (match-end 2))))
1630 crosses)
1631 (goto-char (match-end 0)))
1632 (gnus-agent-crosspost crosses (caar pos) date)))
1633 (goto-char (point-min))
1634 (if (not (re-search-forward
1635 "^Message-ID: *<\\([^>\n]+\\)>" nil t))
1636 (setq id "No-Message-ID-in-article")
1637 (setq id (buffer-substring
1638 (match-beginning 1) (match-end 1))))
1639 (let ((coding-system-for-write
1640 gnus-agent-file-coding-system))
1641 (write-region (point-min) (point-max)
1642 (concat dir (number-to-string (caar pos)))
1643 nil 'silent))
1644
1645 (gnus-agent-append-to-list
1646 tail-fetched-articles (caar pos)))
1647 (widen)
1648 (setq pos (cdr pos)))))
1649
1650 (gnus-agent-save-alist group (cdr fetched-articles) date)
01c52d31
MB		 1651 (gnus-agent-update-files-total-fetched-for group (cdr fetched-articles))
1652
23f87bed
MB		 1653 (gnus-message 7 ""))
1654 (cdr fetched-articles))))))
1655
54506618
MB		 1656(defun gnus-agent-unfetch-articles (group articles)
1657 "Delete ARTICLES that were fetched from GROUP into the agent."
1658 (when articles
01c52d31
MB		 1659 (gnus-agent-with-refreshed-group
1660 group
1661 (gnus-agent-load-alist group)
1662 (let* ((alist (cons nil gnus-agent-article-alist))
1663 (articles (sort articles #'<))
1664 (next-possibility alist)
1665 (delete-this (pop articles)))
1666 (while (and (cdr next-possibility) delete-this)
1667 (let ((have-this (caar (cdr next-possibility))))
1668 (cond
1669 ((< delete-this have-this)
1670 (setq delete-this (pop articles)))
1671 ((= delete-this have-this)
1672 (let ((timestamp (cdar (cdr next-possibility))))
1673 (when timestamp
1674 (let* ((file-name (concat (gnus-agent-group-pathname group)
1675 (number-to-string have-this)))
1676 (size-file
1677 (float (or (and gnus-agent-total-fetched-hashtb
1678 (nth 7 (file-attributes file-name)))
1679 0)))
1680 (file-name-coding-system
1681 nnmail-pathname-coding-system))
1682 (delete-file file-name)
1683 (gnus-agent-update-files-total-fetched-for
1684 group (- size-file)))))
1685
1686 (setcdr next-possibility (cddr next-possibility)))
1687 (t
1688 (setq next-possibility (cdr next-possibility))))))
1689 (setq gnus-agent-article-alist (cdr alist))
1690 (gnus-agent-save-alist group)))))
54506618 1691
23f87bed
MB		 1692(defun gnus-agent-crosspost (crosses article &optional date)
1693 (setq date (or date t))
1694
df80b09f
LMI		 1695 (let (gnus-agent-article-alist group alist beg end)
1696 (save-excursion
1697 (set-buffer gnus-agent-overview-buffer)
1698 (when (nnheader-find-nov-line article)
1699 (forward-word 1)
1700 (setq beg (point))
1701 (setq end (progn (forward-line 1) (point)))))
1702 (while crosses
1703 (setq group (caar crosses))
1704 (unless (setq alist (assoc group gnus-agent-group-alist))
1705 (push (setq alist (list group (gnus-agent-load-alist (caar crosses))))
1706 gnus-agent-group-alist))
23f87bed 1707 (setcdr alist (cons (cons (cdar crosses) date) (cdr alist)))
df80b09f
LMI		 1708 (save-excursion
1709 (set-buffer (gnus-get-buffer-create (format " *Gnus agent overview %s*"
16409b0b 1710 group)))
df80b09f
LMI		 1711 (when (= (point-max) (point-min))
1712 (push (cons group (current-buffer)) gnus-agent-buffer-alist)
1713 (ignore-errors
01c52d31
MB		 1714 (let ((file-name-coding-system nnmail-pathname-coding-system))
1715 (nnheader-insert-file-contents
1716 (gnus-agent-article-name ".overview" group)))))
df80b09f
LMI		 1717 (nnheader-find-nov-line (string-to-number (cdar crosses)))
1718 (insert (string-to-number (cdar crosses)))
23f87bed
MB		 1719 (insert-buffer-substring gnus-agent-overview-buffer beg end)
1720 (gnus-agent-check-overview-buffer))
1721 (setq crosses (cdr crosses)))))
1722
1723(defun gnus-agent-backup-overview-buffer ()
1724 (when gnus-newsgroup-name
1725 (let ((root (gnus-agent-article-name ".overview" gnus-newsgroup-name))
1726 (cnt 0)
01c52d31
MB		 1727 name
1728 (file-name-coding-system nnmail-pathname-coding-system))
23f87bed
MB		 1729 (while (file-exists-p
1730 (setq name (concat root "~"
1731 (int-to-string (setq cnt (1+ cnt))) "~"))))
1732 (write-region (point-min) (point-max) name nil 'no-msg)
1733 (gnus-message 1 "Created backup copy of overview in %s." name)))
1734 t)
1735
1736(defun gnus-agent-check-overview-buffer (&optional buffer)
1737 "Check the overview file given for sanity.
1738In particular, checks that the file is sorted by article number
1739and that there are no duplicates."
1740 (let ((prev-num -1)
1741 (backed-up nil))
1742 (save-excursion
1743 (when buffer
1744 (set-buffer buffer))
1745 (save-restriction
1746 (widen)
1747 (goto-char (point-min))
1748
1749 (while (< (point) (point-max))
1750 (let ((p (point))
1751 (cur (condition-case nil
1752 (read (current-buffer))
1753 (error nil))))
1754 (cond
1755 ((or (not (integerp cur))
1756 (not (eq (char-after) ?\t)))
1757 (or backed-up
1758 (setq backed-up (gnus-agent-backup-overview-buffer)))
1759 (gnus-message 1
1760 "Overview buffer contains garbage '%s'."
1761 (buffer-substring
01c52d31 1762 p (point-at-eol))))
23f87bed
MB		 1763 ((= cur prev-num)
1764 (or backed-up
1765 (setq backed-up (gnus-agent-backup-overview-buffer)))
1766 (gnus-message 1
1767 "Duplicate overview line for %d" cur)
54506618 1768 (delete-region p (progn (forward-line 1) (point))))
23f87bed
MB		 1769 ((< cur prev-num)
1770 (or backed-up
1771 (setq backed-up (gnus-agent-backup-overview-buffer)))
1772 (gnus-message 1 "Overview buffer not sorted!")
1773 (sort-numeric-fields 1 (point-min) (point-max))
1774 (goto-char (point-min))
1775 (setq prev-num -1))
1776 (t
1777 (setq prev-num cur)))
1778 (forward-line 1)))))))
df80b09f 1779
01c52d31
MB		 1780(defun gnus-agent-flush-server (&optional server-or-method)
1781 "Flush all agent index files for every subscribed group within
1782 the given SERVER-OR-METHOD. When called with nil, the current
1783 value of gnus-command-method identifies the server."
1784 (let* ((gnus-command-method (if server-or-method
1785 (gnus-server-to-method server-or-method)
1786 gnus-command-method))
1787 (alist gnus-newsrc-alist))
1788 (while alist
1789 (let ((entry (pop alist)))
1790 (when (gnus-methods-equal-p gnus-command-method (gnus-info-method entry))
c9fc72fa 1791 (gnus-agent-flush-group (gnus-info-group entry)))))))
01c52d31
MB		 1792
1793(defun gnus-agent-flush-group (group)
1794 "Flush the agent's index files such that the GROUP no longer
1795appears to have any local content. The actual content, the
1796article files, may then be deleted using gnus-agent-expire-group.
1797If flushing was a mistake, the gnus-agent-regenerate-group method
1798provides an undo mechanism by reconstructing the index files from
1799the article files."
1800 (interactive (list (gnus-agent-read-group)))
1801
1802 (let* ((gnus-command-method (or gnus-command-method
1803 (gnus-find-method-for-group group)))
1804 (overview (gnus-agent-article-name ".overview" group))
1805 (agentview (gnus-agent-article-name ".agentview" group))
1806 (file-name-coding-system nnmail-pathname-coding-system))
1807
1808 (if (file-exists-p overview)
1809 (delete-file overview))
1810 (if (file-exists-p agentview)
1811 (delete-file agentview))
1812
1813 (gnus-agent-update-view-total-fetched-for group nil gnus-command-method)
1814 (gnus-agent-update-view-total-fetched-for group t gnus-command-method)
1815
1816 ;(gnus-agent-set-local group nil nil)
1817 ;(gnus-agent-save-local t)
1818 (gnus-agent-save-group-info nil group nil)))
1819
df80b09f 1820(defun gnus-agent-flush-cache ()
01c52d31
MB		 1821 "Flush the agent's index files such that the group no longer
1822appears to have any local content. The actual content, the
1823article files, is then deleted using gnus-agent-expire-group. The
1824gnus-agent-regenerate-group method provides an undo mechanism by
1825reconstructing the index files from the article files."
1826 (interactive)
df80b09f 1827 (save-excursion
01c52d31
MB		 1828 (let ((file-name-coding-system nnmail-pathname-coding-system))
1829 (while gnus-agent-buffer-alist
1830 (set-buffer (cdar gnus-agent-buffer-alist))
1831 (let ((coding-system-for-write gnus-agent-file-coding-system))
1832 (write-region (point-min) (point-max)
1833 (gnus-agent-article-name ".overview"
1834 (caar gnus-agent-buffer-alist))
1835 nil 'silent))
1836 (setq gnus-agent-buffer-alist (cdr gnus-agent-buffer-alist)))
1837 (while gnus-agent-group-alist
1838 (with-temp-file (gnus-agent-article-name
1839 ".agentview" (caar gnus-agent-group-alist))
1840 (princ (cdar gnus-agent-group-alist))
1841 (insert "\n")
1842 (princ 1 (current-buffer))
1843 (insert "\n"))
1844 (setq gnus-agent-group-alist (cdr gnus-agent-group-alist))))))
23f87bed 1845
54506618 1846;;;###autoload
23f87bed
MB		 1847(defun gnus-agent-find-parameter (group symbol)
1848 "Search for GROUPs SYMBOL in the group's parameters, the group's
1849topic parameters, the group's category, or the customizable
1850variables. Returns the first non-nil value found."
1851 (or (gnus-group-find-parameter group symbol t)
1852 (gnus-group-parameter-value (cdr (gnus-group-category group)) symbol t)
1853 (symbol-value
1854 (cdr
1855 (assq symbol
1856 '((agent-short-article . gnus-agent-short-article)
1857 (agent-long-article . gnus-agent-long-article)
1858 (agent-low-score . gnus-agent-low-score)
1859 (agent-high-score . gnus-agent-high-score)
1860 (agent-days-until-old . gnus-agent-expire-days)
1861 (agent-enable-expiration
1862 . gnus-agent-enable-expiration)
1863 (agent-predicate . gnus-agent-predicate)))))))
16409b0b 1864
df80b09f 1865(defun gnus-agent-fetch-headers (group &optional force)
23f87bed
MB		 1866 "Fetch interesting headers into the agent. The group's overview
1867file will be updated to include the headers while a list of available
1868article numbers will be returned."
1869 (let* ((fetch-all (and gnus-agent-consider-all-articles
1870 ;; Do not fetch all headers if the predicate
1871 ;; implies that we only consider unread articles.
1872 (not (gnus-predicate-implies-unread
1873 (gnus-agent-find-parameter group
1874 'agent-predicate)))))
1875 (articles (if fetch-all
4b70e299 1876 (if gnus-newsgroup-maximum-articles
11abff8e
MB		 1877 (let ((active (gnus-active group)))
1878 (gnus-uncompress-range
1879 (cons (max (car active)
1880 (- (cdr active)
4b70e299
MB		 1881 gnus-newsgroup-maximum-articles
1882 -1))
11abff8e
MB		 1883 (cdr active))))
1884 (gnus-uncompress-range (gnus-active group)))
23f87bed
MB		 1885 (gnus-list-of-unread-articles group)))
1886 (gnus-decode-encoded-word-function 'identity)
5cedca8d 1887 (gnus-decode-encoded-address-function 'identity)
01c52d31
MB		 1888 (file (gnus-agent-article-name ".overview" group))
1889 (file-name-coding-system nnmail-pathname-coding-system))
23f87bed
MB		 1890
1891 (unless fetch-all
1892 ;; Add articles with marks to the list of article headers we want to
1893 ;; fetch. Don't fetch articles solely on the basis of a recent or seen
1894 ;; mark, but do fetch recent or seen articles if they have other, more
1895 ;; interesting marks. (We have to fetch articles with boring marks
1896 ;; because otherwise the agent will remove their marks.)
1897 (dolist (arts (gnus-info-marks (gnus-get-info group)))
1898 (unless (memq (car arts) '(seen recent killed cache))
1899 (setq articles (gnus-range-add articles (cdr arts)))))
1900 (setq articles (sort (gnus-uncompress-sequence articles) '<)))
1901
1902 ;; At this point, I have the list of articles to consider for
1903 ;; fetching. This is the list that I'll return to my caller. Some
1904 ;; of these articles may have already been fetched. That's OK as
1905 ;; the fetch article code will filter those out. Internally, I'll
1906 ;; filter this list to just those articles whose headers need to
1907 ;; be fetched.
1908 (let ((articles articles))
1909 ;; Remove known articles.
1910 (when (and (or gnus-agent-cache
1911 (not gnus-plugged))
1912 (gnus-agent-load-alist group))
1913 ;; Remove articles marked as downloaded.
1914 (if fetch-all
1915 ;; I want to fetch all headers in the active range.
1916 ;; Therefore, exclude only those headers that are in the
1917 ;; article alist.
1918 ;; NOTE: This is probably NOT what I want to do after
1919 ;; agent expiration in this group.
1920 (setq articles (gnus-agent-uncached-articles articles group))
1921
1922 ;; I want to only fetch those headers that have never been
1923 ;; fetched. Therefore, exclude all headers that are, or
1924 ;; WERE, in the article alist.
1925 (let ((low (1+ (caar (last gnus-agent-article-alist))))
1926 (high (cdr (gnus-active group))))
1927 ;; Low can be greater than High when the same group is
1928 ;; fetched twice in the same session {The first fetch will
1929 ;; fill the article alist such that (last
1930 ;; gnus-agent-article-alist) equals (cdr (gnus-active
1931 ;; group))}. The addition of one(the 1+ above) then
1932 ;; forces Low to be greater than High. When this happens,
1933 ;; gnus-list-range-intersection returns nil which
1934 ;; indicates that no headers need to be fetched. -- Kevin
1935 (setq articles (gnus-list-range-intersection
1936 articles (list (cons low high)))))))
1937
1938 (gnus-message
1939 10 "gnus-agent-fetch-headers: undownloaded articles are '%s'"
1940 (gnus-compress-sequence articles t))
1941
df80b09f 1942 (save-excursion
23f87bed
MB		 1943 (set-buffer nntp-server-buffer)
1944
1945 (if articles
1946 (progn
ec7995fa
KY		 1947 (gnus-message 7 "Fetching headers for %s..."
1948 (gnus-agent-decoded-group-name group))
23f87bed
MB		 1949
1950 ;; Fetch them.
1951 (gnus-make-directory (nnheader-translate-file-chars
1952 (file-name-directory file) t))
1953
1954 (unless (eq 'nov (gnus-retrieve-headers articles group))
1955 (nnvirtual-convert-headers))
1956 (gnus-agent-check-overview-buffer)
1957 ;; Move these headers to the overview buffer so that
1958 ;; gnus-agent-braid-nov can merge them with the contents
1959 ;; of FILE.
1960 (copy-to-buffer
1961 gnus-agent-overview-buffer (point-min) (point-max))
54506618
MB		 1962 ;; NOTE: Call g-a-brand-nov even when the file does not
1963 ;; exist. As a minimum, it will validate the article
1964 ;; numbers already in the buffer.
1965 (gnus-agent-braid-nov group articles file)
23f87bed
MB		 1966 (let ((coding-system-for-write
1967 gnus-agent-file-coding-system))
1968 (gnus-agent-check-overview-buffer)
1969 (write-region (point-min) (point-max) file nil 'silent))
01c52d31 1970 (gnus-agent-update-view-total-fetched-for group t)
23f87bed
MB		 1971 (gnus-agent-save-alist group articles nil)
1972 articles)
1973 (ignore-errors
1974 (erase-buffer)
1975 (nnheader-insert-file-contents file)))))
1976 articles))
df80b09f 1977
54506618
MB		 1978(defsubst gnus-agent-read-article-number ()
1979 "Reads the article number at point. Returns nil when a valid article number can not be read."
1980
58090a8d 1981 ;; It is unfortunate but the read function quietly overflows
54506618
MB		 1982 ;; integer. As a result, I have to use string operations to test
1983 ;; for overflow BEFORE calling read.
1984 (when (looking-at "[0-9]+\t")
1985 (let ((len (- (match-end 0) (match-beginning 0))))
1986 (cond ((< len 9)
1987 (read (current-buffer)))
1988 ((= len 9)
1989 ;; Many 9 digit base-10 numbers can be represented in a 27-bit int
1990 ;; Back convert from int to string to ensure that this is one of them.
1991 (let* ((str1 (buffer-substring (match-beginning 0) (1- (match-end 0))))
1992 (num (read (current-buffer)))
1993 (str2 (int-to-string num)))
1994 (when (equal str1 str2)
1995 num)))))))
1996
df80b09f 1997(defsubst gnus-agent-copy-nov-line (article)
54506618 1998 "Copy the indicated ARTICLE from the overview buffer to the nntp server buffer."
23f87bed 1999 (let (art b e)
df80b09f 2000 (set-buffer gnus-agent-overview-buffer)
23f87bed 2001 (while (and (not (eobp))
54506618
MB		 2002 (or (not (setq art (gnus-agent-read-article-number)))
2003 (< art article)))
23f87bed
MB		 2004 (forward-line 1))
2005 (beginning-of-line)
2006 (if (or (eobp)
2007 (not (eq article art)))
2008 (set-buffer nntp-server-buffer)
2009 (setq b (point))
2010 (setq e (progn (forward-line 1) (point)))
2011 (set-buffer nntp-server-buffer)
2012 (insert-buffer-substring gnus-agent-overview-buffer b e))))
df80b09f
LMI		 2013
2014(defun gnus-agent-braid-nov (group articles file)
23f87bed 2015 "Merge agent overview data with given file.
54506618
MB		 2016Takes unvalidated headers for ARTICLES from
2017`gnus-agent-overview-buffer' and validated headers from the given
2018FILE and places the combined valid headers into
2019`nntp-server-buffer'. This function can be used, when file
2020doesn't exist, to valid the overview buffer."
23f87bed
MB		 2021 (let (start last)
2022 (set-buffer gnus-agent-overview-buffer)
2023 (goto-char (point-min))
2024 (set-buffer nntp-server-buffer)
2025 (erase-buffer)
54506618
MB		 2026 (when (file-exists-p file)
2027 (nnheader-insert-file-contents file))
23f87bed
MB		 2028 (goto-char (point-max))
2029 (forward-line -1)
54506618 2030
23f87bed
MB		 2031 (unless (or (= (point-min) (point-max))
2032 (< (setq last (read (current-buffer))) (car articles)))
54506618 2033 ;; Old and new overlap -- We do it the hard way.
23f87bed
MB		 2034 (when (nnheader-find-nov-line (car articles))
2035 ;; Replacing existing NOV entry
2036 (delete-region (point) (progn (forward-line 1) (point))))
2037 (gnus-agent-copy-nov-line (pop articles))
2038
2039 (ignore-errors
01c52d31
MB		 2040 (while articles
2041 (while (let ((art (read (current-buffer))))
2042 (cond ((< art (car articles))
2043 (forward-line 1)
2044 t)
2045 ((= art (car articles))
2046 (beginning-of-line)
2047 (delete-region
2048 (point) (progn (forward-line 1) (point)))
2049 nil)
2050 (t
2051 (beginning-of-line)
2052 nil))))
54506618 2053
01c52d31 2054 (gnus-agent-copy-nov-line (pop articles)))))
54506618 2055
23f87bed 2056 (goto-char (point-max))
54506618
MB		 2057
2058 ;; Append the remaining lines
df80b09f 2059 (when articles
23f87bed 2060 (when last
df80b09f 2061 (set-buffer gnus-agent-overview-buffer)
23f87bed
MB		 2062 (setq start (point))
2063 (set-buffer nntp-server-buffer))
54506618
MB		 2064
2065 (let ((p (point)))
2066 (insert-buffer-substring gnus-agent-overview-buffer start)
2067 (goto-char p))
2068
2069 (setq last (or last -134217728))
58090a8d 2070 (while (catch 'problems
01c52d31
MB		 2071 (let (sort art)
2072 (while (not (eobp))
2073 (setq art (gnus-agent-read-article-number))
2074 (cond ((not art)
2075 ;; Bad art num - delete this line
2076 (beginning-of-line)
2077 (delete-region (point) (progn (forward-line 1) (point))))
2078 ((< art last)
2079 ;; Art num out of order - enable sort
2080 (setq sort t)
2081 (forward-line 1))
58090a8d
MB		 2082 ((= art last)
2083 ;; Bad repeat of art number - delete this line
2084 (beginning-of-line)
2085 (delete-region (point) (progn (forward-line 1) (point))))
01c52d31
MB		 2086 (t
2087 ;; Good art num
2088 (setq last art)
2089 (forward-line 1))))
2090 (when sort
58090a8d
MB		 2091 ;; something is seriously wrong as we simply shouldn't see out-of-order data.
2092 ;; First, we'll fix the sort.
2093 (sort-numeric-fields 1 (point-min) (point-max))
2094
655591a7 2095 ;; but now we have to consider that we may have duplicate rows...
58090a8d
MB		 2096 ;; so reset to beginning of file
2097 (goto-char (point-min))
2098 (setq last -134217728)
655591a7 2099
58090a8d
MB		 2100 ;; and throw a code that restarts this scan
2101 (throw 'problems t))
2102 nil))))))
df80b09f 2103
23f87bed
MB		 2104;; Keeps the compiler from warning about the free variable in
2105;; gnus-agent-read-agentview.
9efa445f 2106(defvar gnus-agent-read-agentview)
df80b09f 2107
23f87bed
MB		 2108(defun gnus-agent-load-alist (group)
2109 "Load the article-state alist for GROUP."
2110 ;; Bind free variable that's used in `gnus-agent-read-agentview'.
c25d60ab
LMI		 2111 (let* ((gnus-agent-read-agentview group)
2112 (file-name-coding-system nnmail-pathname-coding-system)
2113 (agentview (gnus-agent-article-name ".agentview" group)))
2114 (when (file-exists-p agentview)
2115 (setq gnus-agent-article-alist
2116 (gnus-cache-file-contents
2117 agentview
2118 'gnus-agent-file-loading-cache
2119 'gnus-agent-read-agentview)))))
23f87bed 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)
c9fc72fa 2167 ;; The agentview file is missing.
01c52d31
MB		 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)
c9fc72fa 2173 (file-attributes (directory-files-and-attributes
01c52d31
MB		 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
954c8060 2649(defvar gnus-agent-short-article 500
df80b09f
LMI		 2650 "Articles that have fewer lines than this are short.")
2651
954c8060 2652(defvar gnus-agent-long-article 1000
df80b09f
LMI		 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))
c9fc72fa 3263
01c52d31
MB		 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)))
5e7d4a75
KY		 3639 (if (or gnus-expert-user
3640 (gnus-y-or-n-p (format "Delete %s? " dir)))
23f87bed 3641 (let* (delete-recursive
01c52d31 3642 files f
23f87bed
MB		 3643 (delete-recursive
3644 (function
3645 (lambda (f-or-d)
3646 (ignore-errors
3647 (if (file-directory-p f-or-d)
3648 (condition-case nil
3649 (delete-directory f-or-d)
3650 (file-error
01c52d31
MB		 3651 (setq files (directory-files f-or-d))
3652 (while files
3653 (setq f (pop files))
3654 (or (member f '("." ".."))
3655 (funcall delete-recursive
3656 (nnheader-concat
3657 f-or-d f))))
23f87bed
MB		 3658 (delete-directory f-or-d)))
3659 (delete-file f-or-d)))))))
3660 (funcall delete-recursive dir))))))))))
df80b09f
LMI		 3661
3662;;;###autoload
3663(defun gnus-agent-batch ()
23f87bed 3664 "Start Gnus, send queue and fetch session."
df80b09f
LMI		 3665 (interactive)
3666 (let ((init-file-user "")
3667 (gnus-always-read-dribble-file t))
3668 (gnus))
23f87bed
MB		 3669 (let ((gnus-agent-confirmation-function 'gnus-agent-batch-confirmation))
3670 (gnus-group-send-queue)
3671 (gnus-agent-fetch-session)))
3672
3673(defun gnus-agent-unread-articles (group)
3674 (let* ((read (gnus-info-read (gnus-get-info group)))
3675 (known (gnus-agent-load-alist group))
3676 (unread (list nil))
3677 (tail-unread unread))
3678 (while (and known read)
3679 (let ((candidate (car (pop known))))
3680 (while (let* ((range (car read))
3681 (min (if (numberp range) range (car range)))
3682 (max (if (numberp range) range (cdr range))))
3683 (cond ((or (not min)
3684 (< candidate min))
3685 (gnus-agent-append-to-list tail-unread candidate)
3686 nil)
3687 ((> candidate max)
3688 (setq read (cdr read))
3689 ;; return t so that I always loop one more
3690 ;; time. If I just iterated off the end of
3691 ;; read, min will become nil and the current
3692 ;; candidate will be added to the unread list.
3693 t))))))
3694 (while known
3695 (gnus-agent-append-to-list tail-unread (car (pop known))))
3696 (cdr unread)))
3697
3698(defun gnus-agent-uncached-articles (articles group &optional cached-header)
3699 "Restrict ARTICLES to numbers already fetched.
54506618 3700Returns a sublist of ARTICLES that excludes those article ids in GROUP
23f87bed
MB		 3701that have already been fetched.
3702If CACHED-HEADER is nil, articles are only excluded if the article itself
3703has been fetched."
3704
3705 ;; Logically equivalent to: (gnus-sorted-difference articles (mapcar
3706 ;; 'car gnus-agent-article-alist))
3707
3708 ;; Functionally, I don't need to construct a temp list using mapcar.
3709
3710 (if (and (or gnus-agent-cache (not gnus-plugged))
3711 (gnus-agent-load-alist group))
3712 (let* ((ref gnus-agent-article-alist)
3713 (arts articles)
3714 (uncached (list nil))
3715 (tail-uncached uncached))
3716 (while (and ref arts)
3717 (let ((v1 (car arts))
3718 (v2 (caar ref)))
3719 (cond ((< v1 v2) ; v1 does not appear in the reference list
3720 (gnus-agent-append-to-list tail-uncached v1)
3721 (setq arts (cdr arts)))
3722 ((= v1 v2)
3723 (unless (or cached-header (cdar ref)) ; v1 is already cached
3724 (gnus-agent-append-to-list tail-uncached v1))
3725 (setq arts (cdr arts))
3726 (setq ref (cdr ref)))
3727 (t ; reference article (v2) preceeds the list being filtered
3728 (setq ref (cdr ref))))))
3729 (while arts
3730 (gnus-agent-append-to-list tail-uncached (pop arts)))
3731 (cdr uncached))
3732 ;; if gnus-agent-load-alist fails, no articles are cached.
3733 articles))
3734
3735(defun gnus-agent-retrieve-headers (articles group &optional fetch-old)
3736 (save-excursion
3737 (gnus-agent-create-buffer)
3738 (let ((gnus-decode-encoded-word-function 'identity)
5cedca8d 3739 (gnus-decode-encoded-address-function 'identity)
23f87bed 3740 (file (gnus-agent-article-name ".overview" group))
01c52d31
MB		 3741 cached-articles uncached-articles
3742 (file-name-coding-system nnmail-pathname-coding-system))
23f87bed
MB		 3743 (gnus-make-directory (nnheader-translate-file-chars
3744 (file-name-directory file) t))
3745
3746 ;; Populate temp buffer with known headers
3747 (when (file-exists-p file)
3748 (with-current-buffer gnus-agent-overview-buffer
3749 (erase-buffer)
3750 (let ((nnheader-file-coding-system
3751 gnus-agent-file-coding-system))
3752 (nnheader-insert-nov-file file (car articles)))))
3753
3754 (if (setq uncached-articles (gnus-agent-uncached-articles articles group
3755 t))
3756 (progn
3757 ;; Populate nntp-server-buffer with uncached headers
3758 (set-buffer nntp-server-buffer)
3759 (erase-buffer)
3760 (cond ((not (eq 'nov (let (gnus-agent) ; Turn off agent
3761 (gnus-retrieve-headers
3762 uncached-articles group fetch-old))))
3763 (nnvirtual-convert-headers))
3764 ((eq 'nntp (car gnus-current-select-method))
3765 ;; The author of gnus-get-newsgroup-headers-xover
3766 ;; reports that the XOVER command is commonly
3767 ;; unreliable. The problem is that recently
3768 ;; posted articles may not be entered into the
3769 ;; NOV database in time to respond to my XOVER
3770 ;; query.
3771 ;;
3772 ;; I'm going to use his assumption that the NOV
3773 ;; database is updated in order of ascending
3774 ;; article ID. Therefore, a response containing
3775 ;; article ID N implies that all articles from 1
3776 ;; to N-1 are up-to-date. Therefore, missing
3777 ;; articles in that range have expired.
3778
3779 (set-buffer nntp-server-buffer)
3780 (let* ((fetched-articles (list nil))
3781 (tail-fetched-articles fetched-articles)
3782 (min (cond ((numberp fetch-old)
3783 (max 1 (- (car articles) fetch-old)))
3784 (fetch-old
3785 1)
3786 (t
3787 (car articles))))
3788 (max (car (last articles))))
3789
3790 ;; Get the list of articles that were fetched
3791 (goto-char (point-min))
54506618
MB		 3792 (let ((pm (point-max))
3793 art)
23f87bed 3794 (while (< (point) pm)
54506618
MB		 3795 (when (setq art (gnus-agent-read-article-number))
3796 (gnus-agent-append-to-list tail-fetched-articles art))
23f87bed
MB		 3797 (forward-line 1)))
3798
3799 ;; Clip this list to the headers that will
3800 ;; actually be returned
3801 (setq fetched-articles (gnus-list-range-intersection
3802 (cdr fetched-articles)
3803 (cons min max)))
3804
3805 ;; Clip the uncached articles list to exclude
3806 ;; IDs after the last FETCHED header. The
3807 ;; excluded IDs may be fetchable using HEAD.
3808 (if (car tail-fetched-articles)
3809 (setq uncached-articles
3810 (gnus-list-range-intersection
3811 uncached-articles
3812 (cons (car uncached-articles)
3813 (car tail-fetched-articles)))))
3814
3815 ;; Create the list of articles that were
3816 ;; "successfully" fetched. Success, in this
3817 ;; case, means that the ID should not be
3818 ;; fetched again. In the case of an expired
3819 ;; article, the header will not be fetched.
3820 (setq uncached-articles
3821 (gnus-sorted-nunion fetched-articles
3822 uncached-articles))
3823 )))
3824
3825 ;; Erase the temp buffer
3826 (set-buffer gnus-agent-overview-buffer)
3827 (erase-buffer)
3828
3829 ;; Copy the nntp-server-buffer to the temp buffer
3830 (set-buffer nntp-server-buffer)
3831 (copy-to-buffer gnus-agent-overview-buffer (point-min) (point-max))
3832
54506618
MB		 3833 ;; Merge the temp buffer with the known headers (found on
3834 ;; disk in FILE) into the nntp-server-buffer
3835 (when uncached-articles
23f87bed
MB		 3836 (gnus-agent-braid-nov group uncached-articles file))
3837
54506618 3838 ;; Save the new set of known headers to FILE
23f87bed
MB		 3839 (set-buffer nntp-server-buffer)
3840 (let ((coding-system-for-write
3841 gnus-agent-file-coding-system))
3842 (gnus-agent-check-overview-buffer)
3843 (write-region (point-min) (point-max) file nil 'silent))
3844
01c52d31
MB		 3845 (gnus-agent-update-view-total-fetched-for group t)
3846
23f87bed
MB		 3847 ;; Update the group's article alist to include the newly
3848 ;; fetched articles.
3849 (gnus-agent-load-alist group)
3850 (gnus-agent-save-alist group uncached-articles nil)
3851 )
3852
3853 ;; Copy the temp buffer to the nntp-server-buffer
3854 (set-buffer nntp-server-buffer)
3855 (erase-buffer)
3856 (insert-buffer-substring gnus-agent-overview-buffer)))
3857
3858 (if (and fetch-old
3859 (not (numberp fetch-old)))
3860 t ; Don't remove anything.
3861 (nnheader-nov-delete-outside-range
3862 (if fetch-old (max 1 (- (car articles) fetch-old))
3863 (car articles))
3864 (car (last articles)))
3865 t)
3866
3867 'nov))
3868
3869(defun gnus-agent-request-article (article group)
3870 "Retrieve ARTICLE in GROUP from the agent cache."
3871 (when (and gnus-agent
3872 (or gnus-agent-cache
3873 (not gnus-plugged))
3874 (numberp article))
3875 (let* ((gnus-command-method (gnus-find-method-for-group group))
3876 (file (gnus-agent-article-name (number-to-string article) group))
01c52d31
MB		 3877 (buffer-read-only nil)
3878 (file-name-coding-system nnmail-pathname-coding-system))
23f87bed
MB		 3879 (when (and (file-exists-p file)
3880 (> (nth 7 (file-attributes file)) 0))
3881 (erase-buffer)
3882 (gnus-kill-all-overlays)
3883 (let ((coding-system-for-read gnus-cache-coding-system))
3884 (insert-file-contents file))
3885 t))))
3886
3887(defun gnus-agent-regenerate-group (group &optional reread)
3888 "Regenerate GROUP.
3889If REREAD is t, all articles in the .overview are marked as unread.
3890If REREAD is a list, the specified articles will be marked as unread.
3891In addition, their NOV entries in .overview will be refreshed using
3892the articles' current headers.
3893If REREAD is not nil, downloaded articles are marked as unread."
3894 (interactive
01c52d31 3895 (list (gnus-agent-read-group)
23f87bed
MB		 3896 (catch 'mark
3897 (while (let (c
3898 (cursor-in-echo-area t)
3899 (echo-keystrokes 0))
3900 (message "Mark as unread: (n)one / (a)ll / all (d)ownloaded articles? (n) ")
3901 (setq c (read-char-exclusive))
3902
3903 (cond ((or (eq c ?\r) (eq c ?n) (eq c ?N))
3904 (throw 'mark nil))
3905 ((or (eq c ?a) (eq c ?A))
3906 (throw 'mark t))
3907 ((or (eq c ?d) (eq c ?D))
3908 (throw 'mark 'some)))
3909 (gnus-message 3 "Ignoring unexpected input")
3910 (sit-for 1)
3911 t)))))
23f87bed 3912 (when group
ec7995fa 3913 (gnus-message 5 "Regenerating in %s" (gnus-agent-decoded-group-name group))
01c52d31
MB		 3914 (let* ((gnus-command-method (or gnus-command-method
3915 (gnus-find-method-for-group group)))
3916 (file (gnus-agent-article-name ".overview" group))
3917 (dir (file-name-directory file))
3918 point
3919 (file-name-coding-system nnmail-pathname-coding-system)
3920 (downloaded (if (file-exists-p dir)
655591a7 3921 (sort (delq nil (mapcar (lambda (name)
26c9afc3
MB		 3922 (and (not (file-directory-p (nnheader-concat dir name)))
3923 (string-to-number name)))
3924 (directory-files dir nil "^[0-9]+$" t)))
01c52d31
MB		 3925 '>)
3926 (progn (gnus-make-directory dir) nil)))
3927 dl nov-arts
3928 alist header
3929 regenerated)
3930
3931 (mm-with-unibyte-buffer
3932 (if (file-exists-p file)
3933 (let ((nnheader-file-coding-system
3934 gnus-agent-file-coding-system))
3935 (nnheader-insert-file-contents file)))
3936 (set-buffer-modified-p nil)
3937
3938 ;; Load the article IDs found in the overview file. As a
3939 ;; side-effect, validate the file contents.
3940 (let ((load t))
3941 (while load
3942 (setq load nil)
3943 (goto-char (point-min))
3944 (while (< (point) (point-max))
3945 (cond ((and (looking-at "[0-9]+\t")
3946 (<= (- (match-end 0) (match-beginning 0)) 9))
3947 (push (read (current-buffer)) nov-arts)
3948 (forward-line 1)
3949 (let ((l1 (car nov-arts))
3950 (l2 (cadr nov-arts)))
3951 (cond ((and (listp reread) (memq l1 reread))
3952 (gnus-delete-line)
3953 (setq nov-arts (cdr nov-arts))
3954 (gnus-message 4 "gnus-agent-regenerate-group: NOV\
54506618 3955 entry of article %s deleted." l1))
01c52d31
MB		 3956 ((not l2)
3957 nil)
3958 ((< l1 l2)
3959 (gnus-message 3 "gnus-agent-regenerate-group: NOV\
23f87bed 3960 entries are NOT in ascending order.")
01c52d31
MB		 3961 ;; Don't sort now as I haven't verified
3962 ;; that every line begins with a number
3963 (setq load t))
3964 ((= l1 l2)
3965 (forward-line -1)
3966 (gnus-message 4 "gnus-agent-regenerate-group: NOV\
3967 entries contained duplicate of article %s. Duplicate deleted." l1)
3968 (gnus-delete-line)
3969 (setq nov-arts (cdr nov-arts))))))
3970 (t
3971 (gnus-message 1 "gnus-agent-regenerate-group: NOV\
23f87bed
MB		 3972 entries contained line that did not begin with an article number. Deleted\
3973 line.")
01c52d31
MB		 3974 (gnus-delete-line))))
3975 (when load
3976 (gnus-message 5 "gnus-agent-regenerate-group: Sorting NOV\
23f87bed 3977 entries into ascending order.")
01c52d31
MB		 3978 (sort-numeric-fields 1 (point-min) (point-max))
3979 (setq nov-arts nil))))
3980 (gnus-agent-check-overview-buffer)
3981
3982 ;; Construct a new article alist whose nodes match every header
3983 ;; in the .overview file. As a side-effect, missing headers are
3984 ;; reconstructed from the downloaded article file.
3985 (while (or downloaded nov-arts)
3986 (cond ((and downloaded
3987 (or (not nov-arts)
3988 (> (car downloaded) (car nov-arts))))
3989 ;; This entry is missing from the overview file
ec7995fa
KY		 3990 (gnus-message 3 "Regenerating NOV %s %d..."
3991 (gnus-agent-decoded-group-name group)
01c52d31
MB		 3992 (car downloaded))
3993 (let ((file (concat dir (number-to-string (car downloaded)))))
3994 (mm-with-unibyte-buffer
3995 (nnheader-insert-file-contents file)
3996 (nnheader-remove-body)
3997 (setq header (nnheader-parse-naked-head)))
3998 (mail-header-set-number header (car downloaded))
3999 (if nov-arts
4000 (let ((key (concat "^" (int-to-string (car nov-arts))
4001 "\t")))
4002 (or (re-search-backward key nil t)
4003 (re-search-forward key))
4004 (forward-line 1))
4005 (goto-char (point-min)))
4006 (nnheader-insert-nov header))
4007 (setq nov-arts (cons (car downloaded) nov-arts)))
4008 ((eq (car downloaded) (car nov-arts))
4009 ;; This entry in the overview has been downloaded
4010 (push (cons (car downloaded)
4011 (time-to-days
4012 (nth 5 (file-attributes
4013 (concat dir (number-to-string
4014 (car downloaded))))))) alist)
4015 (setq downloaded (cdr downloaded))
4016 (setq nov-arts (cdr nov-arts)))
4017 (t
4018 ;; This entry in the overview has not been downloaded
4019 (push (cons (car nov-arts) nil) alist)
4020 (setq nov-arts (cdr nov-arts)))))
4021
4022 ;; When gnus-agent-consider-all-articles is set,
4023 ;; gnus-agent-regenerate-group should NOT remove article IDs from
4024 ;; the alist. Those IDs serve as markers to indicate that an
4025 ;; attempt has been made to fetch that article's header.
4026
4027 ;; When gnus-agent-consider-all-articles is NOT set,
4028 ;; gnus-agent-regenerate-group can remove the article ID of every
4029 ;; article (with the exception of the last ID in the list - it's
4030 ;; special) that no longer appears in the overview. In this
4031 ;; situtation, the last article ID in the list implies that it,
4032 ;; and every article ID preceeding it, have been fetched from the
4033 ;; server.
4034
4035 (if gnus-agent-consider-all-articles
4036 ;; Restore all article IDs that were not found in the overview file.
4037 (let* ((n (cons nil alist))
4038 (merged n)
4039 (o (gnus-agent-load-alist group)))
4040 (while o
4041 (let ((nID (caadr n))
4042 (oID (caar o)))
4043 (cond ((not nID)
4044 (setq n (setcdr n (list (list oID))))
4045 (setq o (cdr o)))
4046 ((< oID nID)
4047 (setcdr n (cons (list oID) (cdr n)))
4048 (setq o (cdr o)))
4049 ((= oID nID)
4050 (setq o (cdr o))
4051 (setq n (cdr n)))
4052 (t
4053 (setq n (cdr n))))))
4054 (setq alist (cdr merged)))
4055 ;; Restore the last article ID if it is not already in the new alist
4056 (let ((n (last alist))
4057 (o (last (gnus-agent-load-alist group))))
4058 (cond ((not o)
4059 nil)
4060 ((not n)
4061 (push (cons (caar o) nil) alist))
4062 ((< (caar n) (caar o))
4063 (setcdr n (list (car o)))))))
4064
4065 (let ((inhibit-quit t))
4066 (if (setq regenerated (buffer-modified-p))
4067 (let ((coding-system-for-write gnus-agent-file-coding-system))
4068 (write-region (point-min) (point-max) file nil 'silent)))
4069
4070 (setq regenerated (or regenerated
4071 (and reread gnus-agent-article-alist)
4072 (not (equal alist gnus-agent-article-alist))))
4073
4074 (setq gnus-agent-article-alist alist)
4075
4076 (when regenerated
4077 (gnus-agent-save-alist group)
4078
4079 ;; I have to alter the group's active range NOW as
4080 ;; gnus-make-ascending-articles-unread will use it to
4081 ;; recalculate the number of unread articles in the group
4082
4083 (let ((group (gnus-group-real-name group))
4084 (group-active (or (gnus-active group)
4085 (gnus-activate-group group))))
4086 (gnus-agent-possibly-alter-active group group-active)))))
4087
4088 (when (and reread gnus-agent-article-alist)
655591a7 4089 (gnus-agent-synchronize-group-flags
01c52d31 4090 group
58090a8d 4091 (list (list
01c52d31
MB		 4092 (if (listp reread)
4093 reread
4094 (delq nil (mapcar (function (lambda (c)
4095 (cond ((eq reread t)
4096 (car c))
4097 ((cdr c)
4098 (car c)))))
58090a8d
MB		 4099 gnus-agent-article-alist)))
4100 'del '(read)))
4101 gnus-command-method)
23f87bed 4102
01c52d31
MB		 4103 (when regenerated
4104 (gnus-agent-update-files-total-fetched-for group nil)))
23f87bed 4105
01c52d31
MB		 4106 (gnus-message 5 "")
4107 regenerated)))
23f87bed
MB		 4108
4109;;;###autoload
4110(defun gnus-agent-regenerate (&optional clean reread)
4111 "Regenerate all agent covered files.
4112If CLEAN, obsolete (ignore)."
4113 (interactive "P")
4114 (let (regenerated)
4115 (gnus-message 4 "Regenerating Gnus agent files...")
4116 (dolist (gnus-command-method (gnus-agent-covered-methods))
4117 (dolist (group (gnus-groups-from-server gnus-command-method))
4118 (setq regenerated (or (gnus-agent-regenerate-group group reread)
4119 regenerated))))
4120 (gnus-message 4 "Regenerating Gnus agent files...done")
4121
4122 regenerated))
4123
4124(defun gnus-agent-go-online (&optional force)
4125 "Switch servers into online status."
4126 (interactive (list t))
4127 (dolist (server gnus-opened-servers)
4128 (when (eq (nth 1 server) 'offline)
4129 (if (if (eq force 'ask)
4130 (gnus-y-or-n-p
4131 (format "Switch %s:%s into online status? "
4132 (caar server) (cadar server)))
4133 force)
4134 (setcar (nthcdr 1 server) 'close)))))
4135
4136(defun gnus-agent-toggle-group-plugged (group)
4137 "Toggle the status of the server of the current group."
4138 (interactive (list (gnus-group-group-name)))
4139 (let* ((method (gnus-find-method-for-group group))
4140 (status (cadr (assoc method gnus-opened-servers))))
4141 (if (eq status 'offline)
4142 (gnus-server-set-status method 'closed)
4143 (gnus-close-server method)
4144 (gnus-server-set-status method 'offline))
4145 (message "Turn %s:%s from %s to %s." (car method) (cadr method)
4146 (if (eq status 'offline) 'offline 'online)
4147 (if (eq status 'offline) 'online 'offline))))
4148
4149(defun gnus-agent-group-covered-p (group)
4150 (gnus-agent-method-p (gnus-group-method group)))
4151
01c52d31
MB		 4152(defun gnus-agent-update-files-total-fetched-for
4153 (group delta &optional method path)
4154 "Update, or set, the total disk space used by the articles that the
4155agent has fetched."
4156 (when gnus-agent-total-fetched-hashtb
4157 (gnus-agent-with-refreshed-group
4158 group
4159 ;; if null, gnus-agent-group-pathname will calc method.
4160 (let* ((gnus-command-method method)
4161 (path (or path (gnus-agent-group-pathname group)))
4162 (entry (or (gnus-gethash path gnus-agent-total-fetched-hashtb)
4163 (gnus-sethash path (make-list 3 0)
4164 gnus-agent-total-fetched-hashtb)))
4165 (file-name-coding-system nnmail-pathname-coding-system))
4166 (when (listp delta)
4167 (if delta
4168 (let ((sum 0.0)
4169 file)
4170 (while (setq file (pop delta))
4171 (incf sum (float (or (nth 7 (file-attributes
4172 (nnheader-concat
4173 path
4174 (if (numberp file)
4175 (number-to-string file)
4176 file)))) 0))))
4177 (setq delta sum))
4178 (let ((sum (- (nth 2 entry)))
4179 (info (directory-files-and-attributes path nil "^-?[0-9]+$" t))
4180 file)
4181 (while (setq file (pop info))
4182 (incf sum (float (or (nth 8 file) 0))))
4183 (setq delta sum))))
4184
4185 (setq gnus-agent-need-update-total-fetched-for t)
4186 (incf (nth 2 entry) delta)))))
4187
4188(defun gnus-agent-update-view-total-fetched-for
4189 (group agent-over &optional method path)
4190 "Update, or set, the total disk space used by the .agentview and
4191.overview files. These files are calculated separately as they can be
4192modified."
4193 (when gnus-agent-total-fetched-hashtb
4194 (gnus-agent-with-refreshed-group
4195 group
4196 ;; if null, gnus-agent-group-pathname will calc method.
4197 (let* ((gnus-command-method method)
4198 (path (or path (gnus-agent-group-pathname group)))
4199 (entry (or (gnus-gethash path gnus-agent-total-fetched-hashtb)
4200 (gnus-sethash path (make-list 3 0)
4201 gnus-agent-total-fetched-hashtb)))
4202 (file-name-coding-system nnmail-pathname-coding-system)
4203 (size (or (nth 7 (file-attributes
4204 (nnheader-concat
4205 path (if agent-over
4206 ".overview"
4207 ".agentview"))))
4208 0)))
4209 (setq gnus-agent-need-update-total-fetched-for t)
4210 (setf (nth (if agent-over 1 0) entry) size)))))
4211
4212(defun gnus-agent-total-fetched-for (group &optional method no-inhibit)
4213 "Get the total disk space used by the specified GROUP."
4214 (unless (equal group "dummy.group")
4215 (unless gnus-agent-total-fetched-hashtb
4216 (setq gnus-agent-total-fetched-hashtb (gnus-make-hashtable 1024)))
4217
4218 ;; if null, gnus-agent-group-pathname will calc method.
4219 (let* ((gnus-command-method method)
4220 (path (gnus-agent-group-pathname group))
4221 (entry (gnus-gethash path gnus-agent-total-fetched-hashtb)))
4222 (if entry
4223 (apply '+ entry)
4224 (let ((gnus-agent-inhibit-update-total-fetched-for (not no-inhibit)))
4225 (+
4226 (gnus-agent-update-view-total-fetched-for group nil method path)
4227 (gnus-agent-update-view-total-fetched-for group t method path)
4228 (gnus-agent-update-files-total-fetched-for group nil method path)))))))
4229
df80b09f
LMI		 4230(provide 'gnus-agent)
4231
4232;;; gnus-agent.el ends here
Unnamed repository; edit this file 'description' to name the repository.