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

   1 ;;; nnml.el --- mail spool access for Gnus
   2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Simon Josefsson <simon@josefsson.org> (adding MARKS)
   6 ;;      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 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 ;; Boston, MA 02111-1307, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
  30 ;; For an overview of what the interface functions do, please see the
  31 ;; Gnus sources.
  32
  33 ;;; Code:
  34
  35 (require 'gnus)
  36 (require 'nnheader)
  37 (require 'nnmail)
  38 (require 'nnoo)
  39 (eval-when-compile (require 'cl))
  40
  41 (eval-and-compile
  42   (autoload 'gnus-article-unpropagatable-p "gnus-sum"))
  43
  44 (nnoo-declare nnml)
  45
  46 (defvoo nnml-directory message-directory
  47   "Spool directory for the nnml mail backend.")
  48
  49 (defvoo nnml-active-file
  50     (expand-file-name "active" nnml-directory)
  51   "Mail active file.")
  52
  53 (defvoo nnml-newsgroups-file
  54     (expand-file-name "newsgroups" nnml-directory)
  55   "Mail newsgroups description file.")
  56
  57 (defvoo nnml-get-new-mail t
  58   "If non-nil, nnml will check the incoming mail file and split the mail.")
  59
  60 (defvoo nnml-nov-is-evil nil
  61   "If non-nil, Gnus will never generate and use nov databases for mail spools.
  62 Using nov databases will speed up header fetching considerably.
  63 This variable shouldn't be flipped much.  If you have, for some reason,
  64 set this to t, and want to set it to nil again, you should always run
  65 the `nnml-generate-nov-databases' command.  The function will go
  66 through all nnml directories and generate nov databases for them
  67 all.  This may very well take some time.")
  68
  69 (defvoo nnml-marks-is-evil nil
  70   "If non-nil, Gnus will never generate and use marks file for mail spools.
  71 Using marks files makes it possible to backup and restore mail groups
  72 separately from `.newsrc.eld'.  If you have, for some reason, set this
  73 to t, and want to set it to nil again, you should always remove the
  74 corresponding marks file (usually named `.marks' in the nnml group
  75 directory, but see `nnml-marks-file-name') for the group.  Then the
  76 marks file will be regenerated properly by Gnus.")
  77
  78 (defvoo nnml-prepare-save-mail-hook nil
  79   "Hook run narrowed to an article before saving.")
  80
  81 (defvoo nnml-inhibit-expiry nil
  82   "If non-nil, inhibit expiry.")
  83
  84 (defvoo nnml-use-compressed-files nil
  85   "If non-nil, allow using compressed message files.")
  86
  87 \f
  88
  89 (defconst nnml-version "nnml 1.0"
  90   "nnml version.")
  91
  92 (defvoo nnml-nov-file-name ".overview")
  93 (defvoo nnml-marks-file-name ".marks")
  94
  95 (defvoo nnml-current-directory nil)
  96 (defvoo nnml-current-group nil)
  97 (defvoo nnml-status-string "")
  98 (defvoo nnml-nov-buffer-alist nil)
  99 (defvoo nnml-group-alist nil)
 100 (defvoo nnml-active-timestamp nil)
 101 (defvoo nnml-article-file-alist nil)
 102
 103 (defvoo nnml-generate-active-function 'nnml-generate-active-info)
 104
 105 (defvar nnml-nov-buffer-file-name nil)
 106
 107 (defvoo nnml-file-coding-system nnmail-file-coding-system)
 108
 109 (defvoo nnml-marks nil)
 110
 111 (defvar nnml-marks-modtime (gnus-make-hashtable))
 112
 113 \f
 114 ;;; Interface functions.
 115
 116 (nnoo-define-basics nnml)
 117
 118 (deffoo nnml-retrieve-headers (sequence &optional group server fetch-old)
 119   (when (nnml-possibly-change-directory group server)
 120     (save-excursion
 121       (set-buffer nntp-server-buffer)
 122       (erase-buffer)
 123       (let* ((file nil)
 124              (number (length sequence))
 125              (count 0)
 126              (file-name-coding-system nnmail-pathname-coding-system)
 127              beg article)
 128         (if (stringp (car sequence))
 129             'headers
 130           (if (nnml-retrieve-headers-with-nov sequence fetch-old)
 131               'nov
 132             (while sequence
 133               (setq article (car sequence))
 134               (setq file (nnml-article-to-file article))
 135               (when (and file
 136                          (file-exists-p file)
 137                          (not (file-directory-p file)))
 138                 (insert (format "221 %d Article retrieved.\n" article))
 139                 (setq beg (point))
 140                 (nnheader-insert-head file)
 141                 (goto-char beg)
 142                 (if (re-search-forward "\n\r?\n" nil t)
 143                     (forward-char -1)
 144                   (goto-char (point-max))
 145                   (insert "\n\n"))
 146                 (insert ".\n")
 147                 (delete-region (point) (point-max)))
 148               (setq sequence (cdr sequence))
 149               (setq count (1+ count))
 150               (and (numberp nnmail-large-newsgroup)
 151                    (> number nnmail-large-newsgroup)
 152                    (zerop (% count 20))
 153                    (nnheader-message 6 "nnml: Receiving headers... %d%%"
 154                                      (/ (* count 100) number))))
 155
 156             (and (numberp nnmail-large-newsgroup)
 157                  (> number nnmail-large-newsgroup)
 158                  (nnheader-message 6 "nnml: Receiving headers...done"))
 159
 160             (nnheader-fold-continuation-lines)
 161             'headers))))))
 162
 163 (deffoo nnml-open-server (server &optional defs)
 164   (nnoo-change-server 'nnml server defs)
 165   (when (not (file-exists-p nnml-directory))
 166     (ignore-errors (make-directory nnml-directory t)))
 167   (cond
 168    ((not (file-exists-p nnml-directory))
 169     (nnml-close-server)
 170     (nnheader-report 'nnml "Couldn't create directory: %s" nnml-directory))
 171    ((not (file-directory-p (file-truename nnml-directory)))
 172     (nnml-close-server)
 173     (nnheader-report 'nnml "Not a directory: %s" nnml-directory))
 174    (t
 175     (nnheader-report 'nnml "Opened server %s using directory %s"
 176                      server nnml-directory)
 177     t)))
 178
 179 (deffoo nnml-request-regenerate (server)
 180   (nnml-possibly-change-directory nil server)
 181   (nnml-generate-nov-databases server)
 182   t)
 183
 184 (deffoo nnml-request-article (id &optional group server buffer)
 185   (nnml-possibly-change-directory group server)
 186   (let* ((nntp-server-buffer (or buffer nntp-server-buffer))
 187          (file-name-coding-system nnmail-pathname-coding-system)
 188          path gpath group-num)
 189     (if (stringp id)
 190         (when (and (setq group-num (nnml-find-group-number id))
 191                    (cdr
 192                     (assq (cdr group-num)
 193                           (nnheader-article-to-file-alist
 194                            (setq gpath
 195                                  (nnmail-group-pathname
 196                                   (car group-num)
 197                                   nnml-directory))))))
 198           (setq path (concat gpath (int-to-string (cdr group-num)))))
 199       (setq path (nnml-article-to-file id)))
 200     (cond
 201      ((not path)
 202       (nnheader-report 'nnml "No such article: %s" id))
 203      ((not (file-exists-p path))
 204       (nnheader-report 'nnml "No such file: %s" path))
 205      ((file-directory-p path)
 206       (nnheader-report 'nnml "File is a directory: %s" path))
 207      ((not (save-excursion (let ((nnmail-file-coding-system
 208                                   nnml-file-coding-system))
 209                              (nnmail-find-file path))))
 210       (nnheader-report 'nnml "Couldn't read file: %s" path))
 211      (t
 212       (nnheader-report 'nnml "Article %s retrieved" id)
 213       ;; We return the article number.
 214       (cons (if group-num (car group-num) group)
 215             (string-to-int (file-name-nondirectory path)))))))
 216
 217 (deffoo nnml-request-group (group &optional server dont-check)
 218   (let ((file-name-coding-system nnmail-pathname-coding-system))
 219     (cond
 220      ((not (nnml-possibly-change-directory group server))
 221       (nnheader-report 'nnml "Invalid group (no such directory)"))
 222      ((not (file-exists-p nnml-current-directory))
 223       (nnheader-report 'nnml "Directory %s does not exist"
 224                        nnml-current-directory))
 225      ((not (file-directory-p nnml-current-directory))
 226       (nnheader-report 'nnml "%s is not a directory" nnml-current-directory))
 227      (dont-check
 228       (nnheader-report 'nnml "Group %s selected" group)
 229       t)
 230      (t
 231       (nnheader-re-read-dir nnml-current-directory)
 232       (nnmail-activate 'nnml)
 233       (let ((active (nth 1 (assoc group nnml-group-alist))))
 234         (if (not active)
 235             (nnheader-report 'nnml "No such group: %s" group)
 236           (nnheader-report 'nnml "Selected group %s" group)
 237           (nnheader-insert "211 %d %d %d %s\n"
 238                            (max (1+ (- (cdr active) (car active))) 0)
 239                            (car active) (cdr active) group)))))))
 240
 241 (deffoo nnml-request-scan (&optional group server)
 242   (setq nnml-article-file-alist nil)
 243   (nnml-possibly-change-directory group server)
 244   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
 245
 246 (deffoo nnml-close-group (group &optional server)
 247   (setq nnml-article-file-alist nil)
 248   t)
 249
 250 (deffoo nnml-request-create-group (group &optional server args)
 251   (nnml-possibly-change-directory nil server)
 252   (nnmail-activate 'nnml)
 253   (cond
 254    ((assoc group nnml-group-alist)
 255     t)
 256    ((and (file-exists-p (nnmail-group-pathname group nnml-directory))
 257          (not (file-directory-p (nnmail-group-pathname group nnml-directory))))
 258     (nnheader-report 'nnml "%s is a file"
 259                      (nnmail-group-pathname group nnml-directory)))
 260    (t
 261     (let (active)
 262       (push (list group (setq active (cons 1 0)))
 263             nnml-group-alist)
 264       (nnml-possibly-create-directory group)
 265       (nnml-possibly-change-directory group server)
 266       (let ((articles (nnml-directory-articles nnml-current-directory)))
 267         (when articles
 268           (setcar active (apply 'min articles))
 269           (setcdr active (apply 'max articles))))
 270       (nnmail-save-active nnml-group-alist nnml-active-file)
 271       t))))
 272
 273 (deffoo nnml-request-list (&optional server)
 274   (save-excursion
 275     (let ((nnmail-file-coding-system nnmail-active-file-coding-system)
 276           (file-name-coding-system nnmail-pathname-coding-system))
 277       (nnmail-find-file nnml-active-file))
 278     (setq nnml-group-alist (nnmail-get-active))
 279     t))
 280
 281 (deffoo nnml-request-newgroups (date &optional server)
 282   (nnml-request-list server))
 283
 284 (deffoo nnml-request-list-newsgroups (&optional server)
 285   (save-excursion
 286     (nnmail-find-file nnml-newsgroups-file)))
 287
 288 (deffoo nnml-request-expire-articles (articles group &optional server force)
 289   (nnml-possibly-change-directory group server)
 290   (let ((active-articles
 291          (nnml-directory-articles nnml-current-directory))
 292         (is-old t)
 293         article rest mod-time number)
 294     (nnmail-activate 'nnml)
 295
 296     (setq active-articles (sort active-articles '<))
 297     ;; Articles not listed in active-articles are already gone,
 298     ;; so don't try to expire them.
 299     (setq articles (gnus-sorted-intersection articles active-articles))
 300
 301     (while (and articles is-old)
 302       (if (and (setq article (nnml-article-to-file
 303                               (setq number (pop articles))))
 304                (setq mod-time (nth 5 (file-attributes article)))
 305                (nnml-deletable-article-p group number)
 306                (setq is-old (nnmail-expired-article-p group mod-time force
 307                                                       nnml-inhibit-expiry)))
 308           (progn
 309             ;; Allow a special target group.
 310             (unless (eq nnmail-expiry-target 'delete)
 311               (with-temp-buffer
 312                 (nnml-request-article number group server (current-buffer))
 313                 (let (nnml-current-directory
 314                       nnml-current-group
 315                       nnml-article-file-alist)
 316                   (nnmail-expiry-target-group nnmail-expiry-target group)))
 317               ;; Maybe directory is changed during nnmail-expiry-target-group.
 318               (nnml-possibly-change-directory group server))
 319             (nnheader-message 5 "Deleting article %s in %s"
 320                               number group)
 321             (condition-case ()
 322                 (funcall nnmail-delete-file-function article)
 323               (file-error
 324                (push number rest)))
 325             (setq active-articles (delq number active-articles))
 326             (nnml-nov-delete-article group number))
 327         (push number rest)))
 328     (let ((active (nth 1 (assoc group nnml-group-alist))))
 329       (when active
 330         (setcar active (or (and active-articles
 331                                 (apply 'min active-articles))
 332                            (1+ (cdr active)))))
 333       (nnmail-save-active nnml-group-alist nnml-active-file))
 334     (nnml-save-nov)
 335     (nconc rest articles)))
 336
 337 (deffoo nnml-request-move-article
 338     (article group server accept-form &optional last)
 339   (let ((buf (get-buffer-create " *nnml move*"))
 340         result)
 341     (nnml-possibly-change-directory group server)
 342     (nnml-update-file-alist)
 343     (and
 344      (nnml-deletable-article-p group article)
 345      (nnml-request-article article group server)
 346      (let (nnml-current-directory
 347            nnml-current-group
 348            nnml-article-file-alist)
 349        (save-excursion
 350          (set-buffer buf)
 351          (insert-buffer-substring nntp-server-buffer)
 352          (setq result (eval accept-form))
 353          (kill-buffer (current-buffer))
 354          result))
 355      (progn
 356        (nnml-possibly-change-directory group server)
 357        (condition-case ()
 358            (funcall nnmail-delete-file-function
 359                     (nnml-article-to-file  article))
 360          (file-error nil))
 361        (nnml-nov-delete-article group article)
 362        (when last
 363          (nnml-save-nov)
 364          (nnmail-save-active nnml-group-alist nnml-active-file))))
 365     result))
 366
 367 (deffoo nnml-request-accept-article (group &optional server last)
 368   (nnml-possibly-change-directory group server)
 369   (nnmail-check-syntax)
 370   (let (result)
 371     (when nnmail-cache-accepted-message-ids
 372       (nnmail-cache-insert (nnmail-fetch-field "message-id")
 373                            group
 374                            (nnmail-fetch-field "subject")
 375                            (nnmail-fetch-field "from")))
 376     (if (stringp group)
 377         (and
 378          (nnmail-activate 'nnml)
 379          (setq result (car (nnml-save-mail
 380                             (list (cons group (nnml-active-number group))))))
 381          (progn
 382            (nnmail-save-active nnml-group-alist nnml-active-file)
 383            (and last (nnml-save-nov))))
 384       (and
 385        (nnmail-activate 'nnml)
 386        (if (and (not (setq result (nnmail-article-group 'nnml-active-number)))
 387                 (yes-or-no-p "Moved to `junk' group; delete article? "))
 388            (setq result 'junk)
 389          (setq result (car (nnml-save-mail result))))
 390        (when last
 391          (nnmail-save-active nnml-group-alist nnml-active-file)
 392          (when nnmail-cache-accepted-message-ids
 393            (nnmail-cache-close))
 394          (nnml-save-nov))))
 395     result))
 396
 397 (deffoo nnml-request-post (&optional server)
 398   (nnmail-do-request-post 'nnml-request-accept-article server))
 399
 400 (deffoo nnml-request-replace-article (article group buffer)
 401   (nnml-possibly-change-directory group)
 402   (save-excursion
 403     (set-buffer buffer)
 404     (nnml-possibly-create-directory group)
 405     (let ((chars (nnmail-insert-lines))
 406           (art (concat (int-to-string article) "\t"))
 407           headers)
 408       (when (ignore-errors
 409               (nnmail-write-region
 410                (point-min) (point-max)
 411                (or (nnml-article-to-file article)
 412                    (expand-file-name (int-to-string article)
 413                                      nnml-current-directory))
 414                nil (if (nnheader-be-verbose 5) nil 'nomesg))
 415               t)
 416         (setq headers (nnml-parse-head chars article))
 417         ;; Replace the NOV line in the NOV file.
 418         (save-excursion
 419           (set-buffer (nnml-open-nov group))
 420           (goto-char (point-min))
 421           (if (or (looking-at art)
 422                   (search-forward (concat "\n" art) nil t))
 423               ;; Delete the old NOV line.
 424               (gnus-delete-line)
 425             ;; The line isn't here, so we have to find out where
 426             ;; we should insert it.  (This situation should never
 427             ;; occur, but one likes to make sure...)
 428             (while (and (looking-at "[0-9]+\t")
 429                         (< (string-to-int
 430                             (buffer-substring
 431                              (match-beginning 0) (match-end 0)))
 432                            article)
 433                         (zerop (forward-line 1)))))
 434           (beginning-of-line)
 435           (nnheader-insert-nov headers)
 436           (nnml-save-nov)
 437           t)))))
 438
 439 (deffoo nnml-request-delete-group (group &optional force server)
 440   (nnml-possibly-change-directory group server)
 441   (when force
 442     ;; Delete all articles in GROUP.
 443     (let ((articles
 444            (directory-files
 445             nnml-current-directory t
 446             (concat nnheader-numerical-short-files
 447                     "\\|" (regexp-quote nnml-nov-file-name) "$"
 448                     "\\|" (regexp-quote nnml-marks-file-name) "$"))))
 449       (dolist (article articles)
 450         (when (file-writable-p article)
 451           (nnheader-message 5 "Deleting article %s in %s..." article group)
 452           (funcall nnmail-delete-file-function article))))
 453     ;; Try to delete the directory itself.
 454     (ignore-errors (delete-directory nnml-current-directory)))
 455   ;; Remove the group from all structures.
 456   (setq nnml-group-alist
 457         (delq (assoc group nnml-group-alist) nnml-group-alist)
 458         nnml-current-group nil
 459         nnml-current-directory nil)
 460   ;; Save the active file.
 461   (nnmail-save-active nnml-group-alist nnml-active-file)
 462   t)
 463
 464 (deffoo nnml-request-rename-group (group new-name &optional server)
 465   (nnml-possibly-change-directory group server)
 466   (let ((new-dir (nnmail-group-pathname new-name nnml-directory))
 467         (old-dir (nnmail-group-pathname group nnml-directory)))
 468     (when (ignore-errors
 469             (make-directory new-dir t)
 470             t)
 471       ;; We move the articles file by file instead of renaming
 472       ;; the directory -- there may be subgroups in this group.
 473       ;; One might be more clever, I guess.
 474       (dolist (file (nnheader-article-to-file-alist old-dir))
 475         (rename-file
 476          (concat old-dir (cdr file))
 477          (concat new-dir (cdr file))))
 478       ;; Move .overview file.
 479       (let ((overview (concat old-dir nnml-nov-file-name)))
 480         (when (file-exists-p overview)
 481           (rename-file overview (concat new-dir nnml-nov-file-name))))
 482       ;; Move .marks file.
 483       (let ((marks (concat old-dir nnml-marks-file-name)))
 484         (when (file-exists-p marks)
 485           (rename-file marks (concat new-dir nnml-marks-file-name))))
 486       (when (<= (length (directory-files old-dir)) 2)
 487         (ignore-errors (delete-directory old-dir)))
 488       ;; That went ok, so we change the internal structures.
 489       (let ((entry (assoc group nnml-group-alist)))
 490         (when entry
 491           (setcar entry new-name))
 492         (setq nnml-current-directory nil
 493               nnml-current-group nil)
 494         ;; Save the new group alist.
 495         (nnmail-save-active nnml-group-alist nnml-active-file)
 496         t))))
 497
 498 (deffoo nnml-set-status (article name value &optional group server)
 499   (nnml-possibly-change-directory group server)
 500   (let ((file (nnml-article-to-file article)))
 501     (cond
 502      ((not (file-exists-p file))
 503       (nnheader-report 'nnml "File %s does not exist" file))
 504      (t
 505       (with-temp-file file
 506         (nnheader-insert-file-contents file)
 507         (nnmail-replace-status name value))
 508       t))))
 509
 510 \f
 511 ;;; Internal functions.
 512
 513 (defun nnml-article-to-file (article)
 514   (nnml-update-file-alist)
 515   (let (file)
 516     (if (setq file
 517               (if nnml-use-compressed-files
 518                   (cdr (assq article nnml-article-file-alist))
 519                 (number-to-string article)))
 520         (expand-file-name file nnml-current-directory)
 521       (when (not nnheader-directory-files-is-safe)
 522         ;; Just to make sure nothing went wrong when reading over NFS --
 523         ;; check once more.
 524         (when (file-exists-p
 525                (setq file (expand-file-name (number-to-string article)
 526                                             nnml-current-directory)))
 527           (nnml-update-file-alist t)
 528           file)))))
 529
 530 (defun nnml-deletable-article-p (group article)
 531   "Say whether ARTICLE in GROUP can be deleted."
 532   (let (path)
 533     (when (setq path (nnml-article-to-file article))
 534       (when (file-writable-p path)
 535         (or (not nnmail-keep-last-article)
 536             (not (eq (cdr (nth 1 (assoc group nnml-group-alist)))
 537                      article)))))))
 538
 539 ;; Find an article number in the current group given the Message-ID.
 540 (defun nnml-find-group-number (id)
 541   (save-excursion
 542     (set-buffer (get-buffer-create " *nnml id*"))
 543     (let ((alist nnml-group-alist)
 544           number)
 545       ;; We want to look through all .overview files, but we want to
 546       ;; start with the one in the current directory.  It seems most
 547       ;; likely that the article we are looking for is in that group.
 548       (if (setq number (nnml-find-id nnml-current-group id))
 549           (cons nnml-current-group number)
 550       ;; It wasn't there, so we look through the other groups as well.
 551         (while (and (not number)
 552                     alist)
 553           (or (string= (caar alist) nnml-current-group)
 554               (setq number (nnml-find-id (caar alist) id)))
 555           (or number
 556               (setq alist (cdr alist))))
 557         (and number
 558              (cons (caar alist) number))))))
 559
 560 (defun nnml-find-id (group id)
 561   (erase-buffer)
 562   (let ((nov (expand-file-name nnml-nov-file-name
 563                                (nnmail-group-pathname group nnml-directory)))
 564         number found)
 565     (when (file-exists-p nov)
 566       (nnheader-insert-file-contents nov)
 567       (while (and (not found)
 568                   (search-forward id nil t)) ; We find the ID.
 569         ;; And the id is in the fourth field.
 570         (if (not (and (search-backward "\t" nil t 4)
 571                       (not (search-backward "\t" (point-at-bol) t))))
 572             (forward-line 1)
 573           (beginning-of-line)
 574           (setq found t)
 575           ;; We return the article number.
 576           (setq number
 577                 (ignore-errors (read (current-buffer))))))
 578       number)))
 579
 580 (defun nnml-retrieve-headers-with-nov (articles &optional fetch-old)
 581   (if (or gnus-nov-is-evil nnml-nov-is-evil)
 582       nil
 583     (let ((nov (expand-file-name nnml-nov-file-name nnml-current-directory)))
 584       (when (file-exists-p nov)
 585         (save-excursion
 586           (set-buffer nntp-server-buffer)
 587           (erase-buffer)
 588           (nnheader-insert-file-contents nov)
 589           (if (and fetch-old
 590                    (not (numberp fetch-old)))
 591               t                         ; Don't remove anything.
 592             (nnheader-nov-delete-outside-range
 593              (if fetch-old (max 1 (- (car articles) fetch-old))
 594                (car articles))
 595              (car (last articles)))
 596             t))))))
 597
 598 (defun nnml-possibly-change-directory (group &optional server)
 599   (when (and server
 600              (not (nnml-server-opened server)))
 601     (nnml-open-server server))
 602   (if (not group)
 603       t
 604     (let ((pathname (nnmail-group-pathname group nnml-directory))
 605           (file-name-coding-system nnmail-pathname-coding-system))
 606       (when (not (equal pathname nnml-current-directory))
 607         (setq nnml-current-directory pathname
 608               nnml-current-group group
 609               nnml-article-file-alist nil))
 610       (file-exists-p nnml-current-directory))))
 611
 612 (defun nnml-possibly-create-directory (group)
 613   (let ((dir (nnmail-group-pathname group nnml-directory)))
 614     (unless (file-exists-p dir)
 615       (make-directory (directory-file-name dir) t)
 616       (nnheader-message 5 "Creating mail directory %s" dir))))
 617
 618 (defun nnml-save-mail (group-art)
 619   "Called narrowed to an article."
 620   (let (chars headers extension)
 621     (setq chars (nnmail-insert-lines))
 622     (setq extension
 623          (and nnml-use-compressed-files
 624               (> chars 1000)
 625               ".gz"))
 626     (nnmail-insert-xref group-art)
 627     (run-hooks 'nnmail-prepare-save-mail-hook)
 628     (run-hooks 'nnml-prepare-save-mail-hook)
 629     (goto-char (point-min))
 630     (while (looking-at "From ")
 631       (replace-match "X-From-Line: ")
 632       (forward-line 1))
 633     ;; We save the article in all the groups it belongs in.
 634     (let ((ga group-art)
 635           first)
 636       (while ga
 637         (nnml-possibly-create-directory (caar ga))
 638         (let ((file (concat (nnmail-group-pathname
 639                              (caar ga) nnml-directory)
 640                             (int-to-string (cdar ga))
 641                             extension)))
 642           (if first
 643               ;; It was already saved, so we just make a hard link.
 644               (funcall nnmail-crosspost-link-function first file t)
 645             ;; Save the article.
 646             (nnmail-write-region (point-min) (point-max) file nil
 647                                  (if (nnheader-be-verbose 5) nil 'nomesg))
 648             (setq first file)))
 649         (setq ga (cdr ga))))
 650     ;; Generate a nov line for this article.  We generate the nov
 651     ;; line after saving, because nov generation destroys the
 652     ;; header.
 653     (setq headers (nnml-parse-head chars))
 654     ;; Output the nov line to all nov databases that should have it.
 655     (let ((ga group-art))
 656       (while ga
 657         (nnml-add-nov (caar ga) (cdar ga) headers)
 658         (setq ga (cdr ga))))
 659     group-art))
 660
 661 (defun nnml-active-number (group)
 662   "Compute the next article number in GROUP."
 663   (let ((active (cadr (assoc group nnml-group-alist))))
 664     ;; The group wasn't known to nnml, so we just create an active
 665     ;; entry for it.
 666     (unless active
 667       ;; Perhaps the active file was corrupt?  See whether
 668       ;; there are any articles in this group.
 669       (nnml-possibly-create-directory group)
 670       (nnml-possibly-change-directory group)
 671       (unless nnml-article-file-alist
 672         (setq nnml-article-file-alist
 673               (sort
 674                (nnml-current-group-article-to-file-alist)
 675                'car-less-than-car)))
 676       (setq active
 677             (if nnml-article-file-alist
 678                 (cons (caar nnml-article-file-alist)
 679                       (caar (last nnml-article-file-alist)))
 680               (cons 1 0)))
 681       (push (list group active) nnml-group-alist))
 682     (setcdr active (1+ (cdr active)))
 683     (while (file-exists-p
 684             (expand-file-name (int-to-string (cdr active))
 685                               (nnmail-group-pathname group nnml-directory)))
 686       (setcdr active (1+ (cdr active))))
 687     (cdr active)))
 688
 689 (defun nnml-add-nov (group article headers)
 690   "Add a nov line for the GROUP base."
 691   (save-excursion
 692     (set-buffer (nnml-open-nov group))
 693     (goto-char (point-max))
 694     (mail-header-set-number headers article)
 695     (nnheader-insert-nov headers)))
 696
 697 (defsubst nnml-header-value ()
 698   (buffer-substring (match-end 0) (point-at-eol)))
 699
 700 (defun nnml-parse-head (chars &optional number)
 701   "Parse the head of the current buffer."
 702   (save-excursion
 703     (save-restriction
 704       (unless (zerop (buffer-size))
 705         (narrow-to-region
 706          (goto-char (point-min))
 707          (if (re-search-forward "\n\r?\n" nil t)
 708              (1- (point))
 709            (point-max))))
 710       (let ((headers (nnheader-parse-naked-head)))
 711         (mail-header-set-chars headers chars)
 712         (mail-header-set-number headers number)
 713         headers))))
 714
 715 (defun nnml-get-nov-buffer (group)
 716   (let ((buffer (get-buffer-create (format " *nnml overview %s*" group))))
 717     (save-excursion
 718       (set-buffer buffer)
 719       (set (make-local-variable 'nnml-nov-buffer-file-name)
 720            (expand-file-name
 721             nnml-nov-file-name
 722             (nnmail-group-pathname group nnml-directory)))
 723       (erase-buffer)
 724       (when (file-exists-p nnml-nov-buffer-file-name)
 725         (nnheader-insert-file-contents nnml-nov-buffer-file-name)))
 726     buffer))
 727
 728 (defun nnml-open-nov (group)
 729   (or (cdr (assoc group nnml-nov-buffer-alist))
 730       (let ((buffer (nnml-get-nov-buffer group)))
 731         (push (cons group buffer) nnml-nov-buffer-alist)
 732         buffer)))
 733
 734 (defun nnml-save-nov ()
 735   (save-excursion
 736     (while nnml-nov-buffer-alist
 737       (when (buffer-name (cdar nnml-nov-buffer-alist))
 738         (set-buffer (cdar nnml-nov-buffer-alist))
 739         (when (buffer-modified-p)
 740           (nnmail-write-region (point-min) (point-max)
 741                                nnml-nov-buffer-file-name nil 'nomesg))
 742         (set-buffer-modified-p nil)
 743         (kill-buffer (current-buffer)))
 744       (setq nnml-nov-buffer-alist (cdr nnml-nov-buffer-alist)))))
 745
 746 ;;;###autoload
 747 (defun nnml-generate-nov-databases (&optional server)
 748   "Generate NOV databases in all nnml directories."
 749   (interactive (list (or (nnoo-current-server 'nnml) "")))
 750   ;; Read the active file to make sure we don't re-use articles
 751   ;; numbers in empty groups.
 752   (nnmail-activate 'nnml)
 753   (unless (nnml-server-opened server)
 754     (nnml-open-server server))
 755   (setq nnml-directory (expand-file-name nnml-directory))
 756   ;; Recurse down the directories.
 757   (nnml-generate-nov-databases-1 nnml-directory nil t)
 758   ;; Save the active file.
 759   (nnmail-save-active nnml-group-alist nnml-active-file))
 760
 761 (defun nnml-generate-nov-databases-1 (dir &optional seen no-active)
 762   "Regenerate the NOV database in DIR."
 763   (interactive "DRegenerate NOV in: ")
 764   (setq dir (file-name-as-directory dir))
 765   ;; Only scan this sub-tree if we haven't been here yet.
 766   (unless (member (file-truename dir) seen)
 767     (push (file-truename dir) seen)
 768     ;; We descend recursively
 769     (dolist (dir (directory-files dir t nil t))
 770       (when (and (not (string-match "^\\." (file-name-nondirectory dir)))
 771                  (file-directory-p dir))
 772         (nnml-generate-nov-databases-1 dir seen)))
 773     ;; Do this directory.
 774     (let ((files (sort (nnheader-article-to-file-alist dir)
 775                        'car-less-than-car)))
 776       (if (not files)
 777           (let* ((group (nnheader-file-to-group
 778                          (directory-file-name dir) nnml-directory))
 779                  (info (cadr (assoc group nnml-group-alist))))
 780             (when info
 781               (setcar info (1+ (cdr info)))))
 782         (funcall nnml-generate-active-function dir)
 783         ;; Generate the nov file.
 784         (nnml-generate-nov-file dir files)
 785         (unless no-active
 786           (nnmail-save-active nnml-group-alist nnml-active-file))))))
 787
 788 (eval-when-compile (defvar files))
 789 (defun nnml-generate-active-info (dir)
 790   ;; Update the active info for this group.
 791   (let* ((group (nnheader-file-to-group
 792                  (directory-file-name dir) nnml-directory))
 793          (entry (assoc group nnml-group-alist))
 794          (last (or (caadr entry) 0)))
 795     (setq nnml-group-alist (delq entry nnml-group-alist))
 796     (push (list group
 797                 (cons (or (caar files) (1+ last))
 798                       (max last
 799                            (or (let ((f files))
 800                                  (while (cdr f) (setq f (cdr f)))
 801                                  (caar f))
 802                                0))))
 803           nnml-group-alist)))
 804
 805 (defun nnml-generate-nov-file (dir files)
 806   (let* ((dir (file-name-as-directory dir))
 807          (nov (concat dir nnml-nov-file-name))
 808          (nov-buffer (get-buffer-create " *nov*"))
 809          chars file headers)
 810     (save-excursion
 811       ;; Init the nov buffer.
 812       (set-buffer nov-buffer)
 813       (buffer-disable-undo)
 814       (erase-buffer)
 815       (set-buffer nntp-server-buffer)
 816       ;; Delete the old NOV file.
 817       (when (file-exists-p nov)
 818         (funcall nnmail-delete-file-function nov))
 819       (while files
 820         (unless (file-directory-p (setq file (concat dir (cdar files))))
 821           (erase-buffer)
 822           (nnheader-insert-file-contents file)
 823           (narrow-to-region
 824            (goto-char (point-min))
 825            (progn
 826              (re-search-forward "\n\r?\n" nil t)
 827              (setq chars (- (point-max) (point)))
 828              (max (point-min) (1- (point)))))
 829           (unless (zerop (buffer-size))
 830             (goto-char (point-min))
 831             (setq headers (nnml-parse-head chars (caar files)))
 832             (save-excursion
 833               (set-buffer nov-buffer)
 834               (goto-char (point-max))
 835               (nnheader-insert-nov headers)))
 836           (widen))
 837         (setq files (cdr files)))
 838       (save-excursion
 839         (set-buffer nov-buffer)
 840         (nnmail-write-region (point-min) (point-max) nov nil 'nomesg)
 841         (kill-buffer (current-buffer))))))
 842
 843 (defun nnml-nov-delete-article (group article)
 844   (save-excursion
 845     (set-buffer (nnml-open-nov group))
 846     (when (nnheader-find-nov-line article)
 847       (delete-region (point) (progn (forward-line 1) (point)))
 848       (when (bobp)
 849         (let ((active (cadr (assoc group nnml-group-alist)))
 850               num)
 851           (when active
 852             (if (eobp)
 853                 (setf (car active) (1+ (cdr active)))
 854               (when (and (setq num (ignore-errors (read (current-buffer))))
 855                          (numberp num))
 856                 (setf (car active) num)))))))
 857     t))
 858
 859 (defun nnml-update-file-alist (&optional force)
 860   (when nnml-use-compressed-files
 861     (when (or (not nnml-article-file-alist)
 862               force)
 863       (setq nnml-article-file-alist
 864             (nnml-current-group-article-to-file-alist)))))
 865
 866 (defun nnml-directory-articles (dir)
 867   "Return a list of all article files in a directory.
 868 Use the nov database for that directory if available."
 869   (if (or gnus-nov-is-evil nnml-nov-is-evil
 870           (not (file-exists-p
 871                 (expand-file-name nnml-nov-file-name dir))))
 872       (nnheader-directory-articles dir)
 873     ;; build list from .overview if available
 874     ;; We would use nnml-open-nov, except that nnml-nov-buffer-alist is
 875     ;; defvoo'd, and we might get called when it hasn't been swapped in.
 876     (save-excursion
 877       (let ((list nil)
 878             art
 879             (buffer (nnml-get-nov-buffer nnml-current-group)))
 880         (set-buffer buffer)
 881         (goto-char (point-min))
 882         (while (not (eobp))
 883           (setq art (read (current-buffer)))
 884           (push art list)
 885           (forward-line 1))
 886         list))))
 887
 888 (defun nnml-current-group-article-to-file-alist ()
 889   "Return an alist of article/file pairs in the current group.
 890 Use the nov database for the current group if available."
 891   (if (or nnml-use-compressed-files
 892           gnus-nov-is-evil
 893           nnml-nov-is-evil
 894           (not (file-exists-p
 895                 (expand-file-name nnml-nov-file-name
 896                                   nnml-current-directory))))
 897       (nnheader-article-to-file-alist nnml-current-directory)
 898     ;; build list from .overview if available
 899     (save-excursion
 900       (let ((alist nil)
 901             (buffer (nnml-get-nov-buffer nnml-current-group))
 902             art)
 903         (set-buffer buffer)
 904         (goto-char (point-min))
 905         (while (not (eobp))
 906           (setq art (read (current-buffer)))
 907           ;; assume file name is unadorned (ie. not compressed etc)
 908           (push (cons art (int-to-string art)) alist)
 909           (forward-line 1))
 910         alist))))
 911
 912 (deffoo nnml-request-set-mark (group actions &optional server)
 913   (nnml-possibly-change-directory group server)
 914   (unless nnml-marks-is-evil
 915     (nnml-open-marks group server)
 916     (dolist (action actions)
 917       (let ((range (nth 0 action))
 918             (what  (nth 1 action))
 919             (marks (nth 2 action)))
 920         (assert (or (eq what 'add) (eq what 'del)) nil
 921                 "Unknown request-set-mark action: %s" what)
 922         (dolist (mark marks)
 923           (setq nnml-marks (gnus-update-alist-soft
 924                             mark
 925                             (funcall (if (eq what 'add) 'gnus-range-add
 926                                        'gnus-remove-from-range)
 927                                      (cdr (assoc mark nnml-marks)) range)
 928                             nnml-marks)))))
 929     (nnml-save-marks group server))
 930   nil)
 931
 932 (deffoo nnml-request-update-info (group info &optional server)
 933   (nnml-possibly-change-directory group server)
 934   (when (and (not nnml-marks-is-evil) (nnml-marks-changed-p group))
 935     (nnheader-message 8 "Updating marks for %s..." group)
 936     (nnml-open-marks group server)
 937     ;; Update info using `nnml-marks'.
 938     (mapc (lambda (pred)
 939             (unless (memq (cdr pred) gnus-article-unpropagated-mark-lists)
 940               (gnus-info-set-marks
 941                info
 942                (gnus-update-alist-soft
 943                 (cdr pred)
 944                 (cdr (assq (cdr pred) nnml-marks))
 945                 (gnus-info-marks info))
 946                t)))
 947           gnus-article-mark-lists)
 948     (let ((seen (cdr (assq 'read nnml-marks))))
 949       (gnus-info-set-read info
 950                           (if (and (integerp (car seen))
 951                                    (null (cdr seen)))
 952                               (list (cons (car seen) (car seen)))
 953                             seen)))
 954     (nnheader-message 8 "Updating marks for %s...done" group))
 955   info)
 956
 957 (defun nnml-marks-changed-p (group)
 958   (let ((file (expand-file-name nnml-marks-file-name
 959                                 (nnmail-group-pathname group nnml-directory))))
 960     (if (null (gnus-gethash file nnml-marks-modtime))
 961         t ;; never looked at marks file, assume it has changed
 962       (not (equal (gnus-gethash file nnml-marks-modtime)
 963                   (nth 5 (file-attributes file)))))))
 964
 965 (defun nnml-save-marks (group server)
 966   (let ((file-name-coding-system nnmail-pathname-coding-system)
 967         (file (expand-file-name nnml-marks-file-name
 968                                 (nnmail-group-pathname group nnml-directory))))
 969     (condition-case err
 970         (progn
 971           (nnml-possibly-create-directory group)
 972           (with-temp-file file
 973             (erase-buffer)
 974             (gnus-prin1 nnml-marks)
 975             (insert "\n"))
 976           (gnus-sethash file
 977                         (nth 5 (file-attributes file))
 978                         nnml-marks-modtime))
 979       (error (or (gnus-yes-or-no-p
 980                   (format "Could not write to %s (%s).  Continue? " file err))
 981                  (error "Cannot write to %s (%s)" file err))))))
 982
 983 (defun nnml-open-marks (group server)
 984   (let ((file (expand-file-name
 985                nnml-marks-file-name
 986                (nnmail-group-pathname group nnml-directory))))
 987     (if (file-exists-p file)
 988         (condition-case err
 989             (with-temp-buffer
 990               (gnus-sethash file (nth 5 (file-attributes file))
 991                             nnml-marks-modtime)
 992               (nnheader-insert-file-contents file)
 993               (setq nnml-marks (read (current-buffer)))
 994               (dolist (el gnus-article-unpropagated-mark-lists)
 995                 (setq nnml-marks (gnus-remassoc el nnml-marks))))
 996           (error (or (gnus-yes-or-no-p
 997                       (format "Error reading nnml marks file %s (%s).  Continuing will use marks from .newsrc.eld.  Continue? " file err))
 998                      (error "Cannot read nnml marks file %s (%s)" file err))))
 999       ;; User didn't have a .marks file.  Probably first time
1000       ;; user of the .marks stuff.  Bootstrap it from .newsrc.eld.
1001       (let ((info (gnus-get-info
1002                    (gnus-group-prefixed-name
1003                     group
1004                     (gnus-server-to-method (format "nnml:%s" server))))))
1005         (nnheader-message 7 "Bootstrapping marks for %s..." group)
1006         (setq nnml-marks (gnus-info-marks info))
1007         (push (cons 'read (gnus-info-read info)) nnml-marks)
1008         (dolist (el gnus-article-unpropagated-mark-lists)
1009           (setq nnml-marks (gnus-remassoc el nnml-marks)))
1010         (nnml-save-marks group server)
1011         (nnheader-message 7 "Bootstrapping marks for %s...done" group)))))
1012
1013 (provide 'nnml)
1014
1015 ;;; arch-tag: 52c97dc3-9735-45de-b439-9e4d23b52004
1016 ;;; nnml.el ends here