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     (message-remove-header "date")
133     t))
134
135 (deffoo nndraft-request-update-info (group info &optional server)
136   (nndraft-possibly-change-group group)
137   (gnus-info-set-read
138    info
139    (gnus-update-read-articles (gnus-group-prefixed-name group '(nndraft ""))
140                               (nndraft-articles) t))
141   (let ((marks (nth 3 info)))
142     (when marks
143       ;; Nix out all marks except the `unsend'-able article marks.
144       (setcar (nthcdr 3 info)
145               (if (assq 'unsend marks)
146                   (list (assq 'unsend marks))
147                 nil))))
148   t)
149
150 (deffoo nndraft-request-associate-buffer (group)
151   "Associate the current buffer with some article in the draft group."
152   (nndraft-open-server "")
153   (nndraft-request-group group)
154   (nndraft-possibly-change-group group)
155   (let ((gnus-verbose-backends nil)
156         (buf (current-buffer))
157         article file)
158     (with-temp-buffer
159       (insert-buffer-substring buf)
160       (setq article (nndraft-request-accept-article
161                      group (nnoo-current-server 'nndraft) t 'noinsert)
162             file (nndraft-article-filename article)))
163     (setq buffer-file-name (expand-file-name file)
164           buffer-auto-save-file-name (make-auto-save-file-name))
165     (clear-visited-file-modtime)
166     article))
167
168 (deffoo nndraft-request-expire-articles (articles group &optional server force)
169   (nndraft-possibly-change-group group)
170   (let* ((nnmh-allow-delete-final t)
171          (res (nnoo-parent-function 'nndraft
172                                     'nnmh-request-expire-articles
173                                     (list articles group server force)))
174          article)
175     ;; Delete all the "state" files of articles that have been expired.
176     (while articles
177       (unless (memq (setq article (pop articles)) res)
178         (let ((auto (nndraft-auto-save-file-name
179                      (nndraft-article-filename article))))
180           (when (file-exists-p auto)
181             (funcall nnmail-delete-file-function auto)))
182         (dolist (backup
183                  (let ((kept-new-versions 1)
184                        (kept-old-versions 0))
185                    (find-backup-file-name
186                     (nndraft-article-filename article))))
187           (when (file-exists-p backup)
188             (funcall nnmail-delete-file-function backup)))))
189     res))
190
191 (deffoo nndraft-request-accept-article (group &optional server last noinsert)
192   (nndraft-possibly-change-group group)
193   (let ((gnus-verbose-backends nil))
194     (nnoo-parent-function 'nndraft 'nnmh-request-accept-article
195                           (list group server last noinsert))))
196
197 (deffoo nndraft-request-replace-article (article group buffer)
198   (nndraft-possibly-change-group group)
199   (let ((nnmail-file-coding-system nnheader-text-coding-system))
200     (nnoo-parent-function 'nndraft 'nnmh-request-replace-article
201                           (list article group buffer))))
202
203 (deffoo nndraft-request-create-group (group &optional server args)
204   (nndraft-possibly-change-group group)
205   (if (file-exists-p nndraft-current-directory)
206       (if (file-directory-p nndraft-current-directory)
207           t
208         nil)
209     (condition-case ()
210         (progn
211           (gnus-make-directory nndraft-current-directory)
212           t)
213       (file-error nil))))
214
215 \f
216 ;;; Low-Level Interface
217
218 (defun nndraft-possibly-change-group (group)
219   (when (and group
220              (not (equal group nndraft-current-group)))
221     (nndraft-open-server "")
222     (setq nndraft-current-group group)
223     (setq nndraft-current-directory
224           (nnheader-concat nndraft-directory group))))
225
226 (defun nndraft-article-filename (article &rest args)
227   (apply 'concat
228          (file-name-as-directory nndraft-current-directory)
229          (int-to-string article)
230          args))
231
232 (defun nndraft-auto-save-file-name (file)
233   (save-excursion
234     (prog1
235         (progn
236           (set-buffer (get-buffer-create " *draft tmp*"))
237           (setq buffer-file-name file)
238           (make-auto-save-file-name))
239       (kill-buffer (current-buffer)))))
240
241 (defun nndraft-articles ()
242   "Return the list of messages in the group."
243   (gnus-make-directory nndraft-current-directory)
244   (sort
245    (mapcar 'string-to-int
246            (directory-files nndraft-current-directory nil "\\`[0-9]+\\'" t))
247    '<))
248
249 (nnoo-import nndraft
250   (nnmh
251    nnmh-retrieve-headers
252    nnmh-request-group
253    nnmh-close-group
254    nnmh-request-list
255    nnmh-request-newsgroups
256    nnmh-request-move-article))
257
258 (provide 'nndraft)
259
260 ;;; nndraft.el ends here