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       (gnus-summary-select-article)
 107       (or (file-exists-p (setq dir (file-name-directory file)))
 108           (gnus-make-directory dir))
 109       (if (file-exists-p file)
 110           t
 111         (save-excursion
 112           (set-buffer gnus-article-buffer)
 113           (write-region (point-min) (point-max) file nil 'quiet)
 114           (gnus-cache-change-buffer group)
 115           (set-buffer (cdr gnus-cache-buffer))
 116           (goto-char (point-max))
 117           (forward-line -1)
 118           (while (and (not (bobp))
 119                       (> (read (current-buffer)) number))
 120             (forward-line -1))
 121           (if (bobp)
 122               (if (not (eobp))
 123                   (progn
 124                     (beginning-of-line)
 125                     (if (< (read (current-buffer)) number)
 126                         (forward-line 1)))
 127                 (beginning-of-line))
 128             (forward-line 1))
 129           ;; [number subject from date id references chars lines xref]
 130           (insert (format "%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t\n"
 131                           (header-number headers)
 132                           (header-subject headers)
 133                           (header-from headers)
 134                           (header-date headers)
 135                           (header-id headers)
 136                           (or (header-references headers) "")
 137                           (or (header-chars headers) "")
 138                           (or (header-lines headers) "")
 139                           (or (header-xref headers) ""))))
 140         t))))
 141
 142 (defun gnus-cache-possibly-remove-article
 143   (group article ticked dormant unread)
 144   (let ((file (gnus-cache-file-name group article)))
 145     (if (or (not (file-exists-p file))
 146             (not (gnus-cache-member-of-class
 147                   gnus-cache-remove-articles ticked dormant unread)))
 148         nil
 149       (save-excursion
 150         (delete-file file)
 151         (gnus-cache-change-buffer group)
 152         (set-buffer (cdr gnus-cache-buffer))
 153         (goto-char (point-min))
 154         (if (or (looking-at (concat (int-to-string article) "\t"))
 155                 (search-forward (concat "\n" (int-to-string article) "\t")))
 156             (delete-region (progn (beginning-of-line) (point))
 157                            (progn (forward-line 1) (point))))))))
 158
 159 (defun gnus-cache-request-article (article group)
 160   (let ((file (gnus-cache-file-name group article)))
 161     (if (not (file-exists-p file))
 162         ()
 163       (erase-buffer)
 164       (insert-file-contents file)
 165       t)))
 166
 167 (defun gnus-cache-articles-in-group (group)
 168   (let ((dir (file-name-directory (gnus-cache-file-name group 1)))
 169         articles)
 170     (if (not (file-exists-p dir))
 171         nil
 172       (setq articles (directory-files dir nil "^[0-9]+$" t))
 173       (if (not articles)
 174           nil
 175         (sort (mapcar (function (lambda (name)
 176                                   (string-to-int name)))
 177                       articles)
 178               '<)))))
 179
 180 (defun gnus-cache-active-articles (group)
 181   (let ((articles (gnus-cache-articles-in-group group)))
 182     (and articles
 183          (cons (car articles) (gnus-last-element articles)))))
 184
 185 (defun gnus-cache-possibly-alter-active (group active)
 186   (let ((cache-active (gnus-cache-active-articles group)))
 187     (and cache-active (< (car cache-active) (car active))
 188          (setcar active (car cache-active)))
 189     (and cache-active (> (cdr cache-active) (cdr active))
 190          (setcdr active (cdr cache-active)))))
 191
 192 (defun gnus-cache-retrieve-headers (articles group)
 193   (let* ((cached (gnus-cache-articles-in-group group))
 194          (articles (gnus-sorted-complement articles cached))
 195          (cache-file (gnus-cache-file-name group ".overview"))
 196          type)
 197     (let ((gnus-use-cache nil))
 198       (setq type (and articles (gnus-retrieve-headers articles group))))
 199     (gnus-cache-save-buffers)
 200     (save-excursion
 201       (cond ((not (file-exists-p cache-file))
 202              type)
 203             ((null type)
 204              (set-buffer nntp-server-buffer)
 205              (erase-buffer)
 206              (insert-file-contents cache-file)
 207              'nov)
 208             ((eq type 'nov)
 209              (gnus-cache-braid-nov group cached)
 210              type)
 211             (t
 212              (gnus-cache-braid-heads group cached)
 213              type)))))
 214
 215 (defun gnus-cache-braid-nov (group cached)
 216   (let ((cache-buf (get-buffer-create " *gnus-cache*"))
 217         beg end)
 218     (gnus-cache-save-buffers)
 219     (save-excursion
 220       (set-buffer cache-buf)
 221       (buffer-disable-undo (current-buffer))
 222       (erase-buffer)
 223       (insert-file-contents (gnus-cache-file-name group ".overview"))
 224       (goto-char (point-min))
 225       (insert "\n")
 226       (goto-char (point-min)))
 227     (set-buffer nntp-server-buffer)
 228     (goto-char (point-min))
 229     (while cached
 230       (while (and (not (eobp))
 231                   (< (read (current-buffer)) (car cached)))
 232         (forward-line 1))
 233       (beginning-of-line)
 234       (save-excursion
 235         (set-buffer cache-buf)
 236         (if (search-forward (concat "\n" (int-to-string (car cached)) "\t")
 237                             nil t)
 238             (setq beg (progn (beginning-of-line) (point))
 239                   end (progn (forward-line 1) (point)))
 240           (setq beg nil)))
 241       (and beg (insert-buffer-substring cache-buf beg end))
 242       (setq cached (cdr cached)))
 243     (kill-buffer cache-buf)))
 244
 245 (defun gnus-cache-braid-heads (group cached)
 246   (let ((cache-buf (get-buffer-create " *gnus-cache*"))
 247         beg end)
 248     (save-excursion
 249       (set-buffer cache-buf)
 250       (buffer-disable-undo (current-buffer))
 251       (erase-buffer))
 252     (set-buffer nntp-server-buffer)
 253     (goto-char (point-min))
 254     (while cached
 255       (while (and (not (eobp))
 256                   (looking-at "2.. +\\([0-9]+\\) ")
 257                   (< (progn (goto-char (match-beginning 1))
 258                             (read (current-buffer)))
 259                      (car cached)))
 260         (search-forward "\n.\n" nil 'move))
 261       (beginning-of-line)
 262       (save-excursion
 263         (set-buffer cache-buf)
 264         (erase-buffer)
 265         (insert-file-contents (gnus-cache-file-name group (car cached)))
 266         (goto-char (point-min))
 267         (insert "220 " (int-to-string (car cached)) " Article retrieved.\n")
 268         (search-forward "\n\n" nil 'move)
 269         (delete-region (point) (point-max))
 270         (forward-char -1)
 271         (insert "."))
 272       (insert-buffer-substring cache-buf)
 273       (setq cached (cdr cached)))
 274     (kill-buffer cache-buf)))
 275
 276 (defun gnus-jog-cache ()
 277   "Go through all groups and put the articles into the cache."
 278   (interactive)
 279   (let ((newsrc (cdr gnus-newsrc-alist))
 280         (gnus-cache-enter-articles '(unread))
 281         (gnus-mark-article-hook nil)
 282         (gnus-expert-user t)
 283         (gnus-large-newsgroup nil))
 284     (while newsrc
 285       (gnus-summary-read-group (car (car newsrc)))
 286       (if (not (eq major-mode 'gnus-summary-mode))
 287           ()
 288         (while gnus-newsgroup-unreads
 289           (gnus-summary-select-article t t nil (car gnus-newsgroup-unreads))
 290           (setq gnus-newsgroup-unreads (cdr gnus-newsgroup-unreads)))
 291         (kill-buffer (current-buffer)))
 292       (setq newsrc (cdr newsrc)))))
 293
 294 (provide 'gnus-cache)
 295
 296 ;;; gnus-cache.el ends here