lisp/gnus/nnagent.el

   1 ;;; nnagent.el --- offline backend for Gnus
   2
   3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002
   4 ;;        Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news, mail
   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 (require 'nnheader)
  31 (require 'nnoo)
  32 (eval-when-compile (require 'cl))
  33 (require 'gnus-agent)
  34 (require 'nnml)
  35
  36 (nnoo-declare nnagent
  37   nnml)
  38
  39 \f
  40
  41 (defconst nnagent-version "nnagent 1.0")
  42
  43 (defvoo nnagent-directory nil
  44   "Internal variable."
  45   nnml-directory)
  46
  47 (defvoo nnagent-active-file nil
  48   "Internal variable."
  49   nnml-active-file)
  50
  51 (defvoo nnagent-newsgroups-file nil
  52   "Internal variable."
  53   nnml-newsgroups-file)
  54
  55 (defvoo nnagent-get-new-mail nil
  56   "Internal variable."
  57   nnml-get-new-mail)
  58
  59 ;;; Interface functions.
  60
  61 (nnoo-define-basics nnagent)
  62
  63 (defun nnagent-server (server)
  64   (and server (format "%s+%s" (car gnus-command-method) server)))
  65
  66 (deffoo nnagent-open-server (server &optional defs)
  67   (setq defs
  68         `((nnagent-directory ,(gnus-agent-directory))
  69           (nnagent-active-file ,(gnus-agent-lib-file "active"))
  70           (nnagent-newsgroups-file ,(gnus-agent-lib-file "newsgroups"))
  71           (nnagent-get-new-mail nil)))
  72   (nnoo-change-server 'nnagent
  73                       (nnagent-server server)
  74                       defs)
  75   (let ((dir (gnus-agent-directory))
  76         err)
  77     (cond
  78      ((not (condition-case arg
  79                (file-exists-p dir)
  80              (ftp-error (setq err (format "%s" arg)))))
  81       (nnagent-close-server)
  82       (nnheader-report
  83        'nnagent (or err
  84                     (format "No such file or directory: %s" dir))))
  85      ((not (file-directory-p (file-truename dir)))
  86       (nnagent-close-server)
  87       (nnheader-report 'nnagent "Not a directory: %s" dir))
  88      (t
  89       (nnheader-report 'nnagent "Opened server %s using directory %s"
  90                        server dir)
  91       t))))
  92
  93 (deffoo nnagent-retrieve-groups (groups &optional server)
  94   (save-excursion
  95     (cond
  96      ((file-exists-p (gnus-agent-lib-file "groups"))
  97       (nnmail-find-file (gnus-agent-lib-file "groups"))
  98       'groups)
  99      ((file-exists-p (gnus-agent-lib-file "active"))
 100       (nnmail-find-file (gnus-agent-lib-file "active"))
 101       'active)
 102      (t nil))))
 103
 104 (defun nnagent-request-type (group article)
 105   (unless (stringp article)
 106     (let ((gnus-plugged t))
 107       (if (not (gnus-check-backend-function
 108                 'request-type (car gnus-command-method)))
 109           'unknown
 110         (funcall (gnus-get-function gnus-command-method 'request-type)
 111                  (gnus-group-real-name group) article)))))
 112
 113 (deffoo nnagent-request-newgroups (date server)
 114   nil)
 115
 116 (deffoo nnagent-request-update-info (group info &optional server)
 117   nil)
 118
 119 (deffoo nnagent-request-post (&optional server)
 120   (gnus-agent-insert-meta-information 'news gnus-command-method)
 121   (gnus-request-accept-article "nndraft:queue" nil t t))
 122
 123 (deffoo nnagent-request-set-mark (group action server)
 124   (with-temp-buffer
 125     (insert (format "(%s-request-set-mark \"%s\" '%s \"%s\")\n"
 126                     (nth 0 gnus-command-method) group action
 127                     (or server (nth 1 gnus-command-method))))
 128     (append-to-file (point-min) (point-max) (gnus-agent-lib-file "flags")))
 129   nil)
 130
 131 (deffoo nnagent-retrieve-headers (articles &optional group server fetch-old)
 132   (let ((file (gnus-agent-article-name ".overview" group))
 133         arts n first)
 134     (save-excursion
 135       (gnus-agent-load-alist group)
 136       (setq arts (gnus-sorted-difference
 137                   articles (mapcar 'car gnus-agent-article-alist)))
 138       ;; Assume that articles with smaller numbers than the first one
 139       ;; Agent knows are gone.
 140       (setq first (caar gnus-agent-article-alist))
 141       (when first
 142         (while (and arts (< (car arts) first))
 143           (pop arts)))
 144       (set-buffer nntp-server-buffer)
 145       (erase-buffer)
 146       (nnheader-insert-nov-file file (car articles))
 147       (goto-char (point-min))
 148       (gnus-parse-without-error
 149         (while (and arts (not (eobp)))
 150           (setq n (read (current-buffer)))
 151           (when (> n (car arts))
 152             (beginning-of-line))
 153           (while (and arts (> n (car arts)))
 154             (insert (format
 155                      "%d\t[Undownloaded article %d]\tGnus Agent\t\t\t\n"
 156                      (car arts) (car arts)))
 157             (pop arts))
 158           (when (and arts (= n (car arts)))
 159             (pop arts))
 160           (forward-line 1)))
 161       (while arts
 162         (insert (format
 163                  "%d\t[Undownloaded article %d]\tGnus Agent\t\t\t\n"
 164                  (car arts) (car arts)))
 165         (pop arts))
 166       (if (and fetch-old
 167                (not (numberp fetch-old)))
 168           t                             ; Don't remove anything.
 169         (nnheader-nov-delete-outside-range
 170          (if fetch-old (max 1 (- (car articles) fetch-old))
 171            (car articles))
 172          (car (last articles)))
 173         t)
 174       'nov)))
 175
 176 (deffoo nnagent-request-expire-articles (articles group &optional server force)
 177   articles)
 178
 179 (deffoo nnagent-request-group (group &optional server dont-check)
 180   (nnoo-parent-function 'nnagent 'nnml-request-group
 181                         (list group (nnagent-server server) dont-check)))
 182
 183 (deffoo nnagent-close-group (group &optional server)
 184   (nnoo-parent-function 'nnagent 'nnml-close-group
 185                         (list group (nnagent-server server))))
 186
 187 (deffoo nnagent-request-accept-article (group &optional server last)
 188   (nnoo-parent-function 'nnagent 'nnml-request-accept-article
 189                         (list group (nnagent-server server) last)))
 190
 191 (deffoo nnagent-request-article (id &optional group server buffer)
 192   (nnoo-parent-function 'nnagent 'nnml-request-article
 193                         (list id group (nnagent-server server) buffer)))
 194
 195 (deffoo nnagent-request-create-group (group &optional server args)
 196   (nnoo-parent-function 'nnagent 'nnml-request-create-group
 197                         (list group (nnagent-server server) args)))
 198
 199 (deffoo nnagent-request-delete-group (group &optional force server)
 200   (nnoo-parent-function 'nnagent 'nnml-request-delete-group
 201                         (list group force (nnagent-server server))))
 202
 203 (deffoo nnagent-request-list (&optional server)
 204   (nnoo-parent-function 'nnagent 'nnml-request-list
 205                         (list (nnagent-server server))))
 206
 207 (deffoo nnagent-request-list-newsgroups (&optional server)
 208   (nnoo-parent-function 'nnagent 'nnml-request-list-newsgroups
 209                         (list (nnagent-server server))))
 210
 211 (deffoo nnagent-request-move-article
 212     (article group server accept-form &optional last)
 213   (nnoo-parent-function 'nnagent 'nnml-request-move-article
 214                         (list article group (nnagent-server server)
 215                               accept-form last)))
 216
 217 (deffoo nnagent-request-rename-group (group new-name &optional server)
 218   (nnoo-parent-function 'nnagent 'nnml-request-rename-group
 219                         (list group new-name (nnagent-server server))))
 220
 221 (deffoo nnagent-request-scan (&optional group server)
 222   (nnoo-parent-function 'nnagent 'nnml-request-scan
 223                         (list group (nnagent-server server))))
 224
 225 (deffoo nnagent-set-status (article name value &optional group server)
 226   (nnoo-parent-function 'nnagent 'nnml-set-status
 227                         (list article name value group (nnagent-server server))))
 228
 229 (deffoo nnagent-server-opened (&optional server)
 230   (nnoo-parent-function 'nnagent 'nnml-server-opened
 231                         (list (nnagent-server server))))
 232
 233 (deffoo nnagent-status-message (&optional server)
 234   (nnoo-parent-function 'nnagent 'nnml-status-message
 235                         (list (nnagent-server server))))
 236
 237 (deffoo nnagent-request-regenerate (server)
 238   (nnoo-parent-function 'nnagent 'nnml-request-regenerate
 239                         (list (nnagent-server server))))
 240
 241 ;; Use nnml functions for just about everything.
 242 (nnoo-import nnagent
 243   (nnml))
 244
 245 \f
 246 ;;; Internal functions.
 247
 248 (provide 'nnagent)
 249
 250 ;;; arch-tag: af710b77-f816-4969-af31-6fd94fb42245
 251 ;;; nnagent.el ends here