Commit | Line | Data |
---|---|---|
eec82323 | 1 | ;;; gnus-cache.el --- cache interface for Gnus |
e84b4b86 | 2 | |
91472578 | 3 | ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, |
d7a0267c | 4 | ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
eec82323 | 5 | |
6748645f | 6 | ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org> |
eec82323 LMI |
7 | ;; Keywords: news |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
5a9dffec | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
eec82323 LMI |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
3a35cf56 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
eec82323 LMI |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;;; Code: | |
29 | ||
7df7482d RS |
30 | (eval-when-compile (require 'cl)) |
31 | ||
eec82323 | 32 | (require 'gnus) |
eec82323 | 33 | (eval-when-compile |
01c52d31 | 34 | (unless (fboundp 'gnus-agent-load-alist) |
23f87bed | 35 | (defun gnus-agent-load-alist (group))) |
eec82323 LMI |
36 | (require 'gnus-sum)) |
37 | ||
eec82323 | 38 | (defcustom gnus-cache-active-file |
6ab8077a | 39 | (expand-file-name "active" gnus-cache-directory) |
eec82323 LMI |
40 | "*The cache active file." |
41 | :group 'gnus-cache | |
42 | :type 'file) | |
43 | ||
44 | (defcustom gnus-cache-enter-articles '(ticked dormant) | |
45 | "Classes of articles to enter into the cache." | |
46 | :group 'gnus-cache | |
47 | :type '(set (const ticked) (const dormant) (const unread) (const read))) | |
48 | ||
49 | (defcustom gnus-cache-remove-articles '(read) | |
50 | "Classes of articles to remove from the cache." | |
51 | :group 'gnus-cache | |
52 | :type '(set (const ticked) (const dormant) (const unread) (const read))) | |
53 | ||
6748645f LMI |
54 | (defcustom gnus-cacheable-groups nil |
55 | "*Groups that match this regexp will be cached. | |
56 | ||
57 | If you only want to cache your nntp groups, you could set this | |
58 | variable to \"^nntp\". | |
59 | ||
60 | If a group matches both gnus-cacheable-groups and gnus-uncacheable-groups | |
61 | it's not cached." | |
62 | :group 'gnus-cache | |
63 | :type '(choice (const :tag "off" nil) | |
16409b0b | 64 | regexp)) |
6748645f | 65 | |
eec82323 LMI |
66 | (defcustom gnus-uncacheable-groups nil |
67 | "*Groups that match this regexp will not be cached. | |
68 | ||
69 | If you want to avoid caching your nnml groups, you could set this | |
6748645f LMI |
70 | variable to \"^nnml\". |
71 | ||
72 | If a group matches both gnus-cacheable-groups and gnus-uncacheable-groups | |
73 | it's not cached." | |
eec82323 LMI |
74 | :group 'gnus-cache |
75 | :type '(choice (const :tag "off" nil) | |
76 | regexp)) | |
77 | ||
6748645f LMI |
78 | (defvar gnus-cache-overview-coding-system 'raw-text |
79 | "Coding system used on Gnus cache files.") | |
80 | ||
16409b0b GM |
81 | (defvar gnus-cache-coding-system 'raw-text |
82 | "Coding system used on Gnus cache files.") | |
83 | ||
eec82323 LMI |
84 | \f |
85 | ||
86 | ;;; Internal variables. | |
87 | ||
88 | (defvar gnus-cache-removable-articles nil) | |
89 | (defvar gnus-cache-buffer nil) | |
90 | (defvar gnus-cache-active-hashtb nil) | |
91 | (defvar gnus-cache-active-altered nil) | |
01c52d31 | 92 | (defvar gnus-cache-total-fetched-hashtb nil) |
eec82323 LMI |
93 | |
94 | (eval-and-compile | |
95 | (autoload 'nnml-generate-nov-databases-1 "nnml") | |
96 | (autoload 'nnvirtual-find-group-art "nnvirtual")) | |
97 | ||
98 | \f | |
99 | ||
100 | ;;; Functions called from Gnus. | |
101 | ||
102 | (defun gnus-cache-open () | |
103 | "Initialize the cache." | |
104 | (when (or (file-exists-p gnus-cache-directory) | |
105 | (and gnus-use-cache | |
106 | (not (eq gnus-use-cache 'passive)))) | |
107 | (gnus-cache-read-active))) | |
108 | ||
109 | ;; Complexities of byte-compiling make this kludge necessary. Eeek. | |
110 | (ignore-errors | |
111 | (gnus-add-shutdown 'gnus-cache-close 'gnus)) | |
112 | ||
113 | (defun gnus-cache-close () | |
114 | "Shut down the cache." | |
115 | (gnus-cache-write-active) | |
116 | (gnus-cache-save-buffers) | |
117 | (setq gnus-cache-active-hashtb nil)) | |
118 | ||
119 | (defun gnus-cache-save-buffers () | |
120 | ;; save the overview buffer if it exists and has been modified | |
121 | ;; delete empty cache subdirectories | |
122 | (when gnus-cache-buffer | |
123 | (let ((buffer (cdr gnus-cache-buffer)) | |
124 | (overview-file (gnus-cache-file-name | |
125 | (car gnus-cache-buffer) ".overview"))) | |
126 | ;; write the overview only if it was modified | |
f4dd4ae8 MB |
127 | (when (and (buffer-live-p buffer) (buffer-modified-p buffer)) |
128 | (with-current-buffer buffer | |
eec82323 LMI |
129 | (if (> (buffer-size) 0) |
130 | ;; Non-empty overview, write it to a file. | |
6748645f LMI |
131 | (let ((coding-system-for-write |
132 | gnus-cache-overview-coding-system)) | |
133 | (gnus-write-buffer overview-file)) | |
01c52d31 MB |
134 | (let ((file-name-coding-system nnmail-pathname-coding-system)) |
135 | ;; Empty overview file, remove it | |
136 | (when (file-exists-p overview-file) | |
137 | (delete-file overview-file)) | |
138 | ;; If possible, remove group's cache subdirectory. | |
139 | (condition-case nil | |
140 | ;; FIXME: we can detect the error type and warn the user | |
141 | ;; of any inconsistencies (articles w/o nov entries?). | |
142 | ;; for now, just be conservative...delete only if safe -- sj | |
143 | (delete-directory (file-name-directory overview-file)) | |
144 | (error)))) | |
145 | ||
146 | (gnus-cache-update-overview-total-fetched-for | |
147 | (car gnus-cache-buffer) overview-file))) | |
eec82323 LMI |
148 | ;; Kill the buffer -- it's either unmodified or saved. |
149 | (gnus-kill-buffer buffer) | |
150 | (setq gnus-cache-buffer nil)))) | |
151 | ||
152 | (defun gnus-cache-possibly-enter-article | |
16409b0b | 153 | (group article ticked dormant unread &optional force) |
eec82323 LMI |
154 | (when (and (or force (not (eq gnus-use-cache 'passive))) |
155 | (numberp article) | |
16409b0b | 156 | (> article 0)) ; This might be a dummy article. |
01c52d31 MB |
157 | (let ((number article) |
158 | file headers lines-chars | |
159 | (file-name-coding-system nnmail-pathname-coding-system)) | |
16409b0b GM |
160 | ;; If this is a virtual group, we find the real group. |
161 | (when (gnus-virtual-group-p group) | |
162 | (let ((result (nnvirtual-find-group-art | |
163 | (gnus-group-real-name group) article))) | |
164 | (setq group (car result) | |
165 | number (cdr result)))) | |
a8151ef7 LMI |
166 | (when (and number |
167 | (> number 0) ; Reffed article. | |
eec82323 | 168 | (or force |
23f87bed | 169 | (and (gnus-cache-fully-p group) |
eec82323 LMI |
170 | (gnus-cache-member-of-class |
171 | gnus-cache-enter-articles ticked dormant unread))) | |
172 | (not (file-exists-p (setq file (gnus-cache-file-name | |
173 | group number))))) | |
174 | ;; Possibly create the cache directory. | |
6748645f | 175 | (gnus-make-directory (file-name-directory file)) |
eec82323 LMI |
176 | ;; Save the article in the cache. |
177 | (if (file-exists-p file) | |
178 | t ; The article already is saved. | |
179 | (save-excursion | |
180 | (set-buffer nntp-server-buffer) | |
16409b0b GM |
181 | (require 'gnus-art) |
182 | (let ((gnus-use-cache nil) | |
183 | (gnus-article-decode-hook nil)) | |
eec82323 LMI |
184 | (gnus-request-article-this-buffer number group)) |
185 | (when (> (buffer-size) 0) | |
16409b0b | 186 | (let ((coding-system-for-write gnus-cache-coding-system)) |
01c52d31 MB |
187 | (gnus-write-buffer file) |
188 | (gnus-cache-update-file-total-fetched-for group file)) | |
189 | (setq lines-chars (nnheader-get-lines-and-char)) | |
23f87bed MB |
190 | (nnheader-remove-body) |
191 | (setq headers (nnheader-parse-naked-head)) | |
16409b0b | 192 | (mail-header-set-number headers number) |
01c52d31 MB |
193 | (mail-header-set-lines headers (car lines-chars)) |
194 | (mail-header-set-chars headers (cadr lines-chars)) | |
eec82323 LMI |
195 | (gnus-cache-change-buffer group) |
196 | (set-buffer (cdr gnus-cache-buffer)) | |
197 | (goto-char (point-max)) | |
198 | (forward-line -1) | |
199 | (while (condition-case () | |
200 | (when (not (bobp)) | |
201 | (> (read (current-buffer)) number)) | |
202 | (error | |
203 | ;; The line was malformed, so we just remove it!! | |
204 | (gnus-delete-line) | |
205 | t)) | |
206 | (forward-line -1)) | |
207 | (if (bobp) | |
208 | (if (not (eobp)) | |
209 | (progn | |
210 | (beginning-of-line) | |
211 | (when (< (read (current-buffer)) number) | |
212 | (forward-line 1))) | |
213 | (beginning-of-line)) | |
214 | (forward-line 1)) | |
215 | (beginning-of-line) | |
16409b0b | 216 | (nnheader-insert-nov headers) |
eec82323 LMI |
217 | ;; Update the active info. |
218 | (set-buffer gnus-summary-buffer) | |
23f87bed MB |
219 | (gnus-cache-possibly-update-active group (cons number number)) |
220 | (setq gnus-newsgroup-cached | |
221 | (gnus-add-to-sorted-list gnus-newsgroup-cached article)) | |
eec82323 LMI |
222 | (gnus-summary-update-secondary-mark article)) |
223 | t)))))) | |
224 | ||
225 | (defun gnus-cache-enter-remove-article (article) | |
226 | "Mark ARTICLE for later possible removal." | |
227 | (when article | |
228 | (push article gnus-cache-removable-articles))) | |
229 | ||
230 | (defun gnus-cache-possibly-remove-articles () | |
231 | "Possibly remove some of the removable articles." | |
232 | (if (not (gnus-virtual-group-p gnus-newsgroup-name)) | |
233 | (gnus-cache-possibly-remove-articles-1) | |
234 | (let ((arts gnus-cache-removable-articles) | |
235 | ga) | |
236 | (while arts | |
237 | (when (setq ga (nnvirtual-find-group-art | |
238 | (gnus-group-real-name gnus-newsgroup-name) (pop arts))) | |
239 | (let ((gnus-cache-removable-articles (list (cdr ga))) | |
240 | (gnus-newsgroup-name (car ga))) | |
241 | (gnus-cache-possibly-remove-articles-1))))) | |
242 | (setq gnus-cache-removable-articles nil))) | |
243 | ||
244 | (defun gnus-cache-possibly-remove-articles-1 () | |
245 | "Possibly remove some of the removable articles." | |
23f87bed | 246 | (when (gnus-cache-fully-p gnus-newsgroup-name) |
01c52d31 | 247 | (let ((cache-articles gnus-newsgroup-cached)) |
eec82323 | 248 | (gnus-cache-change-buffer gnus-newsgroup-name) |
01c52d31 MB |
249 | (dolist (article gnus-cache-removable-articles) |
250 | (when (memq article cache-articles) | |
eec82323 LMI |
251 | ;; The article was in the cache, so we see whether we are |
252 | ;; supposed to remove it from the cache. | |
253 | (gnus-cache-possibly-remove-article | |
254 | article (memq article gnus-newsgroup-marked) | |
255 | (memq article gnus-newsgroup-dormant) | |
256 | (or (memq article gnus-newsgroup-unreads) | |
257 | (memq article gnus-newsgroup-unselected)))))) | |
258 | ;; The overview file might have been modified, save it | |
259 | ;; safe because we're only called at group exit anyway. | |
260 | (gnus-cache-save-buffers))) | |
261 | ||
262 | (defun gnus-cache-request-article (article group) | |
263 | "Retrieve ARTICLE in GROUP from the cache." | |
264 | (let ((file (gnus-cache-file-name group article)) | |
01c52d31 MB |
265 | (buffer-read-only nil) |
266 | (file-name-coding-system nnmail-pathname-coding-system)) | |
eec82323 LMI |
267 | (when (file-exists-p file) |
268 | (erase-buffer) | |
269 | (gnus-kill-all-overlays) | |
16409b0b GM |
270 | (let ((coding-system-for-read gnus-cache-coding-system)) |
271 | (insert-file-contents file)) | |
eec82323 LMI |
272 | t))) |
273 | ||
274 | (defun gnus-cache-possibly-alter-active (group active) | |
275 | "Alter the ACTIVE info for GROUP to reflect the articles in the cache." | |
eec82323 LMI |
276 | (when gnus-cache-active-hashtb |
277 | (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb))) | |
a8151ef7 LMI |
278 | (when cache-active |
279 | (when (< (car cache-active) (car active)) | |
280 | (setcar active (car cache-active))) | |
281 | (when (> (cdr cache-active) (cdr active)) | |
282 | (setcdr active (cdr cache-active))))))) | |
eec82323 LMI |
283 | |
284 | (defun gnus-cache-retrieve-headers (articles group &optional fetch-old) | |
285 | "Retrieve the headers for ARTICLES in GROUP." | |
286 | (let ((cached | |
287 | (setq gnus-newsgroup-cached (gnus-cache-articles-in-group group)))) | |
288 | (if (not cached) | |
289 | ;; No cached articles here, so we just retrieve them | |
290 | ;; the normal way. | |
291 | (let ((gnus-use-cache nil)) | |
292 | (gnus-retrieve-headers articles group fetch-old)) | |
23f87bed | 293 | (let ((uncached-articles (gnus-sorted-difference articles cached)) |
eec82323 | 294 | (cache-file (gnus-cache-file-name group ".overview")) |
01c52d31 MB |
295 | type |
296 | (file-name-coding-system nnmail-pathname-coding-system)) | |
eec82323 LMI |
297 | ;; We first retrieve all the headers that we don't have in |
298 | ;; the cache. | |
299 | (let ((gnus-use-cache nil)) | |
300 | (when uncached-articles | |
301 | (setq type (and articles | |
302 | (gnus-retrieve-headers | |
303 | uncached-articles group fetch-old))))) | |
304 | (gnus-cache-save-buffers) | |
305 | ;; Then we insert the cached headers. | |
306 | (save-excursion | |
307 | (cond | |
308 | ((not (file-exists-p cache-file)) | |
309 | ;; There are no cached headers. | |
310 | type) | |
311 | ((null type) | |
312 | ;; There were no uncached headers (or retrieval was | |
313 | ;; unsuccessful), so we use the cached headers exclusively. | |
314 | (set-buffer nntp-server-buffer) | |
315 | (erase-buffer) | |
a1506d29 | 316 | (let ((coding-system-for-read |
16409b0b GM |
317 | gnus-cache-overview-coding-system)) |
318 | (insert-file-contents cache-file)) | |
eec82323 LMI |
319 | 'nov) |
320 | ((eq type 'nov) | |
321 | ;; We have both cached and uncached NOV headers, so we | |
322 | ;; braid them. | |
323 | (gnus-cache-braid-nov group cached) | |
324 | type) | |
325 | (t | |
326 | ;; We braid HEADs. | |
327 | (gnus-cache-braid-heads group (gnus-sorted-intersection | |
328 | cached articles)) | |
329 | type))))))) | |
330 | ||
331 | (defun gnus-cache-enter-article (&optional n) | |
332 | "Enter the next N articles into the cache. | |
333 | If not given a prefix, use the process marked articles instead. | |
334 | Returns the list of articles entered." | |
335 | (interactive "P") | |
01c52d31 MB |
336 | (let (out) |
337 | (dolist (article (gnus-summary-work-articles n)) | |
6748645f | 338 | (gnus-summary-remove-process-mark article) |
eec82323 LMI |
339 | (if (natnump article) |
340 | (when (gnus-cache-possibly-enter-article | |
341 | gnus-newsgroup-name article | |
eec82323 | 342 | nil nil nil t) |
23f87bed | 343 | (setq gnus-newsgroup-undownloaded (delq article gnus-newsgroup-undownloaded)) |
eec82323 LMI |
344 | (push article out)) |
345 | (gnus-message 2 "Can't cache article %d" article)) | |
23f87bed | 346 | (gnus-summary-update-download-mark article) |
eec82323 LMI |
347 | (gnus-summary-update-secondary-mark article)) |
348 | (gnus-summary-next-subject 1) | |
349 | (gnus-summary-position-point) | |
350 | (nreverse out))) | |
351 | ||
23f87bed | 352 | (defun gnus-cache-remove-article (&optional n) |
eec82323 LMI |
353 | "Remove the next N articles from the cache. |
354 | If not given a prefix, use the process marked articles instead. | |
355 | Returns the list of articles removed." | |
356 | (interactive "P") | |
eec82323 | 357 | (gnus-cache-change-buffer gnus-newsgroup-name) |
01c52d31 MB |
358 | (let (out) |
359 | (dolist (article (gnus-summary-work-articles n)) | |
6748645f | 360 | (gnus-summary-remove-process-mark article) |
eec82323 | 361 | (when (gnus-cache-possibly-remove-article article nil nil nil t) |
23f87bed MB |
362 | (when gnus-newsgroup-agentized |
363 | (let ((alist (gnus-agent-load-alist gnus-newsgroup-name))) | |
364 | (unless (cdr (assoc article alist)) | |
365 | (setq gnus-newsgroup-undownloaded | |
e84b4b86 | 366 | (gnus-add-to-sorted-list |
23f87bed | 367 | gnus-newsgroup-undownloaded article))))) |
eec82323 | 368 | (push article out)) |
23f87bed | 369 | (gnus-summary-update-download-mark article) |
eec82323 LMI |
370 | (gnus-summary-update-secondary-mark article)) |
371 | (gnus-summary-next-subject 1) | |
372 | (gnus-summary-position-point) | |
373 | (nreverse out))) | |
374 | ||
375 | (defun gnus-cached-article-p (article) | |
376 | "Say whether ARTICLE is cached in the current group." | |
377 | (memq article gnus-newsgroup-cached)) | |
378 | ||
379 | (defun gnus-summary-insert-cached-articles () | |
380 | "Insert all the articles cached for this group into the current buffer." | |
381 | (interactive) | |
23f87bed MB |
382 | (let ((gnus-verbose (max 6 gnus-verbose))) |
383 | (if (not gnus-newsgroup-cached) | |
384 | (gnus-message 3 "No cached articles for this group") | |
385 | (gnus-summary-goto-subjects gnus-newsgroup-cached)))) | |
eec82323 | 386 | |
23f87bed MB |
387 | (defun gnus-summary-limit-include-cached () |
388 | "Limit the summary buffer to articles that are cached." | |
389 | (interactive) | |
390 | (let ((gnus-verbose (max 6 gnus-verbose))) | |
391 | (if gnus-newsgroup-cached | |
392 | (progn | |
393 | (gnus-summary-limit gnus-newsgroup-cached) | |
394 | (gnus-summary-position-point)) | |
395 | (gnus-message 3 "No cached articles for this group")))) | |
6748645f | 396 | |
eec82323 LMI |
397 | ;;; Internal functions. |
398 | ||
399 | (defun gnus-cache-change-buffer (group) | |
400 | (and gnus-cache-buffer | |
401 | ;; See if the current group's overview cache has been loaded. | |
402 | (or (string= group (car gnus-cache-buffer)) | |
403 | ;; Another overview cache is current, save it. | |
404 | (gnus-cache-save-buffers))) | |
405 | ;; if gnus-cache buffer is nil, create it | |
406 | (unless gnus-cache-buffer | |
407 | ;; Create cache buffer | |
408 | (save-excursion | |
409 | (setq gnus-cache-buffer | |
410 | (cons group | |
6748645f LMI |
411 | (set-buffer (gnus-get-buffer-create |
412 | " *gnus-cache-overview*")))) | |
eec82323 LMI |
413 | ;; Insert the contents of this group's cache overview. |
414 | (erase-buffer) | |
01c52d31 MB |
415 | (let ((file (gnus-cache-file-name group ".overview")) |
416 | (file-name-coding-system nnmail-pathname-coding-system)) | |
eec82323 LMI |
417 | (when (file-exists-p file) |
418 | (nnheader-insert-file-contents file))) | |
419 | ;; We have a fresh (empty/just loaded) buffer, | |
420 | ;; mark it as unmodified to save a redundant write later. | |
421 | (set-buffer-modified-p nil)))) | |
422 | ||
423 | ;; Return whether an article is a member of a class. | |
424 | (defun gnus-cache-member-of-class (class ticked dormant unread) | |
425 | (or (and ticked (memq 'ticked class)) | |
426 | (and dormant (memq 'dormant class)) | |
427 | (and unread (memq 'unread class)) | |
428 | (and (not unread) (not ticked) (not dormant) (memq 'read class)))) | |
429 | ||
01c52d31 MB |
430 | (defvar gnus-cache-decoded-group-names nil |
431 | "Alist of original group names and decoded group names. | |
432 | Decoding is done according to `gnus-group-name-charset-method-alist' | |
433 | or `gnus-group-name-charset-group-alist'.") | |
434 | ||
435 | (defvar gnus-cache-unified-group-names nil | |
436 | "Alist of unified decoded group names and original group names. | |
437 | A group name is decoded according to | |
438 | `gnus-group-name-charset-method-alist' or | |
439 | `gnus-group-name-charset-group-alist' first, and is encoded and | |
440 | decoded again according to `nnmail-pathname-coding-system', | |
441 | `file-name-coding-system', or `default-file-name-coding-system'. | |
442 | ||
443 | It is used when asking for a original group name from a cache | |
444 | directory name, in which non-ASCII characters might have been unified | |
445 | into the ones of a certain charset particularly if the `utf-8' coding | |
446 | system for example was used.") | |
447 | ||
448 | (defun gnus-cache-decoded-group-name (group) | |
449 | "Return a decoded group name of GROUP." | |
450 | (or (cdr (assoc group gnus-cache-decoded-group-names)) | |
451 | (let ((decoded (gnus-group-decoded-name group)) | |
452 | (coding (or nnmail-pathname-coding-system | |
453 | (and (boundp 'file-name-coding-system) | |
454 | file-name-coding-system) | |
455 | (and (boundp 'default-file-name-coding-system) | |
456 | default-file-name-coding-system)))) | |
457 | (push (cons group decoded) gnus-cache-decoded-group-names) | |
458 | (push (cons (mm-decode-coding-string | |
459 | (mm-encode-coding-string decoded coding) | |
460 | coding) | |
461 | group) | |
462 | gnus-cache-unified-group-names) | |
463 | decoded))) | |
464 | ||
eec82323 | 465 | (defun gnus-cache-file-name (group article) |
01c52d31 | 466 | (setq group (gnus-cache-decoded-group-name group)) |
6ab8077a DL |
467 | (expand-file-name |
468 | (if (stringp article) article (int-to-string article)) | |
469 | (file-name-as-directory | |
470 | (expand-file-name | |
471 | (nnheader-translate-file-chars | |
472 | (if (gnus-use-long-file-name 'not-cache) | |
473 | group | |
474 | (let ((group (nnheader-replace-duplicate-chars-in-string | |
475 | (nnheader-replace-chars-in-string group ?/ ?_) | |
476 | ?. ?_))) | |
477 | ;; Translate the first colon into a slash. | |
478 | (when (string-match ":" group) | |
23f87bed MB |
479 | (setq group (concat (substring group 0 (match-beginning 0)) |
480 | "/" (substring group (match-end 0))))) | |
6ab8077a DL |
481 | (nnheader-replace-chars-in-string group ?. ?/))) |
482 | t) | |
483 | gnus-cache-directory)))) | |
eec82323 LMI |
484 | |
485 | (defun gnus-cache-update-article (group article) | |
486 | "If ARTICLE is in the cache, remove it and re-enter it." | |
6748645f | 487 | (gnus-cache-change-buffer group) |
16409b0b | 488 | (when (gnus-cache-possibly-remove-article article nil nil nil t) |
eec82323 LMI |
489 | (let ((gnus-use-cache nil)) |
490 | (gnus-cache-possibly-enter-article | |
16409b0b | 491 | gnus-newsgroup-name article |
eec82323 LMI |
492 | nil nil nil t)))) |
493 | ||
494 | (defun gnus-cache-possibly-remove-article (article ticked dormant unread | |
495 | &optional force) | |
496 | "Possibly remove ARTICLE from the cache." | |
497 | (let ((group gnus-newsgroup-name) | |
498 | (number article) | |
01c52d31 MB |
499 | file |
500 | (file-name-coding-system nnmail-pathname-coding-system)) | |
eec82323 LMI |
501 | ;; If this is a virtual group, we find the real group. |
502 | (when (gnus-virtual-group-p group) | |
503 | (let ((result (nnvirtual-find-group-art | |
504 | (gnus-group-real-name group) article))) | |
505 | (setq group (car result) | |
506 | number (cdr result)))) | |
507 | (setq file (gnus-cache-file-name group number)) | |
508 | (when (and (file-exists-p file) | |
509 | (or force | |
510 | (gnus-cache-member-of-class | |
511 | gnus-cache-remove-articles ticked dormant unread))) | |
512 | (save-excursion | |
01c52d31 | 513 | (gnus-cache-update-file-total-fetched-for group file t) |
eec82323 | 514 | (delete-file file) |
01c52d31 | 515 | |
eec82323 LMI |
516 | (set-buffer (cdr gnus-cache-buffer)) |
517 | (goto-char (point-min)) | |
518 | (when (or (looking-at (concat (int-to-string number) "\t")) | |
519 | (search-forward (concat "\n" (int-to-string number) "\t") | |
520 | (point-max) t)) | |
01c52d31 | 521 | (gnus-delete-line))) |
23f87bed MB |
522 | (unless (setq gnus-newsgroup-cached |
523 | (delq article gnus-newsgroup-cached)) | |
524 | (gnus-sethash gnus-newsgroup-name nil gnus-cache-active-hashtb) | |
525 | (setq gnus-cache-active-altered t)) | |
eec82323 LMI |
526 | (gnus-summary-update-secondary-mark article) |
527 | t))) | |
528 | ||
529 | (defun gnus-cache-articles-in-group (group) | |
530 | "Return a sorted list of cached articles in GROUP." | |
a8151ef7 | 531 | (let ((dir (file-name-directory (gnus-cache-file-name group 1))) |
01c52d31 MB |
532 | articles |
533 | (file-name-coding-system nnmail-pathname-coding-system)) | |
eec82323 | 534 | (when (file-exists-p dir) |
a8151ef7 | 535 | (setq articles |
e9bd5782 | 536 | (sort (mapcar (lambda (name) (string-to-number name)) |
a8151ef7 LMI |
537 | (directory-files dir nil "^[0-9]+$" t)) |
538 | '<)) | |
539 | ;; Update the cache active file, just to synch more. | |
23f87bed MB |
540 | (if articles |
541 | (progn | |
542 | (gnus-cache-update-active group (car articles) t) | |
543 | (gnus-cache-update-active group (car (last articles)))) | |
544 | (when (gnus-gethash group gnus-cache-active-hashtb) | |
545 | (gnus-sethash group nil gnus-cache-active-hashtb) | |
546 | (setq gnus-cache-active-altered t))) | |
a8151ef7 LMI |
547 | articles))) |
548 | ||
549 | (defun gnus-cache-braid-nov (group cached &optional file) | |
6748645f | 550 | (let ((cache-buf (gnus-get-buffer-create " *gnus-cache*")) |
eec82323 LMI |
551 | beg end) |
552 | (gnus-cache-save-buffers) | |
553 | (save-excursion | |
554 | (set-buffer cache-buf) | |
eec82323 | 555 | (erase-buffer) |
01c52d31 MB |
556 | (let ((coding-system-for-read gnus-cache-overview-coding-system) |
557 | (file-name-coding-system nnmail-pathname-coding-system)) | |
a1506d29 | 558 | (insert-file-contents |
16409b0b | 559 | (or file (gnus-cache-file-name group ".overview")))) |
eec82323 LMI |
560 | (goto-char (point-min)) |
561 | (insert "\n") | |
562 | (goto-char (point-min))) | |
563 | (set-buffer nntp-server-buffer) | |
564 | (goto-char (point-min)) | |
565 | (while cached | |
566 | (while (and (not (eobp)) | |
567 | (< (read (current-buffer)) (car cached))) | |
568 | (forward-line 1)) | |
569 | (beginning-of-line) | |
23f87bed MB |
570 | (set-buffer cache-buf) |
571 | (if (search-forward (concat "\n" (int-to-string (car cached)) "\t") | |
572 | nil t) | |
01c52d31 | 573 | (setq beg (point-at-bol) |
23f87bed MB |
574 | end (progn (end-of-line) (point))) |
575 | (setq beg nil)) | |
576 | (set-buffer nntp-server-buffer) | |
eec82323 LMI |
577 | (when beg |
578 | (insert-buffer-substring cache-buf beg end) | |
579 | (insert "\n")) | |
580 | (setq cached (cdr cached))) | |
581 | (kill-buffer cache-buf))) | |
582 | ||
583 | (defun gnus-cache-braid-heads (group cached) | |
6748645f | 584 | (let ((cache-buf (gnus-get-buffer-create " *gnus-cache*"))) |
01c52d31 | 585 | (with-current-buffer cache-buf |
eec82323 LMI |
586 | (erase-buffer)) |
587 | (set-buffer nntp-server-buffer) | |
588 | (goto-char (point-min)) | |
01c52d31 | 589 | (dolist (entry cached) |
eec82323 LMI |
590 | (while (and (not (eobp)) |
591 | (looking-at "2.. +\\([0-9]+\\) ") | |
592 | (< (progn (goto-char (match-beginning 1)) | |
593 | (read (current-buffer))) | |
01c52d31 | 594 | entry)) |
eec82323 LMI |
595 | (search-forward "\n.\n" nil 'move)) |
596 | (beginning-of-line) | |
23f87bed MB |
597 | (set-buffer cache-buf) |
598 | (erase-buffer) | |
01c52d31 MB |
599 | (let ((coding-system-for-read gnus-cache-coding-system) |
600 | (file-name-coding-system nnmail-pathname-coding-system)) | |
601 | (insert-file-contents (gnus-cache-file-name group entry))) | |
23f87bed MB |
602 | (goto-char (point-min)) |
603 | (insert "220 ") | |
604 | (princ (car cached) (current-buffer)) | |
605 | (insert " Article retrieved.\n") | |
606 | (search-forward "\n\n" nil 'move) | |
607 | (delete-region (point) (point-max)) | |
608 | (forward-char -1) | |
609 | (insert ".") | |
610 | (set-buffer nntp-server-buffer) | |
01c52d31 | 611 | (insert-buffer-substring cache-buf)) |
eec82323 LMI |
612 | (kill-buffer cache-buf))) |
613 | ||
614 | ;;;###autoload | |
615 | (defun gnus-jog-cache () | |
616 | "Go through all groups and put the articles into the cache. | |
617 | ||
618 | Usage: | |
619 | $ emacs -batch -l ~/.emacs -l gnus -f gnus-jog-cache" | |
620 | (interactive) | |
621 | (let ((gnus-mark-article-hook nil) | |
622 | (gnus-expert-user t) | |
623 | (nnmail-spool-file nil) | |
16409b0b | 624 | (mail-sources nil) |
eec82323 LMI |
625 | (gnus-use-dribble-file nil) |
626 | (gnus-novice-user nil) | |
627 | (gnus-large-newsgroup nil)) | |
628 | ;; Start Gnus. | |
629 | (gnus) | |
630 | ;; Go through all groups... | |
631 | (gnus-group-mark-buffer) | |
a8151ef7 LMI |
632 | (gnus-group-iterate nil |
633 | (lambda (group) | |
634 | (let (gnus-auto-select-next) | |
635 | (gnus-summary-read-group group nil t) | |
636 | ;; ... and enter the articles into the cache. | |
637 | (when (eq major-mode 'gnus-summary-mode) | |
638 | (gnus-uu-mark-buffer) | |
639 | (gnus-cache-enter-article) | |
640 | (kill-buffer (current-buffer)))))))) | |
eec82323 LMI |
641 | |
642 | (defun gnus-cache-read-active (&optional force) | |
643 | "Read the cache active file." | |
644 | (gnus-make-directory gnus-cache-directory) | |
a8151ef7 | 645 | (if (or (not (file-exists-p gnus-cache-active-file)) |
6748645f | 646 | (zerop (nth 7 (file-attributes gnus-cache-active-file))) |
a8151ef7 | 647 | force) |
eec82323 LMI |
648 | ;; There is no active file, so we generate one. |
649 | (gnus-cache-generate-active) | |
650 | ;; We simply read the active file. | |
651 | (save-excursion | |
652 | (gnus-set-work-buffer) | |
16409b0b | 653 | (nnheader-insert-file-contents gnus-cache-active-file) |
eec82323 LMI |
654 | (gnus-active-to-gnus-format |
655 | nil (setq gnus-cache-active-hashtb | |
656 | (gnus-make-hashtable | |
657 | (count-lines (point-min) (point-max))))) | |
658 | (setq gnus-cache-active-altered nil)))) | |
659 | ||
660 | (defun gnus-cache-write-active (&optional force) | |
661 | "Write the active hashtb to the active file." | |
662 | (when (or force | |
663 | (and gnus-cache-active-hashtb | |
664 | gnus-cache-active-altered)) | |
16409b0b | 665 | (gnus-write-active-file gnus-cache-active-file gnus-cache-active-hashtb t) |
eec82323 LMI |
666 | ;; Mark the active hashtb as unaltered. |
667 | (setq gnus-cache-active-altered nil))) | |
668 | ||
23f87bed MB |
669 | (defun gnus-cache-possibly-update-active (group active) |
670 | "Update active info bounds of GROUP with ACTIVE if necessary. | |
671 | The update is performed if ACTIVE contains a higher or lower bound | |
672 | than the current." | |
673 | (let ((lower t) (higher t)) | |
674 | (if gnus-cache-active-hashtb | |
675 | (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb))) | |
676 | (when cache-active | |
677 | (unless (< (car active) (car cache-active)) | |
678 | (setq lower nil)) | |
679 | (unless (> (cdr active) (cdr cache-active)) | |
680 | (setq higher nil)))) | |
681 | (gnus-cache-read-active)) | |
682 | (when lower | |
683 | (gnus-cache-update-active group (car active) t)) | |
684 | (when higher | |
685 | (gnus-cache-update-active group (cdr active))))) | |
686 | ||
eec82323 LMI |
687 | (defun gnus-cache-update-active (group number &optional low) |
688 | "Update the upper bound of the active info of GROUP to NUMBER. | |
689 | If LOW, update the lower bound instead." | |
690 | (let ((active (gnus-gethash group gnus-cache-active-hashtb))) | |
691 | (if (null active) | |
692 | ;; We just create a new active entry for this group. | |
693 | (gnus-sethash group (cons number number) gnus-cache-active-hashtb) | |
694 | ;; Update the lower or upper bound. | |
695 | (if low | |
696 | (setcar active number) | |
697 | (setcdr active number))) | |
698 | ;; Mark the active hashtb as altered. | |
699 | (setq gnus-cache-active-altered t))) | |
700 | ||
701 | ;;;###autoload | |
702 | (defun gnus-cache-generate-active (&optional directory) | |
703 | "Generate the cache active file." | |
704 | (interactive) | |
705 | (let* ((top (null directory)) | |
706 | (directory (expand-file-name (or directory gnus-cache-directory))) | |
01c52d31 | 707 | (file-name-coding-system nnmail-pathname-coding-system) |
eec82323 LMI |
708 | (files (directory-files directory 'full)) |
709 | (group | |
710 | (if top | |
711 | "" | |
712 | (string-match | |
6748645f LMI |
713 | (concat "^" (regexp-quote |
714 | (file-name-as-directory | |
715 | (expand-file-name gnus-cache-directory)))) | |
eec82323 LMI |
716 | (directory-file-name directory)) |
717 | (nnheader-replace-chars-in-string | |
718 | (substring (directory-file-name directory) (match-end 0)) | |
719 | ?/ ?.))) | |
720 | nums alphs) | |
721 | (when top | |
722 | (gnus-message 5 "Generating the cache active file...") | |
723 | (setq gnus-cache-active-hashtb (gnus-make-hashtable 123))) | |
6748645f | 724 | (when (string-match "^\\(nn[^_]+\\)_" group) |
23f87bed | 725 | (setq group (replace-match "\\1:" t nil group))) |
eec82323 LMI |
726 | ;; Separate articles from all other files and directories. |
727 | (while files | |
728 | (if (string-match "^[0-9]+$" (file-name-nondirectory (car files))) | |
e9bd5782 | 729 | (push (string-to-number (file-name-nondirectory (pop files))) nums) |
eec82323 LMI |
730 | (push (pop files) alphs))) |
731 | ;; If we have nums, then this is probably a valid group. | |
732 | (when (setq nums (sort nums '<)) | |
01c52d31 MB |
733 | ;; Use non-decoded group name. |
734 | ;; FIXME: this is kind of a workaround. The active file should | |
735 | ;; be updated at the time articles are cached. It will make | |
736 | ;; `gnus-cache-unified-group-names' needless. | |
737 | (gnus-sethash (or (cdr (assoc group gnus-cache-unified-group-names)) | |
738 | group) | |
739 | (cons (car nums) (gnus-last-element nums)) | |
eec82323 LMI |
740 | gnus-cache-active-hashtb)) |
741 | ;; Go through all the other files. | |
01c52d31 MB |
742 | (dolist (file alphs) |
743 | (when (and (file-directory-p file) | |
6748645f | 744 | (not (string-match "^\\." |
01c52d31 | 745 | (file-name-nondirectory file)))) |
eec82323 | 746 | ;; We descend directories. |
01c52d31 | 747 | (gnus-cache-generate-active file))) |
eec82323 LMI |
748 | ;; Write the new active file. |
749 | (when top | |
750 | (gnus-cache-write-active t) | |
751 | (gnus-message 5 "Generating the cache active file...done")))) | |
752 | ||
753 | ;;;###autoload | |
754 | (defun gnus-cache-generate-nov-databases (dir) | |
755 | "Generate NOV files recursively starting in DIR." | |
756 | (interactive (list gnus-cache-directory)) | |
757 | (gnus-cache-close) | |
758 | (let ((nnml-generate-active-function 'identity)) | |
23f87bed | 759 | (nnml-generate-nov-databases-1 dir)) |
01c52d31 MB |
760 | |
761 | (setq gnus-cache-total-fetched-hashtb nil) | |
762 | ||
23f87bed | 763 | (gnus-cache-open)) |
eec82323 LMI |
764 | |
765 | (defun gnus-cache-move-cache (dir) | |
766 | "Move the cache tree to somewhere else." | |
a8151ef7 | 767 | (interactive "FMove the cache tree to: ") |
eec82323 LMI |
768 | (rename-file gnus-cache-directory dir)) |
769 | ||
23f87bed MB |
770 | (defun gnus-cache-fully-p (&optional group) |
771 | "Returns non-nil if the cache should be fully used. | |
772 | If GROUP is non-nil, also cater to `gnus-cacheable-groups' and | |
773 | `gnus-uncacheable-groups'." | |
774 | (and gnus-use-cache | |
775 | (not (eq gnus-use-cache 'passive)) | |
776 | (if (null group) | |
777 | t | |
778 | (and (or (not gnus-cacheable-groups) | |
779 | (string-match gnus-cacheable-groups group)) | |
780 | (or (not gnus-uncacheable-groups) | |
781 | (not (string-match gnus-uncacheable-groups group))))))) | |
782 | ||
54506618 MB |
783 | ;;;###autoload |
784 | (defun gnus-cache-rename-group (old-group new-group) | |
58090a8d MB |
785 | "Rename OLD-GROUP as NEW-GROUP. |
786 | Always updates the cache, even when disabled, as the old cache | |
787 | files would corrupt Gnus when the cache was next enabled. It | |
788 | depends on the caller to determine whether group renaming is | |
789 | supported." | |
54506618 | 790 | (let ((old-dir (gnus-cache-file-name old-group "")) |
01c52d31 MB |
791 | (new-dir (gnus-cache-file-name new-group "")) |
792 | (file-name-coding-system nnmail-pathname-coding-system)) | |
54506618 MB |
793 | (gnus-rename-file old-dir new-dir t)) |
794 | ||
01c52d31 MB |
795 | (gnus-cache-rename-group-total-fetched-for old-group new-group) |
796 | ||
54506618 MB |
797 | (let ((no-save gnus-cache-active-hashtb)) |
798 | (unless gnus-cache-active-hashtb | |
799 | (gnus-cache-read-active)) | |
58090a8d MB |
800 | (let* ((old-group-hash-value |
801 | (gnus-gethash old-group gnus-cache-active-hashtb)) | |
802 | (new-group-hash-value | |
803 | (gnus-gethash new-group gnus-cache-active-hashtb)) | |
804 | (delta | |
805 | (or old-group-hash-value new-group-hash-value))) | |
54506618 MB |
806 | (gnus-sethash new-group old-group-hash-value gnus-cache-active-hashtb) |
807 | (gnus-sethash old-group nil gnus-cache-active-hashtb) | |
808 | ||
809 | (if no-save | |
810 | (setq gnus-cache-active-altered delta) | |
811 | (gnus-cache-write-active delta))))) | |
812 | ||
813 | ;;;###autoload | |
814 | (defun gnus-cache-delete-group (group) | |
58090a8d MB |
815 | "Delete GROUP from the cache. |
816 | Always updates the cache, even when disabled, as the old cache | |
817 | files would corrupt gnus when the cache was next enabled. | |
818 | Depends upon the caller to determine whether group deletion is | |
819 | supported." | |
01c52d31 MB |
820 | (let ((dir (gnus-cache-file-name group "")) |
821 | (file-name-coding-system nnmail-pathname-coding-system)) | |
aa0a8561 | 822 | (gnus-delete-directory dir)) |
54506618 | 823 | |
01c52d31 MB |
824 | (gnus-cache-delete-group-total-fetched-for group) |
825 | ||
54506618 MB |
826 | (let ((no-save gnus-cache-active-hashtb)) |
827 | (unless gnus-cache-active-hashtb | |
828 | (gnus-cache-read-active)) | |
829 | (let* ((group-hash-value (gnus-gethash group gnus-cache-active-hashtb))) | |
830 | (gnus-sethash group nil gnus-cache-active-hashtb) | |
831 | ||
832 | (if no-save | |
833 | (setq gnus-cache-active-altered group-hash-value) | |
834 | (gnus-cache-write-active group-hash-value))))) | |
835 | ||
01c52d31 MB |
836 | (defvar gnus-cache-inhibit-update-total-fetched-for nil) |
837 | (defvar gnus-cache-need-update-total-fetched-for nil) | |
838 | ||
839 | (defmacro gnus-cache-with-refreshed-group (group &rest body) | |
840 | `(prog1 (let ((gnus-cache-inhibit-update-total-fetched-for t)) | |
841 | ,@body) | |
842 | (when (and gnus-cache-need-update-total-fetched-for | |
843 | (not gnus-cache-inhibit-update-total-fetched-for)) | |
844 | (save-excursion | |
845 | (set-buffer gnus-group-buffer) | |
846 | (setq gnus-cache-need-update-total-fetched-for nil) | |
847 | (gnus-group-update-group ,group t))))) | |
848 | ||
849 | (defun gnus-cache-update-file-total-fetched-for (group file &optional subtract) | |
850 | (when gnus-cache-total-fetched-hashtb | |
851 | (gnus-cache-with-refreshed-group | |
852 | group | |
853 | (let* ((entry (or (gnus-gethash group gnus-cache-total-fetched-hashtb) | |
854 | (gnus-sethash group (make-vector 2 0) | |
855 | gnus-cache-total-fetched-hashtb))) | |
856 | size) | |
857 | ||
858 | (if file | |
859 | (setq size (or (nth 7 (file-attributes file)) 0)) | |
860 | (let* ((file-name-coding-system nnmail-pathname-coding-system) | |
861 | (files (directory-files (gnus-cache-file-name group "") | |
862 | t nil t)) | |
863 | file attrs) | |
864 | (setq size 0.0) | |
865 | (while (setq file (pop files)) | |
866 | (setq attrs (file-attributes file)) | |
867 | (unless (nth 0 attrs) | |
868 | (incf size (float (nth 7 attrs))))))) | |
869 | ||
870 | (setq gnus-cache-need-update-total-fetched-for t) | |
871 | ||
872 | (incf (nth 1 entry) (if subtract (- size) size)))))) | |
873 | ||
874 | (defun gnus-cache-update-overview-total-fetched-for (group file) | |
875 | (when gnus-cache-total-fetched-hashtb | |
876 | (gnus-cache-with-refreshed-group | |
877 | group | |
878 | (let* ((entry (or (gnus-gethash group gnus-cache-total-fetched-hashtb) | |
879 | (gnus-sethash group (make-list 2 0) | |
880 | gnus-cache-total-fetched-hashtb))) | |
881 | (file-name-coding-system nnmail-pathname-coding-system) | |
882 | (size (or (nth 7 (file-attributes | |
883 | (or file | |
884 | (gnus-cache-file-name group ".overview")))) | |
885 | 0))) | |
886 | (setq gnus-cache-need-update-total-fetched-for t) | |
887 | (setf (nth 0 entry) size))))) | |
888 | ||
889 | (defun gnus-cache-rename-group-total-fetched-for (old-group new-group) | |
890 | "Record of disk space used by OLD-GROUP now associated with NEW-GROUP." | |
891 | (when gnus-cache-total-fetched-hashtb | |
892 | (let ((entry (gnus-gethash old-group gnus-cache-total-fetched-hashtb))) | |
893 | (gnus-sethash new-group entry gnus-cache-total-fetched-hashtb) | |
894 | (gnus-sethash old-group nil gnus-cache-total-fetched-hashtb)))) | |
895 | ||
896 | (defun gnus-cache-delete-group-total-fetched-for (group) | |
897 | "Delete record of disk space used by GROUP being deleted." | |
898 | (when gnus-cache-total-fetched-hashtb | |
899 | (gnus-sethash group nil gnus-cache-total-fetched-hashtb))) | |
900 | ||
901 | (defun gnus-cache-total-fetched-for (group &optional no-inhibit) | |
902 | "Get total disk space used by the cache for the specified GROUP." | |
903 | (unless (equal group "dummy.group") | |
904 | (unless gnus-cache-total-fetched-hashtb | |
905 | (setq gnus-cache-total-fetched-hashtb (gnus-make-hashtable 1024))) | |
906 | ||
907 | (let* ((entry (gnus-gethash group gnus-cache-total-fetched-hashtb))) | |
908 | (if entry | |
909 | (apply '+ entry) | |
910 | (let ((gnus-cache-inhibit-update-total-fetched-for (not no-inhibit))) | |
911 | (+ | |
912 | (gnus-cache-update-overview-total-fetched-for group nil) | |
913 | (gnus-cache-update-file-total-fetched-for group nil))))))) | |
914 | ||
eec82323 LMI |
915 | (provide 'gnus-cache) |
916 | ||
ab5796a9 | 917 | ;;; arch-tag: 05a79442-8c58-4e65-bd0a-3cbb1b89a33a |
eec82323 | 918 | ;;; gnus-cache.el ends here |