cgit.sxemacs.org Git - gnus/blob - lisp/gnus-cache.el

   1 ;;; gnus-cache.el --- cache interface for Gnus
   2 ;; Copyright (C) 1995 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   5 ;; Keywords: news
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (require 'gnus)
  28
  29 (defvar gnus-cache-directory (concat gnus-article-save-directory "cache/")
  30   "*The directory where cached articles will be stored.")
  31
  32 (defvar gnus-cache-enter-articles '(ticked dormant)
  33   "*Classes of articles to enter into the cache.")
  34
  35 (defvar gnus-cache-remove-articles '(read)
  36   "*Classes of articles to remove from the cache.")
  37
  38 \f
  39
  40 (defvar gnus-cache-buffer nil)
  41
  42 \f
  43
  44 (defun gnus-cache-change-buffer (group)
  45   (save-excursion
  46     (cond ((null gnus-cache-buffer)
  47            ;; No current cache, so we create and init the buffer.
  48            (setq gnus-cache-buffer
  49                  (cons group (get-buffer-create " *gnus-cache-overview*")))
  50            (set-buffer (cdr gnus-cache-buffer))
  51            (buffer-disable-undo (current-buffer))
  52            (erase-buffer)
  53            (gnus-add-current-to-buffer-list)
  54            (let ((file (gnus-cache-file-name group ".overview")))
  55              (and (file-exists-p file)
  56                   (insert-file-contents file))))
  57           ((not (string= group (car gnus-cache-buffer)))
  58            ;; If a different overview cache is the current, we
  59            ;; (possibly) save it and change to this groups.
  60            (set-buffer (cdr gnus-cache-buffer))
  61            (and (buffer-modified-p)
  62                 (write-region (point-min) (point-max)
  63                               (gnus-cache-file-name
  64                                (car gnus-cache-buffer) ".overview")
  65                               nil 'quiet))
  66            (erase-buffer)
  67            (setcar gnus-cache-buffer group)
  68            (let ((file (gnus-cache-file-name group ".overview")))
  69              (and (file-exists-p file)
  70                   (insert-file-contents file)))))))
  71
  72
  73 ;; Just save the overview buffer.
  74 (defun gnus-cache-save-buffers ()
  75   (and gnus-cache-buffer
  76        (save-excursion
  77          (set-buffer (cdr gnus-cache-buffer))
  78          (and (buffer-modified-p)
  79               (write-region (point-min) (point-max)
  80                             (gnus-cache-file-name (car gnus-cache-buffer)
  81                                                   ".overview")
  82                             nil 'quiet))))
  83   (setq gnus-cache-buffer nil))
  84
  85 ;; Return whether an article is a member of a class.
  86 (defun gnus-cache-member-of-class (class ticked dormant unread)
  87   (or (and ticked (memq 'ticked class))
  88       (and dormant (memq 'dormant class))
  89       (and unread (memq 'unread class))
  90       (and (not unread) (memq 'read class))))
  91
  92 (defun gnus-cache-file-name (group article)
  93   (concat (file-name-as-directory gnus-cache-directory)
  94           (if (gnus-use-long-file-name 'not-cache)
  95               group (gnus-replace-chars-in-string group ?. ?/))
  96           "/" (if (stringp article) article (int-to-string article))))
  97
  98 (defun gnus-cache-possibly-enter-article
  99   (group article headers ticked dormant unread)
 100   (let ((number (header-number headers))
 101         file dir)
 102     (if (or (not (gnus-cache-member-of-class
 103                   gnus-cache-enter-articles ticked dormant unread))
 104             (file-exists-p (setq file (gnus-cache-file-name group article))))
 105         ()
 106       ;; Possibly create the cache directory.
 107       (or (file-exists-p (setq dir (file-name-directory file)))
 108           (gnus-make-directory dir))
 109       ;; Save the article in the cache.
 110       (if (file-exists-p file)
 111           t ; The article already is saved, so we end here.
 112         (gnus-summary-select-article)
 113         (save-excursion
 114           (set-buffer gnus-article-buffer)
 115           (write-region (point-min) (point-max) file nil 'quiet)
 116           (gnus-cache-change-buffer group)
 117           (set-buffer (cdr gnus-cache-buffer))
 118           (goto-char (point-max))
 119           (forward-line -1)
 120           (while (and (not (bobp))
 121                       (> (read (current-buffer)) number))
 122             (forward-line -1))
 123           (if (bobp)
 124               (if (not (eobp))
 125                   (progn
 126                     (beginning-of-line)
 127                     (if (< (read (current-buffer)) number)
 128                         (forward-line 1)))
 129                 (beginning-of-line))
 130             (forward-line 1))
 131           (beginning-of-line)
 132           ;; [number subject from date id references chars lines xref]
 133           (insert (format "%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t\n"
 134                           (header-number headers)
 135                           (header-subject headers)
 136                           (header-from headers)
 137                           (header-date headers)
 138                           (header-id headers)
 139                           (or (header-references headers) "")
 140                           (or (header-chars headers) "")
 141                           (or (header-lines headers) "")
 142                           (or (header-xref headers) ""))))
 143         t))))
 144
 145 (defun gnus-cache-enter-remove-article (article)
 146   (setq gnus-cache-removeable-articles
 147         (cons article gnus-cache-removeable-articles)))
 148
 149 (defun gnus-cache-possibly-remove-articles ()
 150   (let ((articles gnus-cache-removeable-articles)
 151         (cache-articles (gnus-cache-articles-in-group gnus-newsgroup-name))
 152         article)
 153     (gnus-cache-change-buffer gnus-newsgroup-name)
 154     (while articles
 155       (setq article (car articles)
 156             articles (cdr articles))
 157       (if (memq article cache-articles)
 158           ;; The article was in the cache, so we see whether we are
 159           ;; supposed to remove it from the cache.
 160           (gnus-cache-possibly-remove-article
 161            article (memq article gnus-newsgroup-marked)
 162            (memq article gnus-newsgroup-dormant)
 163            (or (memq article gnus-newsgroup-unreads)
 164                (memq article gnus-newsgroup-unselected)))))))
 165
 166 (defun gnus-cache-possibly-remove-article
 167   (article ticked dormant unread)
 168   (let ((file (gnus-cache-file-name gnus-newsgroup-name article)))
 169     (if (or (not (file-exists-p file))
 170             (not (gnus-cache-member-of-class
 171                   gnus-cache-remove-articles ticked dormant unread)))
 172         nil
 173       (save-excursion
 174         (delete-file file)
 175         (set-buffer (cdr gnus-cache-buffer))
 176         (goto-char (point-min))
 177         (if (or (looking-at (concat (int-to-string article) "\t"))
 178                 (search-forward (concat "\n" (int-to-string article) "\t")
 179                                 (point-max) t))
 180             (delete-region (progn (beginning-of-line) (point))
 181                            (progn (forward-line 1) (point))))))))
 182
 183 (defun gnus-cache-request-article (article group)
 184   (let ((file (gnus-cache-file-name group article)))
 185     (if (not (file-exists-p file))
 186         ()
 187       (erase-buffer)
 188       (insert-file-contents file)
 189       t)))
 190
 191 (defun gnus-cache-articles-in-group (group)
 192   (let ((dir (file-name-directory (gnus-cache-file-name group 1)))
 193         articles)
 194     (if (not (file-exists-p dir))
 195         nil
 196       (setq articles (directory-files dir nil "^[0-9]+$" t))
 197       (if (not articles)
 198           nil
 199         (sort (mapcar (function (lambda (name)
 200                                   (string-to-int name)))
 201                       articles)
 202               '<)))))
 203
 204 (defun gnus-cache-active-articles (group)
 205   (let ((articles (gnus-cache-articles-in-group group)))
 206     (and articles
 207          (cons (car articles) (gnus-last-element articles)))))
 208
 209 (defun gnus-cache-possibly-alter-active (group active)
 210   (let ((cache-active (gnus-cache-active-articles group)))
 211     (and cache-active (< (car cache-active) (car active))
 212          (setcar active (car cache-active)))
 213     (and cache-active (> (cdr cache-active) (cdr active))
 214          (setcdr active (cdr cache-active)))))
 215
 216 (defun gnus-cache-retrieve-headers (articles group)
 217   (let* ((cached (gnus-cache-articles-in-group group))
 218          (articles (gnus-sorted-complement articles cached))
 219          (cache-file (gnus-cache-file-name group ".overview"))
 220          type)
 221     (let ((gnus-use-cache nil))
 222       (setq type (and articles (gnus-retrieve-headers articles group))))
 223     (gnus-cache-save-buffers)
 224     (save-excursion
 225       (cond ((not (file-exists-p cache-file))
 226              type)
 227             ((null type)
 228              (set-buffer nntp-server-buffer)
 229              (erase-buffer)
 230              (insert-file-contents cache-file)
 231              'nov)
 232             ((eq type 'nov)
 233              (gnus-cache-braid-nov group cached)
 234              type)
 235             (t
 236              (gnus-cache-braid-heads group cached)
 237              type)))))
 238
 239 (defun gnus-cache-braid-nov (group cached)
 240   (let ((cache-buf (get-buffer-create " *gnus-cache*"))
 241         beg end)
 242     (gnus-cache-save-buffers)
 243     (save-excursion
 244       (set-buffer cache-buf)
 245       (buffer-disable-undo (current-buffer))
 246       (erase-buffer)
 247       (insert-file-contents (gnus-cache-file-name group ".overview"))
 248       (goto-char (point-min))
 249       (insert "\n")
 250       (goto-char (point-min)))
 251     (set-buffer nntp-server-buffer)
 252     (goto-char (point-min))
 253     (while cached
 254       (while (and (not (eobp))
 255                   (< (read (current-buffer)) (car cached)))
 256         (forward-line 1))
 257       (beginning-of-line)
 258       (save-excursion
 259         (set-buffer cache-buf)
 260         (if (search-forward (concat "\n" (int-to-string (car cached)) "\t")
 261                             nil t)
 262             (setq beg (progn (beginning-of-line) (point))
 263                   end (progn (forward-line 1) (point)))
 264           (setq beg nil)))
 265       (and beg (insert-buffer-substring cache-buf beg end))
 266       (setq cached (cdr cached)))
 267     (kill-buffer cache-buf)))
 268
 269 (defun gnus-cache-braid-heads (group cached)
 270   (let ((cache-buf (get-buffer-create " *gnus-cache*")))
 271     (save-excursion
 272       (set-buffer cache-buf)
 273       (buffer-disable-undo (current-buffer))
 274       (erase-buffer))
 275     (set-buffer nntp-server-buffer)
 276     (goto-char (point-min))
 277     (while cached
 278       (while (and (not (eobp))
 279                   (looking-at "2.. +\\([0-9]+\\) ")
 280                   (< (progn (goto-char (match-beginning 1))
 281                             (read (current-buffer)))
 282                      (car cached)))
 283         (search-forward "\n.\n" nil 'move))
 284       (beginning-of-line)
 285       (save-excursion
 286         (set-buffer cache-buf)
 287         (erase-buffer)
 288         (insert-file-contents (gnus-cache-file-name group (car cached)))
 289         (goto-char (point-min))
 290         (insert "220 " (int-to-string (car cached)) " Article retrieved.\n")
 291         (search-forward "\n\n" nil 'move)
 292         (delete-region (point) (point-max))
 293         (forward-char -1)
 294         (insert "."))
 295       (insert-buffer-substring cache-buf)
 296       (setq cached (cdr cached)))
 297     (kill-buffer cache-buf)))
 298
 299 (defun gnus-jog-cache ()
 300   "Go through all groups and put the articles into the cache."
 301   (interactive)
 302   (let ((newsrc (cdr gnus-newsrc-alist))
 303         (gnus-cache-enter-articles '(unread))
 304         (gnus-mark-article-hook nil)
 305         (gnus-expert-user t)
 306         (gnus-large-newsgroup nil))
 307     (while newsrc
 308       (gnus-summary-read-group (car (car newsrc)))
 309       (if (not (eq major-mode 'gnus-summary-mode))
 310           ()
 311         (while gnus-newsgroup-unreads
 312           (gnus-summary-select-article t t nil (car gnus-newsgroup-unreads))
 313           (setq gnus-newsgroup-unreads (cdr gnus-newsgroup-unreads)))
 314         (kill-buffer (current-buffer)))
 315       (setq newsrc (cdr newsrc)))))
 316
 317 (provide 'gnus-cache)
 318
 319 ;;; gnus-cache.el ends here