1 ;;; nnagent.el --- offline backend for Gnus
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
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)
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.
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., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
32 (eval-when-compile (require 'cl))
41 (defconst nnagent-version "nnagent 1.0")
43 (defvoo nnagent-directory nil
47 (defvoo nnagent-active-file nil
51 (defvoo nnagent-newsgroups-file nil
55 (defvoo nnagent-get-new-mail nil
59 ;;; Interface functions.
61 (nnoo-define-basics nnagent)
63 (defun nnagent-server (server)
64 (and server (format "%s+%s" (car gnus-command-method) server)))
66 (deffoo nnagent-open-server (server &optional 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)
75 (let ((dir (gnus-agent-directory))
78 ((not (condition-case arg
80 (ftp-error (setq err (format "%s" arg)))))
81 (nnagent-close-server)
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))
89 (nnheader-report 'nnagent "Opened server %s using directory %s"
93 (deffoo nnagent-retrieve-groups (groups &optional server)
96 ((file-exists-p (gnus-agent-lib-file "groups"))
97 (nnmail-find-file (gnus-agent-lib-file "groups"))
99 ((file-exists-p (gnus-agent-lib-file "active"))
100 (nnmail-find-file (gnus-agent-lib-file "active"))
104 (defun nnagent-request-type (group article)
105 (unless (stringp article)
106 (let ((gnus-agent nil))
107 (if (not (gnus-check-backend-function
108 'request-type (car gnus-command-method)))
110 (funcall (gnus-get-function gnus-command-method 'request-type)
111 (gnus-group-real-name group) article)))))
113 (deffoo nnagent-request-newgroups (date server)
116 (deffoo nnagent-request-update-info (group info &optional server)
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))
123 (deffoo nnagent-request-set-mark (group action server)
125 (insert "(gnus-agent-synchronize-group-flags \""
130 (gnus-method-to-server gnus-command-method)
133 (write-region (point-min) (point-max) (gnus-agent-lib-file "flags")
137 (deffoo nnagent-retrieve-headers (articles &optional group server fetch-old)
138 (let ((file (gnus-agent-article-name ".overview" group))
141 (gnus-agent-load-alist group)
142 (setq arts (gnus-sorted-difference
143 articles (mapcar 'car gnus-agent-article-alist)))
144 ;; Assume that articles with smaller numbers than the first one
145 ;; Agent knows are gone.
146 (setq first (caar gnus-agent-article-alist))
148 (while (and arts (< (car arts) first))
150 (set-buffer nntp-server-buffer)
152 (nnheader-insert-nov-file file (car articles))
153 (goto-char (point-min))
154 (gnus-parse-without-error
155 (while (and arts (not (eobp)))
156 (setq n (read (current-buffer)))
157 (when (> n (car arts))
159 (while (and arts (> n (car arts)))
161 "%d\t[Undownloaded article %d]\tGnus Agent\t\t\t\n"
162 (car arts) (car arts)))
164 (when (and arts (= n (car arts)))
169 "%d\t[Undownloaded article %d]\tGnus Agent\t\t\t\n"
170 (car arts) (car arts)))
173 (not (numberp fetch-old)))
174 t ; Don't remove anything.
175 (nnheader-nov-delete-outside-range
176 (if fetch-old (max 1 (- (car articles) fetch-old))
178 (car (last articles)))
182 (deffoo nnagent-request-expire-articles (articles group &optional server force)
185 (deffoo nnagent-request-group (group &optional server dont-check)
186 (nnoo-parent-function 'nnagent 'nnml-request-group
187 (list group (nnagent-server server) dont-check)))
189 (deffoo nnagent-close-group (group &optional server)
190 (nnoo-parent-function 'nnagent 'nnml-close-group
191 (list group (nnagent-server server))))
193 (deffoo nnagent-request-accept-article (group &optional server last)
194 (nnoo-parent-function 'nnagent 'nnml-request-accept-article
195 (list group (nnagent-server server) last)))
197 (deffoo nnagent-request-article (id &optional group server buffer)
198 (nnoo-parent-function 'nnagent 'nnml-request-article
199 (list id group (nnagent-server server) buffer)))
201 (deffoo nnagent-request-create-group (group &optional server args)
202 (nnoo-parent-function 'nnagent 'nnml-request-create-group
203 (list group (nnagent-server server) args)))
205 (deffoo nnagent-request-delete-group (group &optional force server)
206 (nnoo-parent-function 'nnagent 'nnml-request-delete-group
207 (list group force (nnagent-server server))))
209 (deffoo nnagent-request-list (&optional server)
210 (nnoo-parent-function 'nnagent 'nnml-request-list
211 (list (nnagent-server server))))
213 (deffoo nnagent-request-list-newsgroups (&optional server)
214 (nnoo-parent-function 'nnagent 'nnml-request-list-newsgroups
215 (list (nnagent-server server))))
217 (deffoo nnagent-request-move-article
218 (article group server accept-form &optional last move-is-internal)
219 (nnoo-parent-function 'nnagent 'nnml-request-move-article
220 (list article group (nnagent-server server)
221 accept-form last move-is-internal)))
223 (deffoo nnagent-request-rename-group (group new-name &optional server)
224 (nnoo-parent-function 'nnagent 'nnml-request-rename-group
225 (list group new-name (nnagent-server server))))
227 (deffoo nnagent-request-scan (&optional group server)
228 (nnoo-parent-function 'nnagent 'nnml-request-scan
229 (list group (nnagent-server server))))
231 (deffoo nnagent-set-status (article name value &optional group server)
232 (nnoo-parent-function 'nnagent 'nnml-set-status
233 (list article name value group (nnagent-server server))))
235 (deffoo nnagent-server-opened (&optional server)
236 (nnoo-parent-function 'nnagent 'nnml-server-opened
237 (list (nnagent-server server))))
239 (deffoo nnagent-status-message (&optional server)
240 (nnoo-parent-function 'nnagent 'nnml-status-message
241 (list (nnagent-server server))))
243 (deffoo nnagent-request-regenerate (server)
244 (nnoo-parent-function 'nnagent 'nnml-request-regenerate
245 (list (nnagent-server server))))
247 ;; Use nnml functions for just about everything.
252 ;;; Internal functions.
256 ;;; arch-tag: af710b77-f816-4969-af31-6fd94fb42245
257 ;;; nnagent.el ends here