1 ;;; nndb.el --- nndb access for Gnus
3 ;; Copyright (C) 1997, 1998, 2000, 2003, 2004 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Kai Grossjohann <grossjohann@ls6.informatik.uni-dortmund.de>
7 ;; Joe Hildebrand <joe.hildebrand@ilg.com>
8 ;; David Blacka <davidb@rwhois.net>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;;; This was based upon Kai Grossjohan's shamessly snarfed code and
31 ;;; further modified by Joe Hildebrand. It has been updated for Red
36 ;; * Fix bug where server connection can be lost and impossible to regain
37 ;; This hasn't happened to me in a while; think it was fixed in Rgnus
39 ;; * make it handle different nndb servers seemlessly
41 ;; * Optimize expire if FORCE
43 ;; * Optimize move (only expire once)
45 ;; * Deal with add/deletion of groups
47 ;; * make the backend TOUCH an article when marked as expireable (will
48 ;; make article expire 'expiry' days after that moment).
51 ;; Register nndb with known select methods.
53 (gnus-declare-backend "nndb" 'mail 'respool 'address 'prompt-address)
60 (eval-when-compile (require 'cl))
63 (autoload 'telnet-send-input "telnet" nil t)
64 (autoload 'gnus-declare-backend "gnus-start"))
66 ;; Declare nndb as derived from nntp
68 (nnoo-declare nndb nntp)
70 ;; Variables specific to nndb
72 ;;- currently not used but just in case...
73 (defvoo nndb-deliver-program "nndel"
74 "*The program used to put a message in an NNDB group.")
76 (defvoo nndb-server-side-expiry nil
77 "If t, expiry calculation will occur on the server side.")
79 (defvoo nndb-set-expire-date-on-mark nil
80 "If t, the expiry date for a given article will be set to the time
81 it was marked as expireable; otherwise the date will be the time the
82 article was posted to nndb")
84 ;; Variables copied from nntp
86 (defvoo nndb-server-opened-hook '(nntp-send-authinfo-from-file)
87 "Like nntp-server-opened-hook."
88 nntp-server-opened-hook)
90 (defvoo nndb-address "localhost"
91 "*The name of the NNDB server."
94 (defvoo nndb-port-number 9000
95 "*Port number to connect to."
98 ;; change to 'news if you are actually using nndb for news
99 (defvoo nndb-article-type 'mail)
101 (defvoo nndb-status-string nil "" nntp-status-string)
105 (defconst nndb-version "nndb 0.7"
106 "Version numbers of this version of NNDB.")
109 ;;; Interface functions.
111 (nnoo-define-basics nndb)
113 ;;------------------------------------------------------------------
115 ;; this function turns the lisp list into a string list. There is
116 ;; probably a more efficient way to do this.
117 (defun nndb-build-article-string (articles)
118 (let (art-string art)
120 (setq art (pop articles))
121 (setq art-string (concat art-string art " ")))
124 (defun nndb-build-expire-rest-list (total expire)
127 (setq art (pop total))
128 (if (memq art expire)
135 (deffoo nndb-request-type (group &optional article)
138 ;; nndb-request-update-info does not exist and is not needed
140 ;; nndb-request-update-mark does not exist; it should be used to TOUCH
141 ;; articles as they are marked exipirable
142 (defun nndb-touch-article (group article)
143 (nntp-send-command nil "X-TOUCH" article))
145 (deffoo nndb-request-update-mark
147 "Sets the expiry date for ARTICLE in GROUP to now, if the mark is 'E'"
148 (if (and nndb-set-expire-date-on-mark (string-equal mark "E"))
149 (nndb-touch-article group article))
152 ;; nndb-request-create-group -- currently this isn't necessary; nndb
153 ;; creates groups on demand.
155 ;; todo -- use some other time than the creation time of the article
156 ;; best is time since article has been marked as expirable
158 (defun nndb-request-expire-articles-local
159 (articles &optional group server force)
160 "Let gnus do the date check and issue the delete commands."
161 (let (msg art delete-list (num-delete 0) rest)
162 (nntp-possibly-change-group group server)
164 (setq art (pop articles))
165 (nntp-send-command "^\\([23]\\|^423\\).*\n" "X-DATE" art)
166 (setq msg (nndb-status-message))
167 (if (string-match "^423" msg)
169 (or (string-match "'\\(.+\\)'" msg)
170 (error "Not a valid response for X-DATE command: %s"
172 (if (nnmail-expired-article-p
174 (date-to-time (substring msg (match-beginning 1) (match-end 1)))
177 (setq delete-list (concat delete-list " " (int-to-string art)))
178 (setq num-delete (1+ num-delete)))
180 (if (> (length delete-list) 0)
182 (nnheader-message 5 "Deleting %s article(s) from %s"
183 (int-to-string num-delete) group)
184 (nntp-send-command "^[23].*\n" "X-DELETE" delete-list))
187 (nnheader-message 5 "")
188 (nconc rest articles)))
190 (defun nndb-get-remote-expire-response ()
192 (set-buffer nntp-server-buffer)
193 (goto-char (point-min))
194 (if (looking-at "^[34]")
195 ;; x-expire returned error--presume no articles were expirable)
197 ;; otherwise, pull all of the following numbers into the list
198 (re-search-forward "follows\r?\n?" nil t)
199 (while (re-search-forward "^[0-9]+$" nil t)
200 (push (string-to-int (match-string 0)) list)))
203 (defun nndb-request-expire-articles-remote
204 (articles &optional group server force)
205 "Let the nndb backend expire articles"
206 (let (days art-string delete-list (num-delete 0))
207 (nntp-possibly-change-group group server)
209 ;; first calculate the wait period in days
210 (setq days (or (and nnmail-expiry-wait-function
211 (funcall nnmail-expiry-wait-function group))
213 ;; now handle the special cases
217 ;; This isn't an expirable group.
219 ((eq days 'immediate)
223 ;; build article string
224 (setq art-string (concat days " " (nndb-build-article-string articles)))
225 (nntp-send-command "^\.\r?\n\\|^[345].*\n" "X-EXPIRE" art-string)
227 (setq delete-list (nndb-get-remote-expire-response))
228 (setq num-delete (length delete-list))
230 (nnheader-message 5 "Deleting %s article(s) from %s"
231 (int-to-string num-delete) group))
233 (nndb-build-expire-rest-list articles delete-list)))
235 (deffoo nndb-request-expire-articles
236 (articles &optional group server force)
237 "Expires ARTICLES from GROUP on SERVER.
238 If FORCE, delete regardless of exiration date, otherwise use normal
240 (if nndb-server-side-expiry
241 (nndb-request-expire-articles-remote articles group server force)
242 (nndb-request-expire-articles-local articles group server force)))
244 (deffoo nndb-request-move-article
245 (article group server accept-form &optional last)
246 "Move ARTICLE (a number) from GROUP on SERVER.
247 Evals ACCEPT-FORM in current buffer, where the article is.
248 Optional LAST is ignored."
249 ;; we guess that the second arg in accept-form is the new group,
250 ;; which it will be for nndb, which is all that matters anyway
251 (let ((new-group (nth 1 accept-form)) result)
252 (nntp-possibly-change-group group server)
254 ;; use the move command for nndb-to-nndb moves
255 (if (string-match "^nndb" new-group)
256 (let ((new-group-name (gnus-group-real-name new-group)))
257 (nntp-send-command "^[23].*\n" "X-MOVE" article new-group-name)
258 (cons new-group article))
259 ;; else move normally
260 (let ((artbuf (get-buffer-create " *nndb move*")))
262 (nndb-request-article article group server artbuf)
265 (insert-buffer-substring nntp-server-buffer)
266 (setq result (eval accept-form))
267 (kill-buffer (current-buffer))
269 (nndb-request-expire-articles (list article)
276 (deffoo nndb-request-accept-article (group server &optional last)
277 "The article in the current buffer is put into GROUP."
278 (nntp-possibly-change-group group server)
280 (when (nntp-send-command "^[23].*\r?\n" "ACCEPT" group)
282 (nntp-send-buffer "^[23].*\n"))
284 (set-buffer nntp-server-buffer)
285 (setq msg (buffer-string))
286 (or (string-match "^\\([0-9]+\\)" msg)
287 (error "nndb: %s" msg))
288 (setq art (substring msg (match-beginning 1) (match-end 1)))
289 (nnheader-message 5 "nndb: accepted %s" art)
292 (deffoo nndb-request-replace-article (article group buffer)
293 "ARTICLE is the number of the article in GROUP to be replaced with the contents of the BUFFER."
295 (when (nntp-send-command "^[23].*\r?\n" "X-REPLACE" (int-to-string article))
297 (nntp-send-buffer "^[23.*\n")
298 (list (int-to-string article))))
300 ; nndb-request-delete-group does not exist
301 ; todo -- maybe later
303 ; nndb-request-rename-group does not exist
304 ; todo -- maybe later
306 ;; -- standard compatability functions
308 (deffoo nndb-status-message (&optional server)
309 "Return server status as a string."
310 (set-buffer nntp-server-buffer)
313 ;; Import stuff from nntp
320 ;;; nndb.el ends here