git.chise.org Git - elisp/gnus.git-/blob - lisp/nnmh.el

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