lisp/gnus/nndraft.el

   1 ;;; nndraft.el --- draft article access for Gnus
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 3, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (require 'nnheader)
  31 (require 'nnmail)
  32 (require 'gnus-start)
  33 (require 'nnmh)
  34 (require 'nnoo)
  35 (require 'mm-util)
  36 (eval-when-compile (require 'cl))
  37
  38 (nnoo-declare nndraft
  39   nnmh)
  40
  41 (defvoo nndraft-directory (nnheader-concat gnus-directory "drafts/")
  42   "Where nndraft will store its files."
  43   nnmh-directory)
  44
  45 \f
  46
  47 (defvoo nndraft-current-group "" nil nnmh-current-group)
  48 (defvoo nndraft-get-new-mail nil nil nnmh-get-new-mail)
  49 (defvoo nndraft-current-directory nil nil nnmh-current-directory)
  50
  51 (defconst nndraft-version "nndraft 1.0")
  52 (defvoo nndraft-status-string "" nil nnmh-status-string)
  53
  54 \f
  55
  56 ;;; Interface functions.
  57
  58 (nnoo-define-basics nndraft)
  59
  60 (deffoo nndraft-open-server (server &optional defs)
  61   (nnoo-change-server 'nndraft server defs)
  62   (cond
  63    ((not (file-exists-p nndraft-directory))
  64     (nndraft-close-server)
  65     (nnheader-report 'nndraft "No such file or directory: %s"
  66                      nndraft-directory))
  67    ((not (file-directory-p (file-truename nndraft-directory)))
  68     (nndraft-close-server)
  69     (nnheader-report 'nndraft "Not a directory: %s" nndraft-directory))
  70    (t
  71     (nnheader-report 'nndraft "Opened server %s using directory %s"
  72                      server nndraft-directory)
  73     t)))
  74
  75 (deffoo nndraft-retrieve-headers (articles &optional group server fetch-old)
  76   (nndraft-possibly-change-group group)
  77   (save-excursion
  78     (set-buffer nntp-server-buffer)
  79     (erase-buffer)
  80     (let* (article)
  81       ;; We don't support fetching by Message-ID.
  82       (if (stringp (car articles))
  83           'headers
  84         (while articles
  85           (narrow-to-region (point) (point))
  86           (when (nndraft-request-article
  87                  (setq article (pop articles)) group server (current-buffer))
  88             (goto-char (point-min))
  89             (if (search-forward "\n\n" nil t)
  90                 (forward-line -1)
  91               (goto-char (point-max)))
  92             (delete-region (point) (point-max))
  93             (goto-char (point-min))
  94             (insert (format "221 %d Article retrieved.\n" article))
  95             (widen)
  96             (goto-char (point-max))
  97             (insert ".\n")))
  98
  99         (nnheader-fold-continuation-lines)
 100         'headers))))
 101
 102 (deffoo nndraft-request-article (id &optional group server buffer)
 103   (nndraft-possibly-change-group group)
 104   (when (numberp id)
 105     ;; We get the newest file of the auto-saved file and the
 106     ;; "real" file.
 107     (let* ((file (nndraft-article-filename id))
 108            (auto (nndraft-auto-save-file-name file))
 109            (newest (if (file-newer-than-file-p file auto) file auto))
 110            (nntp-server-buffer (or buffer nntp-server-buffer)))
 111       (when (and (file-exists-p newest)
 112                  (let ((nnmail-file-coding-system
 113                         (if (file-newer-than-file-p file auto)
 114                             (if (member group '("drafts" "delayed"))
 115                                 message-draft-coding-system
 116                               mm-text-coding-system)
 117                           mm-auto-save-coding-system)))
 118                    (nnmail-find-file newest)))
 119         (save-excursion
 120           (set-buffer nntp-server-buffer)
 121           (goto-char (point-min))
 122           ;; If there's a mail header separator in this file,
 123           ;; we remove it.
 124           (when (re-search-forward
 125                  (concat "^" (regexp-quote mail-header-separator) "$") nil t)
 126             (replace-match "" t t)))
 127         t))))
 128
 129 (deffoo nndraft-request-restore-buffer (article &optional group server)
 130   "Request a new buffer that is restored to the state of ARTICLE."
 131   (nndraft-possibly-change-group group)
 132   (when (nndraft-request-article article group server (current-buffer))
 133     (message-remove-header "xref")
 134     (message-remove-header "lines")
 135     ;; Articles in nndraft:queue are considered as sent messages.  The
 136     ;; Date field should be the time when they are sent.
 137     ;;(message-remove-header "date")
 138     t))
 139
 140 (deffoo nndraft-request-update-info (group info &optional server)
 141   (nndraft-possibly-change-group group)
 142   (gnus-info-set-read
 143    info
 144    (gnus-update-read-articles (gnus-group-prefixed-name group '(nndraft ""))
 145                               (nndraft-articles) t))
 146   (let ((marks (nth 3 info)))
 147     (when marks
 148       ;; Nix out all marks except the `unsend'-able article marks.
 149       (setcar (nthcdr 3 info)
 150               (if (assq 'unsend marks)
 151                   (list (assq 'unsend marks))
 152                 nil))))
 153   t)
 154
 155 (defun nndraft-generate-headers ()
 156   (save-excursion
 157     (message-generate-headers
 158      (message-headers-to-generate
 159       message-required-headers message-draft-headers nil))))
 160
 161 (deffoo nndraft-request-associate-buffer (group)
 162   "Associate the current buffer with some article in the draft group."
 163   (nndraft-open-server "")
 164   (nndraft-request-group group)
 165   (nndraft-possibly-change-group group)
 166   (let ((gnus-verbose-backends nil)
 167         (buf (current-buffer))
 168         article file)
 169     (with-temp-buffer
 170       (insert-buffer-substring buf)
 171       (setq article (nndraft-request-accept-article
 172                      group (nnoo-current-server 'nndraft) t 'noinsert)
 173             file (nndraft-article-filename article)))
 174     (setq buffer-file-name (expand-file-name file)
 175           buffer-auto-save-file-name (make-auto-save-file-name))
 176     (clear-visited-file-modtime)
 177     (let ((hook (if (boundp 'write-contents-functions)
 178                     'write-contents-functions
 179                   'write-contents-hooks)))
 180       (gnus-make-local-hook hook)
 181       (add-hook hook 'nndraft-generate-headers nil t))
 182     article))
 183
 184 (deffoo nndraft-request-group (group &optional server dont-check)
 185   (nndraft-possibly-change-group group)
 186   (unless dont-check
 187     (let* ((pathname (nnmail-group-pathname group nndraft-directory))
 188            (file-name-coding-system nnmail-pathname-coding-system)
 189            dir file)
 190       (nnheader-re-read-dir pathname)
 191       (setq dir (mapcar (lambda (name) (string-to-number (substring name 1)))
 192                         (ignore-errors (directory-files
 193                                         pathname nil "^#[0-9]+#$" t))))
 194       (dolist (n dir)
 195         (unless (file-exists-p
 196                  (setq file (expand-file-name (int-to-string n) pathname)))
 197           (rename-file (nndraft-auto-save-file-name file) file)))))
 198   (nnoo-parent-function 'nndraft
 199                         'nnmh-request-group
 200                         (list group server dont-check)))
 201
 202 (deffoo nndraft-request-move-article (article group server
 203                                               accept-form &optional last)
 204   (nndraft-possibly-change-group group)
 205   (let ((buf (get-buffer-create " *nndraft move*"))
 206         result)
 207     (and
 208      (nndraft-request-article article group server)
 209      (save-excursion
 210        (set-buffer buf)
 211        (erase-buffer)
 212        (insert-buffer-substring nntp-server-buffer)
 213        (setq result (eval accept-form))
 214        (kill-buffer (current-buffer))
 215        result)
 216      (null (nndraft-request-expire-articles (list article) group server 'force))
 217      result)))
 218
 219 (deffoo nndraft-request-expire-articles (articles group &optional server force)
 220   (nndraft-possibly-change-group group)
 221   (let* ((nnmh-allow-delete-final t)
 222          (res (nnoo-parent-function 'nndraft
 223                                     'nnmh-request-expire-articles
 224                                     (list articles group server force)))
 225          article)
 226     ;; Delete all the "state" files of articles that have been expired.
 227     (while articles
 228       (unless (memq (setq article (pop articles)) res)
 229         (let ((auto (nndraft-auto-save-file-name
 230                      (nndraft-article-filename article))))
 231           (when (file-exists-p auto)
 232             (funcall nnmail-delete-file-function auto)))
 233         (dolist (backup
 234                  (let ((kept-new-versions 1)
 235                        (kept-old-versions 0))
 236                    (find-backup-file-name
 237                     (nndraft-article-filename article))))
 238           (when (file-exists-p backup)
 239             (funcall nnmail-delete-file-function backup)))))
 240     res))
 241
 242 (deffoo nndraft-request-accept-article (group &optional server last noinsert)
 243   (nndraft-possibly-change-group group)
 244   (let ((gnus-verbose-backends nil))
 245     (nnoo-parent-function 'nndraft 'nnmh-request-accept-article
 246                           (list group server last noinsert))))
 247
 248 (deffoo nndraft-request-replace-article (article group buffer)
 249   (nndraft-possibly-change-group group)
 250   (let ((nnmail-file-coding-system
 251          (if (member group '("drafts" "delayed"))
 252              message-draft-coding-system
 253            mm-text-coding-system)))
 254     (nnoo-parent-function 'nndraft 'nnmh-request-replace-article
 255                           (list article group buffer))))
 256
 257 (deffoo nndraft-request-create-group (group &optional server args)
 258   (nndraft-possibly-change-group group)
 259   (if (file-exists-p nndraft-current-directory)
 260       (if (file-directory-p nndraft-current-directory)
 261           t
 262         nil)
 263     (condition-case ()
 264         (progn
 265           (gnus-make-directory nndraft-current-directory)
 266           t)
 267       (file-error nil))))
 268
 269 \f
 270 ;;; Low-Level Interface
 271
 272 (defun nndraft-possibly-change-group (group)
 273   (when (and group
 274              (not (equal group nndraft-current-group)))
 275     (nndraft-open-server "")
 276     (setq nndraft-current-group group)
 277     (setq nndraft-current-directory
 278           (nnheader-concat nndraft-directory group))))
 279
 280 (defun nndraft-article-filename (article &rest args)
 281   (apply 'concat
 282          (file-name-as-directory nndraft-current-directory)
 283          (int-to-string article)
 284          args))
 285
 286 (defun nndraft-auto-save-file-name (file)
 287   (save-excursion
 288     (prog1
 289         (progn
 290           (set-buffer (get-buffer-create " *draft tmp*"))
 291           (setq buffer-file-name file)
 292           (make-auto-save-file-name))
 293       (kill-buffer (current-buffer)))))
 294
 295 (defun nndraft-articles ()
 296   "Return the list of messages in the group."
 297   (gnus-make-directory nndraft-current-directory)
 298   (sort
 299    (mapcar 'string-to-number
 300            (directory-files nndraft-current-directory nil "\\`[0-9]+\\'" t))
 301    '<))
 302
 303 (nnoo-import nndraft
 304   (nnmh
 305    nnmh-retrieve-headers
 306    nnmh-request-group
 307    nnmh-close-group
 308    nnmh-request-list
 309    nnmh-request-newsgroups))
 310
 311 (provide 'nndraft)
 312
 313 ;;; arch-tag: 3ce26ca0-41cb-48b1-8703-4dad35e188aa
 314 ;;; nndraft.el ends here