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

   1 ;;; nnmh.el --- mhspool access for Gnus
   2 ;; Copyright (C) 1995,96,97 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
 232                                                &optional server force)
 233   (nnmh-possibly-change-directory newsgroup server)
 234   (let* ((active-articles
 235           (mapcar
 236            (function
 237             (lambda (name)
 238               (string-to-int name)))
 239            (directory-files nnmh-current-directory nil "^[0-9]+$" t)))
 240          (is-old t)
 241          article rest mod-time)
 242     (nnmail-activate 'nnmh)
 243
 244     (while (and articles is-old)
 245       (setq article (concat nnmh-current-directory
 246                             (int-to-string (car articles))))
 247       (when (setq mod-time (nth 5 (file-attributes article)))
 248         (if (and (nnmh-deletable-article-p newsgroup (car articles))
 249                  (setq is-old
 250                        (nnmail-expired-article-p newsgroup mod-time force)))
 251             (progn
 252               (nnheader-message 5 "Deleting article %s in %s..."
 253                                 article newsgroup)
 254               (condition-case ()
 255                   (funcall nnmail-delete-file-function article)
 256                 (file-error
 257                  (nnheader-message 1 "Couldn't delete article %s in %s"
 258                                    article newsgroup)
 259                  (push (car articles) rest))))
 260           (push (car articles) rest)))
 261       (setq articles (cdr articles)))
 262     (message "")
 263     (nconc rest articles)))
 264
 265 (deffoo nnmh-close-group (group &optional server)
 266   t)
 267
 268 (deffoo nnmh-request-move-article
 269   (article group server accept-form &optional last)
 270   (let ((buf (get-buffer-create " *nnmh move*"))
 271         result)
 272     (and
 273      (nnmh-deletable-article-p group article)
 274      (nnmh-request-article article group server)
 275      (save-excursion
 276        (set-buffer buf)
 277        (insert-buffer-substring nntp-server-buffer)
 278        (setq result (eval accept-form))
 279        (kill-buffer (current-buffer))
 280        result)
 281      (progn
 282        (nnmh-possibly-change-directory group server)
 283        (condition-case ()
 284            (funcall nnmail-delete-file-function
 285                     (concat nnmh-current-directory (int-to-string article)))
 286          (file-error nil))))
 287     result))
 288
 289 (deffoo nnmh-request-accept-article (group &optional server last noinsert)
 290   (nnmh-possibly-change-directory group server)
 291   (nnmail-check-syntax)
 292   (if (stringp group)
 293       (and
 294        (nnmail-activate 'nnmh)
 295        (car (nnmh-save-mail
 296              (list (cons group (nnmh-active-number group)))
 297              noinsert)))
 298     (and
 299      (nnmail-activate 'nnmh)
 300      (car (nnmh-save-mail (nnmail-article-group 'nnmh-active-number)
 301                           noinsert)))))
 302
 303 (deffoo nnmh-request-replace-article (article group buffer)
 304   (nnmh-possibly-change-directory group)
 305   (save-excursion
 306     (set-buffer buffer)
 307     (nnmh-possibly-create-directory group)
 308     (ignore-errors
 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
 315 (deffoo nnmh-request-create-group (group &optional server args)
 316   (nnmail-activate 'nnmh)
 317   (unless (assoc group nnmh-group-alist)
 318     (let (active)
 319       (push (list group (setq active (cons 1 0)))
 320             nnmh-group-alist)
 321       (nnmh-possibly-create-directory group)
 322       (nnmh-possibly-change-directory group server)
 323       (let ((articles (mapcar
 324                        (lambda (file)
 325                          (string-to-int file))
 326                        (directory-files
 327                         nnmh-current-directory nil "^[0-9]+$"))))
 328         (when articles
 329           (setcar active (apply 'min articles))
 330           (setcdr active (apply 'max articles))))))
 331   t)
 332
 333 (deffoo nnmh-request-delete-group (group &optional force server)
 334   (nnmh-possibly-change-directory group server)
 335   ;; Delete all articles in GROUP.
 336   (if (not force)
 337       ()                                ; Don't delete the articles.
 338     (let ((articles (directory-files nnmh-current-directory t "^[0-9]+$")))
 339       (while articles
 340         (when (file-writable-p (car articles))
 341           (nnheader-message 5 "Deleting article %s in %s..."
 342                             (car articles) group)
 343           (funcall nnmail-delete-file-function (car articles)))
 344         (setq articles (cdr articles))))
 345     ;; Try to delete the directory itself.
 346     (ignore-errors
 347       (delete-directory nnmh-current-directory)))
 348   ;; Remove the group from all structures.
 349   (setq nnmh-group-alist
 350         (delq (assoc group nnmh-group-alist) nnmh-group-alist)
 351         nnmh-current-directory nil)
 352   t)
 353
 354 (deffoo nnmh-request-rename-group (group new-name &optional server)
 355   (nnmh-possibly-change-directory group server)
 356   (let ((new-dir (nnmail-group-pathname new-name nnmh-directory))
 357         (old-dir (nnmail-group-pathname group nnmh-directory)))
 358     (when (ignore-errors
 359             (make-directory new-dir t)
 360             t)
 361       ;; We move the articles file by file instead of renaming
 362       ;; the directory -- there may be subgroups in this group.
 363       ;; One might be more clever, I guess.
 364       (let ((files (nnheader-article-to-file-alist old-dir)))
 365         (while files
 366           (rename-file
 367            (concat old-dir (cdar files))
 368            (concat new-dir (cdar files)))
 369           (pop files)))
 370       (when (<= (length (directory-files old-dir)) 2)
 371         (ignore-errors
 372           (delete-directory old-dir)))
 373       ;; That went ok, so we change the internal structures.
 374       (let ((entry (assoc group nnmh-group-alist)))
 375         (when entry
 376           (setcar entry new-name))
 377         (setq nnmh-current-directory nil)
 378         t))))
 379
 380 (nnoo-define-skeleton nnmh)
 381
 382 \f
 383 ;;; Internal functions.
 384
 385 (defun nnmh-possibly-change-directory (newsgroup &optional server)
 386   (when (and server
 387              (not (nnmh-server-opened server)))
 388     (nnmh-open-server server))
 389   (when newsgroup
 390     (let ((pathname (nnmail-group-pathname newsgroup nnmh-directory)))
 391       (if (file-directory-p pathname)
 392           (setq nnmh-current-directory pathname)
 393         (error "No such newsgroup: %s" newsgroup)))))
 394
 395 (defun nnmh-possibly-create-directory (group)
 396   (let (dir dirs)
 397     (setq dir (nnmail-group-pathname group nnmh-directory))
 398     (while (not (file-directory-p dir))
 399       (push dir dirs)
 400       (setq dir (file-name-directory (directory-file-name dir))))
 401     (while dirs
 402       (when (make-directory (directory-file-name (car dirs)))
 403         (error "Could not create directory %s" (car dirs)))
 404       (nnheader-message 5 "Creating mail directory %s" (car dirs))
 405       (setq dirs (cdr dirs)))))
 406
 407 (defun nnmh-save-mail (group-art &optional noinsert)
 408   "Called narrowed to an article."
 409   (unless noinsert
 410     (nnmail-insert-lines)
 411     (nnmail-insert-xref group-art))
 412   (run-hooks 'nnmail-prepare-save-mail-hook)
 413   (run-hooks 'nnmh-prepare-save-mail-hook)
 414   (goto-char (point-min))
 415   (while (looking-at "From ")
 416     (replace-match "X-From-Line: ")
 417     (forward-line 1))
 418   ;; We save the article in all the newsgroups it belongs in.
 419   (let ((ga group-art)
 420         first)
 421     (while ga
 422       (nnmh-possibly-create-directory (caar ga))
 423       (let ((file (concat (nnmail-group-pathname
 424                            (caar ga) nnmh-directory)
 425                           (int-to-string (cdar ga)))))
 426         (if first
 427             ;; It was already saved, so we just make a hard link.
 428             (funcall nnmail-crosspost-link-function first file t)
 429           ;; Save the article.
 430           (nnmail-write-region (point-min) (point-max) file nil nil)
 431           (setq first file)))
 432       (setq ga (cdr ga))))
 433   group-art)
 434
 435 (defun nnmh-active-number (group)
 436   "Compute the next article number in GROUP."
 437   (let ((active (cadr (assoc group nnmh-group-alist))))
 438     (unless active
 439       ;; The group wasn't known to nnmh, so we just create an active
 440       ;; entry for it.
 441       (setq active (cons 1 0))
 442       (push (list group active) nnmh-group-alist)
 443       ;; Find the highest number in the group.
 444       (let ((files (sort
 445                     (mapcar
 446                      (lambda (f)
 447                        (string-to-int f))
 448                      (directory-files
 449                       (nnmail-group-pathname group nnmh-directory)
 450                       nil "^[0-9]+$"))
 451                      '>)))
 452         (when files
 453           (setcdr active (car files)))))
 454     (setcdr active (1+ (cdr active)))
 455     (while (file-exists-p
 456             (concat (nnmail-group-pathname group nnmh-directory)
 457                     (int-to-string (cdr active))))
 458       (setcdr active (1+ (cdr active))))
 459     (cdr active)))
 460
 461 (defun nnmh-update-gnus-unreads (group)
 462   ;; Go through the .nnmh-articles file and compare with the actual
 463   ;; articles in this folder.  The articles that are "new" will be
 464   ;; marked as unread by Gnus.
 465   (let* ((dir nnmh-current-directory)
 466          (files (sort (mapcar (function (lambda (name) (string-to-int name)))
 467                               (directory-files nnmh-current-directory
 468                                                nil "^[0-9]+$" t))
 469                       '<))
 470          (nnmh-file (concat dir ".nnmh-articles"))
 471          new articles)
 472     ;; Load the .nnmh-articles file.
 473     (when (file-exists-p nnmh-file)
 474       (setq articles
 475             (let (nnmh-newsgroup-articles)
 476               (ignore-errors (load nnmh-file nil t t))
 477               nnmh-newsgroup-articles)))
 478     ;; Add all new articles to the `new' list.
 479     (let ((art files))
 480       (while art
 481         (unless (assq (car art) articles)
 482           (push (car art) new))
 483         (setq art (cdr art))))
 484     ;; Remove all deleted articles.
 485     (let ((art articles))
 486       (while art
 487         (unless (memq (caar art) files)
 488           (setq articles (delq (car art) articles)))
 489         (setq art (cdr art))))
 490     ;; Check whether the articles really are the ones that Gnus thinks
 491     ;; they are by looking at the time-stamps.
 492     (let ((arts articles)
 493           art)
 494       (while (setq art (pop arts))
 495         (when (not (equal
 496                     (nth 5 (file-attributes
 497                             (concat dir (int-to-string (car art)))))
 498                     (cdr art)))
 499           (setq articles (delq art articles))
 500           (push (car art) new))))
 501     ;; Go through all the new articles and add them, and their
 502     ;; time-stamps, to the list.
 503     (setq articles
 504           (nconc articles
 505                  (mapcar
 506                   (lambda (art)
 507                     (cons art
 508                           (nth 5 (file-attributes
 509                                   (concat dir (int-to-string art))))))
 510                   new)))
 511     ;; Make Gnus mark all new articles as unread.
 512     (when new
 513       (gnus-make-articles-unread
 514        (gnus-group-prefixed-name group (list 'nnmh ""))
 515        (setq new (sort new '<))))
 516     ;; Sort the article list with highest numbers first.
 517     (setq articles (sort articles (lambda (art1 art2)
 518                                     (> (car art1) (car art2)))))
 519     ;; Finally write this list back to the .nnmh-articles file.
 520     (nnheader-temp-write nnmh-file
 521       (insert ";; Gnus article active file for " group "\n\n")
 522       (insert "(setq nnmh-newsgroup-articles '")
 523       (gnus-prin1 articles)
 524       (insert ")\n"))))
 525
 526 (defun nnmh-deletable-article-p (group article)
 527   "Say whether ARTICLE in GROUP can be deleted."
 528   (let ((path (concat nnmh-current-directory (int-to-string article))))
 529     ;; Writable.
 530     (and (file-writable-p path)
 531          ;; We can never delete the last article in the group.
 532          (not (eq (cdr (nth 1 (assoc group nnmh-group-alist)))
 533                   article)))))
 534
 535 (provide 'nnmh)
 536
 537 ;;; nnmh.el ends here