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