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