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

   1 ;;; nnmh.el --- mhspool access for Gnus
   2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   5 ;;      Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;; Keywords: news, mail
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
  28 ;; For an overview of what the interface functions do, please see the
  29 ;; Gnus sources.
  30
  31 ;;; Code:
  32
  33 (require 'nnheader)
  34 (require 'nnmail)
  35 (require 'gnus-start)
  36 (require 'nnoo)
  37 (require 'cl)
  38
  39 (nnoo-declare nnmh)
  40
  41 (defvoo nnmh-directory message-directory
  42   "*Mail spool directory.")
  43
  44 (defvoo nnmh-get-new-mail t
  45   "*If non-nil, nnmh will check the incoming mail file and split the mail.")
  46
  47 (defvoo nnmh-prepare-save-mail-hook nil
  48   "*Hook run narrowed to an article before saving.")
  49
  50 (defvoo nnmh-be-safe nil
  51   "*If non-nil, nnmh will check all articles to make sure whether they are new or not.")
  52
  53 \f
  54
  55 (defconst nnmh-version "nnmh 1.0"
  56   "nnmh version.")
  57
  58 (defvoo nnmh-current-directory nil
  59   "Current news group directory.")
  60
  61 (defvoo nnmh-status-string "")
  62 (defvoo nnmh-group-alist nil)
  63
  64 \f
  65
  66 ;;; Interface functions.
  67
  68 (nnoo-define-basics nnmh)
  69
  70 (deffoo nnmh-retrieve-headers (articles &optional newsgroup server fetch-old)
  71   (save-excursion
  72     (set-buffer nntp-server-buffer)
  73     (erase-buffer)
  74     (let* ((file nil)
  75            (number (length articles))
  76            (large (and (numberp nnmail-large-newsgroup)
  77                        (> number nnmail-large-newsgroup)))
  78            (count 0)
  79            beg article)
  80       (nnmh-possibly-change-directory newsgroup server)
  81       ;; We don't support fetching by Message-ID.
  82       (if (stringp (car articles))
  83           'headers
  84         (while articles
  85           (when (and (file-exists-p
  86                       (setq file (concat (file-name-as-directory
  87                                           nnmh-current-directory)
  88                                          (int-to-string
  89                                           (setq article (pop articles))))))
  90                      (not (file-directory-p file)))
  91             (insert (format "221 %d Article retrieved.\n" article))
  92             (setq beg (point))
  93             (nnheader-insert-head file)
  94             (goto-char beg)
  95             (if (search-forward "\n\n" nil t)
  96                 (forward-char -1)
  97               (goto-char (point-max))
  98               (insert "\n\n"))
  99             (insert ".\n")
 100             (delete-region (point) (point-max)))
 101           (setq count (1+ count))
 102
 103           (and large
 104                (zerop (% count 20))
 105                (message "nnmh: Receiving headers... %d%%"
 106                         (/ (* count 100) number))))
 107
 108         (when large
 109           (message "nnmh: Receiving headers...done"))
 110
 111         (nnheader-fold-continuation-lines)
 112         'headers))))
 113
 114 (deffoo nnmh-open-server (server &optional defs)
 115   (nnoo-change-server 'nnmh server defs)
 116   (when (not (file-exists-p nnmh-directory))
 117     (condition-case ()
 118         (make-directory nnmh-directory t)
 119       (error t)))
 120   (cond
 121    ((not (file-exists-p nnmh-directory))
 122     (nnmh-close-server)
 123     (nnheader-report 'nnmh "Couldn't create directory: %s" nnmh-directory))
 124    ((not (file-directory-p (file-truename nnmh-directory)))
 125     (nnmh-close-server)
 126     (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))
 127    (t
 128     (nnheader-report 'nnmh "Opened server %s using directory %s"
 129                      server nnmh-directory)
 130     t)))
 131
 132 (deffoo nnmh-request-article (id &optional newsgroup server buffer)
 133   (nnmh-possibly-change-directory newsgroup server)
 134   (let ((file (if (stringp id)
 135                   nil
 136                 (concat nnmh-current-directory (int-to-string id))))
 137         (nntp-server-buffer (or buffer nntp-server-buffer)))
 138     (and (stringp file)
 139          (file-exists-p file)
 140          (not (file-directory-p file))
 141          (save-excursion (nnmail-find-file file))
 142          (string-to-int (file-name-nondirectory file)))))
 143
 144 (deffoo nnmh-request-group (group &optional server dont-check)
 145   (let ((pathname (nnmail-group-pathname group nnmh-directory))
 146         dir)
 147     (cond
 148      ((not (file-directory-p pathname))
 149       (nnheader-report
 150        'nnmh "Can't select group (no such directory): %s" group))
 151      (t
 152       (setq nnmh-current-directory pathname)
 153       (and nnmh-get-new-mail
 154            nnmh-be-safe
 155            (nnmh-update-gnus-unreads group))
 156       (cond
 157        (dont-check
 158         (nnheader-report 'nnmh "Selected group %s" group)
 159         t)
 160        (t
 161         ;; Re-scan the directory if it's on a foreign system.
 162         (nnheader-re-read-dir pathname)
 163         (setq dir
 164               (sort
 165                (mapcar (lambda (name) (string-to-int name))
 166                        (directory-files pathname nil "^[0-9]+$" t))
 167                '<))
 168           (cond
 169            (dir
 170             (nnheader-report 'nnmh "Selected group %s" group)
 171             (nnheader-insert
 172              "211 %d %d %d %s\n" (length dir) (car dir)
 173              (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
 174              group))
 175            (t
 176             (nnheader-report 'nnmh "Empty group %s" group)
 177             (nnheader-insert (format "211 0 1 0 %s\n" group))))))))))
 178
 179 (deffoo nnmh-request-scan (&optional group server)
 180   (nnmail-get-new-mail 'nnmh nil nnmh-directory group))
 181
 182 (deffoo nnmh-request-list (&optional server dir)
 183   (nnheader-insert "")
 184   (let ((nnmh-toplev
 185          (or dir (file-truename (file-name-as-directory nnmh-directory)))))
 186     (nnmh-request-list-1 nnmh-toplev))
 187   (setq nnmh-group-alist (nnmail-get-active))
 188   t)
 189
 190 (defvar nnmh-toplev)
 191 (defun nnmh-request-list-1 (dir)
 192   (setq dir (expand-file-name dir))
 193   ;; Recurse down all directories.
 194   (let ((dirs (and (file-readable-p dir)
 195                    (> (nth 1 (file-attributes (file-chase-links dir))) 2)
 196                    (directory-files dir t nil t)))
 197         dir)
 198     ;; Recurse down directories.
 199     (while (setq dir (pop dirs))
 200       (when (and (not (member (file-name-nondirectory dir) '("." "..")))
 201                  (file-directory-p dir)
 202                  (file-readable-p dir))
 203         (nnmh-request-list-1 dir))))
 204   ;; For each directory, generate an active file line.
 205   (unless (string= (expand-file-name nnmh-toplev) dir)
 206     (let ((files (mapcar
 207                   (lambda (name) (string-to-int name))
 208                   (directory-files dir nil "^[0-9]+$" t))))
 209       (when files
 210         (save-excursion
 211           (set-buffer nntp-server-buffer)
 212           (goto-char (point-max))
 213           (insert
 214            (format
 215             "%s %d %d y\n"
 216             (progn
 217               (string-match
 218                (regexp-quote
 219                 (file-truename (file-name-as-directory
 220                                 (expand-file-name nnmh-toplev))))
 221                dir)
 222               (nnheader-replace-chars-in-string
 223                (substring dir (match-end 0)) ?/ ?.))
 224             (apply 'max files)
 225             (apply 'min files)))))))
 226   t)
 227
 228 (deffoo nnmh-request-newgroups (date &optional server)
 229   (nnmh-request-list server))
 230
 231 (deffoo nnmh-request-expire-articles (articles newsgroup &optional server force)
 232   (nnmh-possibly-change-directory newsgroup server)
 233   (let* ((active-articles
 234           (mapcar
 235            (function
 236             (lambda (name)
 237               (string-to-int name)))
 238            (directory-files nnmh-current-directory nil "^[0-9]+$" t)))
 239          (is-old t)
 240          article rest mod-time)
 241     (nnmail-activate 'nnmh)
 242
 243     (while (and articles is-old)
 244       (setq article (concat nnmh-current-directory
 245                             (int-to-string (car articles))))
 246       (when (setq mod-time (nth 5 (file-attributes article)))
 247         (if (and (nnmh-deletable-article-p newsgroup (car articles))
 248                  (setq is-old
 249                        (nnmail-expired-article-p newsgroup mod-time force)))
 250             (progn
 251               (nnheader-message 5 "Deleting article %s in %s..."
 252                                 article newsgroup)
 253               (condition-case ()
 254                   (funcall nnmail-delete-file-function article)
 255                 (file-error
 256                  (nnheader-message 1 "Couldn't delete article %s in %s"
 257                                    article newsgroup)
 258                  (push (car articles) rest))))
 259           (push (car articles) rest)))
 260       (setq articles (cdr articles)))
 261     (message "")
 262     (nconc rest articles)))
 263
 264 (deffoo nnmh-close-group (group &optional server)
 265   t)
 266
 267 (deffoo nnmh-request-move-article
 268   (article group server accept-form &optional last)
 269   (let ((buf (get-buffer-create " *nnmh move*"))
 270         result)
 271     (and
 272      (nnmh-deletable-article-p group article)
 273      (nnmh-request-article article group server)
 274      (save-excursion
 275        (set-buffer buf)
 276        (insert-buffer-substring nntp-server-buffer)
 277        (setq result (eval accept-form))
 278        (kill-buffer (current-buffer))
 279        result)
 280      (progn
 281        (nnmh-possibly-change-directory group server)
 282        (condition-case ()
 283            (funcall nnmail-delete-file-function
 284                     (concat nnmh-current-directory (int-to-string article)))
 285          (file-error nil))))
 286     result))
 287
 288 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
 289   (nnmh-possibly-change-directory group server)
 290   (nnmail-check-syntax)
 291   (if (stringp group)
 292       (and
 293        (nnmail-activate 'nnmh)
 294        (car (nnmh-save-mail
 295              (list (cons group (nnmh-active-number group)))
 296              noinsert)))
 297     (and
 298      (nnmail-activate 'nnmh)
 299      (car (nnmh-save-mail (nnmail-article-group 'nnmh-active-number)
 300                           noinsert)))))
 301
 302 (deffoo nnmh-request-replace-article (article group buffer)
 303   (nnmh-possibly-change-directory group)
 304   (save-excursion
 305     (set-buffer buffer)
 306     (nnmh-possibly-create-directory group)
 307     (condition-case ()
 308         (progn
 309           (nnmail-write-region
 310            (point-min) (point-max)
 311            (concat nnmh-current-directory (int-to-string article))
 312            nil (if (nnheader-be-verbose 5) nil 'nomesg))
 313           t)
 314       (error nil))))
 315
 316 (deffoo nnmh-request-create-group (group &optional server args)
 317   (nnmail-activate 'nnmh)
 318   (unless (assoc group nnmh-group-alist)
 319     (let (active)
 320       (push (list group (setq active (cons 1 0)))
 321             nnmh-group-alist)
 322       (nnmh-possibly-create-directory group)
 323       (nnmh-possibly-change-directory group server)
 324       (let ((articles (mapcar
 325                        (lambda (file)
 326                          (string-to-int file))
 327                        (directory-files
 328                         nnmh-current-directory nil "^[0-9]+$"))))
 329         (when articles
 330           (setcar active (apply 'min articles))
 331           (setcdr active (apply 'max articles))))))
 332   t)
 333
 334 (deffoo nnmh-request-delete-group (group &optional force server)
 335   (nnmh-possibly-change-directory group server)
 336   ;; Delete all articles in GROUP.
 337   (if (not force)
 338       ()                                ; Don't delete the articles.
 339     (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
 340       (while articles
 341         (when (file-writable-p (car articles))
 342           (nnheader-message 5 "Deleting article %s in %s..."
 343                             (car articles) group)
 344           (funcall nnmail-delete-file-function (car articles)))
 345         (setq articles (cdr articles))))
 346     ;; Try to delete the directory itself.
 347     (condition-case ()
 348         (delete-directory nnmh-current-directory)
 349       (error nil)))
 350   ;; Remove the group from all structures.
 351   (setq nnmh-group-alist
 352         (delq (assoc group nnmh-group-alist) nnmh-group-alist)
 353         nnmh-current-directory nil)
 354   t)
 355
 356 (deffoo nnmh-request-rename-group (group new-name &optional server)
 357   (nnmh-possibly-change-directory group server)
 358   (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
 359         (old-dir (nnmail-group-pathname group nnmh-directory)))
 360     (when (condition-case ()
 361               (progn
 362                 (make-directory new-dir t)
 363                 t)
 364             (error nil))
 365       ;; We move the articles file by file instead of renaming
 366       ;; the directory -- there may be subgroups in this group.
 367       ;; One might be more clever, I guess.
 368       (let ((files (nnheader-article-to-file-alist old-dir)))
 369         (while files
 370           (rename-file
 371            (concat old-dir (cdar files))
 372            (concat new-dir (cdar files)))
 373           (pop files)))
 374       (when (<= (length (directory-files old-dir)) 2)
 375         (condition-case ()
 376             (delete-directory old-dir)
 377           (error nil)))
 378       ;; That went ok, so we change the internal structures.
 379       (let ((entry (assoc group nnmh-group-alist)))
 380         (when entry
 381           (setcar entry new-name))
 382         (setq nnmh-current-directory nil)
 383         t))))
 384
 385 (nnoo-define-skeleton nnmh)
 386
 387 \f
 388 ;;; Internal functions.
 389
 390 (defun nnmh-possibly-change-directory (newsgroup &optional server)
 391   (when (and server
 392              (not (nnmh-server-opened server)))
 393     (nnmh-open-server server))
 394   (when newsgroup
 395     (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory)))
 396       (if (file-directory-p pathname)
 397           (setq nnmh-current-directory pathname)
 398         (error "No such newsgroup: %s" newsgroup)))))
 399
 400 (defun nnmh-possibly-create-directory (group)
 401   (let (dir dirs)
 402     (setq dir (nnmail-group-pathname group nnmh-directory))
 403     (while (not (file-directory-p dir))
 404       (push dir dirs)
 405       (setq dir (file-name-directory (directory-file-name dir))))
 406     (while dirs
 407       (when (make-directory (directory-file-name (car dirs)))
 408         (error "Could not create directory %s" (car dirs)))
 409       (nnheader-message 5 "Creating mail directory %s" (car dirs))
 410       (setq dirs (cdr dirs)))))
 411
 412 (defun nnmh-save-mail (group-art &optional noinsert)
 413   "Called narrowed to an article."
 414   (unless noinsert
 415     (nnmail-insert-lines)
 416     (nnmail-insert-xref group-art))
 417   (run-hooks 'nnmail-prepare-save-mail-hook)
 418   (run-hooks 'nnmh-prepare-save-mail-hook)
 419   (goto-char (point-min))
 420   (while (looking-at "From ")
 421     (replace-match "X-From-Line: ")
 422     (forward-line 1))
 423   ;; We save the article in all the newsgroups it belongs in.
 424   (let ((ga group-art)
 425         first)
 426     (while ga
 427       (nnmh-possibly-create-directory (caar ga))
 428       (let ((file (concat (nnmail-group-pathname
 429                            (caar ga) nnmh-directory)
 430                           (int-to-string (cdar ga)))))
 431         (if first
 432             ;; It was already saved, so we just make a hard link.
 433             (funcall nnmail-crosspost-link-function first file t)
 434           ;; Save the article.
 435           (nnmail-write-region (point-min) (point-max) file nil nil)
 436           (setq first file)))
 437       (setq ga (cdr ga))))
 438   group-art)
 439
 440 (defun nnmh-active-number (group)
 441   "Compute the next article number in GROUP."
 442   (let ((active (cadr (assoc group nnmh-group-alist))))
 443     (unless active
 444       ;; The group wasn't known to nnmh, so we just create an active
 445       ;; entry for it.
 446       (setq active (cons 1 0))
 447       (push (list group active) nnmh-group-alist)
 448       ;; Find the highest number in the group.
 449       (let ((files (sort
 450                     (mapcar
 451                      (lambda (f)
 452                        (string-to-int f))
 453                      (directory-files
 454                       (nnmail-group-pathname group nnmh-directory)
 455                       nil "^[0-9]+$")
 456                      '>))))
 457         (when files
 458           (setcdr active (car files)))))
 459     (setcdr active (1+ (cdr active)))
 460     (while (file-exists-p
 461             (concat (nnmail-group-pathname group nnmh-directory)
 462                     (int-to-string (cdr active))))
 463       (setcdr active (1+ (cdr active))))
 464     (cdr active)))
 465
 466 (defun nnmh-update-gnus-unreads (group)
 467   ;; Go through the .nnmh-articles file and compare with the actual
 468   ;; articles in this folder.  The articles that are "new" will be
 469   ;; marked as unread by Gnus.
 470   (let* ((dir nnmh-current-directory)
 471          (files (sort (mapcar (function (lambda (name) (string-to-int name)))
 472                               (directory-files nnmh-current-directory
 473                                                nil "^[0-9]+$" t))
 474                       '<))
 475          (nnmh-file (concat dir ".nnmh-articles"))
 476          new articles)
 477     ;; Load the .nnmh-articles file.
 478     (when (file-exists-p nnmh-file)
 479       (setq articles
 480             (let (nnmh-newsgroup-articles)
 481               (condition-case nil (load nnmh-file nil t t) (error nil))
 482               nnmh-newsgroup-articles)))
 483     ;; Add all new articles to the `new' list.
 484     (let ((art files))
 485       (while art
 486         (unless (assq (car art) articles)
 487           (push (car art) new))
 488         (setq art (cdr art))))
 489     ;; Remove all deleted articles.
 490     (let ((art articles))
 491       (while art
 492         (unless (memq (caar art) files)
 493           (setq articles (delq (car art) articles)))
 494         (setq art (cdr art))))
 495     ;; Check whether the articles really are the ones that Gnus thinks
 496     ;; they are by looking at the time-stamps.
 497     (let ((arts articles)
 498           art)
 499       (while (setq art (pop arts))
 500         (when (not (equal
 501                     (nth 5 (file-attributes
 502                             (concat dir (int-to-string (car art)))))
 503                     (cdr art)))
 504           (setq articles (delq art articles))
 505           (push (car art) new))))
 506     ;; Go through all the new articles and add them, and their
 507     ;; time-stamps, to the list.
 508     (setq articles
 509           (nconc articles
 510                  (mapcar
 511                   (lambda (art)
 512                     (cons art
 513                           (nth 5 (file-attributes
 514                                   (concat dir (int-to-string art))))))
 515                   new)))
 516     ;; Make Gnus mark all new articles as unread.
 517     (when new
 518       (gnus-make-articles-unread
 519        (gnus-group-prefixed-name group (list 'nnmh ""))
 520        (setq new (sort new '<))))
 521     ;; Sort the article list with highest numbers first.
 522     (setq articles (sort articles (lambda (art1 art2)
 523                                     (> (car art1) (car art2)))))
 524     ;; Finally write this list back to the .nnmh-articles file.
 525     (nnheader-temp-write nnmh-file
 526       (insert ";; Gnus article active file for " group "\n\n")
 527       (insert "(setq nnmh-newsgroup-articles '")
 528       (gnus-prin1 articles)
 529       (insert ")\n"))))
 530
 531 (defun nnmh-deletable-article-p (group article)
 532   "Say whether ARTICLE in GROUP can be deleted."
 533   (let ((path (concat nnmh-current-directory (int-to-string article))))
 534     (when (file-writable-p path)
 535       (or (not nnmail-keep-last-article)
 536           (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
 537                    article))))))
 538
 539 (provide 'nnmh)
 540
 541 ;;; nnmh.el ends here