gnus-cache.el 32.9 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; gnus-cache.el --- cache interface for Gnus
2

3
;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4
;;   2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
5

6
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
7 8 9 10
;; Keywords: news

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
23 24 25 26 27

;;; Commentary:

;;; Code:

28 29 30 31
;; For Emacs < 22.2.
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))

32 33
(eval-when-compile (require 'cl))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
34
(require 'gnus)
35 36
(require 'gnus-sum)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
37
(eval-when-compile
38
  (unless (fboundp 'gnus-agent-load-alist)
39
    (defun gnus-agent-load-alist (group))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
40 41

(defcustom gnus-cache-active-file
42
  (expand-file-name "active" gnus-cache-directory)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56
  "*The cache active file."
  :group 'gnus-cache
  :type 'file)

(defcustom gnus-cache-enter-articles '(ticked dormant)
  "Classes of articles to enter into the cache."
  :group 'gnus-cache
  :type '(set (const ticked) (const dormant) (const unread) (const read)))

(defcustom gnus-cache-remove-articles '(read)
  "Classes of articles to remove from the cache."
  :group 'gnus-cache
  :type '(set (const ticked) (const dormant) (const unread) (const read)))

57 58 59 60 61 62 63 64 65 66
(defcustom gnus-cacheable-groups nil
  "*Groups that match this regexp will be cached.

If you only want to cache your nntp groups, you could set this
variable to \"^nntp\".

If a group matches both gnus-cacheable-groups and gnus-uncacheable-groups
it's not cached."
  :group 'gnus-cache
  :type '(choice (const :tag "off" nil)
67
		 regexp))
68

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
69 70 71 72
(defcustom gnus-uncacheable-groups nil
  "*Groups that match this regexp will not be cached.

If you want to avoid caching your nnml groups, you could set this
73 74 75 76
variable to \"^nnml\".

If a group matches both gnus-cacheable-groups and gnus-uncacheable-groups
it's not cached."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
77 78 79 80
  :group 'gnus-cache
  :type '(choice (const :tag "off" nil)
		 regexp))

81 82 83
(defvar gnus-cache-overview-coding-system 'raw-text
  "Coding system used on Gnus cache files.")

84 85 86
(defvar gnus-cache-coding-system 'raw-text
  "Coding system used on Gnus cache files.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
87 88 89 90 91 92 93 94


;;; Internal variables.

(defvar gnus-cache-removable-articles nil)
(defvar gnus-cache-buffer nil)
(defvar gnus-cache-active-hashtb nil)
(defvar gnus-cache-active-altered nil)
95
(defvar gnus-cache-total-fetched-hashtb nil)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
96

97 98
(declare-function nnvirtual-find-group-art "nnvirtual" (group article))

99 100
(autoload 'nnml-generate-nov-databases-directory "nnml")
(autoload 'nnvirtual-find-group-art "nnvirtual")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130



;;; Functions called from Gnus.

(defun gnus-cache-open ()
  "Initialize the cache."
  (when (or (file-exists-p gnus-cache-directory)
	    (and gnus-use-cache
		 (not (eq gnus-use-cache 'passive))))
    (gnus-cache-read-active)))

;; Complexities of byte-compiling make this kludge necessary.  Eeek.
(ignore-errors
  (gnus-add-shutdown 'gnus-cache-close 'gnus))

(defun gnus-cache-close ()
  "Shut down the cache."
  (gnus-cache-write-active)
  (gnus-cache-save-buffers)
  (setq gnus-cache-active-hashtb nil))

(defun gnus-cache-save-buffers ()
  ;; save the overview buffer if it exists and has been modified
  ;; delete empty cache subdirectories
  (when gnus-cache-buffer
    (let ((buffer (cdr gnus-cache-buffer))
	  (overview-file (gnus-cache-file-name
			  (car gnus-cache-buffer) ".overview")))
      ;; write the overview only if it was modified
131 132
      (when (and (buffer-live-p buffer) (buffer-modified-p buffer))
	(with-current-buffer buffer
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
133 134
	  (if (> (buffer-size) 0)
	      ;; Non-empty overview, write it to a file.
135 136 137
	      (let ((coding-system-for-write
		     gnus-cache-overview-coding-system))
		(gnus-write-buffer overview-file))
138 139 140 141 142 143 144 145 146 147 148 149 150 151
	    (let ((file-name-coding-system nnmail-pathname-coding-system))
	      ;; Empty overview file, remove it
	      (when (file-exists-p overview-file)
		(delete-file overview-file))
	      ;; If possible, remove group's cache subdirectory.
	      (condition-case nil
		  ;; FIXME: we can detect the error type and warn the user
		  ;; of any inconsistencies (articles w/o nov entries?).
		  ;; for now, just be conservative...delete only if safe -- sj
		  (delete-directory (file-name-directory overview-file))
		(error))))

	  (gnus-cache-update-overview-total-fetched-for
	   (car gnus-cache-buffer) overview-file)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
152 153 154 155 156
      ;; Kill the buffer -- it's either unmodified or saved.
      (gnus-kill-buffer buffer)
      (setq gnus-cache-buffer nil))))

(defun gnus-cache-possibly-enter-article
157
  (group article ticked dormant unread &optional force)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
158 159
  (when (and (or force (not (eq gnus-use-cache 'passive)))
	     (numberp article)
160
	     (> article 0))		; This might be a dummy article.
161 162 163
    (let ((number article)
	  file headers lines-chars
	  (file-name-coding-system nnmail-pathname-coding-system))
164 165 166 167 168 169
      ;; If this is a virtual group, we find the real group.
      (when (gnus-virtual-group-p group)
	(let ((result (nnvirtual-find-group-art
		       (gnus-group-real-name group) article)))
	  (setq group (car result)
		number (cdr result))))
170 171
      (when (and number
		 (> number 0)		; Reffed article.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
172
		 (or force
173
		     (and (gnus-cache-fully-p group)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
174 175 176 177 178
			  (gnus-cache-member-of-class
			   gnus-cache-enter-articles ticked dormant unread)))
		 (not (file-exists-p (setq file (gnus-cache-file-name
						 group number)))))
	;; Possibly create the cache directory.
179
	(gnus-make-directory (file-name-directory file))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
180 181 182 183 184
	;; Save the article in the cache.
	(if (file-exists-p file)
	    t				; The article already is saved.
	  (save-excursion
	    (set-buffer nntp-server-buffer)
185 186 187
	    (require 'gnus-art)
	    (let ((gnus-use-cache nil)
		  (gnus-article-decode-hook nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
188 189
	      (gnus-request-article-this-buffer number group))
	    (when (> (buffer-size) 0)
190
	      (let ((coding-system-for-write gnus-cache-coding-system))
191 192 193
		(gnus-write-buffer file)
		(gnus-cache-update-file-total-fetched-for group file))
	      (setq lines-chars (nnheader-get-lines-and-char))
194 195
	      (nnheader-remove-body)
	      (setq headers (nnheader-parse-naked-head))
196
	      (mail-header-set-number headers number)
197 198
	      (mail-header-set-lines headers (car lines-chars))
	      (mail-header-set-chars headers (cadr lines-chars))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
	      (gnus-cache-change-buffer group)
	      (set-buffer (cdr gnus-cache-buffer))
	      (goto-char (point-max))
	      (forward-line -1)
	      (while (condition-case ()
			 (when (not (bobp))
			   (> (read (current-buffer)) number))
		       (error
			;; The line was malformed, so we just remove it!!
			(gnus-delete-line)
			t))
		(forward-line -1))
	      (if (bobp)
		  (if (not (eobp))
		      (progn
			(beginning-of-line)
			(when (< (read (current-buffer)) number)
			  (forward-line 1)))
		    (beginning-of-line))
		(forward-line 1))
	      (beginning-of-line)
220
	      (nnheader-insert-nov headers)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
221 222
	      ;; Update the active info.
	      (set-buffer gnus-summary-buffer)
223 224 225
	      (gnus-cache-possibly-update-active group (cons number number))
	      (setq gnus-newsgroup-cached
		    (gnus-add-to-sorted-list gnus-newsgroup-cached article))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
	      (gnus-summary-update-secondary-mark article))
	    t))))))

(defun gnus-cache-enter-remove-article (article)
  "Mark ARTICLE for later possible removal."
  (when article
    (push article gnus-cache-removable-articles)))

(defun gnus-cache-possibly-remove-articles ()
  "Possibly remove some of the removable articles."
  (if (not (gnus-virtual-group-p gnus-newsgroup-name))
      (gnus-cache-possibly-remove-articles-1)
    (let ((arts gnus-cache-removable-articles)
	  ga)
      (while arts
	(when (setq ga (nnvirtual-find-group-art
			(gnus-group-real-name gnus-newsgroup-name) (pop arts)))
	  (let ((gnus-cache-removable-articles (list (cdr ga)))
		(gnus-newsgroup-name (car ga)))
	    (gnus-cache-possibly-remove-articles-1)))))
    (setq gnus-cache-removable-articles nil)))

(defun gnus-cache-possibly-remove-articles-1 ()
  "Possibly remove some of the removable articles."
250
  (when (gnus-cache-fully-p gnus-newsgroup-name)
251
    (let ((cache-articles gnus-newsgroup-cached))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
252
      (gnus-cache-change-buffer gnus-newsgroup-name)
253 254
      (dolist (article gnus-cache-removable-articles)
	(when (memq article cache-articles)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268
	  ;; The article was in the cache, so we see whether we are
	  ;; supposed to remove it from the cache.
	  (gnus-cache-possibly-remove-article
	   article (memq article gnus-newsgroup-marked)
	   (memq article gnus-newsgroup-dormant)
	   (or (memq article gnus-newsgroup-unreads)
	       (memq article gnus-newsgroup-unselected))))))
    ;; The overview file might have been modified, save it
    ;; safe because we're only called at group exit anyway.
    (gnus-cache-save-buffers)))

(defun gnus-cache-request-article (article group)
  "Retrieve ARTICLE in GROUP from the cache."
  (let ((file (gnus-cache-file-name group article))
269 270
	(buffer-read-only nil)
	(file-name-coding-system nnmail-pathname-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
271 272 273
    (when (file-exists-p file)
      (erase-buffer)
      (gnus-kill-all-overlays)
274 275
      (let ((coding-system-for-read gnus-cache-coding-system))
	(insert-file-contents file))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
276 277 278 279 280 281
      t)))

(defun gnus-cache-possibly-alter-active (group active)
  "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
  (when gnus-cache-active-hashtb
    (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb)))
282 283 284 285 286
      (when cache-active
	(when (< (car cache-active) (car active))
	  (setcar active (car cache-active)))
	(when (> (cdr cache-active) (cdr active))
	  (setcdr active (cdr cache-active)))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
287 288 289 290 291 292 293 294 295 296

(defun gnus-cache-retrieve-headers (articles group &optional fetch-old)
  "Retrieve the headers for ARTICLES in GROUP."
  (let ((cached
	 (setq gnus-newsgroup-cached (gnus-cache-articles-in-group group))))
    (if (not cached)
	;; No cached articles here, so we just retrieve them
	;; the normal way.
	(let ((gnus-use-cache nil))
	  (gnus-retrieve-headers articles group fetch-old))
297
      (let ((uncached-articles (gnus-sorted-difference articles cached))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
298
	    (cache-file (gnus-cache-file-name group ".overview"))
299 300
	    type
	    (file-name-coding-system nnmail-pathname-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
	;; We first retrieve all the headers that we don't have in
	;; the cache.
	(let ((gnus-use-cache nil))
	  (when uncached-articles
	    (setq type (and articles
			    (gnus-retrieve-headers
			     uncached-articles group fetch-old)))))
	(gnus-cache-save-buffers)
	;; Then we insert the cached headers.
	(save-excursion
	  (cond
	   ((not (file-exists-p cache-file))
	    ;; There are no cached headers.
	    type)
	   ((null type)
	    ;; There were no uncached headers (or retrieval was
	    ;; unsuccessful), so we use the cached headers exclusively.
	    (set-buffer nntp-server-buffer)
	    (erase-buffer)
320
	    (let ((coding-system-for-read
321 322
		   gnus-cache-overview-coding-system))
	      (insert-file-contents cache-file))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
	    'nov)
	   ((eq type 'nov)
	    ;; We have both cached and uncached NOV headers, so we
	    ;; braid them.
	    (gnus-cache-braid-nov group cached)
	    type)
	   (t
	    ;; We braid HEADs.
	    (gnus-cache-braid-heads group (gnus-sorted-intersection
					   cached articles))
	    type)))))))

(defun gnus-cache-enter-article (&optional n)
  "Enter the next N articles into the cache.
If not given a prefix, use the process marked articles instead.
Returns the list of articles entered."
  (interactive "P")
340 341
  (let (out)
    (dolist (article (gnus-summary-work-articles n))
342
      (gnus-summary-remove-process-mark article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
343 344 345 346
      (if (natnump article)
	  (when (gnus-cache-possibly-enter-article
		 gnus-newsgroup-name article
		 nil nil nil t)
347
            (setq gnus-newsgroup-undownloaded (delq article gnus-newsgroup-undownloaded))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
348 349
	    (push article out))
	(gnus-message 2 "Can't cache article %d" article))
350
      (gnus-summary-update-download-mark article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
351 352 353 354 355
      (gnus-summary-update-secondary-mark article))
    (gnus-summary-next-subject 1)
    (gnus-summary-position-point)
    (nreverse out)))

356
(defun gnus-cache-remove-article (&optional n)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
357 358 359 360 361
  "Remove the next N articles from the cache.
If not given a prefix, use the process marked articles instead.
Returns the list of articles removed."
  (interactive "P")
  (gnus-cache-change-buffer gnus-newsgroup-name)
362 363
  (let (out)
    (dolist (article (gnus-summary-work-articles n))
364
      (gnus-summary-remove-process-mark article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
365
      (when (gnus-cache-possibly-remove-article article nil nil nil t)
366 367 368 369
        (when gnus-newsgroup-agentized
          (let ((alist (gnus-agent-load-alist gnus-newsgroup-name)))
            (unless (cdr (assoc article alist))
              (setq gnus-newsgroup-undownloaded
370
                    (gnus-add-to-sorted-list
371
                     gnus-newsgroup-undownloaded article)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
372
	(push article out))
373
      (gnus-summary-update-download-mark article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
374 375 376 377 378 379 380 381 382 383 384 385
      (gnus-summary-update-secondary-mark article))
    (gnus-summary-next-subject 1)
    (gnus-summary-position-point)
    (nreverse out)))

(defun gnus-cached-article-p (article)
  "Say whether ARTICLE is cached in the current group."
  (memq article gnus-newsgroup-cached))

(defun gnus-summary-insert-cached-articles ()
  "Insert all the articles cached for this group into the current buffer."
  (interactive)
386 387 388 389
  (let ((gnus-verbose (max 6 gnus-verbose)))
    (if (not gnus-newsgroup-cached)
	(gnus-message 3 "No cached articles for this group")
      (gnus-summary-goto-subjects gnus-newsgroup-cached))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
390

391 392 393 394 395 396 397 398 399
(defun gnus-summary-limit-include-cached ()
  "Limit the summary buffer to articles that are cached."
  (interactive)
  (let ((gnus-verbose (max 6 gnus-verbose)))
    (if gnus-newsgroup-cached
	(progn
	  (gnus-summary-limit gnus-newsgroup-cached)
	  (gnus-summary-position-point))
      (gnus-message 3 "No cached articles for this group"))))
400

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
401 402 403 404 405 406 407 408 409 410 411 412 413 414
;;; Internal functions.

(defun gnus-cache-change-buffer (group)
  (and gnus-cache-buffer
       ;; See if the current group's overview cache has been loaded.
       (or (string= group (car gnus-cache-buffer))
	   ;; Another overview cache is current, save it.
	   (gnus-cache-save-buffers)))
  ;; if gnus-cache buffer is nil, create it
  (unless gnus-cache-buffer
    ;; Create cache buffer
    (save-excursion
      (setq gnus-cache-buffer
	    (cons group
415 416
		  (set-buffer (gnus-get-buffer-create
			       " *gnus-cache-overview*"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
417 418
      ;; Insert the contents of this group's cache overview.
      (erase-buffer)
419 420
      (let ((file (gnus-cache-file-name group ".overview"))
	    (file-name-coding-system nnmail-pathname-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
421 422 423 424 425 426 427 428 429 430 431 432 433
	(when (file-exists-p file)
	  (nnheader-insert-file-contents file)))
      ;; We have a fresh (empty/just loaded) buffer,
      ;; mark it as unmodified to save a redundant write later.
      (set-buffer-modified-p nil))))

;; Return whether an article is a member of a class.
(defun gnus-cache-member-of-class (class ticked dormant unread)
  (or (and ticked (memq 'ticked class))
      (and dormant (memq 'dormant class))
      (and unread (memq 'unread class))
      (and (not unread) (not ticked) (not dormant) (memq 'read class))))

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
(defvar gnus-cache-decoded-group-names nil
  "Alist of original group names and decoded group names.
Decoding is done according to `gnus-group-name-charset-method-alist'
or `gnus-group-name-charset-group-alist'.")

(defvar gnus-cache-unified-group-names nil
  "Alist of unified decoded group names and original group names.
A group name is decoded according to
`gnus-group-name-charset-method-alist' or
`gnus-group-name-charset-group-alist' first, and is encoded and
decoded again according to `nnmail-pathname-coding-system',
`file-name-coding-system', or `default-file-name-coding-system'.

It is used when asking for a original group name from a cache
directory name, in which non-ASCII characters might have been unified
into the ones of a certain charset particularly if the `utf-8' coding
system for example was used.")

(defun gnus-cache-decoded-group-name (group)
  "Return a decoded group name of GROUP."
  (or (cdr (assoc group gnus-cache-decoded-group-names))
      (let ((decoded (gnus-group-decoded-name group))
	    (coding (or nnmail-pathname-coding-system
			(and (boundp 'file-name-coding-system)
			     file-name-coding-system)
			(and (boundp 'default-file-name-coding-system)
			     default-file-name-coding-system))))
	(push (cons group decoded) gnus-cache-decoded-group-names)
	(push (cons (mm-decode-coding-string
		     (mm-encode-coding-string decoded coding)
		     coding)
		    group)
	      gnus-cache-unified-group-names)
	decoded)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
469
(defun gnus-cache-file-name (group article)
470
  (setq group (gnus-cache-decoded-group-name group))
471 472 473 474 475 476 477 478 479 480 481 482
  (expand-file-name
   (if (stringp article) article (int-to-string article))
   (file-name-as-directory
    (expand-file-name
     (nnheader-translate-file-chars
      (if (gnus-use-long-file-name 'not-cache)
	  group
	(let ((group (nnheader-replace-duplicate-chars-in-string
		      (nnheader-replace-chars-in-string group ?/ ?_)
		      ?. ?_)))
	  ;; Translate the first colon into a slash.
	  (when (string-match ":" group)
483 484
		  (setq group (concat (substring group 0 (match-beginning 0))
				      "/" (substring group (match-end 0)))))
485 486 487
	  (nnheader-replace-chars-in-string group ?. ?/)))
      t)
     gnus-cache-directory))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
488 489 490

(defun gnus-cache-update-article (group article)
  "If ARTICLE is in the cache, remove it and re-enter it."
491
  (gnus-cache-change-buffer group)
492
  (when (gnus-cache-possibly-remove-article article nil nil nil t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
493 494
    (let ((gnus-use-cache nil))
      (gnus-cache-possibly-enter-article
495
       gnus-newsgroup-name article
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
496 497 498 499 500 501 502
       nil nil nil t))))

(defun gnus-cache-possibly-remove-article (article ticked dormant unread
						   &optional force)
  "Possibly remove ARTICLE from the cache."
  (let ((group gnus-newsgroup-name)
	(number article)
503 504
	file
	(file-name-coding-system nnmail-pathname-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
505 506 507 508 509 510 511 512 513 514 515 516
    ;; If this is a virtual group, we find the real group.
    (when (gnus-virtual-group-p group)
      (let ((result (nnvirtual-find-group-art
		     (gnus-group-real-name group) article)))
	(setq group (car result)
	      number (cdr result))))
    (setq file (gnus-cache-file-name group number))
    (when (and (file-exists-p file)
	       (or force
		   (gnus-cache-member-of-class
		    gnus-cache-remove-articles ticked dormant unread)))
      (save-excursion
517
	(gnus-cache-update-file-total-fetched-for group file t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
518
	(delete-file file)
519

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
520 521 522 523 524
	(set-buffer (cdr gnus-cache-buffer))
	(goto-char (point-min))
	(when (or (looking-at (concat (int-to-string number) "\t"))
		  (search-forward (concat "\n" (int-to-string number) "\t")
				  (point-max) t))
525
	    (gnus-delete-line)))
526 527 528 529
      (unless (setq gnus-newsgroup-cached
		    (delq article gnus-newsgroup-cached))
	(gnus-sethash gnus-newsgroup-name nil gnus-cache-active-hashtb)
	(setq gnus-cache-active-altered t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
530 531 532 533 534
      (gnus-summary-update-secondary-mark article)
      t)))

(defun gnus-cache-articles-in-group (group)
  "Return a sorted list of cached articles in GROUP."
535
  (let ((dir (file-name-directory (gnus-cache-file-name group 1)))
536 537
	articles
	(file-name-coding-system nnmail-pathname-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
538
    (when (file-exists-p dir)
539
      (setq articles
540
	    (sort (mapcar (lambda (name) (string-to-number name))
541 542 543
			  (directory-files dir nil "^[0-9]+$" t))
		  '<))
      ;; Update the cache active file, just to synch more.
544 545 546 547 548 549 550
      (if articles
	  (progn
	    (gnus-cache-update-active group (car articles) t)
	    (gnus-cache-update-active group (car (last articles))))
	(when (gnus-gethash group gnus-cache-active-hashtb)
	  (gnus-sethash group nil gnus-cache-active-hashtb)
	  (setq gnus-cache-active-altered t)))
551 552 553
      articles)))

(defun gnus-cache-braid-nov (group cached &optional file)
554
  (let ((cache-buf (gnus-get-buffer-create " *gnus-cache*"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
555 556 557 558 559
	beg end)
    (gnus-cache-save-buffers)
    (save-excursion
      (set-buffer cache-buf)
      (erase-buffer)
560 561
      (let ((coding-system-for-read gnus-cache-overview-coding-system)
	    (file-name-coding-system nnmail-pathname-coding-system))
562
	(insert-file-contents
563
	 (or file (gnus-cache-file-name group ".overview"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
564 565 566 567 568 569 570 571 572 573
      (goto-char (point-min))
      (insert "\n")
      (goto-char (point-min)))
    (set-buffer nntp-server-buffer)
    (goto-char (point-min))
    (while cached
      (while (and (not (eobp))
		  (< (read (current-buffer)) (car cached)))
	(forward-line 1))
      (beginning-of-line)
574 575 576
      (set-buffer cache-buf)
      (if (search-forward (concat "\n" (int-to-string (car cached)) "\t")
			  nil t)
577
	  (setq beg (point-at-bol)
578 579 580
		end (progn (end-of-line) (point)))
	(setq beg nil))
      (set-buffer nntp-server-buffer)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
581 582 583 584 585 586 587
      (when beg
	(insert-buffer-substring cache-buf beg end)
	(insert "\n"))
      (setq cached (cdr cached)))
    (kill-buffer cache-buf)))

(defun gnus-cache-braid-heads (group cached)
588
  (let ((cache-buf (gnus-get-buffer-create " *gnus-cache*")))
589
    (with-current-buffer cache-buf
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
590 591 592
      (erase-buffer))
    (set-buffer nntp-server-buffer)
    (goto-char (point-min))
593
    (dolist (entry cached)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
594 595 596 597
      (while (and (not (eobp))
		  (looking-at "2.. +\\([0-9]+\\) ")
		  (< (progn (goto-char (match-beginning 1))
			    (read (current-buffer)))
598
		     entry))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
599 600
	(search-forward "\n.\n" nil 'move))
      (beginning-of-line)
601 602
      (set-buffer cache-buf)
      (erase-buffer)
603 604 605
      (let ((coding-system-for-read gnus-cache-coding-system)
	    (file-name-coding-system nnmail-pathname-coding-system))
	(insert-file-contents (gnus-cache-file-name group entry)))
606 607 608 609 610 611 612 613 614
      (goto-char (point-min))
      (insert "220 ")
      (princ (car cached) (current-buffer))
      (insert " Article retrieved.\n")
      (search-forward "\n\n" nil 'move)
      (delete-region (point) (point-max))
      (forward-char -1)
      (insert ".")
      (set-buffer nntp-server-buffer)
615
      (insert-buffer-substring cache-buf))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
616 617 618 619 620 621 622 623 624 625 626
    (kill-buffer cache-buf)))

;;;###autoload
(defun gnus-jog-cache ()
  "Go through all groups and put the articles into the cache.

Usage:
$ emacs -batch -l ~/.emacs -l gnus -f gnus-jog-cache"
  (interactive)
  (let ((gnus-mark-article-hook nil)
	(gnus-expert-user t)
627
	(mail-sources nil)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
628 629 630 631 632 633 634
	(gnus-use-dribble-file nil)
	(gnus-novice-user nil)
	(gnus-large-newsgroup nil))
    ;; Start Gnus.
    (gnus)
    ;; Go through all groups...
    (gnus-group-mark-buffer)
635 636 637 638 639 640 641 642 643
    (gnus-group-iterate nil
      (lambda (group)
	(let (gnus-auto-select-next)
	  (gnus-summary-read-group group nil t)
	  ;; ... and enter the articles into the cache.
	  (when (eq major-mode 'gnus-summary-mode)
	    (gnus-uu-mark-buffer)
	    (gnus-cache-enter-article)
	    (kill-buffer (current-buffer))))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
644 645 646 647

(defun gnus-cache-read-active (&optional force)
  "Read the cache active file."
  (gnus-make-directory gnus-cache-directory)
648
  (if (or (not (file-exists-p gnus-cache-active-file))
649
	  (zerop (nth 7 (file-attributes gnus-cache-active-file)))
650
	  force)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
651 652 653 654 655
      ;; There is no active file, so we generate one.
      (gnus-cache-generate-active)
    ;; We simply read the active file.
    (save-excursion
      (gnus-set-work-buffer)
656
      (nnheader-insert-file-contents gnus-cache-active-file)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
657 658 659 660 661 662 663 664 665 666 667
      (gnus-active-to-gnus-format
       nil (setq gnus-cache-active-hashtb
		 (gnus-make-hashtable
		  (count-lines (point-min) (point-max)))))
      (setq gnus-cache-active-altered nil))))

(defun gnus-cache-write-active (&optional force)
  "Write the active hashtb to the active file."
  (when (or force
	    (and gnus-cache-active-hashtb
		 gnus-cache-active-altered))
668
    (gnus-write-active-file gnus-cache-active-file gnus-cache-active-hashtb t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
669 670 671
    ;; Mark the active hashtb as unaltered.
    (setq gnus-cache-active-altered nil)))

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
(defun gnus-cache-possibly-update-active (group active)
  "Update active info bounds of GROUP with ACTIVE if necessary.
The update is performed if ACTIVE contains a higher or lower bound
than the current."
  (let ((lower t) (higher t))
    (if gnus-cache-active-hashtb
	(let ((cache-active (gnus-gethash group gnus-cache-active-hashtb)))
	  (when cache-active
	    (unless (< (car active) (car cache-active))
	      (setq lower nil))
	    (unless (> (cdr active) (cdr cache-active))
	      (setq higher nil))))
      (gnus-cache-read-active))
    (when lower
      (gnus-cache-update-active group (car active) t))
    (when higher
      (gnus-cache-update-active group (cdr active)))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
(defun gnus-cache-update-active (group number &optional low)
  "Update the upper bound of the active info of GROUP to NUMBER.
If LOW, update the lower bound instead."
  (let ((active (gnus-gethash group gnus-cache-active-hashtb)))
    (if (null active)
	;; We just create a new active entry for this group.
	(gnus-sethash group (cons number number) gnus-cache-active-hashtb)
      ;; Update the lower or upper bound.
      (if low
	  (setcar active number)
	(setcdr active number)))
    ;; Mark the active hashtb as altered.
    (setq gnus-cache-active-altered t)))

;;;###autoload
(defun gnus-cache-generate-active (&optional directory)
  "Generate the cache active file."
  (interactive)
  (let* ((top (null directory))
	 (directory (expand-file-name (or directory gnus-cache-directory)))
710
	 (file-name-coding-system nnmail-pathname-coding-system)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
711 712 713 714 715
	 (files (directory-files directory 'full))
	 (group
	  (if top
	      ""
	    (string-match
716 717 718
	     (concat "^" (regexp-quote
			  (file-name-as-directory
			   (expand-file-name gnus-cache-directory))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
719 720 721 722 723 724 725 726
	     (directory-file-name directory))
	    (nnheader-replace-chars-in-string
	     (substring (directory-file-name directory) (match-end 0))
	     ?/ ?.)))
	 nums alphs)
    (when top
      (gnus-message 5 "Generating the cache active file...")
      (setq gnus-cache-active-hashtb (gnus-make-hashtable 123)))
727
    (when (string-match "^\\(nn[^_]+\\)_" group)
728
      (setq group (replace-match "\\1:" t nil group)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
729 730 731
    ;; Separate articles from all other files and directories.
    (while files
      (if (string-match "^[0-9]+$" (file-name-nondirectory (car files)))
732
	  (push (string-to-number (file-name-nondirectory (pop files))) nums)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
733 734 735
	(push (pop files) alphs)))
    ;; If we have nums, then this is probably a valid group.
    (when (setq nums (sort nums '<))
736 737 738 739 740 741 742
      ;; Use non-decoded group name.
      ;; FIXME: this is kind of a workaround.  The active file should
      ;; be updated at the time articles are cached.  It will make
      ;; `gnus-cache-unified-group-names' needless.
      (gnus-sethash (or (cdr (assoc group gnus-cache-unified-group-names))
			group)
		    (cons (car nums) (gnus-last-element nums))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
743 744
		    gnus-cache-active-hashtb))
    ;; Go through all the other files.
745 746
    (dolist (file alphs)
      (when (and (file-directory-p file)
747
		 (not (string-match "^\\."
748
				    (file-name-nondirectory file))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
749
	;; We descend directories.
750
	(gnus-cache-generate-active file)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
751 752 753 754 755 756 757 758 759 760 761
    ;; Write the new active file.
    (when top
      (gnus-cache-write-active t)
      (gnus-message 5 "Generating the cache active file...done"))))

;;;###autoload
(defun gnus-cache-generate-nov-databases (dir)
  "Generate NOV files recursively starting in DIR."
  (interactive (list gnus-cache-directory))
  (gnus-cache-close)
  (let ((nnml-generate-active-function 'identity))
Miles Bader's avatar
Miles Bader committed
762
    (nnml-generate-nov-databases-directory dir))
763 764 765

  (setq gnus-cache-total-fetched-hashtb nil)

766
  (gnus-cache-open))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
767 768 769

(defun gnus-cache-move-cache (dir)
  "Move the cache tree to somewhere else."
770
  (interactive "FMove the cache tree to: ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
771 772
  (rename-file gnus-cache-directory dir))

773 774 775 776 777 778 779 780 781 782 783 784 785
(defun gnus-cache-fully-p (&optional group)
  "Returns non-nil if the cache should be fully used.
If GROUP is non-nil, also cater to `gnus-cacheable-groups' and
`gnus-uncacheable-groups'."
  (and gnus-use-cache
       (not (eq gnus-use-cache 'passive))
       (if (null group)
	   t
	 (and (or (not gnus-cacheable-groups)
		  (string-match gnus-cacheable-groups group))
	      (or (not gnus-uncacheable-groups)
		  (not (string-match gnus-uncacheable-groups group)))))))

786 787
;;;###autoload
(defun gnus-cache-rename-group (old-group new-group)
788 789 790 791 792
  "Rename OLD-GROUP as NEW-GROUP.
Always updates the cache, even when disabled, as the old cache
files would corrupt Gnus when the cache was next enabled.  It
depends on the caller to determine whether group renaming is
supported."
793
  (let ((old-dir (gnus-cache-file-name old-group ""))
794 795
	(new-dir (gnus-cache-file-name new-group ""))
	(file-name-coding-system nnmail-pathname-coding-system))
796 797
    (gnus-rename-file old-dir new-dir t))

798 799
  (gnus-cache-rename-group-total-fetched-for old-group new-group)

800 801 802
  (let ((no-save gnus-cache-active-hashtb))
    (unless gnus-cache-active-hashtb
      (gnus-cache-read-active))
803 804 805 806 807 808
    (let* ((old-group-hash-value
	    (gnus-gethash old-group gnus-cache-active-hashtb))
	   (new-group-hash-value
	    (gnus-gethash new-group gnus-cache-active-hashtb))
	   (delta
	    (or old-group-hash-value new-group-hash-value)))
809 810 811 812 813 814 815 816 817
      (gnus-sethash new-group old-group-hash-value gnus-cache-active-hashtb)
      (gnus-sethash old-group nil gnus-cache-active-hashtb)

      (if no-save
	  (setq gnus-cache-active-altered delta)
	(gnus-cache-write-active delta)))))

;;;###autoload
(defun gnus-cache-delete-group (group)
818 819 820 821 822
  "Delete GROUP from the cache.
Always updates the cache, even when disabled, as the old cache
files would corrupt gnus when the cache was next enabled.
Depends upon the caller to determine whether group deletion is
supported."
823 824
  (let ((dir (gnus-cache-file-name group ""))
	(file-name-coding-system nnmail-pathname-coding-system))
825
    (gnus-delete-directory dir))
826

827 828
  (gnus-cache-delete-group-total-fetched-for group)

829 830 831 832 833 834 835 836 837 838
  (let ((no-save gnus-cache-active-hashtb))
    (unless gnus-cache-active-hashtb
      (gnus-cache-read-active))
    (let* ((group-hash-value (gnus-gethash group gnus-cache-active-hashtb)))
      (gnus-sethash group nil gnus-cache-active-hashtb)

      (if no-save
	  (setq gnus-cache-active-altered group-hash-value)
	(gnus-cache-write-active group-hash-value)))))

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
(defvar gnus-cache-inhibit-update-total-fetched-for nil)
(defvar gnus-cache-need-update-total-fetched-for nil)

(defmacro gnus-cache-with-refreshed-group (group &rest body)
  `(prog1 (let ((gnus-cache-inhibit-update-total-fetched-for t))
	    ,@body)
     (when (and gnus-cache-need-update-total-fetched-for
		(not gnus-cache-inhibit-update-total-fetched-for))
	(save-excursion
	  (set-buffer gnus-group-buffer)
	  (setq gnus-cache-need-update-total-fetched-for nil)
	  (gnus-group-update-group ,group t)))))

(defun gnus-cache-update-file-total-fetched-for (group file &optional subtract)
  (when gnus-cache-total-fetched-hashtb
    (gnus-cache-with-refreshed-group
     group
     (let* ((entry (or (gnus-gethash group gnus-cache-total-fetched-hashtb)
		       (gnus-sethash group (make-vector 2 0)
				     gnus-cache-total-fetched-hashtb)))
	    size)

       (if file
	   (setq size (or (nth 7 (file-attributes file)) 0))
	 (let* ((file-name-coding-system nnmail-pathname-coding-system)
		(files (directory-files (gnus-cache-file-name group "")
					t nil t))
		file attrs)
	   (setq size 0.0)
	   (while (setq file (pop files))
	     (setq attrs (file-attributes file))
	     (unless (nth 0 attrs)
	       (incf size (float (nth 7 attrs)))))))	     

       (setq gnus-cache-need-update-total-fetched-for t)

       (incf (nth 1 entry) (if subtract (- size) size))))))

(defun gnus-cache-update-overview-total-fetched-for (group file)
  (when gnus-cache-total-fetched-hashtb
    (gnus-cache-with-refreshed-group
     group
     (let* ((entry (or (gnus-gethash group gnus-cache-total-fetched-hashtb)
		       (gnus-sethash group (make-list 2 0) 
				     gnus-cache-total-fetched-hashtb)))
	    (file-name-coding-system nnmail-pathname-coding-system)
	    (size (or (nth 7 (file-attributes 
			      (or file
				  (gnus-cache-file-name group ".overview"))))
		      0)))
       (setq gnus-cache-need-update-total-fetched-for t)
       (setf (nth 0 entry) size)))))

(defun gnus-cache-rename-group-total-fetched-for (old-group new-group)
  "Record of disk space used by OLD-GROUP now associated with NEW-GROUP."
  (when gnus-cache-total-fetched-hashtb
    (let ((entry (gnus-gethash old-group gnus-cache-total-fetched-hashtb)))
      (gnus-sethash new-group entry gnus-cache-total-fetched-hashtb)
      (gnus-sethash old-group nil gnus-cache-total-fetched-hashtb))))

(defun gnus-cache-delete-group-total-fetched-for (group)
  "Delete record of disk space used by GROUP being deleted."
  (when gnus-cache-total-fetched-hashtb
      (gnus-sethash group nil gnus-cache-total-fetched-hashtb)))

(defun gnus-cache-total-fetched-for (group &optional no-inhibit)
  "Get total disk space used by the cache for the specified GROUP."
  (unless (equal group "dummy.group")
    (unless gnus-cache-total-fetched-hashtb
      (setq gnus-cache-total-fetched-hashtb (gnus-make-hashtable 1024)))

    (let* ((entry (gnus-gethash group gnus-cache-total-fetched-hashtb)))
      (if entry
	  (apply '+ entry)
	(let ((gnus-cache-inhibit-update-total-fetched-for (not no-inhibit)))
	  (+ 
	   (gnus-cache-update-overview-total-fetched-for group nil)
	   (gnus-cache-update-file-total-fetched-for     group nil)))))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
918 919
(provide 'gnus-cache)

920
;; arch-tag: 05a79442-8c58-4e65-bd0a-3cbb1b89a33a
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
921
;;; gnus-cache.el ends here