;;; Code:
(require 'gnus)
+(eval-when-compile (require 'cl))
-(defvar gnus-cache-directory (concat gnus-article-save-directory "cache/")
+(defvar gnus-cache-directory
+ (concat (file-name-as-directory gnus-article-save-directory) "cache/")
"*The directory where cached articles will be stored.")
+(defvar gnus-cache-active-file
+ (concat (file-name-as-directory gnus-cache-directory) "active")
+ "*The cache active file.")
+
(defvar gnus-cache-enter-articles '(ticked dormant)
"*Classes of articles to enter into the cache.")
(defvar gnus-cache-remove-articles '(read)
"*Classes of articles to remove from the cache.")
+(defvar gnus-uncacheable-groups "^nnvirtual"
+ "*Groups that match this regexp will not be cached.
+
+If you want to avoid caching your nnml groups, you could set this
+variable to \"^nnml\".")
+
\f
+;;; Internal variables.
+
(defvar gnus-cache-buffer nil)
+(defvar gnus-cache-active-hashtb nil)
+(defvar gnus-cache-active-altered nil)
\f
-(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
- (or gnus-cache-buffer
- ;; create cache buffer
- (save-excursion
- (setq gnus-cache-buffer
- (cons group
- (set-buffer (get-buffer-create " *gnus-cache-overview*"))))
- (buffer-disable-undo (current-buffer))
- ;; insert the contents of this groups cache overview
- (erase-buffer)
- (let ((file (gnus-cache-file-name group ".overview")))
- (and (file-exists-p file)
- (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))))
+;;; Functions called from Gnus.
+
+(defun gnus-cache-open ()
+ "Initialize the cache."
+ (gnus-cache-read-active))
+(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
(gnus-kill-buffer buffer)
(setq gnus-cache-buffer nil))))
+(defun gnus-cache-possibly-enter-article
+ (group article headers ticked dormant unread &optional force)
+ (when (or force (not (eq gnus-use-cache 'passive)))
+ (let ((number (mail-header-number headers))
+ file dir)
+ (when (and (vectorp headers) ; This might be a dummy article.
+ (> number 0) ; Reffed article.
+ (or (not gnus-uncacheable-groups)
+ (not (string-match gnus-uncacheable-groups group)))
+ (or force
+ (gnus-cache-member-of-class
+ gnus-cache-enter-articles ticked dormant unread))
+ (not (file-exists-p (setq file (gnus-cache-file-name
+ group article)))))
+ ;; Possibly create the cache directory.
+ (or (file-exists-p (setq dir (file-name-directory file)))
+ (gnus-make-directory dir))
+ ;; Save the article in the cache.
+ (if (file-exists-p file)
+ t ; The article already is saved.
+ (let ((gnus-use-cache nil))
+ (gnus-summary-select-article))
+ (save-excursion
+ (set-buffer gnus-original-article-buffer)
+ (save-restriction
+ (widen)
+ (write-region (point-min) (point-max) file nil 'quiet))
+ (gnus-cache-change-buffer group)
+ (set-buffer (cdr gnus-cache-buffer))
+ (goto-char (point-max))
+ (forward-line -1)
+ (while (condition-case ()
+ (and (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)
+ (if (< (read (current-buffer)) number)
+ (forward-line 1)))
+ (beginning-of-line))
+ (forward-line 1))
+ (beginning-of-line)
+ ;; [number subject from date id references chars lines xref]
+ (insert (format "%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t\n"
+ (mail-header-number headers)
+ (mail-header-subject headers)
+ (mail-header-from headers)
+ (mail-header-date headers)
+ (mail-header-id headers)
+ (or (mail-header-references headers) "")
+ (or (mail-header-chars headers) "")
+ (or (mail-header-lines headers) "")
+ (or (mail-header-xref headers) ""))))
+ ;; Update the active info.
+ (gnus-cache-update-active group number)
+ (push number gnus-newsgroup-cached)
+ t)))))
+
+(defun gnus-cache-enter-remove-article (article)
+ "Mark ARTICLE for later possible removal."
+ (setq gnus-cache-removeable-articles
+ (cons article gnus-cache-removeable-articles)))
+
+(defun gnus-cache-possibly-remove-articles ()
+ "Possibly remove some of the removable articles."
+ (unless (eq gnus-use-cache 'passive)
+ (let ((articles gnus-cache-removeable-articles)
+ (cache-articles gnus-newsgroup-cached)
+ article)
+ (gnus-cache-change-buffer gnus-newsgroup-name)
+ (while articles
+ (if (memq (setq article (pop articles)) cache-articles)
+ ;; 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))
+ (buffer-read-only nil))
+ (when (file-exists-p file)
+ (erase-buffer)
+ (gnus-kill-all-overlays)
+ (insert-file-contents file)
+ t)))
+
+(defun gnus-cache-possibly-alter-active (group active)
+ "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
+ (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb)))
+ (and cache-active
+ (< (car cache-active) (car active))
+ (setcar active (car cache-active)))
+ (and cache-active
+ (> (cdr cache-active) (cdr active))
+ (setcdr active (cdr cache-active)))))
+
+(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)))
+ (articles (gnus-sorted-complement articles cached))
+ (cache-file (gnus-cache-file-name group ".overview"))
+ type)
+ ;; We first retrieve all the headers that we don't have in
+ ;; the cache.
+ (let ((gnus-use-cache nil))
+ (setq type (and articles
+ (gnus-retrieve-headers 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)
+ (insert-file-contents cache-file)
+ '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 cached)
+ type)))))
+
+(defun gnus-cache-enter-article (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")
+ (gnus-set-global-variables)
+ (let ((articles (gnus-summary-work-articles n))
+ article out)
+ (while articles
+ (setq article (pop articles))
+ (when (gnus-cache-possibly-enter-article
+ gnus-newsgroup-name article (gnus-summary-article-header article)
+ nil nil nil t)
+ (push article out))
+ (gnus-summary-remove-process-mark article)
+ (gnus-summary-update-secondary-mark article))
+ (gnus-summary-position-point)
+ (nreverse out)))
+
+(defun gnus-cache-remove-article (n)
+ "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-set-global-variables)
+ (let ((articles (gnus-summary-work-articles n))
+ article out)
+ (while articles
+ (setq article (pop articles))
+ (when (gnus-cache-possibly-remove-article article nil nil nil t)
+ (push article out))
+ (gnus-summary-remove-process-mark article)
+ (gnus-summary-update-secondary-mark article))
+ (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))
+
+;;; 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
+ (or gnus-cache-buffer
+ ;; Create cache buffer
+ (save-excursion
+ (setq gnus-cache-buffer
+ (cons group
+ (set-buffer (get-buffer-create " *gnus-cache-overview*"))))
+ (buffer-disable-undo (current-buffer))
+ ;; Insert the contents of this group's cache overview.
+ (erase-buffer)
+ (let ((file (gnus-cache-file-name group ".overview")))
+ (and (file-exists-p file)
+ (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)
(defun gnus-cache-file-name (group article)
(concat (file-name-as-directory gnus-cache-directory)
- (if (gnus-use-long-file-name 'not-cache)
- group
- (let ((group (concat group "")))
- (if (string-match ":" group)
- (aset group (match-beginning 0) ?/))
- (gnus-replace-chars-in-string group ?. ?/)))
- "/" (if (stringp article) article (int-to-string article))))
-
-(defun gnus-cache-possibly-enter-article
- (group article headers ticked dormant unread)
- (let ((number (mail-header-number headers))
- file dir)
- (if (or (not (vectorp headers)) ; This might be a dummy article.
- (< number 0) ; Reffed article from other group.
- (not (gnus-cache-member-of-class
- gnus-cache-enter-articles ticked dormant unread))
- (file-exists-p (setq file (gnus-cache-file-name group article))))
- () ; Do nothing.
- ;; Possibly create the cache directory.
- (or (file-exists-p (setq dir (file-name-directory file)))
- (gnus-make-directory dir))
- ;; Save the article in the cache.
- (if (file-exists-p file)
- t ; The article already is saved, so we end here.
- (let ((gnus-use-cache nil))
- (gnus-summary-select-article))
- (save-excursion
- (set-buffer gnus-article-buffer)
- (save-restriction
- (widen)
- (write-region (point-min) (point-max) file nil 'quiet))
- (gnus-cache-change-buffer group)
- (set-buffer (cdr gnus-cache-buffer))
- (goto-char (point-max))
- (forward-line -1)
- (while (condition-case ()
- (and (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)
- (if (< (read (current-buffer)) number)
- (forward-line 1)))
- (beginning-of-line))
- (forward-line 1))
- (beginning-of-line)
- ;; [number subject from date id references chars lines xref]
- (insert (format "%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t\n"
- (mail-header-number headers)
- (mail-header-subject headers)
- (mail-header-from headers)
- (mail-header-date headers)
- (mail-header-id headers)
- (or (mail-header-references headers) "")
- (or (mail-header-chars headers) "")
- (or (mail-header-lines headers) "")
- (or (mail-header-xref headers) ""))))
- t))))
-
-(defun gnus-cache-enter-remove-article (article)
- (setq gnus-cache-removeable-articles
- (cons article gnus-cache-removeable-articles)))
-
-(defsubst gnus-cache-possibly-remove-article
- (article ticked dormant unread)
+ (file-name-as-directory
+ (if (gnus-use-long-file-name 'not-cache)
+ group
+ (let ((group (concat group "")))
+ (if (string-match ":" group)
+ (aset group (match-beginning 0) ?/))
+ (gnus-replace-chars-in-string group ?. ?/))))
+ (if (stringp article) article (int-to-string article))))
+
+(defun gnus-cache-possibly-remove-article
+ (article ticked dormant unread &optional force)
+ "Possibly remove ARTICLE from the cache."
(let ((file (gnus-cache-file-name gnus-newsgroup-name article)))
- (if (or (not (file-exists-p file))
- (not (gnus-cache-member-of-class
- gnus-cache-remove-articles ticked dormant unread)))
- nil
+ (when (and (file-exists-p file)
+ (or force
+ (gnus-cache-member-of-class
+ gnus-cache-remove-articles ticked dormant unread)))
(save-excursion
(delete-file file)
(set-buffer (cdr gnus-cache-buffer))
(search-forward (concat "\n" (int-to-string article) "\t")
(point-max) t))
(delete-region (progn (beginning-of-line) (point))
- (progn (forward-line 1) (point))))))))
-
-(defun gnus-cache-possibly-remove-articles ()
- (let ((articles gnus-cache-removeable-articles)
- (cache-articles (gnus-cache-articles-in-group gnus-newsgroup-name))
- article)
- (gnus-cache-change-buffer gnus-newsgroup-name)
- (while articles
- (setq article (car articles)
- articles (cdr articles))
- (if (memq article cache-articles)
- ;; 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)
- (let ((file (gnus-cache-file-name group article)))
- (if (not (file-exists-p file))
- ()
- (erase-buffer)
- (insert-file-contents file)
+ (progn (forward-line 1) (point)))))
+ (setq gnus-newsgroup-cached
+ (delq article gnus-newsgroup-cached))
t)))
(defun gnus-cache-articles-in-group (group)
+ "Return a sorted list of cached articles in GROUP."
(let ((dir (file-name-directory (gnus-cache-file-name group 1)))
articles)
- (if (not (file-exists-p dir))
- nil
- (setq articles (directory-files dir nil "^[0-9]+$" t))
- (if (not articles)
- nil
- (sort (mapcar (function (lambda (name)
- (string-to-int name)))
- articles)
- '<)))))
-
-(defun gnus-cache-active-articles (group)
- (let ((articles (gnus-cache-articles-in-group group)))
- (and articles
- (cons (car articles) (gnus-last-element articles)))))
-
-(defun gnus-cache-possibly-alter-active (group active)
- (let ((cache-active (gnus-cache-active-articles group)))
- (and cache-active (< (car cache-active) (car active))
- (setcar active (car cache-active)))
- (and cache-active (> (cdr cache-active) (cdr active))
- (setcdr active (cdr cache-active)))))
-
-(defun gnus-cache-retrieve-headers (articles group)
- (let* ((cached (gnus-cache-articles-in-group group))
- (articles (gnus-sorted-complement articles cached))
- (cache-file (gnus-cache-file-name group ".overview"))
- type)
- (let ((gnus-use-cache nil))
- (setq type (and articles (gnus-retrieve-headers articles group))))
- (gnus-cache-save-buffers)
- (save-excursion
- (cond ((not (file-exists-p cache-file))
- type)
- ((null type)
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (insert-file-contents cache-file)
- 'nov)
- ((eq type 'nov)
- (gnus-cache-braid-nov group cached)
- type)
- (t
- (gnus-cache-braid-heads group cached)
- type)))))
+ (when (file-exists-p dir)
+ (sort (mapcar (lambda (name) (string-to-int name))
+ (directory-files dir nil "^[0-9]+$" t))
+ '<))))
(defun gnus-cache-braid-nov (group cached)
(let ((cache-buf (get-buffer-create " *gnus-cache*"))
(setq cached (cdr cached)))
(kill-buffer cache-buf)))
+;;;###autoload
(defun gnus-jog-cache ()
"Go through all groups and put the articles into the cache."
(interactive)
(kill-buffer (current-buffer)))
(setq newsrc (cdr newsrc)))))
+(defun gnus-cache-read-active (&optional force)
+ "Read the cache active file."
+ (if (not (and (file-exists-p gnus-cache-active-file)
+ (or force (not gnus-cache-active-hashtb))))
+ ;; There is no active file, so we generate one.
+ (gnus-cache-generate-active)
+ &nb
projects / gnus / blobdiff