-;;; gnus-cache --- cache interface for Gnus
-;; Copyright (C) 1995 Free Software Foundation, Inc.
+;;; gnus-cache.el --- cache interface for Gnus
-;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
+;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
+;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+
+;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: news
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
+;; For Emacs <22.2 and XEmacs.
+(eval-and-compile
+ (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
+
+(eval-when-compile (require 'cl))
+
(require 'gnus)
+(require 'gnus-sum)
+
+(eval-when-compile
+ (unless (fboundp 'gnus-agent-load-alist)
+ (defun gnus-agent-load-alist (group))))
+
+(defcustom gnus-cache-active-file
+ (expand-file-name "active" gnus-cache-directory)
+ "*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)))
-(defvar gnus-cache-directory (concat gnus-article-save-directory "cache/")
- "*The directory where cached articles will be stored.")
+(defcustom gnus-cacheable-groups nil
+ "*Groups that match this regexp will be cached.
-(defvar gnus-cache-enter-articles '(ticked dormant)
- "*Classes of articles to enter into the cache.")
+If you only want to cache your nntp groups, you could set this
+variable to \"^nntp\".
-(defvar gnus-cache-remove-articles '(read)
- "*Classes of articles to remove from the cache.")
+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)
+ regexp))
+
+(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
+variable to \"^nnml\".
+
+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)
+ regexp))
+
+(defvar gnus-cache-overview-coding-system 'raw-text
+ "Coding system used on Gnus cache files.")
+
+(defvar gnus-cache-coding-system 'raw-text
+ "Coding system used on Gnus cache files.")
\f
+;;; 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)
+(defvar gnus-cache-total-fetched-hashtb nil)
+
+(declare-function nnvirtual-find-group-art "nnvirtual" (group article))
+
+(autoload 'nnml-generate-nov-databases-directory "nnml")
+(autoload 'nnvirtual-find-group-art "nnvirtual")
\f
-(defun gnus-cache-change-buffer (group)
- (save-excursion
- (cond ((null gnus-cache-buffer)
- ;; No current cache, so we create and init the buffer.
- (setq gnus-cache-buffer
- (cons group (get-buffer-create " *gnus-cache-overview*")))
- (set-buffer (cdr gnus-cache-buffer))
- (buffer-disable-undo (current-buffer))
- (erase-buffer)
- (gnus-add-current-to-buffer-list)
- (let ((file (gnus-cache-file-name group ".overview")))
- (and (file-exists-p file)
- (insert-file-contents file))))
- ((not (string= group (car gnus-cache-buffer)))
- ;; If a different overview cache is the current, we
- ;; (possibly) save it and change to this groups.
- (set-buffer (cdr gnus-cache-buffer))
- (and (buffer-modified-p)
- (write-region (point-min) (point-max)
- (gnus-cache-file-name
- (car gnus-cache-buffer) ".overview")
- nil 'quiet))
- (erase-buffer)
- (setcar gnus-cache-buffer group)
- (let ((file (gnus-cache-file-name group ".overview")))
- (and (file-exists-p file)
- (insert-file-contents file)))))))
-
-
-;; Just save the overview buffer.
+;;; 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
+ (when (and (buffer-live-p buffer) (buffer-modified-p buffer))
+ (with-current-buffer buffer
+ (if (> (buffer-size) 0)
+ ;; Non-empty overview, write it to a file.
+ (let ((coding-system-for-write
+ gnus-cache-overview-coding-system))
+ (gnus-write-buffer overview-file))
+ (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)))
+ ;; Kill the buffer -- it's either unmodified or saved.
+ (gnus-kill-buffer buffer)
+ (setq gnus-cache-buffer nil))))
+
+(defun gnus-cache-possibly-enter-article
+ (group article ticked dormant unread &optional force)
+ (when (and (or force (not (eq gnus-use-cache 'passive)))
+ (numberp article)
+ (> article 0)) ; This might be a dummy article.
+ (let ((number article)
+ file headers lines-chars
+ (file-name-coding-system nnmail-pathname-coding-system))
+ ;; 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))))
+ (when (and number
+ (> number 0) ; Reffed article.
+ (or force
+ (and (gnus-cache-fully-p group)
+ (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.
+ (gnus-make-directory (file-name-directory file))
+ ;; Save the article in the cache.
+ (if (file-exists-p file)
+ t ; The article already is saved.
+ (with-current-buffer nntp-server-buffer
+ (require 'gnus-art)
+ (let ((gnus-use-cache nil)
+ (gnus-article-decode-hook nil))
+ (gnus-request-article-this-buffer number group))
+ (when (> (buffer-size) 0)
+ (let ((coding-system-for-write gnus-cache-coding-system))
+ (gnus-write-buffer file)
+ (gnus-cache-update-file-total-fetched-for group file))
+ (setq lines-chars (nnheader-get-lines-and-char))
+ (nnheader-remove-body)
+ (setq headers (nnheader-parse-naked-head))
+ (mail-header-set-number headers number)
+ (mail-header-set-lines headers (car lines-chars))
+ (mail-header-set-chars headers (cadr lines-chars))
+ (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)
+ (nnheader-insert-nov headers)
+ ;; Update the active info.
+ (set-buffer gnus-summary-buffer)
+ (gnus-cache-possibly-update-active group (cons number number))
+ (setq gnus-newsgroup-cached
+ (gnus-add-to-sorted-list gnus-newsgroup-cached article))
+ (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."
+ (when (gnus-cache-fully-p gnus-newsgroup-name)
+ (let ((cache-articles gnus-newsgroup-cached))
+ (gnus-cache-change-buffer gnus-newsgroup-name)
+ (dolist (article gnus-cache-removable-articles)
+ (when (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)
+ "Retrieve ARTICLE in GROUP from the cache."
+ (let ((file (gnus-cache-file-name group article))
+ (buffer-read-only nil)
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (when (file-exists-p file)
+ (erase-buffer)
+ (gnus-kill-all-overlays)
+ (let ((coding-system-for-read gnus-cache-coding-system))
+ (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."
+ (when gnus-cache-active-hashtb
+ (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb)))
+ (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)))))))
+
+(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))
+ (let ((uncached-articles (gnus-sorted-difference articles cached))
+ (cache-file (gnus-cache-file-name group ".overview"))
+ type
+ (file-name-coding-system nnmail-pathname-coding-system))
+ ;; 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)
+ (let ((coding-system-for-read
+ gnus-cache-overview-coding-system))
+ (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 (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")
+ (let (out)
+ (dolist (article (gnus-summary-work-articles n))
+ (gnus-summary-remove-process-mark article)
+ (if (natnump article)
+ (when (gnus-cache-possibly-enter-article
+ gnus-newsgroup-name article
+ nil nil nil t)
+ (setq gnus-newsgroup-undownloaded (delq article gnus-newsgroup-undownloaded))
+ (push article out))
+ (gnus-message 2 "Can't cache article %d" article))
+ (gnus-summary-update-download-mark article)
+ (gnus-summary-update-secondary-mark article))
+ (gnus-summary-next-subject 1)
+ (gnus-summary-position-point)
+ (nreverse out)))
+
+(defun gnus-cache-remove-article (&optional 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-cache-change-buffer gnus-newsgroup-name)
+ (let (out)
+ (dolist (article (gnus-summary-work-articles n))
+ (gnus-summary-remove-process-mark article)
+ (when (gnus-cache-possibly-remove-article article nil nil nil t)
+ (when gnus-newsgroup-agentized
+ (let ((alist (gnus-agent-load-alist gnus-newsgroup-name)))
+ (unless (cdr (assoc article alist))
+ (setq gnus-newsgroup-undownloaded
+ (gnus-add-to-sorted-list
+ gnus-newsgroup-undownloaded article)))))
+ (push article out))
+ (gnus-summary-update-download-mark article)
+ (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)
+ (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))))
+
+(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"))))
+
+;;; Internal functions.
+
+(defun gnus-cache-change-buffer (group)
(and gnus-cache-buffer
- (save-excursion
- (set-buffer (cdr gnus-cache-buffer))
- (and (buffer-modified-p)
- (write-region (point-min) (point-max)
- (gnus-cache-file-name (car gnus-cache-buffer)
- ".overview")
- nil 'quiet))))
- (setq gnus-cache-buffer nil))
+ ;; 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
+ (set-buffer (gnus-get-buffer-create
+ " *gnus-cache-overview*"))))
+ ;; Insert the contents of this group's cache overview.
+ (erase-buffer)
+ (let ((file (gnus-cache-file-name group ".overview"))
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (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) (memq 'read class))))
+ (and (not unread) (not ticked) (not dormant) (memq 'read class))))
+
+(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)))
(defun gnus-cache-file-name (group article)
- (concat (file-name-as-directory gnus-cache-directory)
- (if (gnus-use-long-file-name 'not-cache)
- group (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 (header-number headers))
- file dir)
- (if (or (not (gnus-cache-member-of-class
- gnus-cache-enter-articles ticked dormant unread))
- (file-exists-p (setq file (gnus-cache-file-name group article))))
- ()
- (gnus-summary-select-article)
- (or (file-exists-p (setq dir (file-name-directory file)))
- (gnus-make-directory dir))
- (if (file-exists-p file)
- t
- (save-excursion
- (set-buffer gnus-article-buffer)
- (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 (and (not (bobp))
- (> (read (current-buffer)) number))
- (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))
- ;; [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\n"
- (header-number headers)
- (header-subject headers)
- (header-date headers)
- (header-id headers)
- (or (header-references headers) "")
- (or (header-chars headers) "")
- (or (header-lines headers) "")
- (or (header-xref headers) ""))))
- t))))
-
-(defun gnus-cache-possibly-remove-article
- (group article ticked dormant unread)
- (let ((file (gnus-cache-file-name group article)))
- (if (or (not (file-exists-p file))
- (not (gnus-cache-member-of-class
- gnus-cache-remove-articles ticked dormant unread)))
- nil
+ (setq group (gnus-cache-decoded-group-name group))
+ (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)
+ (setq group (concat (substring group 0 (match-beginning 0))
+ "/" (substring group (match-end 0)))))
+ (nnheader-replace-chars-in-string group ?. ?/)))
+ t)
+ gnus-cache-directory))))
+
+(defun gnus-cache-update-article (group article)
+ "If ARTICLE is in the cache, remove it and re-enter it."
+ (gnus-cache-change-buffer group)
+ (when (gnus-cache-possibly-remove-article article nil nil nil t)
+ (let ((gnus-use-cache nil))
+ (gnus-cache-possibly-enter-article
+ gnus-newsgroup-name article
+ 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)
+ file
+ (file-name-coding-system nnmail-pathname-coding-system))
+ ;; 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
+ (gnus-cache-update-file-total-fetched-for group file t)
(delete-file file)
- (gnus-cache-change-buffer group)
+
(set-buffer (cdr gnus-cache-buffer))
(goto-char (point-min))
- (if (or (looking-at (concat (string-to-int article) "\t"))
- (search-forward (concat "\n" (string-to-int article) "\t")))
- (delete-region (progn (beginning-of-line) (point))
- (progn (forward-line 1) (point))))))))
-
-(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)
+ (when (or (looking-at (concat (int-to-string number) "\t"))
+ (search-forward (concat "\n" (int-to-string number) "\t")
+ (point-max) t))
+ (gnus-delete-line)))
+ (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))
+ (gnus-summary-update-secondary-mark article)
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)))))
+ articles
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (when (file-exists-p dir)
+ (setq articles
+ (sort (mapcar (lambda (name) (string-to-number name))
+ (directory-files dir nil "^[0-9]+$" t))
+ '<))
+ ;; Update the cache active file, just to synch more.
+ (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)))
+ 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 (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)))))
-
-(defun gnus-cache-braid-nov (group cached)
- (let ((cache-buf (get-buffer-create " *gnus-cache*"))
+(defun gnus-cache-braid-nov (group cached &optional file)
+ (let ((cache-buf (gnus-get-buffer-create " *gnus-cache*"))
beg end)
(gnus-cache-save-buffers)
- (save-excursion
- (set-buffer cache-buf)
- (buffer-disable-undo (current-buffer))
+ (with-current-buffer cache-buf
(erase-buffer)
- (insert-file-contents (gnus-cache-file-name group ".overview"))
+ (let ((coding-system-for-read gnus-cache-overview-coding-system)
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (insert-file-contents
+ (or file (gnus-cache-file-name group ".overview"))))
(goto-char (point-min))
(insert "\n")
(goto-char (point-min)))
(< (read (current-buffer)) (car cached)))
(forward-line 1))
(beginning-of-line)
- (save-excursion
- (set-buffer cache-buf)
- (if (search-forward (concat "\n" (int-to-string (car cached)) "\t")
- nil t)
- (setq beg (progn (beginning-of-line) (point))
- end (progn (forward-line 1) (point)))
- (setq beg nil)))
- (and beg (insert-buffer-substring cache-buf beg end))
+ (set-buffer cache-buf)
+ (if (search-forward (concat "\n" (int-to-string (car cached)) "\t")
+ nil t)
+ (setq beg (point-at-bol)
+ end (progn (end-of-line) (point)))
+ (setq beg nil))
+ (set-buffer nntp-server-buffer)
+ (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)
- (let ((cache-buf (get-buffer-create " *gnus-cache*"))
- beg end)
- (save-excursion
- (set-buffer cache-buf)
- (buffer-disable-undo (current-buffer))
+ (let ((cache-buf (gnus-get-buffer-create " *gnus-cache*")))
+ (with-current-buffer cache-buf
(erase-buffer))
(set-buffer nntp-server-buffer)
(goto-char (point-min))
- (while cached
+ (dolist (entry cached)
(while (and (not (eobp))
(looking-at "2.. +\\([0-9]+\\) ")
(< (progn (goto-char (match-beginning 1))
(read (current-buffer)))
- (car cached)))
+ entry))
(search-forward "\n.\n" nil 'move))
(beginning-of-line)
- (save-excursion
- (set-buffer cache-buf)
- (erase-buffer)
- (insert-file-contents (gnus-cache-file-name group (car cached)))
- (goto-char (point-min))
- (insert "220 " (int-to-string (car cached)) " Article retrieved.\n")
- (search-forward "\n\n" nil 'move)
- (delete-region (point) (point-max))
- (forward-char -1)
- (insert "."))
- (insert-buffer-substring cache-buf)
- (setq cached (cdr cached)))
+ (set-buffer cache-buf)
+ (erase-buffer)
+ (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)))
+ (goto-char (point-min))
+ (insert "220 ")
+ (princ (pop 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)
+ (insert-buffer-substring cache-buf))
(kill-buffer cache-buf)))
+;;;###autoload
(defun gnus-jog-cache ()
- "Go through all groups and put the articles into the 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 ((newsrc (cdr gnus-newsrc-alist))
- (gnus-cache-enter-articles '(unread))
- (gnus-mark-article-hook nil)
+ (let ((gnus-mark-article-hook nil)
(gnus-expert-user t)
+ (mail-sources nil)
+ (gnus-use-dribble-file nil)
+ (gnus-novice-user nil)
(gnus-large-newsgroup nil))
- (while newsrc
- (gnus-summary-read-group (car (car newsrc)))
- (if (not (eq major-mode 'gnus-summary-mode))
- ()
- (while gnus-newsgroup-unreads
- (gnus-summary-select-article t t nil (car gnus-newsgroup-unreads))
- (setq gnus-newsgroup-unreads (cdr gnus-newsgroup-unreads)))
- (kill-buffer (current-buffer)))
- (setq newsrc (cdr newsrc)))))
+ ;; Start Gnus.
+ (gnus)
+ ;; Go through all groups...
+ (gnus-group-mark-buffer)
+ (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))))))))
+
+(defun gnus-cache-read-active (&optional force)
+ "Read the cache active file."
+ (gnus-make-directory gnus-cache-directory)
+ (if (or (not (file-exists-p gnus-cache-active-file))
+ (zerop (nth 7 (file-attributes gnus-cache-active-file)))
+ force)
+ ;; 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)
+ (nnheader-insert-file-contents gnus-cache-active-file)
+ (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))
+ (gnus-write-active-file gnus-cache-active-file gnus-cache-active-hashtb t)
+ ;; Mark the active hashtb as unaltered.
+ (setq gnus-cache-active-altered nil)))
+
+(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)))))
+
+(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)))
+ (file-name-coding-system nnmail-pathname-coding-system)
+ (files (directory-files directory 'full))
+ (group
+ (if top
+ ""
+ (string-match
+ (concat "^" (regexp-quote
+ (file-name-as-directory
+ (expand-file-name gnus-cache-directory))))
+ (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)))
+ (when (string-match "^\\(nn[^_]+\\)_" group)
+ (setq group (replace-match "\\1:" t nil group)))
+ ;; Separate articles from all other files and directories.
+ (while files
+ (if (string-match "^[0-9]+$" (file-name-nondirectory (car files)))
+ (push (string-to-number (file-name-nondirectory (pop files))) nums)
+ (push (pop files) alphs)))
+ ;; If we have nums, then this is probably a valid group.
+ (when (setq nums (sort nums '<))
+ ;; 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))
+ gnus-cache-active-hashtb))
+ ;; Go through all the other files.
+ (dolist (file alphs)
+ (when (and (file-directory-p file)
+ (not (string-match "^\\."
+ (file-name-nondirectory file))))
+ ;; We descend directories.
+ (gnus-cache-generate-active file)))
+ ;; 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))
+ (nnml-generate-nov-databases-directory dir))
+
+ (setq gnus-cache-total-fetched-hashtb nil)
+
+ (gnus-cache-open))
+
+(defun gnus-cache-move-cache (dir)
+ "Move the cache tree to somewhere else."
+ (interactive "FMove the cache tree to: ")
+ (rename-file gnus-cache-directory dir))
+
+(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)))))))
+
+;;;###autoload
+(defun gnus-cache-rename-group (old-group new-group)
+ "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."
+ (let ((old-dir (gnus-cache-file-name old-group ""))
+ (new-dir (gnus-cache-file-name new-group ""))
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (gnus-rename-file old-dir new-dir t))
+
+ (gnus-cache-rename-group-total-fetched-for old-group new-group)
+
+ (let ((no-save gnus-cache-active-hashtb))
+ (unless gnus-cache-active-hashtb
+ (gnus-cache-read-active))
+ (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)))
+ (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)
+ "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."
+ (let ((dir (gnus-cache-file-name group ""))
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (gnus-delete-directory dir))
+
+ (gnus-cache-delete-group-total-fetched-for group)
+
+ (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)))))
+
+(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))
+ (with-current-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)))))))
(provide 'gnus-cache)
-
+
;;; gnus-cache.el ends here
projects / gnus / blobdiff