1 ;;; nnrss.el --- interfacing with RSS
2 ;; Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
4 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published
11 ;; by the Free Software Foundation; either version 2, or (at your
12 ;; option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful, but
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 ;; General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
28 (eval-when-compile (require 'cl))
42 (eval '(require 'xml))
46 (defvoo nnrss-directory (nnheader-concat gnus-directory "rss/")
47 "Where nnrss will save its files.")
49 ;; (group max rss-url)
50 (defvoo nnrss-server-data nil)
52 ;; (num timestamp url subject author date extra)
53 (defvoo nnrss-group-data nil)
54 (defvoo nnrss-group-max 0)
55 (defvoo nnrss-group-min 1)
56 (defvoo nnrss-group nil)
57 (defvoo nnrss-group-hashtb (make-hash-table :test 'equal))
58 (defvoo nnrss-status-string "")
60 (defconst nnrss-version "nnrss 1.0")
62 (defvar nnrss-group-alist '()
63 "List of RSS addresses.")
65 (defvar nnrss-use-local nil)
67 (defvar nnrss-description-field 'X-Gnus-Description
68 "Field name used for DESCRIPTION.
69 To use the description in headers, put this name into `nnmail-extra-headers'.")
71 (defvar nnrss-url-field 'X-Gnus-Url
72 "Field name used for URL.
73 To use the description in headers, put this name into `nnmail-extra-headers'.")
75 (defvar nnrss-content-function nil
76 "A function which is called in `nnrss-request-article'.
77 The arguments are (ENTRY GROUP ARTICLE).
78 ENTRY is the record of the current headline. GROUP is the group name.
79 ARTICLE is the article number of the current headline.")
81 (nnoo-define-basics nnrss)
83 ;;; Interface functions
85 (deffoo nnrss-retrieve-headers (articles &optional group server fetch-old)
86 (nnrss-possibly-change-group group server)
89 (set-buffer nntp-server-buffer)
91 (dolist (article articles)
92 (if (setq e (assq article nnrss-group-data))
93 (insert (number-to-string (car e)) "\t" ;; number
95 (nnrss-format-string (nth 3 e)) "")
98 (nnrss-format-string (nth 4 e))
103 (format "<%d@%s.nnrss>" (car e) group)
110 (memq nnrss-description-field
111 nnmail-extra-headers))
112 (concat (symbol-name nnrss-description-field)
114 (nnrss-format-string (nth 6 e))
118 (memq nnrss-url-field
119 nnmail-extra-headers))
120 (concat (symbol-name nnrss-url-field)
122 (nnrss-format-string (nth 2 e))
128 (deffoo nnrss-request-group (group &optional server dont-check)
129 (nnrss-possibly-change-group group server)
132 (nnrss-check-group group server)
133 (nnheader-report 'nnrss "Opened group %s" group)
135 "211 %d %d %d %s\n" nnrss-group-max nnrss-group-min nnrss-group-max
136 (prin1-to-string group)
139 (deffoo nnrss-close-group (group &optional server)
142 (deffoo nnrss-request-article (article &optional group server buffer)
143 (nnrss-possibly-change-group group server)
144 (let ((e (assq article nnrss-group-data))
145 (boundary "=-=-=-=-=-=-=-=-=-")
146 (nntp-server-buffer (or buffer nntp-server-buffer))
150 (with-current-buffer nntp-server-buffer
152 (goto-char (point-min))
153 (insert "Mime-Version: 1.0\nContent-Type: multipart/alternative; boundary=\"" boundary "\"\n")
155 (insert "Newsgroups: " group "\n"))
157 (insert "Subject: " (nnrss-format-string (nth 3 e)) "\n"))
159 (insert "From: " (nnrss-format-string (nth 4 e)) "\n"))
161 (insert "Date: " (nnrss-format-string (nth 5 e)) "\n"))
162 (insert "Message-ID: " (format "<%d@%s.nnrss>" (car e) group) "\n")
164 (let ((text (if (nth 6 e)
165 (nnrss-string-as-multibyte (nth 6 e))))
168 (insert "\n\n--" boundary "\nContent-Type: text/plain\n\n")
169 (let ((point (point)))
173 (while (re-search-forward "\n" nil t)
175 (goto-char (point-max))
179 (insert "\n\n--" boundary "\nContent-Type: text/html\n\n")
180 (let ((point (point)))
182 (insert "<html><head></head><body>\n" text "\n</body></html>")
184 (while (re-search-forward "\n" nil t)
186 (goto-char (point-max))
189 (insert "<p><a href=\"" link "\">link</a></p>\n"))))
190 (when nnrss-content-function
191 (funcall nnrss-content-function e group article)))))
194 (nnheader-report 'nnrss err))
196 (nnheader-report 'nnrss "no such id: %d" article))
198 (nnheader-report 'nnrss "article %s retrieved" (car e))
199 ;; we return the article number.
200 (cons nnrss-group (car e))))))
202 (deffoo nnrss-request-list (&optional server)
203 (nnrss-possibly-change-group nil server)
204 (nnrss-generate-active)
207 (deffoo nnrss-open-server (server &optional defs connectionless)
208 (nnrss-read-server-data server)
209 (nnoo-change-server 'nnrss server defs)
212 (deffoo nnrss-request-expire-articles
213 (articles group &optional server force)
214 (nnrss-possibly-change-group group server)
215 (let (e days not-expirable changed)
216 (dolist (art articles)
217 (if (and (setq e (assq art nnrss-group-data))
218 (nnmail-expired-article-p
220 (if (listp (setq days (nth 1 e))) days
221 (days-to-time (- days (time-to-days '(0 0)))))
223 (setq nnrss-group-data (delq e nnrss-group-data)
225 (push art not-expirable)))
227 (nnrss-save-group-data group server))
230 (deffoo nnrss-request-delete-group (group &optional force server)
231 (nnrss-possibly-change-group group server)
232 (setq nnrss-server-data
233 (delq (assoc group nnrss-server-data) nnrss-server-data))
234 (nnrss-save-server-data server)
236 (delete-file (nnrss-make-filename group server)))
239 (deffoo nnrss-request-list-newsgroups (&optional server)
240 (nnrss-possibly-change-group nil server)
242 (set-buffer nntp-server-buffer)
244 (dolist (elem nnrss-group-alist)
246 (insert (car elem) "\t" (third elem) "\n"))))
249 (nnoo-define-skeleton nnrss)
251 ;;; Internal functions
252 (eval-when-compile (defun xml-rpc-method-call (&rest args)))
253 (defun nnrss-fetch (url &optional local)
254 "Fetch URL and put it in a the expected Lisp structure."
256 ;some CVS versions of url.el need this to close the connection quickly
257 (let* (xmlform htmlform)
258 ;; bit o' work necessary for w3 pre-cvs and post-cvs
260 (let ((coding-system-for-read 'binary))
261 (insert-file-contents url))
264 ;; Because xml-parse-region can't deal with anything that isn't
265 ;; xml and w3-parse-buffer can't deal with some xml, we have to
266 ;; parse with xml-parse-region first and, if that fails, parse
267 ;; with w3-parse-buffer. Yuck. Eventually, someone should find out
268 ;; why w3-parse-buffer fails to parse some well-formed xml and
272 (setq xmlform (xml-parse-region (point-min) (point-max)))
273 (error (if (fboundp 'w3-parse-buffer)
274 (setq htmlform (caddar (w3-parse-buffer
276 (message "nnrss: Not valid XML and w3 parse not available (%s)"
282 (defun nnrss-possibly-change-group (&optional group server)
284 (not (nnrss-server-opened server)))
285 (nnrss-open-server server))
286 (when (and group (not (equal group nnrss-group)))
287 (nnrss-read-group-data group server)
288 (setq nnrss-group group)))
290 (defvar nnrss-extra-categories '(nnrss-snarf-moreover-categories))
292 (defun nnrss-generate-active ()
293 (if (y-or-n-p "Fetch extra categories? ")
294 (dolist (func nnrss-extra-categories)
297 (set-buffer nntp-server-buffer)
299 (dolist (elem nnrss-group-alist)
300 (insert (prin1-to-string (car elem)) " 0 1 y\n"))
301 (dolist (elem nnrss-server-data)
302 (unless (assoc (car elem) nnrss-group-alist)
303 (insert (prin1-to-string (car elem)) " 0 1 y\n")))))
307 (defun nnrss-read-server-data (server)
308 (setq nnrss-server-data nil)
309 (let ((file (nnrss-make-filename "nnrss" server)))
310 (when (file-exists-p file)
311 (let ((coding-system-for-read 'binary))
312 (load file nil nil t)))))
314 (defun nnrss-save-server-data (server)
315 (gnus-make-directory nnrss-directory)
316 (let ((coding-system-for-write 'binary))
317 (with-temp-file (nnrss-make-filename "nnrss" server)
318 (gnus-prin1 `(setq nnrss-group-alist ',nnrss-group-alist))
319 (gnus-prin1 `(setq nnrss-server-data ',nnrss-server-data)))))
321 (defun nnrss-read-group-data (group server)
322 (setq nnrss-group-data nil)
323 (if (hash-table-p nnrss-group-hashtb)