Sync up with Gnus v5.8.3.
[elisp/gnus.git-] / lisp / nndraft.el
1 ;;; nndraft.el --- draft article access for Gnus
2 ;; Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; Keywords: news
6
7 ;; This file is part of GNU Emacs.
8
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (eval-when-compile (require 'cl))
29
30 (require 'nnheader)
31 (require 'nnmail)
32 (require 'gnus-start)
33 (require 'nnmh)
34 (require 'nnoo)
35 (eval-when-compile
36   ;; This is just to shut up the byte-compiler.
37   (fset 'nndraft-request-group 'ignore))
38
39 (nnoo-declare nndraft
40   nnmh)
41
42 (defvoo nndraft-directory (nnheader-concat gnus-directory "drafts/")
43   "Where nndraft will store its files."
44   nnmh-directory)
45
46 \f
47
48 (defvoo nndraft-current-group "" nil nnmh-current-group)
49 (defvoo nndraft-get-new-mail nil nil nnmh-get-new-mail)
50 (defvoo nndraft-current-directory nil nil nnmh-current-directory)
51
52 (defconst nndraft-version "nndraft 1.0")
53 (defvoo nndraft-status-string "" nil nnmh-status-string)
54
55 \f
56
57 ;;; Interface functions.
58
59 (nnoo-define-basics nndraft)
60
61 (deffoo nndraft-open-server (server &optional defs)
62   (nnoo-change-server 'nndraft server defs)
63   (cond
64    ((not (file-exists-p nndraft-directory))
65     (nndraft-close-server)
66     (nnheader-report 'nndraft "No such file or directory: %s"
67                      nndraft-directory))
68    ((not (file-directory-p (file-truename nndraft-directory)))
69     (nndraft-close-server)
70     (nnheader-report 'nndraft "Not a directory: %s" nndraft-directory))
71    (t
72     (nnheader-report 'nndraft "Opened server %s using directory %s"
73                      server nndraft-directory)
74     t)))
75
76 (deffoo nndraft-retrieve-headers (articles &optional group server fetch-old)
77   (nndraft-possibly-change-group group)
78   (save-excursion
79     (set-buffer nntp-server-buffer)
80     (erase-buffer)
81     (let* (article)
82       ;; We don't support fetching by Message-ID.
83       (if (stringp (car articles))
84           'headers
85         (while articles
86           (narrow-to-region (point) (point))
87           (when (nndraft-request-article
88                  (setq article (pop articles)) group server (current-buffer))
89             (goto-char (point-min))
90             (if (search-forward "\n\n" nil t)
91                 (forward-line -1)
92               (goto-char (point-max)))
93             (delete-region (point) (point-max))
94             (goto-char (point-min))
95             (insert (format "221 %d Article retrieved.\n" article))
96             (widen)
97             (goto-char (point-max))
98             (insert ".\n")))
99
100         (nnheader-fold-continuation-lines)
101         'headers))))
102
103 (deffoo nndraft-request-article (id &optional group server buffer)
104   (nndraft-possibly-change-group group)
105   (when (numberp id)
106     ;; We get the newest file of the auto-saved file and the
107     ;; "real" file.
108     (let* ((file (nndraft-article-filename id))
109            (auto (nndraft-auto-save-file-name file))
110            (newest (if (file-newer-than-file-p file auto) file auto))
111            (nntp-server-buffer (or buffer nntp-server-buffer)))
112       (when (and (file-exists-p newest)
113                  (nnmail-find-file newest))
114         (save-excursion
115           (set-buffer nntp-server-buffer)
116           (goto-char (point-min))
117           ;; If there's a mail header separator in this file,
118           ;; we remove it.
119           (when (re-search-forward
120                  (concat "^" mail-header-separator "$") nil t)
121             (replace-match "" t t)))
122         t))))
123
124 (deffoo nndraft-request-restore-buffer (article &optional group server)
125   "Request a new buffer that is restored to the state of ARTICLE."
126   (nndraft-possibly-change-group group)
127   (when (nndraft-request-article article group server (current-buffer))
128     (message-remove-header "xref")
129     (message-remove-header "lines")
130     t))
131
132 (deffoo nndraft-request-update-info (group info &optional server)
133   (nndraft-possibly-change-group group)
134   (gnus-info-set-read
135    info
136    (gnus-update-read-articles (gnus-group-prefixed-name group '(nndraft ""))
137                               (nndraft-articles) t))
138   (let ((marks (nth 3 info)))
139     (when marks
140       ;; Nix out all marks except the `unsend'-able article marks.
141       (setcar (nthcdr 3 info)
142               (if (assq 'unsend marks)
143                   (list (assq 'unsend marks))
144                 nil))))
145   t)
146
147 (deffoo nndraft-request-associate-buffer (group)
148   "Associate the current buffer with some article in the draft group."
149   (nndraft-open-server "")
150   (nndraft-request-group group)
151   (nndraft-possibly-change-group group)
152   (let ((gnus-verbose-backends nil)
153         (buf (current-buffer))
154         article file)
155     (with-temp-buffer
156       (insert-buffer-substring buf)
157       (setq article (nndraft-request-accept-article
158                      group (nnoo-current-server 'nndraft) t 'noinsert)
159             file (nndraft-article-filename article)))
160     (setq buffer-file-name (expand-file-name file)
161           buffer-auto-save-file-name (make-auto-save-file-name))
162     (clear-visited-file-modtime)
163     article))
164
165 (deffoo nndraft-request-expire-articles (articles group &optional server force)
166   (nndraft-possibly-change-group group)
167   (let* ((nnmh-allow-delete-final t)
168          (res (nnoo-parent-function 'nndraft
169                                     'nnmh-request-expire-articles
170                                     (list articles group server force)))
171          article)
172     ;; Delete all the "state" files of articles that have been expired.
173     (while articles
174       (unless (memq (setq article (pop articles)) res)
175         (let ((auto (nndraft-auto-save-file-name
176                      (nndraft-article-filename article))))
177           (when (file-exists-p auto)
178             (funcall nnmail-delete-file-function auto)))
179         (dolist (backup
180                  (let ((kept-new-versions 1)
181                        (kept-old-versions 0))
182                    (find-backup-file-name
183                     (nndraft-article-filename article))))
184           (when (file-exists-p backup)
185             (funcall nnmail-delete-file-function backup)))))
186     res))
187
188 (deffoo nndraft-request-accept-article (group &optional server last noinsert)
189   (nndraft-possibly-change-group group)
190   (let ((gnus-verbose-backends nil))
191     (nnoo-parent-function 'nndraft 'nnmh-request-accept-article
192                           (list group server last noinsert))))
193
194 (deffoo nndraft-request-create-group (group &optional server args)
195   (nndraft-possibly-change-group group)
196   (if (file-exists-p nndraft-current-directory)
197       (if (file-directory-p nndraft-current-directory)
198           t
199         nil)
200     (condition-case ()
201         (progn
202           (gnus-make-directory nndraft-current-directory)
203           t)
204       (file-error nil))))
205
206 \f
207 ;;; Low-Level Interface
208
209 (defun nndraft-possibly-change-group (group)
210   (when (and group
211              (not (equal group nndraft-current-group)))
212     (nndraft-open-server "")
213     (setq nndraft-current-group group)
214     (setq nndraft-current-directory
215           (nnheader-concat nndraft-directory group))))
216
217 (defun nndraft-article-filename (article &rest args)
218   (apply 'concat
219          (file-name-as-directory nndraft-current-directory)
220          (int-to-string article)
221          args))
222
223 (defun nndraft-auto-save-file-name (file)
224   (save-excursion
225     (prog1
226         (progn
227           (set-buffer (get-buffer-create " *draft tmp*"))
228           (setq buffer-file-name file)
229           (make-auto-save-file-name))
230       (kill-buffer (current-buffer)))))
231
232 (defun nndraft-articles ()
233   "Return the list of messages in the group."
234   (gnus-make-directory nndraft-current-directory)
235   (sort
236    (mapcar 'string-to-int
237            (directory-files nndraft-current-directory nil "\\`[0-9]+\\'" t))
238    '<))
239
240 (nnoo-import nndraft
241   (nnmh
242    nnmh-retrieve-headers
243    nnmh-request-group
244    nnmh-close-group
245    nnmh-request-list
246    nnmh-request-newsgroups
247    nnmh-request-move-article
248    nnmh-request-replace-article))
249
250 (provide 'nndraft)
251
252 ;;; nndraft.el ends here