2001-03-01 22:00:00 ShengHuo ZHU <zsh@cs.rochester.edu>
[gnus] / 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 (require 'nnheader)
30 (require 'nnmail)
31 (require 'gnus-start)
32 (require 'nnmh)
33 (require 'nnoo)
34 (require 'mm-util)
35 (eval-when-compile
36   (require 'cl))
37
38 (nnoo-declare nndraft
39   nnmh)
40
41 (defvoo nndraft-directory (nnheader-concat gnus-directory "drafts/")
42   "Where nndraft will store its files."
43   nnmh-directory)
44
45 \f
46
47 (defvoo nndraft-current-group "" nil nnmh-current-group)
48 (defvoo nndraft-get-new-mail nil nil nnmh-get-new-mail)
49 (defvoo nndraft-current-directory nil nil nnmh-current-directory)
50
51 (defconst nndraft-version "nndraft 1.0")
52 (defvoo nndraft-status-string "" nil nnmh-status-string)
53
54 \f
55
56 ;;; Interface functions.
57
58 (nnoo-define-basics nndraft)
59
60 (deffoo nndraft-open-server (server &optional defs)
61   (nnoo-change-server 'nndraft server defs)
62   (cond
63    ((not (file-exists-p nndraft-directory))
64     (nndraft-close-server)
65     (nnheader-report 'nndraft "No such file or directory: %s"
66                      nndraft-directory))
67    ((not (file-directory-p (file-truename nndraft-directory)))
68     (nndraft-close-server)
69     (nnheader-report 'nndraft "Not a directory: %s" nndraft-directory))
70    (t
71     (nnheader-report 'nndraft "Opened server %s using directory %s"
72                      server nndraft-directory)
73     t)))
74
75 (deffoo nndraft-retrieve-headers (articles &optional group server fetch-old)
76   (nndraft-possibly-change-group group)
77   (save-excursion
78     (set-buffer nntp-server-buffer)
79     (erase-buffer)
80     (let* (article)
81       ;; We don't support fetching by Message-ID.
82       (if (stringp (car articles))
83           'headers
84         (while articles
85           (narrow-to-region (point) (point))
86           (when (nndraft-request-article
87                  (setq article (pop articles)) group server (current-buffer))
88             (goto-char (point-min))
89             (if (search-forward "\n\n" nil t)
90                 (forward-line -1)
91               (goto-char (point-max)))
92             (delete-region (point) (point-max))
93             (goto-char (point-min))
94             (insert (format "221 %d Article retrieved.\n" article))
95             (widen)
96             (goto-char (point-max))
97             (insert ".\n")))
98
99         (nnheader-fold-continuation-lines)
100         'headers))))
101
102 (deffoo nndraft-request-article (id &optional group server buffer)
103   (nndraft-possibly-change-group group)
104   (when (numberp id)
105     ;; We get the newest file of the auto-saved file and the
106     ;; "real" file.
107     (let* ((file (nndraft-article-filename id))
108            (auto (nndraft-auto-save-file-name file))
109            (newest (if (file-newer-than-file-p file auto) file auto))
110            (nntp-server-buffer (or buffer nntp-server-buffer)))
111       (when (and (file-exists-p newest)
112                  (let ((nnmail-file-coding-system
113                         (if (file-newer-than-file-p file auto)
114                             (if (equal group "drafts")
115                                 message-draft-coding-system
116                               mm-text-coding-system)
117                           mm-auto-save-coding-system)))
118                    (nnmail-find-file newest)))
119         (save-excursion
120           (set-buffer nntp-server-buffer)
121           (goto-char (point-min))
122           ;; If there's a mail header separator in this file,
123           ;; we remove it.
124           (when (re-search-forward
125                  (concat "^" mail-header-separator "$") nil t)
126             (replace-match "" t t)))
127         t))))
128
129 (deffoo nndraft-request-restore-buffer (article &optional group server)
130   "Request a new buffer that is restored to the state of ARTICLE."
131   (nndraft-possibly-change-group group)
132   (when (nndraft-request-article article group server (current-buffer))
133     (message-remove-header "xref")
134     (message-remove-header "lines")
135     (message-remove-header "date")
136     t))
137
138 (deffoo nndraft-request-update-info (group info &optional server)
139   (nndraft-possibly-change-group group)
140   (gnus-info-set-read
141    info
142    (gnus-update-read-articles (gnus-group-prefixed-name group '(nndraft ""))
143                               (nndraft-articles) t))
144   (let ((marks (nth 3 info)))
145     (when marks
146       ;; Nix out all marks except the `unsend'-able article marks.
147       (setcar (nthcdr 3 info)
148               (if (assq 'unsend marks)
149                   (list (assq 'unsend marks))
150                 nil))))
151   t)
152
153 (deffoo nndraft-request-associate-buffer (group)
154   "Associate the current buffer with some article in the draft group."
155   (nndraft-open-server "")
156   (nndraft-request-group group)
157   (nndraft-possibly-change-group group)
158   (let ((gnus-verbose-backends nil)
159         (buf (current-buffer))
160         article file)
161     (with-temp-buffer
162       (insert-buffer-substring buf)
163       (setq article (nndraft-request-accept-article
164                      group (nnoo-current-server 'nndraft) t 'noinsert)
165             file (nndraft-article-filename article)))
166     (setq buffer-file-name (expand-file-name file)
167           buffer-auto-save-file-name (make-auto-save-file-name))
168     (clear-visited-file-modtime)
169     article))
170
171 (deffoo nndraft-request-expire-articles (articles group &optional server force)
172   (nndraft-possibly-change-group group)
173   (let* ((nnmh-allow-delete-final t)
174          (res (nnoo-parent-function 'nndraft
175                                     'nnmh-request-expire-articles
176                                     (list articles group server force)))
177          article)
178     ;; Delete all the "state" files of articles that have been expired.
179     (while articles
180       (unless (memq (setq article (pop articles)) res)
181         (let ((auto (nndraft-auto-save-file-name
182                      (nndraft-article-filename article))))
183           (when (file-exists-p auto)
184             (funcall nnmail-delete-file-function auto)))
185         (dolist (backup
186                  (let ((kept-new-versions 1)
187                        (kept-old-versions 0))
188                    (find-backup-file-name
189                     (nndraft-article-filename article))))
190           (when (file-exists-p backup)
191             (funcall nnmail-delete-file-function backup)))))
192     res))
193
194 (deffoo nndraft-request-accept-article (group &optional server last noinsert)
195   (nndraft-possibly-change-group group)
196   (let ((gnus-verbose-backends nil))
197     (nnoo-parent-function 'nndraft 'nnmh-request-accept-article
198                           (list group server last noinsert))))
199
200 (deffoo nndraft-request-replace-article (article group buffer)
201   (nndraft-possibly-change-group group)
202   (let ((nnmail-file-coding-system
203          (if (equal group "drafts")
204              mm-auto-save-coding-system
205            mm-text-coding-system)))
206     (nnoo-parent-function 'nndraft 'nnmh-request-replace-article
207                           (list article group buffer))))
208
209 (deffoo nndraft-request-create-group (group &optional server args)
210   (nndraft-possibly-change-group group)
211   (if (file-exists-p nndraft-current-directory)
212       (if (file-directory-p nndraft-current-directory)
213           t
214         nil)
215     (condition-case ()
216         (progn
217           (gnus-make-directory nndraft-current-directory)
218           t)
219       (file-error nil))))
220
221 \f
222 ;;; Low-Level Interface
223
224 (defun nndraft-possibly-change-group (group)
225   (when (and group
226              (not (equal group nndraft-current-group)))
227     (nndraft-open-server "")
228     (setq nndraft-current-group group)
229     (setq nndraft-current-directory
230           (nnheader-concat nndraft-directory group))))
231
232 (defun nndraft-article-filename (article &rest args)
233   (apply 'concat
234          (file-name-as-directory nndraft-current-directory)
235          (int-to-string article)
236          args))
237
238 (defun nndraft-auto-save-file-name (file)
239   (save-excursion
240     (prog1
241         (progn
242           (set-buffer (get-buffer-create " *draft tmp*"))
243           (setq buffer-file-name file)
244           (make-auto-save-file-name))
245       (kill-buffer (current-buffer)))))
246
247 (defun nndraft-articles ()
248   "Return the list of messages in the group."
249   (gnus-make-directory nndraft-current-directory)
250   (sort
251    (mapcar 'string-to-int
252            (directory-files nndraft-current-directory nil "\\`[0-9]+\\'" t))
253    '<))
254
255 (nnoo-import nndraft
256   (nnmh
257    nnmh-retrieve-headers
258    nnmh-request-group
259    nnmh-close-group
260    nnmh-request-list
261    nnmh-request-newsgroups
262    nnmh-request-move-article))
263
264 (provide 'nndraft)
265
266 ;;; nndraft.el ends here