;;; nnml.el --- mail spool access for Gnus
-;; Copyright (C) 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
+;; 2004, 2005 Free Software Foundation, Inc.
-;; Author: Lars Ingebrigtsen <larsi@ifi.uio.no>
-;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
-;; Keywords: news
+;; Authors: Didier Verna <didier@xemacs.org> (adding compaction)
+;; Simon Josefsson <simon@josefsson.org> (adding MARKS)
+;; Lars Magne Ingebrigtsen <larsi@gnus.org>
+;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
+;; Keywords: news, mail
;; This file is part of GNU Emacs.
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
+;; For an overview of what the interface functions do, please see the
+;; Gnus sources.
;;; Code:
+(require 'gnus)
(require 'nnheader)
-(require 'rmail)
(require 'nnmail)
+(require 'nnoo)
+(eval-when-compile (require 'cl))
-(defvar nnml-directory "~/Mail/"
- "*Mail directory.")
+(eval-and-compile
+ (autoload 'gnus-article-unpropagatable-p "gnus-sum")
+ (autoload 'gnus-backlog-remove-article "gnus-bcklg"))
-(defvar nnml-active-file (concat nnml-directory "active")
- "*Mail active file.")
+(nnoo-declare nnml)
-(defvar nnml-newsgroups-file (concat nnml-directory "newsgroups")
- "*Mail newsgroups description file.")
+(defvoo nnml-directory message-directory
+ "Spool directory for the nnml mail backend.")
-(defvar nnml-nov-is-evil nil
- "If non-nil, Gnus will never generate and use nov databases for mail groups.
+(defvoo nnml-active-file
+ (expand-file-name "active" nnml-directory)
+ "Mail active file.")
+
+(defvoo nnml-newsgroups-file
+ (expand-file-name "newsgroups" nnml-directory)
+ "Mail newsgroups description file.")
+
+(defvoo nnml-get-new-mail t
+ "If non-nil, nnml will check the incoming mail file and split the mail.")
+
+(defvoo nnml-nov-is-evil nil
+ "If non-nil, Gnus will never generate and use nov databases for mail spools.
Using nov databases will speed up header fetching considerably.
-This variable shouldn't be flipped much. If you have, for some reason,
+This variable shouldn't be flipped much. If you have, for some reason,
set this to t, and want to set it to nil again, you should always run
-the `nnml-generate-nov-databases' command. The function will go
+the `nnml-generate-nov-databases' command. The function will go
through all nnml directories and generate nov databases for them
-all. This may very well take some time.")
+all. This may very well take some time.")
+
+(defvoo nnml-marks-is-evil nil
+ "If non-nil, Gnus will never generate and use marks file for mail spools.
+Using marks files makes it possible to backup and restore mail groups
+separately from `.newsrc.eld'. If you have, for some reason, set this
+to t, and want to set it to nil again, you should always remove the
+corresponding marks file (usually named `.marks' in the nnml group
+directory, but see `nnml-marks-file-name') for the group. Then the
+marks file will be regenerated properly by Gnus.")
+
+(defvoo nnml-prepare-save-mail-hook nil
+ "Hook run narrowed to an article before saving.")
-(defvar nnml-large-newsgroup 50
- "*The number of the articles which indicates a large newsgroup.
-If the number of the articles is greater than the value, verbose
-messages will be shown to indicate the current status.")
+(defvoo nnml-inhibit-expiry nil
+ "If non-nil, inhibit expiry.")
+
+(defvoo nnml-use-compressed-files nil
+ "If non-nil, allow using compressed message files.
+
+If it is a string, use it as the file extension which specifies
+the comression program. You can set it to \".bz2\" if your Emacs
+supports auto-compression using the bzip2 program. A value of t
+is equivalent to \".gz\".")
+
+(defvoo nnml-compressed-files-size-threshold 1000
+ "Default size threshold for compressed message files.
+Message files with bodies larger than that many characters will
+be automatically compressed if `nnml-use-compressed-files' is
+non-nil.")
\f
-(defconst nnml-version "nnml 0.2"
+(defconst nnml-version "nnml 1.0"
"nnml version.")
-(defvar nnml-current-directory nil
- "Current news group directory.")
+(defvoo nnml-nov-file-name ".overview")
+(defvoo nnml-marks-file-name ".marks")
-(defvar nnml-status-string "")
+(defvoo nnml-current-directory nil)
+(defvoo nnml-current-group nil)
+(defvoo nnml-status-string "")
+(defvoo nnml-nov-buffer-alist nil)
+(defvoo nnml-group-alist nil)
+(defvoo nnml-active-timestamp nil)
+(defvoo nnml-article-file-alist nil)
-(defvar nnml-nov-buffer-alist nil)
+(defvoo nnml-generate-active-function 'nnml-generate-active-info)
-\f
+(defvar nnml-nov-buffer-file-name nil)
+
+(defvoo nnml-file-coding-system nnmail-file-coding-system)
+(defvoo nnml-marks nil)
+
+(defvar nnml-marks-modtime (gnus-make-hashtable))
+
+\f
;;; Interface functions.
-(defun nnml-retrieve-headers (sequence &optional newsgroup server)
- "Retrieve the headers for the articles in SEQUENCE.
-Newsgroup must be selected before calling this function."
- (save-excursion
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (let ((file nil)
- (number (length sequence))
- (count 0)
- beg article)
- (nnml-possibly-change-directory newsgroup)
- (if (nnml-retrieve-header-with-nov sequence)
- 'nov
- (while sequence
- (setq article (car sequence))
- (setq file
- (concat nnml-current-directory (prin1-to-string article)))
- (if (and (file-exists-p file)
- (not (file-directory-p file)))
- (progn
+(nnoo-define-basics nnml)
+
+(deffoo nnml-retrieve-headers (sequence &optional group server fetch-old)
+ (when (nnml-possibly-change-directory group server)
+ (save-excursion
+ (set-buffer nntp-server-buffer)
+ (erase-buffer)
+ (let* ((file nil)
+ (number (length sequence))
+ (count 0)
+ (file-name-coding-system nnmail-pathname-coding-system)
+ beg article)
+ (if (stringp (car sequence))
+ 'headers
+ (if (nnml-retrieve-headers-with-nov sequence fetch-old)
+ 'nov
+ (while sequence
+ (setq article (car sequence))
+ (setq file (nnml-article-to-file article))
+ (when (and file
+ (file-exists-p file)
+ (not (file-directory-p file)))
(insert (format "221 %d Article retrieved.\n" article))
(setq beg (point))
- (insert-file-contents file)
+ (nnheader-insert-head file)
(goto-char beg)
- (if (search-forward "\n\n" nil t)
+ (if (re-search-forward "\n\r?\n" nil t)
(forward-char -1)
(goto-char (point-max))
(insert "\n\n"))
(insert ".\n")
- (delete-region (point) (point-max))))
- (setq sequence (cdr sequence))
- (setq count (1+ count))
- (and (numberp nnml-large-newsgroup)
- (> number nnml-large-newsgroup)
- (zerop (% count 20))
- (message "NNML: Receiving headers... %d%%"
- (/ (* count 100) number))))
-
- (and (numberp nnml-large-newsgroup)
- (> number nnml-large-newsgroup)
- (message "NNML: Receiving headers... done"))
-
- ;; Fold continuation lines.
- (goto-char 1)
- (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
- (replace-match " " t t))
- 'headers))))
-
-(defun nnml-open-server (host &optional service)
- "Open news server on HOST.
-If HOST is nil, use value of environment variable `NNTPSERVER'.
-If optional argument SERVICE is non-nil, open by the service name."
- (let ((host (or host (getenv "NNTPSERVER"))))
- (setq nnml-status-string "")
- (nnmail-open-server-internal host service)))
-
-(defun nnml-close-server (&optional server)
- "Close news server."
- (nnml-close-server-internal))
-
-(fset 'nnml-request-quit (symbol-function 'nnml-close-server))
-
-(defun nnml-server-opened (&optional server)
- "Return server process status, T or NIL.
-If the stream is opened, return T, otherwise return NIL."
- (and nntp-server-buffer
- (get-buffer nntp-server-buffer)))
-
-(defun nnml-status-message ()
- "Return server status response as string."
- nnml-status-string)
-
-(defun nnml-request-article (id &optional newsgroup server buffer)
- "Select article by message ID (or number)."
- (nnml-possibly-change-directory newsgroup)
- (let ((file (if (stringp id)
- nil
- (concat nnml-current-directory (prin1-to-string id))))
- (nntp-server-buffer (or buffer nntp-server-buffer)))
- (if (and (stringp file)
- (file-exists-p file)
- (not (file-directory-p file)))
- (save-excursion
- (nnml-find-file file)))))
-
-(defun nnml-request-group (group &optional server dont-check)
- "Select news GROUP."
- (if (not dont-check)
- (nnml-get-new-mail))
- (let ((pathname (nnml-article-pathname group))
- dir)
- (if (file-directory-p pathname)
- (progn
- (setq nnml-current-directory pathname)
- (if (not dont-check)
- (progn
- (setq dir
- (sort
- (mapcar
- (function
- (lambda (name)
- (string-to-int name)))
- (directory-files pathname nil "^[0-9]+$" t))
- '<))
- (save-excursion
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (if dir
- (insert (format "211 %d %d %d %s\n" (length dir)
- (car dir)
- (progn (while (cdr dir)
- (setq dir (cdr dir)))
- (car dir))
- group))
- (insert (format "211 0 1 0 %s\n" group))))))
- t))))
-
-(defun nnml-request-list (&optional server)
- "List active newsgoups."
+ (delete-region (point) (point-max)))
+ (setq sequence (cdr sequence))
+ (setq count (1+ count))
+ (and (numberp nnmail-large-newsgroup)
+ (> number nnmail-large-newsgroup)
+ (zerop (% count 20))
+ (nnheader-message 6 "nnml: Receiving headers... %d%%"
+ (/ (* count 100) number))))
+
+ (and (numberp nnmail-large-newsgroup)
+ (> number nnmail-large-newsgroup)
+ (nnheader-message 6 "nnml: Receiving headers...done"))
+
+ (nnheader-fold-continuation-lines)
+ 'headers))))))
+
+(deffoo nnml-open-server (server &optional defs)
+ (nnoo-change-server 'nnml server defs)
+ (when (not (file-exists-p nnml-directory))
+ (ignore-errors (make-directory nnml-directory t)))
+ (cond
+ ((not (file-exists-p nnml-directory))
+ (nnml-close-server)
+ (nnheader-report 'nnml "Couldn't create directory: %s" nnml-directory))
+ ((not (file-directory-p (file-truename nnml-directory)))
+ (nnml-close-server)
+ (nnheader-report 'nnml "Not a directory: %s" nnml-directory))
+ (t
+ (nnheader-report 'nnml "Opened server %s using directory %s"
+ server nnml-directory)
+ t)))
+
+(deffoo nnml-request-regenerate (server)
+ (nnml-possibly-change-directory nil server)
+ (nnml-generate-nov-databases server)
+ t)
+
+(deffoo nnml-request-article (id &optional group server buffer)
+ (nnml-possibly-change-directory group server)
+ (let* ((nntp-server-buffer (or buffer nntp-server-buffer))
+ (file-name-coding-system nnmail-pathname-coding-system)
+ path gpath group-num)
+ (if (stringp id)
+ (when (and (setq group-num (nnml-find-group-number id))
+ (cdr
+ (assq (cdr group-num)
+ (nnheader-article-to-file-alist
+ (setq gpath
+ (nnmail-group-pathname
+ (car group-num)
+ nnml-directory))))))
+ (setq path (concat gpath (int-to-string (cdr group-num)))))
+ (setq path (nnml-article-to-file id)))
+ (cond
+ ((not path)
+ (nnheader-report 'nnml "No such article: %s" id))
+ ((not (file-exists-p path))
+ (nnheader-report 'nnml "No such file: %s" path))
+ ((file-directory-p path)
+ (nnheader-report 'nnml "File is a directory: %s" path))
+ ((not (save-excursion (let ((nnmail-file-coding-system
+ nnml-file-coding-system))
+ (nnmail-find-file path))))
+ (nnheader-report 'nnml "Couldn't read file: %s" path))
+ (t
+ (nnheader-report 'nnml "Article %s retrieved" id)
+ ;; We return the article number.
+ (cons (if group-num (car group-num) group)
+ (string-to-number (file-name-nondirectory path)))))))
+
+(deffoo nnml-request-group (group &optional server dont-check)
+ (let ((file-name-coding-system nnmail-pathname-coding-system))
+ (cond
+ ((not (nnml-possibly-change-directory group server))
+ (nnheader-report 'nnml "Invalid group (no such directory)"))
+ ((not (file-exists-p nnml-current-directory))
+ (nnheader-report 'nnml "Directory %s does not exist"
+ nnml-current-directory))
+ ((not (file-directory-p nnml-current-directory))
+ (nnheader-report 'nnml "%s is not a directory" nnml-current-directory))
+ (dont-check
+ (nnheader-report 'nnml "Group %s selected" group)
+ t)
+ (t
+ (nnheader-re-read-dir nnml-current-directory)
+ (nnmail-activate 'nnml)
+ (let ((active (nth 1 (assoc group nnml-group-alist))))
+ (if (not active)
+ (nnheader-report 'nnml "No such group: %s" group)
+ (nnheader-report 'nnml "Selected group %s" group)
+ (nnheader-insert "211 %d %d %d %s\n"
+ (max (1+ (- (cdr active) (car active))) 0)
+ (car active) (cdr active) group)))))))
+
+(deffoo nnml-request-scan (&optional group server)
+ (setq nnml-article-file-alist nil)
+ (nnml-possibly-change-directory group server)
+ (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
+
+(deffoo nnml-close-group (group &optional server)
+ (setq nnml-article-file-alist nil)
+ t)
+
+(deffoo nnml-request-create-group (group &optional server args)
+ (nnml-possibly-change-directory nil server)
+ (nnmail-activate 'nnml)
+ (cond
+ ((assoc group nnml-group-alist)
+ t)
+ ((and (file-exists-p (nnmail-group-pathname group nnml-directory))
+ (not (file-directory-p (nnmail-group-pathname group nnml-directory))))
+ (nnheader-report 'nnml "%s is a file"
+ (nnmail-group-pathname group nnml-directory)))
+ (t
+ (let (active)
+ (push (list group (setq active (cons 1 0)))
+ nnml-group-alist)
+ (nnml-possibly-create-directory group)
+ (nnml-possibly-change-directory group server)
+ (let ((articles (nnml-directory-articles nnml-current-directory)))
+ (when articles
+ (setcar active (apply 'min articles))
+ (setcdr active (apply 'max articles))))
+ (nnmail-save-active nnml-group-alist nnml-active-file)
+ t))))
+
+(deffoo nnml-request-list (&optional server)
(save-excursion
- (nnml-find-file nnml-active-file)))
+ (let ((nnmail-file-coding-system nnmail-active-file-coding-system)
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (nnmail-find-file nnml-active-file))
+ (setq nnml-group-alist (nnmail-get-active))
+ t))
+
+(deffoo nnml-request-newgroups (date &optional server)
+ (nnml-request-list server))
-(defun nnml-request-list-newsgroups (&optional server)
- "List newsgroups (defined in NNTP2)."
+(deffoo nnml-request-list-newsgroups (&optional server)
(save-excursion
- (nnml-find-file nnml-newsgroups-file)))
-
-(defun nnml-request-post (&optional server)
- "Post a new news in current buffer."
- (mail-send-and-exit nil))
-
-(fset 'nnml-request-post-buffer 'nnmail-request-post-buffer)
-
-(defun nnml-request-expire-articles (articles newsgroup &optional server)
- "Expire all articles in the ARTICLES list in group GROUP.
-The list of unexpired articles will be returned (ie. all articles that
-were too fresh to be expired)."
- (nnml-possibly-change-directory newsgroup)
- (let* ((days (or (and nnmail-expiry-wait-function
- (funcall nnmail-expiry-wait-function newsgroup))
- nnmail-expiry-wait))
- (cur-time (current-time))
- (day-sec (* 24 60 60 days))
- (day-time (list nil nil))
- mod-time article rest)
- (setcar day-time (/ day-sec 65536))
- (setcar (cdr day-time) (- day-sec (* (car day-time) 65536)))
- (if (< (car (cdr cur-time)) (car (cdr day-time)))
- (progn
- (setcar day-time (+ 1 (- (car cur-time) (car day-time))))
- (setcar (cdr day-time) (- (+ 65536 (car (cdr cur-time)))
- (car (cdr day-time)))))
- (setcar day-time (- (car cur-time) (car day-time)))
- (setcar (cdr day-time) (- (car (cdr cur-time)) (car (cdr day-time)))))
- (while articles
- (setq article (concat nnml-current-directory (int-to-string
- (car articles))))
- (if (setq mod-time (nth 5 (file-attributes article)))
- (if (or (< (car mod-time) (car day-time))
- (and (= (car mod-time) (car day-time))
- (< (car (cdr mod-time)) (car (cdr day-time)))))
- (progn
- (message "Deleting %s..." article)
- (condition-case ()
- (delete-file article)
- (file-error nil))
- (nnml-nov-delete-article newsgroup (car articles)))
- (setq rest (cons (car articles) rest))))
- (setq articles (cdr articles)))
+ (nnmail-find-file nnml-newsgroups-file)))
+
+(deffoo nnml-request-expire-articles (articles group &optional server force)
+ (nnml-possibly-change-directory group server)
+ (let ((active-articles
+ (nnml-directory-articles nnml-current-directory))
+ (is-old t)
+ article rest mod-time number)
+ (nnmail-activate 'nnml)
+
+ (setq active-articles (sort active-articles '<))
+ ;; Articles not listed in active-articles are already gone,
+ ;; so don't try to expire them.
+ (setq articles (gnus-sorted-intersection articles active-articles))
+
+ (while (and articles is-old)
+ (if (and (setq article (nnml-article-to-file
+ (setq number (pop articles))))
+ (setq mod-time (nth 5 (file-attributes article)))
+ (nnml-deletable-article-p group number)
+ (setq is-old (nnmail-expired-article-p group mod-time force
+ nnml-inhibit-expiry)))
+ (progn
+ ;; Allow a special target group.
+ (unless (eq nnmail-expiry-target 'delete)
+ (with-temp-buffer
+ (nnml-request-article number group server (current-buffer))
+ (let (nnml-current-directory
+ nnml-current-group
+ nnml-article-file-alist)
+ (nnmail-expiry-target-group nnmail-expiry-target group)))
+ ;; Maybe directory is changed during nnmail-expiry-target-group.
+ (nnml-possibly-change-directory group server))
+ (nnheader-message 5 "Deleting article %s in %s"
+ number group)
+ (condition-case ()
+ (funcall nnmail-delete-file-function article)
+ (file-error
+ (push number rest)))
+ (setq active-articles (delq number active-articles))
+ (nnml-nov-delete-article group number))
+ (push number rest)))
+ (let ((active (nth 1 (assoc group nnml-group-alist))))
+ (when active
+ (setcar active (or (and active-articles
+ (apply 'min active-articles))
+ (1+ (cdr active)))))
+ (nnmail-save-active nnml-group-alist nnml-active-file))
(nnml-save-nov)
- rest))
+ (nconc rest articles)))
-(defun nnml-request-move-article (article group server accept-form)
+(deffoo nnml-request-move-article
+ (article group server accept-form &optional last move-is-internal)
(let ((buf (get-buffer-create " *nnml move*"))
result)
- (and
+ (nnml-possibly-change-directory group server)
+ (nnml-update-file-alist)
+ (and
+ (nnml-deletable-article-p group article)
(nnml-request-article article group server)
- (save-excursion
- (set-buffer buf)
- (insert-buffer-substring nntp-server-buffer)
- (setq result (eval accept-form))
- (kill-buffer (current-buffer))
- result)
- (and (condition-case ()
- (delete-file (concat nnml-current-directory
- (int-to-string article)))
- (file-error nil))
- (nnml-nov-delete-article group article)
- (nnml-save-nov)))
+ (let (nnml-current-directory
+ nnml-current-group
+ nnml-article-file-alist)
+ (save-excursion
+ (set-buffer buf)
+ (insert-buffer-substring nntp-server-buffer)
+ (setq result (eval accept-form))
+ (kill-buffer (current-buffer))
+ result))
+ (progn
+ (nnml-possibly-change-directory group server)
+ (condition-case ()
+ (funcall nnmail-delete-file-function
+ (nnml-article-to-file article))
+ (file-error nil))
+ (nnml-nov-delete-article group article)
+ (when last
+ (nnml-save-nov)
+ (nnmail-save-active nnml-group-alist nnml-active-file))))
result))
-(defun nnml-request-accept-article (group)
+(deffoo nnml-request-accept-article (group &optional server last)
+ (nnml-possibly-change-directory group server)
+ (nnmail-check-syntax)
(let (result)
+ (when nnmail-cache-accepted-message-ids
+ (nnmail-cache-insert (nnmail-fetch-field "message-id")
+ group
+ (nnmail-fetch-field "subject")
+ (nnmail-fetch-field "from")))
(if (stringp group)
- (and
- (nnml-get-active)
- ;; We trick the choosing function into believing that only one
- ;; group is availiable.
- (let ((nnmail-split-methods '(group "")))
- (setq result
- (cons group (nnml-choose-mail (point-min) (point-max)))))
- (nnml-save-active))
+ (and
+ (nnmail-activate 'nnml)
+ (setq result (car (nnml-save-mail
+ (list (cons group (nnml-active-number group))))))
+ (progn
+ (nnmail-save-active nnml-group-alist nnml-active-file)
+ (and last (nnml-save-nov))))
(and
- (nnml-get-active)
- (setq result (nnml-choose-mail (point-min) (point-max)))
- (nnml-save-active)))
+ (nnmail-activate 'nnml)
+ (if (and (not (setq result (nnmail-article-group 'nnml-active-number)))
+ (yes-or-no-p "Moved to `junk' group; delete article? "))
+ (setq result 'junk)
+ (setq result (car (nnml-save-mail result))))
+ (when last
+ (nnmail-save-active nnml-group-alist nnml-active-file)
+ (when nnmail-cache-accepted-message-ids
+ (nnmail-cache-close))
+ (nnml-save-nov))))
result))
-\f
-;;; Low-Level Interface
+(deffoo nnml-request-post (&optional server)
+ (nnmail-do-request-post 'nnml-request-accept-article server))
-(defun nnml-retrieve-header-with-nov (articles)
- (if nnml-nov-is-evil
- nil
- (let ((first (car articles))
- (last (progn (while (cdr articles) (setq articles (cdr articles)))
- (car articles)))
- (nov (concat nnml-current-directory ".nov")))
- (if (file-exists-p nov)
- (save-excursion
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (insert-file-contents nov)
- (goto-char 1)
- (while (and (not (eobp)) (< first (read (current-buffer))))
- (forward-line 1))
- (beginning-of-line)
- (if (not (eobp)) (delete-region 1 (point)))
- (while (and (not (eobp)) (>= last (read (current-buffer))))
- (forward-line 1))
- (beginning-of-line)
- (if (not (eobp)) (delete-region (point) (point-max)))
- t)))))
-
-(defun nnml-open-server-internal (host &optional service)
- "Open connection to news server on HOST by SERVICE."
+(deffoo nnml-request-replace-article (article group buffer)
+ (nnml-possibly-change-directory group)
(save-excursion
- (if (not (string-equal host (system-name)))
- (error "nnml: cannot talk to %s." host))
- ;; Initialize communication buffer.
- (setq nntp-server-buffer (get-buffer-create " *nntpd*"))
- (set-buffer nntp-server-buffer)
- (buffer-disable-undo (current-buffer))
- (erase-buffer)
- (kill-all-local-variables)
- (setq case-fold-search t) ;Should ignore case.
- t))
-
-(defun nnml-close-server-internal ()
- "Close connection to news server."
- nil)
-
-(defun nnml-find-file (file)
- "Insert FILE in server buffer safely."
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (condition-case ()
- (progn (insert-file-contents file) t)
- (file-error nil)))
-
-(defun nnml-possibly-change-directory (newsgroup)
- (if newsgroup
- (let ((pathname (nnml-article-pathname newsgroup)))
- (if (file-directory-p pathname)
- (setq nnml-current-directory pathname)
- (error "No such newsgroup: %s" newsgroup)))))
-
-(defun nnml-article-pathname (group)
- "Make pathname for GROUP."
- (concat (file-name-as-directory (expand-file-name nnml-directory))
- (nnml-replace-chars-in-string group ?. ?/) "/"))
-
-(defun nnml-replace-chars-in-string (string from to)
- "Replace characters in STRING from FROM to TO."
- (let ((string (substring string 0)) ;Copy string.
- (len (length string))
- (idx 0))
- ;; Replace all occurrences of FROM with TO.
- (while (< idx len)
- (if (= (aref string idx) from)
- (aset string idx to))
- (setq idx (1+ idx)))
- string))
-
-(defun nnml-create-directories ()
- (let ((methods nnmail-split-methods)
- dir dirs)
- (while methods
- (setq dir (nnml-article-pathname (car (car methods))))
- (while (not (file-directory-p dir))
- (setq dirs (cons dir dirs))
- (setq dir (file-name-directory (directory-file-name dir))))
- (while dirs
- (if (make-directory (directory-file-name (car dirs)))
- (error "Could not create directory %s" (car dirs)))
- (message "Creating mail directory %s" (car dirs))
- (setq dirs (cdr dirs)))
- (setq methods (cdr methods)))))
-
-;; Most of this function was taken from rmail.el
-(defun nnml-move-inbox ()
- (let ((inbox (expand-file-name nnmail-spool-file))
- tofile errors)
- (setq tofile (make-temp-name
- (expand-file-name (concat nnml-directory "Incoming"))))
- (unwind-protect
+ (set-buffer buffer)
+ (nnml-possibly-create-directory group)
+ (let ((chars (nnmail-insert-lines))
+ (art (concat (int-to-string article) "\t"))
+ headers)
+ (when (ignore-errors
+ (nnmail-write-region
+ (point-min) (point-max)
+ (or (nnml-article-to-file article)
+ (expand-file-name (int-to-string article)
+ nnml-current-directory))
+ nil (if (nnheader-be-verbose 5) nil 'nomesg))
+ t)
+ (setq headers (nnml-parse-head chars article))
+ ;; Replace the NOV line in the NOV file.
(save-excursion
- (setq errors (generate-new-buffer " *nnml loss*"))
- (buffer-disable-undo errors)
- (call-process
- (expand-file-name "movemail" exec-directory)
- nil errors nil inbox tofile)
- (if (not (buffer-modified-p errors))
- ;; No output => movemail won
- nil
- (set-buffer errors)
- (subst-char-in-region (point-min) (point-max) ?\n ?\ )
- (goto-char (point-max))
- (skip-chars-backward " \t")
- (delete-region (point) (point-max))
- (goto-char (point-min))
- (if (looking-at "movemail: ")
- (delete-region (point-min) (match-end 0)))
- (error (concat "movemail: "
- (buffer-substring (point-min)
- (point-max)))))))
- (if (buffer-name errors)
- (kill-buffer errors))
- tofile))
-
-(defvar nnml-newsgroups nil)
-
-(defun nnml-get-active ()
- (let ((methods nnmail-split-methods))
- (setq nnml-newsgroups nil)
- (if (nnml-request-list)
- (save-excursion
- (set-buffer (get-buffer-create " *nntpd*"))
- (goto-char 1)
- (while (re-search-forward
- "^\\([^ \t]+\\)[ \t]+\\([0-9]+\\)[ \t]+\\([0-9]+\\)" nil t)
- (setq nnml-newsgroups
- (cons (list (buffer-substring (match-beginning 1)
- (match-end 1))
- (cons (string-to-int
- (buffer-substring (match-beginning 3)
- (match-end 3)))
- (string-to-int
- (buffer-substring (match-beginning 2)
- (match-end 2)))))
- nnml-newsgroups)))))
- (while methods
- (if (not (assoc (car (car methods)) nnml-newsgroups))
- (setq nnml-newsgroups
- (cons (list (car (car methods)) (cons 1 0))
- nnml-newsgroups)))
- (setq methods (cdr methods)))
- t))
+ (set-buffer (nnml-open-nov group))
+ (goto-char (point-min))
+ (if (or (looking-at art)
+ (search-forward (concat "\n" art) nil t))
+ ;; Delete the old NOV line.
+ (gnus-delete-line)
+ ;; The line isn't here, so we have to find out where
+ ;; we should insert it. (This situation should never
+ ;; occur, but one likes to make sure...)
+ (while (and (looking-at "[0-9]+\t")
+ (< (string-to-number
+ (buffer-substring
+ (match-beginning 0) (match-end 0)))
+ article)
+ (zerop (forward-line 1)))))
+ (beginning-of-line)
+ (nnheader-insert-nov headers)
+ (nnml-save-nov)
+ t)))))
+
+(deffoo nnml-request-delete-group (group &optional force server)
+ (nnml-possibly-change-directory group server)
+ (when force
+ ;; Delete all articles in GROUP.
+ (let ((articles
+ (directory-files
+ nnml-current-directory t
+ (concat nnheader-numerical-short-files
+ "\\|" (regexp-quote nnml-nov-file-name) "$"
+ "\\|" (regexp-quote nnml-marks-file-name) "$"))))
+ (dolist (article articles)
+ (when (file-writable-p article)
+ (nnheader-message 5 "Deleting article %s in %s..." article group)
+ (funcall nnmail-delete-file-function article))))
+ ;; Try to delete the directory itself.
+ (ignore-errors (delete-directory nnml-current-directory)))
+ ;; Remove the group from all structures.
+ (setq nnml-group-alist
+ (delq (assoc group nnml-group-alist) nnml-group-alist)
+ nnml-current-group nil
+ nnml-current-directory nil)
+ ;; Save the active file.
+ (nnmail-save-active nnml-group-alist nnml-active-file)
+ t)
+
+(deffoo nnml-request-rename-group (group new-name &optional server)
+ (nnml-possibly-change-directory group server)
+ (let ((new-dir (nnmail-group-pathname new-name nnml-directory))
+ (old-dir (nnmail-group-pathname group nnml-directory)))
+ (when (ignore-errors
+ (make-directory new-dir t)
+ t)
+ ;; We move the articles file by file instead of renaming
+ ;; the directory -- there may be subgroups in this group.
+ ;; One might be more clever, I guess.
+ (dolist (file (nnheader-article-to-file-alist old-dir))
+ (rename-file
+ (concat old-dir (cdr file))
+ (concat new-dir (cdr file))))
+ ;; Move .overview file.
+ (let ((overview (concat old-dir nnml-nov-file-name)))
+ (when (file-exists-p overview)
+ (rename-file overview (concat new-dir nnml-nov-file-name))))
+ ;; Move .marks file.
+ (let ((marks (concat old-dir nnml-marks-file-name)))
+ (when (file-exists-p marks)
+ (rename-file marks (concat new-dir nnml-marks-file-name))))
+ (when (<= (length (directory-files old-dir)) 2)
+ (ignore-errors (delete-directory old-dir)))
+ ;; That went ok, so we change the internal structures.
+ (let ((entry (assoc group nnml-group-alist)))
+ (when entry
+ (setcar entry new-name))
+ (setq nnml-current-directory nil
+ nnml-current-group nil)
+ ;; Save the new group alist.
+ (nnmail-save-active nnml-group-alist nnml-active-file)
+ t))))
+
+(deffoo nnml-set-status (article name value &optional group server)
+ (nnml-possibly-change-directory group server)
+ (let ((file (nnml-article-to-file article)))
+ (cond
+ ((not (file-exists-p file))
+ (nnheader-report 'nnml "File %s does not exist" file))
+ (t
+ (with-temp-file file
+ (nnheader-insert-file-contents file)
+ (nnmail-replace-status name value))
+ t))))
-(defun nnml-save-active ()
- (let ((groups nnml-newsgroups)
- group)
- (save-excursion
- (set-buffer (get-buffer-create " *nnml*"))
- (buffer-disable-undo (current-buffer))
- (erase-buffer)
- (while groups
- (setq group (car groups))
- (insert (format "%s %d %d y\n" (car group) (cdr (car (cdr group)) )
- (car (car (cdr group)))))
- (setq groups (cdr groups)))
- (write-region 1 (point-max) (expand-file-name nnml-active-file) nil
- 'nomesg)
- (kill-buffer (current-buffer)))))
-
-(defun nnml-split-incoming (incoming)
- "Go through the entire INCOMING file and pick out each individual mail."
- (let (start)
- (nnml-get-active)
- (save-excursion
- (set-buffer (get-buffer-create "*(ding) Gnus mail*"))
- (buffer-disable-undo (current-buffer))
- (erase-buffer)
- (insert-file-contents incoming)
- (goto-char 1)
- ;; Go to the beginning of the first mail...
- (if (and (re-search-forward (concat "^" rmail-unix-mail-delimiter) nil t)
- (goto-char (match-beginning 0)))
- ;; and then carry on until the bitter end.
- (while (not (eobp))
- (setq start (point))
+\f
+;;; Internal functions.
+
+(defun nnml-article-to-file (article)
+ (nnml-update-file-alist)
+ (let (file)
+ (if (setq file
+ (if nnml-use-compressed-files
+ (cdr (assq article nnml-article-file-alist))
+ (number-to-string article)))
+ (expand-file-name file nnml-current-directory)
+ (when (not nnheader-directory-files-is-safe)
+ ;; Just to make sure nothing went wrong when reading over NFS --
+ ;; check once more.
+ (when (file-exists-p
+ (setq file (expand-file-name (number-to-string article)
+ nnml-current-directory)))
+ (nnml-update-file-alist t)
+ file)))))
+
+(defun nnml-deletable-article-p (group article)
+ "Say whether ARTICLE in GROUP can be deleted."
+ (let (path)
+ (when (setq path (nnml-article-to-file article))
+ (when (file-writable-p path)
+ (or (not nnmail-keep-last-article)
+ (not (eq (cdr (nth 1 (assoc group nnml-group-alist)))
+ article)))))))
+
+;; Find an article number in the current group given the Message-ID.
+(defun nnml-find-group-number (id)
+ (save-excursion
+ (set-buffer (get-buffer-create " *nnml id*"))
+ (let ((alist nnml-group-alist)
+ number)
+ ;; We want to look through all .overview files, but we want to
+ ;; start with the one in the current directory. It seems most
+ ;; likely that the article we are looking for is in that group.
+ (if (setq number (nnml-find-id nnml-current-group id))
+ (cons nnml-current-group number)
+ ;; It wasn't there, so we look through the other groups as well.
+ (while (and (not number)
+ alist)
+ (or (string= (caar alist) nnml-current-group)
+ (setq number (nnml-find-id (caar alist) id)))
+ (or number
+ (setq alist (cdr alist))))
+ (and number
+ (cons (caar alist) number))))))
+
+(defun nnml-find-id (group id)
+ (erase-buffer)
+ (let ((nov (expand-file-name nnml-nov-file-name
+ (nnmail-group-pathname group nnml-directory)))
+ number found)
+ (when (file-exists-p nov)
+ (nnheader-insert-file-contents nov)
+ (while (and (not found)
+ (search-forward id nil t)) ; We find the ID.
+ ;; And the id is in the fourth field.
+ (if (not (and (search-backward "\t" nil t 4)
+ (not (search-backward "\t" (point-at-bol) t))))
(forward-line 1)
- (if (re-search-forward
- (concat "^" rmail-unix-mail-delimiter) nil t)
- (goto-char (match-beginning 0))
- (goto-char (point-max)))
- (nnml-choose-mail start (point))))
- (kill-buffer (current-buffer)))))
-
-;; Mail crossposts syggested by Brian Edmonds <edmonds@cs.ubc.ca>.
-(defun nnml-article-group (beg end)
- (let ((methods nnmail-split-methods)
- found group-art)
- (save-excursion
- (save-restriction
- (narrow-to-region beg end)
- (while methods
- (goto-char (point-max))
- (if (or (cdr methods)
- (not (string= "" (nth 1 (car methods)))))
- (if (re-search-backward (car (cdr (car methods))) nil t)
- (setq group-art
- (cons
- (cons (car (car methods))
- (nnml-active-number (car (car methods))))
- group-art)))
- (or group-art
- (setq group-art
- (list (cons (car (car methods))
- (nnml-active-number (car (car methods))))))))
- (setq methods (cdr methods)))
- group-art))))
-
-(defun nnml-choose-mail (beg end)
- "Find out what mail group the mail between BEG and END belongs in."
- (let ((group-art (nreverse (nnml-article-group beg end)))
- chars nov-line lines)
- (save-excursion
- (save-restriction
- (narrow-to-region beg end)
- ;; First fix headers.
- (goto-char (point-min))
+ (beginning-of-line)
+ (setq found t)
+ ;; We return the article number.
+ (setq number
+ (ignore-errors (read (current-buffer))))))
+ number)))
+
+(defun nnml-retrieve-headers-with-nov (articles &optional fetch-old)
+ (if (or gnus-nov-is-evil nnml-nov-is-evil)
+ nil
+ (let ((nov (expand-file-name nnml-nov-file-name nnml-current-directory)))
+ (when (file-exists-p nov)
(save-excursion
- (save-restriction
- (narrow-to-region (point)
- (progn (search-forward "\n\n" nil t)
- (setq chars (- (point-max) (point)))
- (setq lines (- (count-lines
- (point) (point-max)) 1))
- (1- (point))))
- ;; Insert Lines.
- (if (not (save-excursion (re-search-backward "^Lines:" beg t)))
- (insert (format "Lines: %d\n" lines)))
- ;; Make an Xref header.
- (save-excursion
- (goto-char (point-max))
- (if (re-search-backward "^Xref:" nil t)
- (delete-region (match-beginning 0)
- (progn (forward-line 1) (point)))))
- (insert (format "Xref: %s" (system-name)))
- (let ((ga group-art))
- (while ga
- (insert (format " %s:%d" (car (car ga)) (cdr (car ga))))
- (setq ga (cdr ga))))
- (insert "\n")
- ;; Generate a nov line for this article.
- (setq nov-line (nnml-make-nov-line chars))))
- ;; Then we actually save the article.
- (let ((ga group-art)
- first)
- (while ga
- (nnml-add-nov (car (car ga)) (cdr (car ga)) nov-line)
- (let ((file (concat (nnml-article-pathname
- (car (car ga)))
- (int-to-string (cdr (car ga))))))
- (if first
- ;; It was already saved, so we just make a hard link.
- (add-name-to-file first file t)
- ;; Save the article.
- (write-region (point-min) (point-max) file nil nil)
- (setq first file)))
- (setq ga (cdr ga))))
- group-art))))
+ (set-buffer nntp-server-buffer)
+ (erase-buffer)
+ (nnheader-insert-file-contents nov)
+ (if (and fetch-old
+ (not (numberp fetch-old)))
+ t ; Don't remove anything.
+ (nnheader-nov-delete-outside-range
+ (if fetch-old (max 1 (- (car articles) fetch-old))
+ (car articles))
+ (car (last articles)))
+ t))))))
+
+(defun nnml-possibly-change-directory (group &optional server)
+ (when (and server
+ (not (nnml-server-opened server)))
+ (nnml-open-server server))
+ (if (not group)
+ t
+ (let ((pathname (nnmail-group-pathname group nnml-directory))
+ (file-name-coding-system nnmail-pathname-coding-system))
+ (when (not (equal pathname nnml-current-directory))
+ (setq nnml-current-directory pathname
+ nnml-current-group group
+ nnml-article-file-alist nil))
+ (file-exists-p nnml-current-directory))))
+
+(defun nnml-possibly-create-directory (group)
+ (let ((dir (nnmail-group-pathname group nnml-directory)))
+ (unless (file-exists-p dir)
+ (make-directory (directory-file-name dir) t)
+ (nnheader-message 5 "Creating mail directory %s" dir))))
+
+(defun nnml-save-mail (group-art)
+ "Called narrowed to an article."
+ (let (chars headers extension)
+ (setq chars (nnmail-insert-lines))
+ (setq extension
+ (and nnml-use-compressed-files
+ (> chars nnml-compressed-files-size-threshold)
+ (if (stringp nnml-use-compressed-files)
+ nnml-use-compressed-files
+ ".gz")))
+ (nnmail-insert-xref group-art)
+ (run-hooks 'nnmail-prepare-save-mail-hook)
+ (run-hooks 'nnml-prepare-save-mail-hook)
+ (goto-char (point-min))
+ (while (looking-at "From ")
+ (replace-match "X-From-Line: ")
+ (forward-line 1))
+ ;; We save the article in all the groups it belongs in.
+ (let ((ga group-art)
+ first)
+ (while ga
+ (nnml-possibly-create-directory (caar ga))
+ (let ((file (concat (nnmail-group-pathname
+ (caar ga) nnml-directory)
+ (int-to-string (cdar ga))
+ extension)))
+ (if first
+ ;; It was already saved, so we just make a hard link.
+ (funcall nnmail-crosspost-link-function first file t)
+ ;; Save the article.
+ (nnmail-write-region (point-min) (point-max) file nil
+ (if (nnheader-be-verbose 5) nil 'nomesg))
+ (setq first file)))
+ (setq ga (cdr ga))))
+ ;; Generate a nov line for this article. We generate the nov
+ ;; line after saving, because nov generation destroys the
+ ;; header.
+ (setq headers (nnml-parse-head chars))
+ ;; Output the nov line to all nov databases that should have it.
+ (let ((ga group-art))
+ (while ga
+ (nnml-add-nov (caar ga) (cdar ga) headers)
+ (setq ga (cdr ga))))
+ group-art))
(defun nnml-active-number (group)
"Compute the next article number in GROUP."
- (let ((active (car (cdr (assoc group nnml-newsgroups)))))
+ (let ((active (cadr (assoc group nnml-group-alist))))
+ ;; The group wasn't known to nnml, so we just create an active
+ ;; entry for it.
+ (unless active
+ ;; Perhaps the active file was corrupt? See whether
+ ;; there are any articles in this group.
+ (nnml-possibly-create-directory group)
+ (nnml-possibly-change-directory group)
+ (unless nnml-article-file-alist
+ (setq nnml-article-file-alist
+ (sort
+ (nnml-current-group-article-to-file-alist)
+ 'car-less-than-car)))
+ (setq active
+ (if nnml-article-file-alist
+ (cons (caar nnml-article-file-alist)
+ (caar (last nnml-article-file-alist)))
+ (cons 1 0)))
+ (push (list group active) nnml-group-alist))
(setcdr active (1+ (cdr active)))
- (let (file)
- (while (file-exists-p
- (setq file (concat (nnml-article-pathname group)
- (int-to-string (cdr active)))))
- (setcdr active (1+ (cdr active)))))
+ (while (file-exists-p
+ (expand-file-name (int-to-string (cdr active))
+ (nnmail-group-pathname group nnml-directory)))
+ (setcdr active (1+ (cdr active))))
(cdr active)))
-(defun nnml-get-new-mail ()
- "Read new incoming mail."
- (let (incoming)
- (nnml-create-directories)
- (if (and (file-exists-p nnmail-spool-file)
- (> (nth 7 (file-attributes nnmail-spool-file)) 0))
- (progn
- (message "nnml: Reading incoming mail...")
- (setq incoming (nnml-move-inbox))
- (nnml-split-incoming incoming)
- (nnml-save-active)
- (nnml-save-nov)
-;; (delete-file incoming)
- (message "nnml: Reading incoming mail...done")))))
-
-
-(defun nnml-add-nov (group article line)
+(defun nnml-add-nov (group article headers)
"Add a nov line for the GROUP base."
- (save-excursion
+ (save-excursion
(set-buffer (nnml-open-nov group))
(goto-char (point-max))
- (insert (int-to-string article) line)))
+ (mail-header-set-number headers article)
+ (nnheader-insert-nov headers)))
(defsubst nnml-header-value ()
- (buffer-substring (match-end 0) (save-excursion (end-of-line) (point))))
+ (buffer-substring (match-end 0) (point-at-eol)))
-(defun nnml-make-nov-line (chars)
- "Create a nov from the current headers."
- (let (subject from date id references lines xref in-reply-to char)
- ;; [number subject from date id references chars lines xref]
+(defun nnml-parse-head (chars &optional number)
+ "Parse the head of the current buffer."
+ (save-excursion
+ (save-restriction
+ (unless (zerop (buffer-size))
+ (narrow-to-region
+ (goto-char (point-min))
+ (if (re-search-forward "\n\r?\n" nil t)
+ (1- (point))
+ (point-max))))
+ (let ((headers (nnheader-parse-naked-head)))
+ (mail-header-set-chars headers chars)
+ (mail-header-set-number headers number)
+ headers))))
+
+(defun nnml-get-nov-buffer (group)
+ (let ((buffer (get-buffer-create (format " *nnml overview %s*" group))))
(save-excursion
- (goto-char (point-min))
- (while (re-search-forward "^\\(from\\|subject\\|message-id\\|date\\|lines\\|xref\\|references\\|in-reply-to\\): "
- nil t)
- (beginning-of-line)
- (setq char (downcase (following-char)))
- (cond
- ((eq char ?s)
- (setq subject (nnml-header-value)))
- ((eq char ?f)
- (setq from (nnml-header-value)))
- ((eq char ?x)
- (setq xref (nnml-header-value)))
- ((eq char ?l)
- (setq lines (nnml-header-value)))
- ((eq char ?d)
- (setq date (nnml-header-value)))
- ((eq char ?m)
- (setq id (setq id (nnml-header-value))))
- ((eq char ?r)
- (setq references (nnml-header-value)))
- ((eq char ?i)
- (setq in-reply-to (nnml-header-value))))
- (forward-line 1))
-
- (and (not references)
- in-reply-to
- (string-match "<[^>]+>" in-reply-to)
- (setq references
- (substring in-reply-to (match-beginning 0)
- (match-end 0)))))
- ;; [number subject from date id references chars lines xref]
- (format "\t%s\t%s\t%s\t%s\t%s\t%d\t%s\t%s\n"
- (or subject "(none)")
- (or from "(nobody)") (or date "")
- (or id "") (or references "")
- chars (or lines "0") (or xref ""))))
+ (set-buffer buffer)
+ (set (make-local-variable 'nnml-nov-buffer-file-name)
+ (expand-file-name
+ nnml-nov-file-name
+ (nnmail-group-pathname group nnml-directory)))
+ (erase-buffer)
+ (when (file-exists-p nnml-nov-buffer-file-name)
+ (nnheader-insert-file-contents nnml-nov-buffer-file-name)))
+ buffer))
(defun nnml-open-nov (group)
(or (cdr (assoc group nnml-nov-buffer-alist))
- (let ((buffer (find-file-noselect
- (concat (nnml-article-pathname group) ".nov"))))
- (save-excursion
- (set-buffer buffer)
- (buffer-disable-undo (current-buffer)))
- (setq nnml-nov-buffer-alist (cons (cons group buffer)
- nnml-nov-buffer-alist))
+ (let ((buffer (nnml-get-nov-buffer group)))
+ (push (cons group buffer) nnml-nov-buffer-alist)
buffer)))
(defun nnml-save-nov ()
(save-excursion
(while nnml-nov-buffer-alist
- (if (buffer-name (cdr (car nnml-nov-buffer-alist)))
- (progn
- (set-buffer (cdr (car nnml-nov-buffer-alist)))
- (write-region 1 (point-max) (buffer-file-name) nil 'nomesg)
- (set-buffer-modified-p nil)
- (kill-buffer (current-buffer))))
+ (when (buffer-name (cdar nnml-nov-buffer-alist))
+ (set-buffer (cdar nnml-nov-buffer-alist))
+ (when (buffer-modified-p)
+ (nnmail-write-region (point-min) (point-max)
+ nnml-nov-buffer-file-name nil 'nomesg))
+ (set-buffer-modified-p nil)
+ (kill-buffer (current-buffer)))
(setq nnml-nov-buffer-alist (cdr nnml-nov-buffer-alist)))))
-(defun nnml-generate-nov-databases (dir)
- (interactive (list nnml-directory))
- (let ((dirs (directory-files dir t nil t)))
- (while dirs
- (if (and (not (string-match "/\\.\\.$" (car dirs)))
- (not (string-match "/\\.$" (car dirs)))
- (file-directory-p (car dirs)))
- (nnml-generate-nov-databases (car dirs)))
- (setq dirs (cdr dirs))))
- (let ((files (sort
- (mapcar
- (function
- (lambda (name)
- (string-to-int name)))
- (directory-files dir nil "^[0-9]+$" t))
- (function <)))
- (nov (concat dir "/.nov"))
- (nov-buffer (get-buffer-create "*nov*"))
- nov-line chars)
- (if files
- (save-excursion
- (set-buffer nntp-server-buffer)
- (if (file-exists-p nov)
- (delete-file nov))
- (save-excursion
- (set-buffer nov-buffer)
- (buffer-disable-undo (current-buffer))
- (erase-buffer))
- (while files
- (erase-buffer)
- (insert-file-contents (concat dir "/" (int-to-string (car files))))
- (goto-char 1)
- (narrow-to-region 1 (save-excursion (search-forward "\n\n" nil t)
- (setq chars (- (point-max)
- (point)))
- (point)))
- (setq nov-line (nnml-make-nov-line chars))
+;;;###autoload
+(defun nnml-generate-nov-databases (&optional server)
+ "Generate NOV databases in all nnml directories."
+ (interactive (list (or (nnoo-current-server 'nnml) "")))
+ ;; Read the active file to make sure we don't re-use articles
+ ;; numbers in empty groups.
+ (nnmail-activate 'nnml)
+ (unless (nnml-server-opened server)
+ (nnml-open-server server))
+ (setq nnml-directory (expand-file-name nnml-directory))
+ ;; Recurse down the directories.
+ (nnml-generate-nov-databases-1 nnml-directory nil t)
+ ;; Save the active file.
+ (nnmail-save-active nnml-group-alist nnml-active-file))
+
+(defun nnml-generate-nov-databases-1 (dir &optional seen no-active)
+ "Regenerate the NOV database in DIR."
+ (interactive "DRegenerate NOV in: ")
+ (setq dir (file-name-as-directory dir))
+ ;; Only scan this sub-tree if we haven't been here yet.
+ (unless (member (file-truename dir) seen)
+ (push (file-truename dir) seen)
+ ;; We descend recursively
+ (dolist (dir (directory-files dir t nil t))
+ (when (and (not (string-match "^\\." (file-name-nondirectory dir)))
+ (file-directory-p dir))
+ (nnml-generate-nov-databases-1 dir seen)))
+ ;; Do this directory.
+ (let ((files (sort (nnheader-article-to-file-alist dir)
+ 'car-less-than-car)))
+ (if (not files)
+ (let* ((group (nnheader-file-to-group
+ (directory-file-name dir) nnml-directory))
+ (info (cadr (assoc group nnml-group-alist))))
+ (when info
+ (setcar info (1+ (cdr info)))))
+ (funcall nnml-generate-active-function dir)
+ ;; Generate the nov file.
+ (nnml-generate-nov-file dir files)
+ (unless no-active
+ (nnmail-save-active nnml-group-alist nnml-active-file))))))
+
+(eval-when-compile (defvar files))
+(defun nnml-generate-active-info (dir)
+ ;; Update the active info for this group.
+ (let* ((group (nnheader-file-to-group
+ (directory-file-name dir) nnml-directory))
+ (entry (assoc group nnml-group-alist))
+ (last (or (caadr entry) 0)))
+ (setq nnml-group-alist (delq entry nnml-group-alist))
+ (push (list group
+ (cons (or (caar files) (1+ last))
+ (max last
+ (or (caar (last files))
+ 0))))
+ nnml-group-alist)))
+
+(defun nnml-generate-nov-file (dir files)
+ (let* ((dir (file-name-as-directory dir))
+ (nov (concat dir nnml-nov-file-name))
+ (nov-buffer (get-buffer-create " *nov*"))
+ chars file headers)
+ (save-excursion
+ ;; Init the nov buffer.
+ (set-buffer nov-buffer)
+ (buffer-disable-undo)
+ (erase-buffer)
+ (set-buffer nntp-server-buffer)
+ ;; Delete the old NOV file.
+ (when (file-exists-p nov)
+ (funcall nnmail-delete-file-function nov))
+ (while files
+ (unless (file-directory-p (setq file (concat dir (cdar files))))
+ (erase-buffer)
+ (nnheader-insert-file-contents file)
+ (narrow-to-region
+ (goto-char (point-min))
+ (progn
+ (re-search-forward "\n\r?\n" nil t)
+ (setq chars (- (point-max) (point)))
+ (max (point-min) (1- (point)))))
+ (unless (zerop (buffer-size))
+ (goto-char (point-min))
+ (setq headers (nnml-parse-head chars (caar files)))
(save-excursion
(set-buffer nov-buffer)
(goto-char (point-max))
- (insert (int-to-string (car files)) nov-line))
- (widen)
- (setq files (cdr files)))
- (save-excursion
- (set-buffer nov-buffer)
- (write-region 1 (point-max) (expand-file-name nov) nil
- 'nomesg)
- (kill-buffer (current-buffer)))))))
+ (nnheader-insert-nov headers)))
+ (widen))
+ (setq files (cdr files)))
+ (save-excursion
+ (set-buffer nov-buffer)
+ (nnmail-write-region (point-min) (point-max) nov nil 'nomesg)
+ (kill-buffer (current-buffer))))))
(defun nnml-nov-delete-article (group article)
(save-excursion
(set-buffer (nnml-open-nov group))
- (goto-char 1)
- (if (re-search-forward (concat "^" (int-to-string article) "\t"))
- (delete-region (match-beginning 0) (progn (forward-line 1) (point))))))
+ (when (nnheader-find-nov-line article)
+ (delete-region (point) (progn (forward-line 1) (point)))
+ (when (bobp)
+ (let ((active (cadr (assoc group nnml-group-alist)))
+ num)
+ (when active
+ (if (eobp)
+ (setf (car active) (1+ (cdr active)))
+ (when (and (setq num (ignore-errors (read (current-buffer))))
+ (numberp num))
+ (setf (car active) num)))))))
+ t))
+
+(defun nnml-update-file-alist (&optional force)
+ (when nnml-use-compressed-files
+ (when (or (not nnml-article-file-alist)
+ force)
+ (setq nnml-article-file-alist
+ (nnml-current-group-article-to-file-alist)))))
+
+(defun nnml-directory-articles (dir)
+ "Return a list of all article files in a directory.
+Use the nov database for that directory if available."
+ (if (or gnus-nov-is-evil nnml-nov-is-evil
+ (not (file-exists-p
+ (expand-file-name nnml-nov-file-name dir))))
+ (nnheader-directory-articles dir)
+ ;; build list from .overview if available
+ ;; We would use nnml-open-nov, except that nnml-nov-buffer-alist is
+ ;; defvoo'd, and we might get called when it hasn't been swapped in.
+ (save-excursion
+ (let ((list nil)
+ art
+ (buffer (nnml-get-nov-buffer nnml-current-group)))
+ (set-buffer buffer)
+ (goto-char (point-min))
+ (while (not (eobp))
+ (setq art (read (current-buffer)))
+ (push art list)
+ (forward-line 1))
+ list))))
+
+(defun nnml-current-group-article-to-file-alist ()
+ "Return an alist of article/file pairs in the current group.
+Use the nov database for the current group if available."
+ (if (or nnml-use-compressed-files
+ gnus-nov-is-evil
+ nnml-nov-is-evil
+ (not (file-exists-p
+ (expand-file-name nnml-nov-file-name
+ nnml-current-directory))))
+ (nnheader-article-to-file-alist nnml-current-directory)
+ ;; build list from .overview if available
+ (save-excursion
+ (let ((alist nil)
+ (buffer (nnml-get-nov-buffer nnml-current-group))
+ art)
+ (set-buffer buffer)
+ (goto-char (point-min))
+ (while (not (eobp))
+ (setq art (read (current-buffer)))
+ ;; assume file name is unadorned (ie. not compressed etc)
+ (push (cons art (int-to-string art)) alist)
+ (forward-line 1))
+ alist))))
+
+(deffoo nnml-request-set-mark (group actions &optional server)
+ (nnml-possibly-change-directory group server)
+ (unless nnml-marks-is-evil
+ (nnml-open-marks group server)
+ (dolist (action actions)
+ (let ((range (nth 0 action))
+ (what (nth 1 action))
+ (marks (nth 2 action)))
+ (assert (or (eq what 'add) (eq what 'del)) nil
+ "Unknown request-set-mark action: %s" what)
+ (dolist (mark marks)
+ (setq nnml-marks (gnus-update-alist-soft
+ mark
+ (funcall (if (eq what 'add) 'gnus-range-add
+ 'gnus-remove-from-range)
+ (cdr (assoc mark nnml-marks)) range)
+ nnml-marks)))))
+ (nnml-save-marks group server))
+ nil)
+
+(deffoo nnml-request-update-info (group info &optional server)
+ (nnml-possibly-change-directory group server)
+ (when (and (not nnml-marks-is-evil) (nnml-marks-changed-p group))
+ (nnheader-message 8 "Updating marks for %s..." group)
+ (nnml-open-marks group server)
+ ;; Update info using `nnml-marks'.
+ (mapc (lambda (pred)
+ (unless (memq (cdr pred) gnus-article-unpropagated-mark-lists)
+ (gnus-info-set-marks
+ info
+ (gnus-update-alist-soft
+ (cdr pred)
+ (cdr (assq (cdr pred) nnml-marks))
+ (gnus-info-marks info))
+ t)))
+ gnus-article-mark-lists)
+ (let ((seen (cdr (assq 'read nnml-marks))))
+ (gnus-info-set-read info
+ (if (and (integerp (car seen))
+ (null (cdr seen)))
+ (list (cons (car seen) (car seen)))
+ seen)))
+ (nnheader-message 8 "Updating marks for %s...done" group))
+ info)
+
+(defun nnml-marks-changed-p (group)
+ (let ((file (expand-file-name nnml-marks-file-name
+ (nnmail-group-pathname group nnml-directory))))
+ (if (null (gnus-gethash file nnml-marks-modtime))
+ t ;; never looked at marks file, assume it has changed
+ (not (equal (gnus-gethash file nnml-marks-modtime)
+ (nth 5 (file-attributes file)))))))
+
+(defun nnml-save-marks (group server)
+ (let ((file-name-coding-system nnmail-pathname-coding-system)
+ (file (expand-file-name nnml-marks-file-name
+ (nnmail-group-pathname group nnml-directory))))
+ (condition-case err
+ (progn
+ (nnml-possibly-create-directory group)
+ (with-temp-file file
+ (erase-buffer)
+ (gnus-prin1 nnml-marks)
+ (insert "\n"))
+ (gnus-sethash file
+ (nth 5 (file-attributes file))
+ nnml-marks-modtime))
+ (error (or (gnus-yes-or-no-p
+ (format "Could not write to %s (%s). Continue? " file err))
+ (error "Cannot write to %s (%s)" file err))))))
+
+(defun nnml-open-marks (group server)
+ (let ((file (expand-file-name
+ nnml-marks-file-name
+ (nnmail-group-pathname group nnml-directory))))
+ (if (file-exists-p file)
+ (condition-case err
+ (with-temp-buffer
+ (gnus-sethash file (nth 5 (file-attributes file))
+ nnml-marks-modtime)
+ (nnheader-insert-file-contents file)
+ (setq nnml-marks (read (current-buffer)))
+ (dolist (el gnus-article-unpropagated-mark-lists)
+ (setq nnml-marks (gnus-remassoc el nnml-marks))))
+ (error (or (gnus-yes-or-no-p
+ (format "Error reading nnml marks file %s (%s). Continuing will use marks from .newsrc.eld. Continue? " file err))
+ (error "Cannot read nnml marks file %s (%s)" file err))))
+ ;; User didn't have a .marks file. Probably first time
+ ;; user of the .marks stuff. Bootstrap it from .newsrc.eld.
+ (let ((info (gnus-get-info
+ (gnus-group-prefixed-name
+ group
+ (gnus-server-to-method (format "nnml:%s" server))))))
+ (nnheader-message 7 "Bootstrapping marks for %s..." group)
+ (setq nnml-marks (gnus-info-marks info))
+ (push (cons 'read (gnus-info-read info)) nnml-marks)
+ (dolist (el gnus-article-unpropagated-mark-lists)
+ (setq nnml-marks (gnus-remassoc el nnml-marks)))
+ (nnml-save-marks group server)
+ (nnheader-message 7 "Bootstrapping marks for %s...done" group)))))
+
+
+;;;
+;;; Group and server compaction. -- dvl
+;;;
+
+;; #### FIXME: this function handles self Xref: entry correctly, but I don't
+;; #### know how to handle external cross-references. I actually don't know if
+;; #### this is handled correctly elsewhere. For instance, what happens if you
+;; #### move all articles to a new group (that's what people do for manual
+;; #### compaction) ?
+
+;; #### NOTE: the function below handles the article backlog. This is
+;; #### conceptually the wrong place to do it because the backend is at a
+;; #### lower level. However, this is the only place where we have the needed
+;; #### information to do the job. Ideally, this function should not handle
+;; #### the backlog by itself, but return a list of moved groups / articles to
+;; #### the caller. This will become important to avoid code duplication when
+;; #### other backends get a compaction feature. Also, note that invalidating
+;; #### the "original article buffer" is already done at an upper level.
+
+(defun nnml-request-compact-group (group &optional server save)
+ (nnml-possibly-change-directory group server)
+ (unless nnml-article-file-alist
+ (setq nnml-article-file-alist
+ (sort (nnml-current-group-article-to-file-alist)
+ 'car-less-than-car)))
+ (if (not nnml-article-file-alist)
+ ;; The group is empty: do nothing but return t
+ t
+ ;; The group is not empty:
+ (let* ((group-full-name
+ (gnus-group-prefixed-name
+ group
+ (gnus-server-to-method (format "nnml:%s" server))))
+ (info (gnus-get-info group-full-name))
+ (new-number 1)
+ compacted)
+ (let ((articles nnml-article-file-alist)
+ article)
+ (while (setq article (pop articles))
+ (let ((old-number (car article)))
+ (when (> old-number new-number)
+ ;; There is a gap here:
+ (let ((old-number-string (int-to-string old-number))
+ (new-number-string (int-to-string new-number)))
+ (setq compacted t)
+ ;; #### NOTE: `nnml-article-to-file' calls
+ ;; #### `nnml-update-file-alist' (which in turn calls
+ ;; #### `nnml-current-group-article-to-file-alist', which
+ ;; #### might use the NOV database). This might turn out to be
+ ;; #### inefficient. In that case, we will do the work
+ ;; #### manually.
+ ;; 1/ Move the article to a new file:
+ (let* ((oldfile (nnml-article-to-file old-number))
+ (newfile
+ (gnus-replace-in-string
+ oldfile (concat "\\("
+ old-number-string
+ "\\)\\(\\(\\.gz\\)?\\)$")
+ (concat new-number-string "\\2"))))
+ (with-current-buffer nntp-server-buffer
+ (nnmail-find-file oldfile)
+ ;; Update the Xref header in the article itself:
+ (when (and (re-search-forward "^Xref: [^ ]+ " nil t)
+ (re-search-forward
+ (concat "\\<"
+ (regexp-quote
+ (concat group ":" old-number-string))
+ "\\>")
+ (point-at-eol) t))
+ (replace-match
+ (concat group ":" new-number-string)))
+ ;; Save to the new file:
+ (nnmail-write-region (point-min) (point-max) newfile))
+ (funcall nnmail-delete-file-function oldfile))
+ ;; 2/ Update all marks for this article:
+ ;; #### NOTE: it is possible that the new article number
+ ;; #### already belongs to a range, whereas the corresponding
+ ;; #### article doesn't exist (for example, if you delete an
+ ;; #### article). For that reason, it is important to update
+ ;; #### the ranges (meaning remove inexistant articles) before
+ ;; #### doing anything on them.
+ ;; 2 a/ read articles:
+ (let ((read (gnus-info-read info)))
+ (setq read (gnus-remove-from-range read (list new-number)))
+ (when (gnus-member-of-range old-number read)
+ (setq read (gnus-remove-from-range read (list old-number)))
+ (setq read (gnus-add-to-range read (list new-number))))
+ (gnus-info-set-read info read))
+ ;; 2 b/ marked articles:
+ (let ((oldmarks (gnus-info-marks info))
+ mark newmarks)
+ (while (setq mark (pop oldmarks))
+ (setcdr mark (gnus-remove-from-range (cdr mark)
+ (list new-number)))
+ (when (gnus-member-of-range old-number (cdr mark))
+ (setcdr mark (gnus-remove-from-range (cdr mark)
+ (list old-number)))
+ (setcdr mark (gnus-add-to-range (cdr mark)
+ (list new-number))))
+ (push mark newmarks))
+ (gnus-info-set-marks info newmarks))
+ ;; 3/ Update the NOV entry for this article:
+ (unless nnml-nov-is-evil
+ (save-excursion
+ (set-buffer (nnml-open-nov group))
+ (when (nnheader-find-nov-line old-number)
+ ;; Replace the article number:
+ (looking-at old-number-string)
+ (replace-match new-number-string nil t)
+ ;; Update the Xref header:
+ (when (re-search-forward
+ (concat "\\(Xref:[^\t\n]* \\)\\<"
+ (regexp-quote
+ (concat group ":" old-number-string))
+ "\\>")
+ (point-at-eol) t)
+ (replace-match
+ (concat "\\1" group ":" new-number-string))))))
+ ;; 4/ Possibly remove the article from the backlog:
+ (when gnus-keep-backlog
+ ;; #### NOTE: instead of removing the article, we could
+ ;; #### modify the backlog to reflect the numbering change,
+ ;; #### but I don't think it's worth it.
+ (gnus-backlog-remove-article group-full-name old-number)
+ (gnus-backlog-remove-article group-full-name new-number))))
+ (setq new-number (1+ new-number)))))
+ (if (not compacted)
+ ;; No compaction had to be done:
+ t
+ ;; Some articles have actually been renamed:
+ ;; 1/ Rebuild active information:
+ (let ((entry (assoc group nnml-group-alist))
+ (active (cons 1 (1- new-number))))
+ (setq nnml-group-alist (delq entry nnml-group-alist))
+ (push (list group active) nnml-group-alist)
+ ;; Update the active hashtable to let the *Group* buffer display
+ ;; up-to-date lines. I don't think that either gnus-newsrc-hashtb or
+ ;; gnus-newwrc-alist are out of date, since all we did is to modify
+ ;; the info of the group internally.
+ (gnus-set-active group-full-name active))
+ ;; 1 bis/
+ ;; #### NOTE: normally, we should save the overview (NOV) file
+ ;; #### here, just like we save the marks file. However, there is no
+ ;; #### such function as nnml-save-nov for a single group. Only for
+ ;; #### all groups. Gnus inconsistency is getting worse every day...
+ ;; 2/ Rebuild marks file:
+ (unless nnml-marks-is-evil
+ ;; #### NOTE: this constant use of global variables everywhere is
+ ;; #### truly disgusting. Gnus really needs a *major* cleanup.
+ (setq nnml-marks (gnus-info-marks info))
+ (push (cons 'read (gnus-info-read info)) nnml-marks)
+ (dolist (el gnus-article-unpropagated-mark-lists)
+ (setq nnml-marks (gnus-remassoc el nnml-marks)))
+ (nnml-save-marks group server))
+ ;; 3/ Save everything if this was not part of a bigger operation:
+ (if (not save)
+ ;; Nothing to save (yet):
+ t
+ ;; Something to save:
+ ;; a/ Save the NOV databases:
+ ;; #### NOTE: this should be done directory per directory in 1bis
+ ;; #### above. See comment there.
+ (nnml-save-nov)
+ ;; b/ Save the active file:
+ (nnmail-save-active nnml-group-alist nnml-active-file)
+ t)))))
+
+(defun nnml-request-compact (&optional server)
+ "Request compaction of all SERVER nnml groups."
+ (interactive (list (or (nnoo-current-server 'nnml) "")))
+ (nnmail-activate 'nnml)
+ (unless (nnml-server-opened server)
+ (nnml-open-server server))
+ (setq nnml-directory (expand-file-name nnml-directory))
+ (let* ((groups (gnus-groups-from-server
+ (gnus-server-to-method (format "nnml:%s" server))))
+ (first (pop groups))
+ group)
+ (when first
+ (while (setq group (pop groups))
+ (nnml-request-compact-group (gnus-group-real-name group) server))
+ (nnml-request-compact-group (gnus-group-real-name first) server t))))
+
(provide 'nnml)
+;;; arch-tag: 52c97dc3-9735-45de-b439-9e4d23b52004
;;; nnml.el ends here