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