xemacs-beta: lisp/gnus/gnus-cache.el comparison

comparison lisp/gnus/gnus-cache.el @ 16:0293115a14e9 r19-15b91

Import from CVS: tag r19-15b91

author	cvs
date	Mon, 13 Aug 2007 08:49:20 +0200
parents	ac2d302a0011
children	ec9a17fef872

comparison

equal deleted inserted replaced

-:ad457d5f7d04
+:0293115a14e9
 ;;; gnus-cache.el --- cache interface for Gnus
-;; Copyright (C) 1995,96 Free Software Foundation, Inc.
+;; Copyright (C) 1995,96,97 Free Software Foundation, Inc.
 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
 ;; Keywords: news
 ;; This file is part of GNU Emacs.
 ;;; Commentary:
 ;;; Code:
 (require 'gnus)
-(eval-when-compile (require 'cl))
+(require 'gnus-int)
+(require 'gnus-range)
-(defvar gnus-cache-directory
+(require 'gnus-start)
+(eval-when-compile
+(require 'gnus-sum))
+(defgroup gnus-cache nil
+"Cache interface."
+:group 'gnus)
+(defcustom gnus-cache-directory
 (nnheader-concat gnus-directory "cache/")
-"*The directory where cached articles will be stored.")
+"*The directory where cached articles will be stored."
+:group 'gnus-cache
-(defvar gnus-cache-active-file
+:type 'directory)
+(defcustom gnus-cache-active-file
 (concat (file-name-as-directory gnus-cache-directory) "active")
-"*The cache active file.")
+"*The cache active file."
+:group 'gnus-cache
-(defvar gnus-cache-enter-articles '(ticked dormant)
+:type 'file)
-"*Classes of articles to enter into the cache.")
+(defcustom gnus-cache-enter-articles '(ticked dormant)
-(defvar gnus-cache-remove-articles '(read)
+"Classes of articles to enter into the cache."
-"*Classes of articles to remove from the cache.")
+:group 'gnus-cache
+:type '(set (const ticked) (const dormant) (const unread) (const read)))
-(defvar gnus-uncacheable-groups nil
+(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)))
+(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\".")
+variable to \"^nnml\"."
+:group 'gnus-cache
+:type '(choice (const :tag "off" nil)
+		 regexp))
 ;;; 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)
 (eval-and-compile
 (when (or (file-exists-p gnus-cache-directory)
 	    (and gnus-use-cache
 		 (not (eq gnus-use-cache 'passive))))
 (gnus-cache-read-active)))
-(condition-case ()
+;; Complexities of byte-compiling make this kludge necessary.  Eeek.
-(gnus-add-shutdown 'gnus-cache-close 'gnus)
+(ignore-errors
-;; Complexities of byte-compiling makes this kludge necessary.  Eeek.
+(gnus-add-shutdown 'gnus-cache-close 'gnus))
-(error nil))
 (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
-(if (null gnus-cache-buffer)
+(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
-(if (buffer-modified-p buffer)
+(when (buffer-modified-p buffer)
-	  (save-excursion
+	(save-excursion
-	    (set-buffer buffer)
+	  (set-buffer buffer)
-	    (if (> (buffer-size) 0)
+	  (if (> (buffer-size) 0)
-		;; non-empty overview, write it out
+	      ;; Non-empty overview, write it to a file.
-		(progn
+	      (gnus-write-buffer overview-file)
-		  (gnus-make-directory (file-name-directory overview-file))
+	    ;; Empty overview file, remove it
-		  (write-region (point-min) (point-max)
+	    (when (file-exists-p overview-file)
-				overview-file nil 'quietly))
+	      (delete-file overview-file))
-	      ;; empty overview file, remove it
+	    ;; If possible, remove group's cache subdirectory.
-	      (and (file-exists-p overview-file)
+	    (condition-case nil
-		   (delete-file overview-file))
+		;; FIXME: we can detect the error type and warn the user
-	      ;; if possible, remove group's cache subdirectory
+		;; of any inconsistencies (articles w/o nov entries?).
-	      (condition-case nil
+		;; for now, just be conservative...delete only if safe -- sj
-		  ;; FIXME: we can detect the error type and warn the user
+		(delete-directory (file-name-directory overview-file))
-		  ;; of any inconsistencies (articles w/o nov entries?).
+	      (error nil)))))
-		  ;; for now, just be conservative...delete only if safe -- sj
+;; Kill the buffer -- it's either unmodified or saved.
-		  (delete-directory (file-name-directory overview-file))
-		(error nil)))))
-;; 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 headers ticked dormant unread &optional force)
 (when (and (or force (not (eq gnus-use-cache 'passive)))
 	     (numberp article)
 	     (> article 0)
-	     (vectorp headers))	; This might be a dummy article.
+	     (vectorp headers))
+					; This might be a dummy article.
 ;; 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)
 	      headers (copy-sequence headers))
 	(mail-header-set-number headers (cdr result))))
 (let ((number (mail-header-number headers))
 	  file dir)
 (when (and (> number 0)		; Reffed article.
-		 (or (not gnus-uncacheable-groups)
-		     (not (string-match gnus-uncacheable-groups group)))
 		 (or force
-		     (gnus-cache-member-of-class
+		     (and (or (not gnus-uncacheable-groups)
-		      gnus-cache-enter-articles ticked dormant unread))
+			      (not (string-match
+				    gnus-uncacheable-groups 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.
-	(or (file-exists-p (setq dir (file-name-directory file)))
+	(gnus-make-directory (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.
 	  (save-excursion
 	    (set-buffer nntp-server-buffer)
 	    (let ((gnus-use-cache nil))
 	      (gnus-request-article-this-buffer number group))
 	    (when (> (buffer-size) 0)
-	      (write-region (point-min) (point-max) file nil 'quiet)
+	      (gnus-write-buffer file)
 	      (gnus-cache-change-buffer group)
 	      (set-buffer (cdr gnus-cache-buffer))
 	      (goto-char (point-max))
 	      (forward-line -1)
 	      (while (condition-case ()
-			 (and (not (bobp))
+			 (when (not (bobp))
-			      (> (read (current-buffer)) number))
+			   (> (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)
+			(when (< (read (current-buffer)) number)
-			    (forward-line 1)))
+			  (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"
 (let ((articles gnus-cache-removable-articles)
 	  (cache-articles gnus-newsgroup-cached)
 	  article)
 (gnus-cache-change-buffer gnus-newsgroup-name)
 (while articles
-	(if (memq (setq article (pop articles)) cache-articles)
+	(when (memq (setq article (pop articles)) cache-articles)
-	    ;; The article was in the cache, so we see whether we are
+	  ;; The article was in the cache, so we see whether we are
-	    ;; supposed to remove it from the cache.
+	  ;; supposed to remove it from the cache.
-	    (gnus-cache-possibly-remove-article
+	  (gnus-cache-possibly-remove-article
-	     article (memq article gnus-newsgroup-marked)
+	   article (memq article gnus-newsgroup-marked)
-	     (memq article gnus-newsgroup-dormant)
+	   (memq article gnus-newsgroup-dormant)
-	     (or (memq article gnus-newsgroup-unreads)
+	   (or (memq article gnus-newsgroup-unreads)
-		 (memq article gnus-newsgroup-unselected))))))
+	       (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)
 (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 (equal group "no.norsk") (error "hie"))
 (when gnus-cache-active-hashtb
 (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb)))
 (and cache-active
 	   (< (car cache-active) (car active))
 	   (setcar active (car cache-active)))
 Returns the list of articles entered."
 (interactive "P")
 (gnus-set-global-variables)
 (let ((articles (gnus-summary-work-articles n))
 	article out)
-(while articles
+(while (setq article (pop articles))
-(setq article (pop articles))
+(if (natnump article)
-(when (gnus-cache-possibly-enter-article
+	  (when (gnus-cache-possibly-enter-article
-	     gnus-newsgroup-name article (gnus-summary-article-header article)
+		 gnus-newsgroup-name article
-	     nil nil nil t)
+		 (gnus-summary-article-header article)
-	(push article out))
+		 nil nil nil t)
+	    (push article out))
+	(gnus-message 2 "Can't cache article %d" article))
 (gnus-summary-remove-process-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 ((cached gnus-newsgroup-cached)
+	(gnus-verbose (max 6 gnus-verbose)))
+(unless cached
+(error "No cached articles for this group"))
+(while cached
+(gnus-summary-goto-subject (pop cached) t))))
 ;;; 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
+(unless gnus-cache-buffer
 ;; Create cache buffer
 (save-excursion
-	(setq gnus-cache-buffer
+(setq gnus-cache-buffer
-	      (cons group
+	    (cons group
-		    (set-buffer (get-buffer-create " *gnus-cache-overview*"))))
+		  (set-buffer (get-buffer-create " *gnus-cache-overview*"))))
-	(buffer-disable-undo (current-buffer))
+(buffer-disable-undo (current-buffer))
-	;; Insert the contents of this group's cache overview.
+;; Insert the contents of this group's cache overview.
-	(erase-buffer)
+(erase-buffer)
-	(let ((file (gnus-cache-file-name group ".overview")))
+(let ((file (gnus-cache-file-name group ".overview")))
-	  (and (file-exists-p file)
+	(when (file-exists-p file)
-	       (insert-file-contents file)))
+	  (nnheader-insert-file-contents file)))
-	;; We have a fresh (empty/just loaded) buffer,
+;; We have a fresh (empty/just loaded) buffer,
-	;; mark it as unmodified to save a redundant write later.
+;; mark it as unmodified to save a redundant write later.
-	(set-buffer-modified-p nil))))
+(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 (not unread) (not ticked) (not dormant) (memq 'read class))))
 (defun gnus-cache-file-name (group article)
 (concat (file-name-as-directory gnus-cache-directory)
 	  (file-name-as-directory
-	   (if (gnus-use-long-file-name 'not-cache)
+	   (nnheader-translate-file-chars
-	       group
+	    (if (gnus-use-long-file-name 'not-cache)
-	     (let ((group (nnheader-replace-chars-in-string group ?/ ?_)))
+		group
-	       ;; Translate the first colon into a slash.
+	      (let ((group (nnheader-replace-chars-in-string group ?/ ?_)))
-	       (when (string-match ":" group)
+		;; Translate the first colon into a slash.
-		 (aset group (match-beginning 0) ?/))
+		(when (string-match ":" group)
-	       (nnheader-replace-chars-in-string group ?. ?/))))
+		  (aset group (match-beginning 0) ?/))
+		(nnheader-replace-chars-in-string group ?. ?/)))))
 	  (if (stringp article) article (int-to-string article))))
 (defun gnus-cache-update-article (group article)
 "If ARTICLE is in the cache, remove it and re-enter it."
 (when (gnus-cache-possibly-remove-article article nil nil nil t)
 		    gnus-cache-remove-articles ticked dormant unread)))
 (save-excursion
 	(delete-file file)
 	(set-buffer (cdr gnus-cache-buffer))
 	(goto-char (point-min))
-	(if (or (looking-at (concat (int-to-string number) "\t"))
+	(when (or (looking-at (concat (int-to-string number) "\t"))
-		(search-forward (concat "\n" (int-to-string number) "\t")
+		  (search-forward (concat "\n" (int-to-string number) "\t")
-				(point-max) t))
+				  (point-max) t))
-	    (delete-region (progn (beginning-of-line) (point))
+	  (delete-region (progn (beginning-of-line) (point))
-			   (progn (forward-line 1) (point)))))
+			 (progn (forward-line 1) (point)))))
 (setq gnus-newsgroup-cached
 	    (delq article gnus-newsgroup-cached))
 (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)))
+(let ((dir (file-name-directory (gnus-cache-file-name group 1))))
-	articles)
 (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*"))
 	(if (search-forward (concat "\n" (int-to-string (car cached)) "\t")
 			    nil t)
 	    (setq beg (progn (beginning-of-line) (point))
 		  end (progn (end-of-line) (point)))
 	  (setq beg nil)))
-(if beg (progn (insert-buffer-substring cache-buf beg end)
+(when beg
-		     (insert "\n")))
+	(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*")))
 (setq cached (cdr cached)))
 (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 ((gnus-mark-article-hook nil)
 	(gnus-expert-user t)
 	(nnmail-spool-file nil)
 	(gnus-use-dribble-file nil)
 ;; Go through all groups...
 (gnus-group-mark-buffer)
 (gnus-group-universal-argument
 nil nil
 (lambda ()
-(gnus-summary-read-group nil nil t)
+(interactive)
+(gnus-summary-read-group (gnus-group-group-name) 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."
-(unless (file-exists-p gnus-cache-directory)
+(gnus-make-directory gnus-cache-directory)
-(make-directory gnus-cache-directory t))
 (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)
 ;; We simply read the active file.
 (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))
-(save-excursion
+(nnheader-temp-write gnus-cache-active-file
-(gnus-set-work-buffer)
 (mapatoms
 (lambda (sym)
 	 (when (and sym (boundp sym))
 	   (insert (format "%s %d %d y\n"
 			   (symbol-name sym) (cdr (symbol-value sym))
 			   (car (symbol-value sym))))))
-gnus-cache-active-hashtb)
+gnus-cache-active-hashtb))
-(gnus-make-directory (file-name-directory gnus-cache-active-file))
-(write-region
-(point-min) (point-max) gnus-cache-active-file nil 'silent))
 ;; Mark the active hashtb as unaltered.
 (setq gnus-cache-active-altered nil)))
 (defun gnus-cache-update-active (group number &optional low)
 "Update the upper bound of the active info of GROUP to NUMBER.
 	;; 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))
+	(setcdr active number)))
 ;; Mark the active hashtb as altered.
-(setq gnus-cache-active-altered t))))
+(setq gnus-cache-active-altered t)))
 ;;;###autoload
 (defun gnus-cache-generate-active (&optional directory)
 "Generate the cache active file."
 (interactive)
 (interactive (list gnus-cache-directory))
 (gnus-cache-close)
 (let ((nnml-generate-active-function 'identity))
 (nnml-generate-nov-databases-1 dir)))
+(defun gnus-cache-move-cache (dir)
+"Move the cache tree to somewhere else."
+(interactive "DMove the cache tree to: ")
+(rename-file gnus-cache-directory dir))
 (provide 'gnus-cache)
 ;;; gnus-cache.el ends here

Mercurial > hg > xemacs-beta

comparison lisp/gnus/gnus-cache.el @ 16:0293115a14e9 r19-15b91