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