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

   1 ;;; nnmbox.el --- mail mbox access for Gnus
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
   4 ;;      Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;;      Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   8 ;; Keywords: news, mail
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 ;; Boston, MA 02111-1307, USA.
  21
  22 ;;; Commentary:
  23
  24 ;; For an overview of what the interface functions do, please see the
  25 ;; Gnus sources.
  26
  27 ;;; Code:
  28
  29 (require 'nnheader)
  30 (require 'message)
  31 (require 'nnmail)
  32 (require 'nnoo)
  33 (require 'gnus-range)
  34 (eval-when-compile (require 'cl))
  35
  36 (nnoo-declare nnmbox)
  37
  38 (defvoo nnmbox-mbox-file (expand-file-name "~/mbox")
  39   "The name of the mail box file in the user's home directory.")
  40
  41 (defvoo nnmbox-active-file (expand-file-name "~/.mbox-active")
  42   "The name of the active file for the mail box.")
  43
  44 (defvoo nnmbox-get-new-mail t
  45   "If non-nil, nnmbox will check the incoming mail file and split the mail.")
  46
  47 (defvoo nnmbox-prepare-save-mail-hook nil
  48   "Hook run narrowed to an article before saving.")
  49
  50 \f
  51
  52 (defconst nnmbox-version "nnmbox 1.0"
  53   "nnmbox version.")
  54
  55 (defvoo nnmbox-current-group nil
  56   "Current nnmbox news group directory.")
  57
  58 (defconst nnmbox-mbox-buffer nil)
  59
  60 (defvoo nnmbox-status-string "")
  61
  62 (defvoo nnmbox-group-alist nil)
  63 (defvoo nnmbox-active-timestamp nil)
  64
  65 (defvoo nnmbox-file-coding-system mm-binary-coding-system)
  66 (defvoo nnmbox-file-coding-system-for-write nil)
  67 (defvoo nnmbox-active-file-coding-system mm-binary-coding-system)
  68 (defvoo nnmbox-active-file-coding-system-for-write nil)
  69
  70 (defvar nnmbox-group-building-active-articles nil)
  71 (defvar nnmbox-group-active-articles nil)
  72 \f
  73
  74 ;;; Interface functions
  75
  76 (nnoo-define-basics nnmbox)
  77
  78 (deffoo nnmbox-retrieve-headers (sequence &optional newsgroup server fetch-old)
  79   (save-excursion
  80     (set-buffer nntp-server-buffer)
  81     (erase-buffer)
  82     (let ((number (length sequence))
  83           (count 0)
  84           article start stop)
  85       (nnmbox-possibly-change-newsgroup newsgroup server)
  86       (while sequence
  87         (setq article (car sequence))
  88         (set-buffer nnmbox-mbox-buffer)
  89         (when (nnmbox-find-article article)
  90           (setq start
  91                 (save-excursion
  92                   (re-search-backward
  93                    (concat "^" message-unix-mail-delimiter) nil t)
  94                   (point)))
  95           (search-forward "\n\n" nil t)
  96           (setq stop (1- (point)))
  97           (set-buffer nntp-server-buffer)
  98           (insert (format "221 %d Article retrieved.\n" article))
  99           (insert-buffer-substring nnmbox-mbox-buffer start stop)
 100           (goto-char (point-max))
 101           (insert ".\n"))
 102         (setq sequence (cdr sequence))
 103         (setq count (1+ count))
 104         (and (numberp nnmail-large-newsgroup)
 105              (> number nnmail-large-newsgroup)
 106              (zerop (% count 20))
 107              (nnheader-message 5 "nnmbox: Receiving headers... %d%%"
 108                                (/ (* count 100) number))))
 109
 110       (and (numberp nnmail-large-newsgroup)
 111            (> number nnmail-large-newsgroup)
 112            (nnheader-message 5 "nnmbox: Receiving headers...done"))
 113
 114       (set-buffer nntp-server-buffer)
 115       (nnheader-fold-continuation-lines)
 116       'headers)))
 117
 118 (deffoo nnmbox-open-server (server &optional defs)
 119   (nnoo-change-server 'nnmbox server defs)
 120   (nnmbox-create-mbox)
 121   (cond
 122    ((not (file-exists-p nnmbox-mbox-file))
 123     (nnmbox-close-server)
 124     (nnheader-report 'nnmbox "No such file: %s" nnmbox-mbox-file))
 125    ((file-directory-p nnmbox-mbox-file)
 126     (nnmbox-close-server)
 127     (nnheader-report 'nnmbox "Not a regular file: %s" nnmbox-mbox-file))
 128    (t
 129     (nnheader-report 'nnmbox "Opened server %s using mbox %s" server
 130                      nnmbox-mbox-file)
 131     t)))
 132
 133 (deffoo nnmbox-close-server (&optional server)
 134   (when (and nnmbox-mbox-buffer
 135              (buffer-name nnmbox-mbox-buffer))
 136     (kill-buffer nnmbox-mbox-buffer))
 137   (nnoo-close-server 'nnmbox server)
 138   t)
 139
 140 (deffoo nnmbox-server-opened (&optional server)
 141   (and (nnoo-current-server-p 'nnmbox server)
 142        nnmbox-mbox-buffer
 143        (buffer-name nnmbox-mbox-buffer)
 144        nntp-server-buffer
 145        (buffer-name nntp-server-buffer)))
 146
 147 (deffoo nnmbox-request-article (article &optional newsgroup server buffer)
 148   (nnmbox-possibly-change-newsgroup newsgroup server)
 149   (save-excursion
 150     (set-buffer nnmbox-mbox-buffer)
 151     (when (nnmbox-find-article article)
 152       (let (start stop)
 153         (re-search-backward (concat "^" message-unix-mail-delimiter) nil t)
 154         (setq start (point))
 155         (forward-line 1)
 156         (or (and (re-search-forward
 157                   (concat "^" message-unix-mail-delimiter) nil t)
 158                  (forward-line -1))
 159             (goto-char (point-max)))
 160         (setq stop (point))
 161         (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
 162           (set-buffer nntp-server-buffer)
 163           (erase-buffer)
 164           (insert-buffer-substring nnmbox-mbox-buffer start stop)
 165           (goto-char (point-min))
 166           (while (looking-at "From ")
 167             (delete-char 5)
 168             (insert "X-From-Line: ")
 169             (forward-line 1))
 170           (if (numberp article)
 171               (cons nnmbox-current-group article)
 172             (nnmbox-article-group-number nil)))))))
 173
 174 (deffoo nnmbox-request-group (group &optional server dont-check)
 175   (nnmbox-possibly-change-newsgroup nil server)
 176   (let ((active (cadr (assoc group nnmbox-group-alist))))
 177     (cond
 178      ((or (null active)
 179           (null (nnmbox-possibly-change-newsgroup group server)))
 180       (nnheader-report 'nnmbox "No such group: %s" group))
 181      (dont-check
 182       (nnheader-report 'nnmbox "Selected group %s" group)
 183       (nnheader-insert ""))
 184      (t
 185       (nnheader-report 'nnmbox "Selected group %s" group)
 186       (nnheader-insert "211 %d %d %d %s\n"
 187                        (1+ (- (cdr active) (car active)))
 188                        (car active) (cdr active) group)))))
 189
 190 (defun nnmbox-save-buffer ()
 191   (let ((coding-system-for-write
 192          (or nnmbox-file-coding-system-for-write
 193              nnmbox-file-coding-system)))
 194     (save-buffer)))
 195
 196 (defun nnmbox-save-active (group-alist active-file)
 197   (let ((nnmail-active-file-coding-system
 198          (or nnmbox-active-file-coding-system-for-write
 199              nnmbox-active-file-coding-system)))
 200     (nnmail-save-active group-alist active-file)))
 201
 202 (deffoo nnmbox-request-scan (&optional group server)
 203   (nnmbox-possibly-change-newsgroup group server)
 204   (nnmbox-read-mbox)
 205   (nnmail-get-new-mail
 206    'nnmbox
 207    (lambda ()
 208      (save-excursion
 209        (set-buffer nnmbox-mbox-buffer)
 210        (nnmbox-save-buffer)))
 211    (file-name-directory nnmbox-mbox-file)
 212    group
 213    (lambda ()
 214      (save-excursion
 215        (let ((in-buf (current-buffer)))
 216          (set-buffer nnmbox-mbox-buffer)
 217          (goto-char (point-max))
 218          (insert-buffer-substring in-buf)))
 219      (nnmbox-save-active nnmbox-group-alist nnmbox-active-file))))
 220
 221 (deffoo nnmbox-close-group (group &optional server)
 222   t)
 223
 224 (deffoo nnmbox-request-create-group (group &optional server args)
 225   (nnmail-activate 'nnmbox)
 226   (unless (assoc group nnmbox-group-alist)
 227     (push (list group (cons 1 0))
 228           nnmbox-group-alist)
 229     (nnmbox-save-active nnmbox-group-alist nnmbox-active-file))
 230   t)
 231
 232 (deffoo nnmbox-request-list (&optional server)
 233   (save-excursion
 234     (let ((nnmail-file-coding-system
 235            nnmbox-active-file-coding-system))
 236       (nnmail-find-file nnmbox-active-file))
 237     (setq nnmbox-group-alist (nnmail-get-active))
 238     t))
 239
 240 (deffoo nnmbox-request-newgroups (date &optional server)
 241   (nnmbox-request-list server))
 242
 243 (deffoo nnmbox-request-list-newsgroups (&optional server)
 244   (nnheader-report 'nnmbox "LIST NEWSGROUPS is not implemented."))
 245
 246 (deffoo nnmbox-request-expire-articles
 247     (articles newsgroup &optional server force)
 248   (nnmbox-possibly-change-newsgroup newsgroup server)
 249   (let* ((is-old t)
 250          rest)
 251     (nnmail-activate 'nnmbox)
 252
 253     (save-excursion
 254       (set-buffer nnmbox-mbox-buffer)
 255       (while (and articles is-old)
 256         (when (nnmbox-find-article (car articles))
 257           (if (setq is-old
 258                     (nnmail-expired-article-p
 259                      newsgroup
 260                      (buffer-substring
 261                       (point) (progn (end-of-line) (point))) force))
 262               (progn
 263                 (unless (eq nnmail-expiry-target 'delete)
 264                   (with-temp-buffer
 265                     (nnmbox-request-article (car articles)
 266                                              newsgroup server
 267                                              (current-buffer))
 268                     (let ((nnml-current-directory nil))
 269                       (nnmail-expiry-target-group
 270                        nnmail-expiry-target newsgroup)))
 271                   (nnmbox-possibly-change-newsgroup newsgroup server))
 272                 (nnheader-message 5 "Deleting article %d in %s..."
 273                                   (car articles) newsgroup)
 274                 (nnmbox-delete-mail))
 275             (push (car articles) rest)))
 276         (setq articles (cdr articles)))
 277       (nnmbox-save-buffer)
 278       ;; Find the lowest active article in this group.
 279       (let ((active (nth 1 (assoc newsgroup nnmbox-group-alist))))
 280         (while (and (not (nnmbox-find-article (car active)))
 281                     (<= (car active) (cdr active)))
 282           (setcar active (1+ (car active)))))
 283       (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
 284       (nconc rest articles))))
 285
 286 (deffoo nnmbox-request-move-article
 287     (article group server accept-form &optional last)
 288   (let ((buf (get-buffer-create " *nnmbox move*"))
 289         result)
 290     (and
 291      (nnmbox-request-article article group server)
 292      (save-excursion
 293        (set-buffer buf)
 294        (erase-buffer)
 295        (insert-buffer-substring nntp-server-buffer)
 296        (goto-char (point-min))
 297        (while (re-search-forward
 298                "^X-Gnus-Newsgroup:"
 299                (save-excursion (search-forward "\n\n" nil t) (point)) t)
 300          (gnus-delete-line))
 301        (setq result (eval accept-form))
 302        (kill-buffer buf)
 303        result)
 304      (save-excursion
 305        (nnmbox-possibly-change-newsgroup group server)
 306        (set-buffer nnmbox-mbox-buffer)
 307        (when (nnmbox-find-article article)
 308          (nnmbox-delete-mail))
 309        (and last (nnmbox-save-buffer))))
 310     result))
 311
 312 (deffoo nnmbox-request-accept-article (group &optional server last)
 313   (nnmbox-possibly-change-newsgroup group server)
 314   (nnmail-check-syntax)
 315   (let ((buf (current-buffer))
 316         result)
 317     (goto-char (point-min))
 318     ;; The From line may have been quoted by movemail.
 319     (when (looking-at (concat ">" message-unix-mail-delimiter))
 320       (delete-char 1))
 321     (if (looking-at "X-From-Line: ")
 322         (replace-match "From ")
 323       (insert "From nobody " (current-time-string) "\n"))
 324     (and
 325      (nnmail-activate 'nnmbox)
 326      (progn
 327        (set-buffer buf)
 328        (goto-char (point-min))
 329        (search-forward "\n\n" nil t)
 330        (forward-line -1)
 331        (while (re-search-backward "^X-Gnus-Newsgroup: " nil t)
 332          (delete-region (point) (progn (forward-line 1) (point))))
 333        (when nnmail-cache-accepted-message-ids
 334          (nnmail-cache-insert (nnmail-fetch-field "message-id") group))
 335        (setq result (if (stringp group)
 336                         (list (cons group (nnmbox-active-number group)))
 337                       (nnmail-article-group 'nnmbox-active-number)))
 338        (if (and (null result)
 339                 (yes-or-no-p "Moved to `junk' group; delete article? "))
 340            (setq result 'junk)
 341          (setq result (car (nnmbox-save-mail result)))))
 342      (save-excursion
 343        (set-buffer nnmbox-mbox-buffer)
 344        (goto-char (point-max))
 345        (insert-buffer-substring buf)
 346        (when last
 347          (when nnmail-cache-accepted-message-ids
 348            (nnmail-cache-close))
 349          (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
 350          (nnmbox-save-buffer))))
 351     result))
 352
 353 (deffoo nnmbox-request-replace-article (article group buffer)
 354   (nnmbox-possibly-change-newsgroup group)
 355   (save-excursion
 356     (set-buffer nnmbox-mbox-buffer)
 357     (if (not (nnmbox-find-article article))
 358         nil
 359       (nnmbox-delete-mail t t)
 360       (insert-buffer-substring buffer)
 361       (nnmbox-save-buffer)
 362       t)))
 363
 364 (deffoo nnmbox-request-delete-group (group &optional force server)
 365   (nnmbox-possibly-change-newsgroup group server)
 366   ;; Delete all articles in GROUP.
 367   (if (not force)
 368       ()                                ; Don't delete the articles.
 369     (save-excursion
 370       (set-buffer nnmbox-mbox-buffer)
 371       (goto-char (point-min))
 372       ;; Delete all articles in this group.
 373       (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))
 374             found)
 375         (while (search-forward ident nil t)
 376           (setq found t)
 377           (nnmbox-delete-mail))
 378         (when found
 379           (nnmbox-save-buffer)))))
 380   ;; Remove the group from all structures.
 381   (setq nnmbox-group-alist
 382         (delq (assoc group nnmbox-group-alist) nnmbox-group-alist)
 383         nnmbox-current-group nil)
 384   ;; Save the active file.
 385   (nnmbox-save-active nnmbox-group-alist nnmbox-active-file)
 386   t)
 387
 388 (deffoo nnmbox-request-rename-group (group new-name &optional server)
 389   (nnmbox-possibly-change-newsgroup group server)
 390   (save-excursion
 391     (set-buffer nnmbox-mbox-buffer)
 392     (goto-char (point-min))
 393     (let ((ident (concat "\nX-Gnus-Newsgroup: " nnmbox-current-group ":"))