git.chise.org Git - elisp/gnus.git-/blob - lisp/nndraft.el

   1 ;;; nndraft.el --- draft article access for Gnus
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001
   4 ;;        Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval-when-compile (require 'cl))
  31
  32 (require 'nnheader)
  33 (require 'nnmail)
  34 (require 'gnus-start)
  35 (require 'nnmh)
  36 (require 'nnoo)
  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 nnheader-text-coding-system))
 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     ;; Articles in nndraft:queue are considered as sent messages.  The
 131     ;; Date field should be the time when they are sent.
 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-group (group &optional server dont-check)
 169   (nndraft-possibly-change-group group)
 170   (unless dont-check
 171     (let* ((pathname (nnmail-group-pathname group nndraft-directory))
 172            (file-name-coding-system nnmail-pathname-coding-system)
 173            dir file)
 174       (nnheader-re-read-dir pathname)
 175       (setq dir (mapcar (lambda (name) (string-to-int (substring name 1)))
 176                         (directory-files pathname nil "^#[0-9]+#$" t)))
 177       (dolist (n dir)
 178         (unless (file-exists-p
 179                  (setq file (expand-file-name (int-to-string n) pathname)))
 180           (rename-file (nndraft-auto-save-file-name file) file)))))
 181   (nnoo-parent-function 'nndraft
 182                         'nnmh-request-group
 183                         (list group server dont-check)))
 184
 185 (deffoo nndraft-request-expire-articles (articles group &optional server force)
 186   (nndraft-possibly-change-group group)
 187   (let* ((nnmh-allow-delete-final t)
 188          (res (nnoo-parent-function 'nndraft
 189                                     'nnmh-request-expire-articles
 190                                     (list articles group server force)))
 191          article)
 192     ;; Delete all the "state" files of articles that have been expired.
 193     (while articles
 194       (unless (memq (setq article (pop articles)) res)
 195         (let ((auto (nndraft-auto-save-file-name
 196                      (nndraft-article-filename article))))
 197           (when (file-exists-p auto)
 198             (funcall nnmail-delete-file-function auto)))
 199         (dolist (backup
 200                  (let ((kept-new-versions 1)
 201                        (kept-old-versions 0))
 202                    (find-backup-file-name
 203                     (nndraft-article-filename article))))
 204           (when (file-exists-p backup)
 205             (funcall nnmail-delete-file-function backup)))))
 206     res))
 207
 208 (deffoo nndraft-request-accept-article (group &optional server last noinsert)
 209   (nndraft-possibly-change-group group)
 210   (let ((gnus-verbose-backends nil))
 211     (nnoo-parent-function 'nndraft 'nnmh-request-accept-article
 212                           (list group server last noinsert))))
 213
 214 (deffoo nndraft-request-replace-article (article group buffer)
 215   (nndraft-possibly-change-group group)
 216   (let ((nnmail-file-coding-system nnheader-text-coding-system))
 217     (nnoo-parent-function 'nndraft 'nnmh-request-replace-article
 218                           (list article group buffer))))
 219
 220 (deffoo nndraft-request-create-group (group &optional server args)
 221   (nndraft-possibly-change-group group)
 222   (if (file-exists-p nndraft-current-directory)
 223       (if (file-directory-p nndraft-current-directory)
 224           t
 225         nil)
 226     (condition-case ()
 227         (progn
 228           (gnus-make-directory nndraft-current-directory)
 229           t)
 230       (file-error nil))))
 231
 232 \f
 233 ;;; Low-Level Interface
 234
 235 (defun nndraft-possibly-change-group (group)
 236   (when (and group
 237              (not (equal group nndraft-current-group)))
 238     (nndraft-open-server "")
 239     (setq nndraft-current-group group)
 240     (setq nndraft-current-directory
 241           (nnheader-concat nndraft-directory group))))
 242
 243 (defun nndraft-article-filename (article &rest args)
 244   (apply 'concat
 245          (file-name-as-directory nndraft-current-directory)
 246          (int-to-string article)
 247          args))
 248
 249 (defun nndraft-auto-save-file-name (file)
 250   (save-excursion
 251     (prog1
 252         (progn
 253           (set-buffer (get-buffer-create " *draft tmp*"))
 254           (setq buffer-file-name file)
 255           (make-auto-save-file-name))
 256       (kill-buffer (current-buffer)))))
 257
 258 (defun nndraft-articles ()
 259   "Return the list of messages in the group."
 260   (gnus-make-directory nndraft-current-directory)
 261   (sort
 262    (mapcar 'string-to-int
 263            (directory-files nndraft-current-directory nil "\\`[0-9]+\\'" t))
 264    '<))
 265
 266 (nnoo-import nndraft
 267   (nnmh
 268    nnmh-retrieve-headers
 269    nnmh-request-group
 270    nnmh-close-group
 271    nnmh-request-list
 272    nnmh-request-newsgroups
 273    nnmh-request-move-article))
 274
 275 (provide 'nndraft)
 276
 277 ;;; nndraft.el ends here