* net/newst-treeview.el (newsticker-groups-filename):
[emacs.git] / lisp / net / newst-backend.el
blob56254ccd5395d9867f6139127451eea0fac95419
1 ;;; newst-backend.el --- Retrieval backend for newsticker.
3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Author: Ulf Jasper <ulf.jasper@web.de>
7 ;; Filename: newst-backend.el
8 ;; URL: http://www.nongnu.org/newsticker
9 ;; Keywords: News, RSS, Atom
10 ;; Time-stamp: "23. Januar 2009, 19:39:22 (ulf)"
12 ;; ======================================================================
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software: you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation, either version 3 of the License, or
19 ;; (at your option) any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; ======================================================================
31 ;;; Commentary:
33 ;; See newsticker.el
35 ;; ======================================================================
36 ;;; Code:
38 (require 'derived)
39 (require 'xml)
41 ;; Silence warnings
42 (defvar w3-mode-map)
43 (defvar w3m-minor-mode-map)
46 (defvar newsticker--retrieval-timer-list nil
47 "List of timers for news retrieval.
48 This is an alist, each element consisting of (feed-name . timer).")
50 (defvar newsticker--download-logos nil
51 "If non-nil download feed logos if available.")
53 (defvar newsticker--sentinel-callback nil
54 "Function called at end of `newsticker--sentinel'.")
56 ;;;###autoload
57 (defun newsticker-running-p ()
58 "Check whether newsticker is running.
59 Return t if newsticker is running, nil otherwise. Newsticker is
60 considered to be running if the newsticker timer list is not empty."
61 (> (length newsticker--retrieval-timer-list) 0))
63 ;; ======================================================================
64 ;;; Customization
65 ;; ======================================================================
66 (defgroup newsticker nil
67 "Aggregator for RSS and Atom feeds."
68 :group 'applications)
70 (defconst newsticker--raw-url-list-defaults
71 '(("CNET News.com"
72 "http://export.cnet.com/export/feeds/news/rss/1,11176,,00.xml")
73 ("Debian Security Advisories"
74 "http://www.debian.org/security/dsa.en.rdf")
75 ("Debian Security Advisories - Long format"
76 "http://www.debian.org/security/dsa-long.en.rdf")
77 ("Emacs Wiki"
78 "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
79 nil
80 3600)
81 ("Freshmeat.net"
82 "http://freshmeat.net/index.atom")
83 ("Kuro5hin.org"
84 "http://www.kuro5hin.org/backend.rdf")
85 ("LWN (Linux Weekly News)"
86 "http://lwn.net/headlines/rss")
87 ("NY Times: Technology"
88 "http://partners.userland.com/nytRss/technology.xml")
89 ("NY Times"
90 "http://partners.userland.com/nytRss/nytHomepage.xml")
91 ("Quote of the day"
92 "http://www.quotationspage.com/data/qotd.rss"
93 "07:00"
94 86400)
95 ("The Register"
96 "http://www.theregister.co.uk/tonys/slashdot.rdf")
97 ("slashdot"
98 "http://slashdot.org/index.rss"
99 nil
100 3600) ;/. will ban you if under 3600 seconds!
101 ("Wired News"
102 "http://www.wired.com/news_drop/netcenter/netcenter.rdf")
103 ("Heise News (german)"
104 "http://www.heise.de/newsticker/heise.rdf")
105 ("Tagesschau (german)"
106 "http://www.tagesschau.de/newsticker.rdf"
108 1800)
109 ("Telepolis (german)"
110 "http://www.heise.de/tp/news.rdf"))
111 "Default URL list in raw form.
112 This list is fed into defcustom via `newsticker--splicer'.")
114 (defun newsticker--splicer (item)
115 "Convert ITEM for splicing into `newsticker-url-list-defaults'."
116 (let ((result (list 'list :tag (nth 0 item) (list 'const (nth 0 item))))
117 (element (cdr item)))
118 (while element
119 (setq result (append result (list (list 'const (car element)))))
120 (setq element (cdr element)))
121 result))
123 (defun newsticker--set-customvar-retrieval (symbol value)
124 "Set retrieval related newsticker-variable SYMBOL value to VALUE.
125 Calls all actions which are necessary in order to make the new
126 value effective."
127 (if (or (not (boundp symbol))
128 (equal (symbol-value symbol) value))
129 (set symbol value)
130 ;; something must have changed
131 (let ((need-restart nil)
132 (new-or-changed-feeds nil)
133 (removed-feeds))
134 (cond ((eq symbol 'newsticker-retrieval-interval)
135 (setq need-restart t))
136 ((memq symbol '(newsticker-url-list-defaults newsticker-url-list))
137 (dolist (elt value)
138 (unless (member elt (symbol-value symbol))
139 (setq new-or-changed-feeds (cons elt new-or-changed-feeds))))
140 (dolist (elt (symbol-value symbol))
141 (unless (member elt value)
142 (setq removed-feeds (cons elt removed-feeds))))))
143 (cond (need-restart
144 (set symbol value)
145 (when (newsticker-running-p)
146 (message "Restarting newsticker")
147 (newsticker-stop)
148 (newsticker-start)))
150 (dolist (feed removed-feeds)
151 (message "Stopping feed `%s'" (car feed))
152 (newsticker--stop-feed (car feed)))
153 (dolist (feed new-or-changed-feeds)
154 (message "Starting feed `%s'" (car feed))
155 (newsticker--stop-feed (car feed))
156 (newsticker--start-feed feed))
157 (unless new-or-changed-feeds
158 (when newsticker--sentinel-callback
159 (funcall newsticker--sentinel-callback)))))
160 (set symbol value))))
162 ;; ======================================================================
163 ;; retrieval
164 (defgroup newsticker-retrieval nil
165 "Settings for news retrieval."
166 :group 'newsticker)
168 (defcustom newsticker-url-list-defaults
169 '(("Emacs Wiki"
170 "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
172 3600))
173 "A customizable list of news feeds to select from.
174 These were mostly extracted from the Radio Community Server at
175 http://subhonker6.userland.com/rcsPublic/rssHotlist.
177 You may add other entries in `newsticker-url-list'."
178 :type `(set ,@(mapcar `newsticker--splicer
179 newsticker--raw-url-list-defaults))
180 :set 'newsticker--set-customvar-retrieval
181 :group 'newsticker-retrieval)
183 (defcustom newsticker-url-list nil
184 "The news feeds which you like to watch.
186 This alist will be used in addition to selection made customizing
187 `newsticker-url-list-defaults'.
189 This is an alist. Each element consists of two items: a LABEL and a URL,
190 optionally followed by a START-TIME, INTERVAL specifier and WGET-ARGUMENTS.
192 The LABEL gives the name of the news feed. It can be an arbitrary string.
194 The URL gives the location of the news feed. It must point to a valid
195 RSS or Atom file. The file is retrieved by calling wget, or whatever you
196 specify as `newsticker-wget-name'.
198 URL may also be a function which returns news data. In this case
199 `newsticker-retrieval-method' etc. are ignored for this feed.
201 The START-TIME can be either a string, or nil. If it is a string it
202 specifies a fixed time at which this feed shall be retrieved for the
203 first time. (Examples: \"11:00pm\", \"23:00\".) If it is nil (or
204 unspecified), this feed will be retrieved immediately after calling
205 `newsticker-start'.
207 The INTERVAL specifies the time between retrievals for this feed. If it
208 is nil (or unspecified) the default interval value as set in
209 `newsticker-retrieval-interval' is used.
211 \(newsticker.el calls `run-at-time'. The newsticker-parameters START-TIME
212 and INTERVAL correspond to the `run-at-time'-parameters TIME and REPEAT.)
214 WGET-ARGUMENTS specifies arguments for wget (see `newsticker-wget-name')
215 which apply for this feed only, overriding the value of
216 `newsticker-wget-arguments'."
217 :type '(repeat (list :tag "News feed"
218 (string :tag "Label")
219 (choice :tag "URI"
220 (string :tag "String")
221 (function :tag "Function"))
222 (choice :tag "Start"
223 (const :tag "Default" nil)
224 (string :tag "Fixed Time"))
225 (choice :tag "Interval"
226 (const :tag "Default" nil)
227 (const :tag "Hourly" 3600)
228 (const :tag "Daily" 86400)
229 (const :tag "Weekly" 604800)
230 (integer :tag "Interval"))
231 (choice :tag "Wget Arguments"
232 (const :tag "Default arguments" nil)
233 (repeat :tag "Special arguments" string))))
234 :set 'newsticker--set-customvar-retrieval
235 :group 'newsticker-retrieval)
237 (defcustom newsticker-retrieval-method
238 'intern
239 "Method for retrieving news from the web, either `intern' or `extern'.
240 Default value `intern' uses Emacs' built-in asynchronous download
241 capabilities ('url-retrieve'). If set to `extern' the external
242 program wget is used, see `newsticker-wget-name'."
243 :type '(choice :tag "Method"
244 (const :tag "Intern" intern)
245 (const :tag "Extern" extern))
246 :group 'newsticker-retrieval)
248 (defcustom newsticker-wget-name
249 "wget"
250 "Name of the program which is called to retrieve news from the web.
251 The canonical choice is wget but you may take any other program which is
252 able to return the contents of a news feed file on stdout."
253 :type 'string
254 :group 'newsticker-retrieval)
256 (defcustom newsticker-wget-arguments
257 '("-q" "-O" "-")
258 "Arguments which are passed to wget.
259 There is probably no reason to change the default settings, unless you
260 are living behind a firewall."
261 :type '(repeat (string :tag "Argument"))
262 :group 'newsticker-retrieval)
264 (defcustom newsticker-retrieval-interval
265 3600
266 "Time interval for retrieving new news items (seconds).
267 If this value is not positive (i.e. less than or equal to 0)
268 items are retrieved only once!
269 Please note that some feeds, e.g. Slashdot, will ban you if you
270 make it less than 1800 seconds (30 minutes)!"
271 :type '(choice :tag "Interval"
272 (const :tag "No automatic retrieval" 0)
273 (const :tag "Hourly" 3600)
274 (const :tag "Daily" 86400)
275 (const :tag "Weekly" 604800)
276 (integer :tag "Interval"))
277 :set 'newsticker--set-customvar-retrieval
278 :group 'newsticker-retrieval)
280 (defcustom newsticker-desc-comp-max
282 "Relevant length of headline descriptions.
283 This value gives the maximum number of characters which will be
284 taken into account when newsticker compares two headline
285 descriptions."
286 :type 'integer
287 :group 'newsticker-retrieval)
289 ;; ======================================================================
290 ;; headline processing
291 (defgroup newsticker-headline-processing nil
292 "Settings for the automatic processing of headlines."
293 :group 'newsticker)
295 (defcustom newsticker-automatically-mark-items-as-old
297 "Decides whether to automatically mark items as old.
298 If t a new item is considered as new only after its first retrieval. As
299 soon as it is retrieved a second time, it becomes old. If not t all
300 items stay new until you mark them as old. This is done in the
301 *newsticker* buffer."
302 :type 'boolean
303 :group 'newsticker-headline-processing)
305 (defcustom newsticker-automatically-mark-visited-items-as-old
307 "Decides whether to automatically mark visited items as old.
308 If t an item is marked as old as soon as the associated link is
309 visited, i.e. after pressing RET or mouse2 on the item's
310 headline."
312 :type 'boolean
313 :group 'newsticker-headline-processing)
315 (defcustom newsticker-keep-obsolete-items
317 "Decides whether to keep unread items which have been removed from feed.
318 If t a new item, which has been removed from the feed, is kept in
319 the cache until it is marked as read."
320 :type 'boolean
321 :group 'newsticker-headline-processing)
323 (defcustom newsticker-obsolete-item-max-age
324 (* 60 60 24)
325 "Maximal age of obsolete items, in seconds.
326 Obsolete items which are older than this value will be silently
327 deleted at the next retrieval."
328 :type 'integer
329 :group 'newsticker-headline-processing)
331 (defcustom newsticker-auto-mark-filter-list
333 "A list of filters for automatically marking headlines.
335 This is an alist of the form (FEED-NAME PATTERN-LIST). I.e. each
336 element consists of a FEED-NAME a PATTERN-LIST. Each element of
337 the pattern-list has the form (AGE TITLE-OR-DESCRIPTION REGEXP).
338 AGE must be one of the symbols 'old or 'immortal.
339 TITLE-OR-DESCRIPTION must be on of the symbols 'title,
340 'description, or 'all. REGEXP is a regular expression, i.e. a
341 string.
343 This filter is checked after a new headline has been retrieved.
344 If FEED-NAME matches the name of the corresponding news feed, the
345 pattern-list is checked: The new headline will be marked as AGE
346 if REGEXP matches the headline's TITLE-OR-DESCRIPTION.
348 If, for example, `newsticker-auto-mark-filter-list' looks like
349 \((slashdot ('old 'title \"^Forget me!$\") ('immortal 'title \"Read me\")
350 \('immortal 'all \"important\"))))
352 then all articles from slashdot are marked as old if they have
353 the title \"Forget me!\". All articles with a title containing
354 the string \"Read me\" are marked as immortal. All articles which
355 contain the string \"important\" in their title or their
356 description are marked as immortal."
357 :type '(repeat (list :tag "Auto mark filter"
358 (string :tag "Feed name")
359 (repeat
360 (list :tag "Filter element"
361 (choice
362 :tag "Auto-assigned age"
363 (const :tag "Old" old)
364 (const :tag "Immortal" immortal))
365 (choice
366 :tag "Title/Description"
367 (const :tag "Title" title)
368 (const :tag "Description" description)
369 (const :tag "All" all))
370 (string :tag "Regexp")))))
371 :group 'newsticker-headline-processing)
373 ;; ======================================================================
374 ;; hooks
375 (defgroup newsticker-hooks nil
376 "Settings for newsticker hooks."
377 :group 'newsticker)
379 (defcustom newsticker-start-hook
381 "Hook run when starting newsticker.
382 This hook is run at the very end of `newsticker-start'."
383 :options '(newsticker-start-ticker)
384 :type 'hook
385 :group 'newsticker-hooks)
387 (defcustom newsticker-stop-hook
389 "Hook run when stopping newsticker.
390 This hook is run at the very end of `newsticker-stop'."
391 :options nil
392 :type 'hook
393 :group 'newsticker-hooks)
395 (defcustom newsticker-new-item-functions
397 "List of functions run after a new headline has been retrieved.
398 Each function is called with the following three arguments:
399 FEED the name of the corresponding news feed,
400 TITLE the title of the headline,
401 DESC the decoded description of the headline.
403 See `newsticker-download-images', and
404 `newsticker-download-enclosures' for sample functions.
406 Please note that these functions are called only once for a
407 headline after it has been retrieved for the first time."
408 :type 'hook
409 :options '(newsticker-download-images
410 newsticker-download-enclosures)
411 :group 'newsticker-hooks)
413 ;; ======================================================================
414 ;; miscellaneous
415 (defgroup newsticker-miscellaneous nil
416 "Miscellaneous newsticker settings."
417 :group 'newsticker)
419 (defcustom newsticker-cache-filename
420 "~/.newsticker-cache"
421 "Name of the newsticker cache file."
422 :type 'string
423 :group 'newsticker-miscellaneous)
424 (make-obsolete 'newsticker-cache-filename 'newsticker-dir "23.1")
426 (defcustom newsticker-dir
427 (locate-user-emacs-file "newsticker/" ".newsticker/")
428 "Directory where newsticker saves data."
429 :type 'directory
430 :group 'newsticker-miscellaneous)
432 ;; debugging
433 (defcustom newsticker-debug
435 "Enables some features needed for debugging newsticker.el.
437 If set to t newsticker.el will print lots of debugging messages, and the
438 buffers *newsticker-wget-<feed>* will not be closed."
439 :type 'boolean
440 :group 'newsticker-miscellaneous)
442 ;; ======================================================================
443 ;;; Compatibility section, XEmacs, Emacs
444 ;; ======================================================================
445 (unless (fboundp 'time-add)
446 (require 'time-date);;FIXME
447 (defun time-add (t1 t2)
448 (seconds-to-time (+ (time-to-seconds t1) (time-to-seconds t2)))))
450 (unless (fboundp 'match-string-no-properties)
451 (defalias 'match-string-no-properties 'match-string))
453 (when (featurep 'xemacs)
454 (unless (fboundp 'replace-regexp-in-string)
455 (defun replace-regexp-in-string (re rp st)
456 (save-match-data ;; apparently XEmacs needs save-match-data
457 (replace-in-string st re rp)))))
459 ;; copied from subr.el
460 (unless (fboundp 'add-to-invisibility-spec)
461 (defun add-to-invisibility-spec (arg)
462 "Add elements to `buffer-invisibility-spec'.
463 See documentation for `buffer-invisibility-spec' for the kind of elements
464 that can be added."
465 (if (eq buffer-invisibility-spec t)
466 (setq buffer-invisibility-spec (list t)))
467 (setq buffer-invisibility-spec
468 (cons arg buffer-invisibility-spec))))
470 ;; copied from subr.el
471 (unless (fboundp 'remove-from-invisibility-spec)
472 (defun remove-from-invisibility-spec (arg)
473 "Remove elements from `buffer-invisibility-spec'."
474 (if (consp buffer-invisibility-spec)
475 (setq buffer-invisibility-spec
476 (delete arg buffer-invisibility-spec)))))
478 ;; ======================================================================
479 ;;; Internal variables
480 ;; ======================================================================
481 (defvar newsticker--item-list nil
482 "List of newsticker items.")
483 (defvar newsticker--item-position 0
484 "Actual position in list of newsticker items.")
485 (defvar newsticker--prev-message "There was no previous message yet!"
486 "Last message that the newsticker displayed.")
487 (defvar newsticker--scrollable-text ""
488 "The text which is scrolled smoothly in the echo area.")
489 (defvar newsticker--buffer-uptodate-p nil
490 "Tells whether the newsticker buffer is up to date.")
491 (defvar newsticker--latest-update-time (current-time)
492 "The time at which the latest news arrived.")
493 (defvar newsticker--process-ids nil
494 "List of PIDs of active newsticker processes.")
496 (defvar newsticker--cache nil "Cached newsticker data.
497 This is a list of the form
499 ((label1
500 (title description link time age index preformatted-contents
501 preformatted-title extra-elements)
502 ...)
503 (label2
504 (title description link time age index preformatted-contents
505 preformatted-title extra-elements)
506 ...)
507 ...)
509 where LABEL is a symbol. TITLE, DESCRIPTION, and LINK are
510 strings. TIME is a time value as returned by `current-time'.
511 AGE is a symbol: 'new, 'old, 'immortal, and 'obsolete denote
512 ordinary news items, whereas 'feed denotes an item which is not a
513 headline but describes the feed itself. INDEX denotes the
514 original position of the item -- used for restoring the original
515 order. PREFORMATTED-CONTENTS and PREFORMATTED-TITLE hold the
516 formatted contents of the item's description and title. This
517 speeds things up if HTML rendering is used, which is rather
518 slow. EXTRA-ELEMENTS is an alist containing additional elements.")
520 (defvar newsticker--auto-narrow-to-feed nil
521 "Automatically narrow to current news feed.
522 If non-nil only the items of the current news feed are visible.")
524 (defvar newsticker--auto-narrow-to-item nil
525 "Automatically narrow to current news item.
526 If non-nil only the current headline is visible.")
528 (defconst newsticker--error-headline
529 "[COULD NOT DOWNLOAD HEADLINES!]"
530 "Title of error headline which will be inserted if news retrieval fails.")
532 ;; ======================================================================
533 ;;; Shortcuts
534 ;; ======================================================================
535 (defsubst newsticker--title (item)
536 "Return title of ITEM."
537 (nth 0 item))
538 (defsubst newsticker--desc (item)
539 "Return description of ITEM."
540 (nth 1 item))
541 (defsubst newsticker--link (item)
542 "Return link of ITEM."
543 (nth 2 item))
544 (defsubst newsticker--time (item)
545 "Return time of ITEM."
546 (nth 3 item))
547 (defsubst newsticker--age (item)
548 "Return age of ITEM."
549 (nth 4 item))
550 (defsubst newsticker--pos (item)
551 "Return position/index of ITEM."
552 (nth 5 item))
553 (defsubst newsticker--preformatted-contents (item)
554 "Return pre-formatted text of ITEM."
555 (nth 6 item))
556 (defsubst newsticker--preformatted-title (item)
557 "Return pre-formatted title of ITEM."
558 (nth 7 item))
559 (defsubst newsticker--extra (item)
560 "Return extra attributes of ITEM."
561 (nth 8 item))
562 (defsubst newsticker--guid-to-string (guid)
563 "Return string representation of GUID."
564 (if (stringp guid)
565 guid
566 (car (xml-node-children guid))))
567 (defsubst newsticker--guid (item)
568 "Return guid of ITEM."
569 (newsticker--guid-to-string (assoc 'guid (newsticker--extra item))))
570 (defsubst newsticker--enclosure (item)
571 "Return enclosure element of ITEM in the form \(...FIXME...\) or nil."
572 (let ((enclosure (assoc 'enclosure (newsticker--extra item))))
573 (if enclosure
574 (xml-node-attributes enclosure))))
575 (defun newsticker--real-feed-name (feed)
576 "Return real name of FEED."
577 (catch 'name
578 (mapc (lambda (item)
579 (if (eq (newsticker--age item) 'feed)
580 (throw 'name (newsticker--title item))))
581 (cdr (newsticker--cache-get-feed feed)))
582 (symbol-name feed)))
585 ;; ======================================================================
586 ;;; User fun
587 ;; ======================================================================
589 (defun newsticker--start-feed (feed &optional do-not-complain-if-running)
590 "Start retrieval timer for FEED.
591 If timer is running already a warning message is printed unless
592 DO-NOT-COMPLAIN-IF-RUNNING is not nil. Add the started
593 name/timer pair to `newsticker--retrieval-timer-list'."
594 (let* ((feed-name (car feed))
595 (start-time (nth 2 feed))
596 (interval (or (nth 3 feed)
597 newsticker-retrieval-interval))
598 (timer (assoc (car feed)
599 newsticker--retrieval-timer-list)))
600 (if timer
601 (or do-not-complain-if-running
602 (message "Timer for %s is running already!"
603 feed-name))
604 (newsticker--debug-msg "Starting timer for %s: %s, %d"
605 feed-name start-time interval)
606 ;; do not repeat retrieval if interval not positive
607 (if (<= interval 0)
608 (setq interval nil))
609 ;; Suddenly XEmacs doesn't like start-time 0
610 (if (or (not start-time)
611 (and (numberp start-time) (= start-time 0)))
612 (setq start-time 1))
613 ;; (message "start-time %s" start-time)
614 (setq timer (run-at-time start-time interval
615 'newsticker-get-news feed-name))
616 (if interval
617 (add-to-list 'newsticker--retrieval-timer-list
618 (cons feed-name timer))))))
620 ;;;###autoload
621 (defun newsticker-start (&optional do-not-complain-if-running)
622 "Start the newsticker.
623 Start the timers for display and retrieval. If the newsticker, i.e. the
624 timers, are running already a warning message is printed unless
625 DO-NOT-COMPLAIN-IF-RUNNING is not nil.
626 Run `newsticker-start-hook' if newsticker was not running already."
627 (interactive)
628 (let ((running (newsticker-running-p)))
629 ;; read old cache if it exists and newsticker is not running
630 (unless running
631 (newsticker--cache-read))
632 ;; start retrieval timers -- one timer for each feed
633 (dolist (feed (append newsticker-url-list-defaults newsticker-url-list))
634 (newsticker--start-feed feed))
635 (unless running
636 (run-hooks 'newsticker-start-hook)
637 (message "Newsticker started!"))))
639 (defun newsticker--stop-feed (feed-name)
640 "Stop retrieval for feed FEED-NAME.
641 Delete the stopped name/timer pair from `newsticker--retrieval-timer-list'."
642 (let ((name-and-timer (assoc feed-name newsticker--retrieval-timer-list)))
643 (when name-and-timer
644 (cancel-timer (cdr name-and-timer))
645 (setq newsticker--retrieval-timer-list
646 (delete name-and-timer newsticker--retrieval-timer-list)))))
648 (defun newsticker-stop ()
649 "Stop the newsticker and the newsticker-ticker.
650 Cancel the timers for display and retrieval. Run `newsticker-stop-hook'
651 if newsticker has been running."
652 (interactive)
653 (newsticker--cache-save)
654 (when (fboundp 'newsticker-stop-ticker) ; silence compiler warnings
655 (newsticker-stop-ticker))
656 (when (newsticker-running-p)
657 (mapc (lambda (name-and-timer)
658 (newsticker--stop-feed (car name-and-timer)))
659 newsticker--retrieval-timer-list)
660 (setq newsticker--retrieval-timer-list nil)
661 (run-hooks 'newsticker-stop-hook)
662 (message "Newsticker stopped!")))
664 (defun newsticker-get-all-news ()
665 "Launch retrieval of news from all configured newsticker sites.
666 This does NOT start the retrieval timers."
667 (interactive)
668 ;; launch retrieval of news
669 (mapc (lambda (item)
670 (newsticker-get-news (car item)))
671 (append newsticker-url-list-defaults newsticker-url-list)))
673 (defun newsticker-save-item (feed item)
674 "Save FEED ITEM."
675 (interactive)
676 (let ((filename (read-string "Filename: "
677 (concat feed ":_"
678 (replace-regexp-in-string
679 " " "_" (newsticker--title item))
680 ".html"))))
681 (with-temp-buffer
682 (insert (newsticker--desc item))
683 (write-file filename t))))
685 (defun newsticker-add-url (url name)
686 "Add given URL under given NAME to `newsticker-url-list'.
687 If URL is nil it is searched at point."
688 (interactive
689 (list
690 (read-string "URL: "
691 (save-excursion
692 (end-of-line)
693 (and
694 (re-search-backward
695 "http://"
696 (if (> (point) (+ (point-min) 100))
697 (- (point) 100)
698 (point-min))
700 (re-search-forward
701 "http://[-a-zA-Z0-9&/_.]*"
702 (if (< (point) (- (point-max) 200))
703 (+ (point) 200)
704 (point-max))
706 (buffer-substring-no-properties (match-beginning 0)
707 (match-end 0)))))
708 (read-string "Name: ")))
709 (add-to-list 'newsticker-url-list (list name url nil nil nil) t)
710 (customize-variable 'newsticker-url-list))
712 (defun newsticker-customize ()
713 "Open the newsticker customization group."
714 (interactive)
715 (customize-group "newsticker"))
717 ;; ======================================================================
718 ;;; Local stuff
719 ;; ======================================================================
720 (defun newsticker--get-news-by-funcall (feed-name function)
721 "Get news for the site FEED-NAME by calling FUNCTION.
722 See `newsticker-get-news'."
723 (let ((buffername (concat " *newsticker-funcall-" feed-name "*")))
724 (save-excursion
725 (set-buffer (get-buffer-create buffername))
726 (erase-buffer)
727 (insert (string-to-multibyte (funcall function feed-name)))
728 (newsticker--sentinel-work nil t feed-name function
729 (current-buffer)))))
731 (defun newsticker--get-news-by-url (feed-name url)
732 "Get news for the site FEED-NAME from address URL using `url-retrieve'.
733 See `newsticker-get-news'."
734 (let ((coding-system-for-read 'no-conversion))
735 (condition-case error-data
736 (url-retrieve url 'newsticker--get-news-by-url-callback
737 (list feed-name))
738 (error (message "Error retrieving news from %s: %s" feed-name
739 error-data))))
740 (force-mode-line-update))
742 (defun newsticker--get-news-by-url-callback (status feed-name)
743 "Callback function for `newsticker--get-news-by-url'.
744 STATUS is the return status as delivered by `url-retrieve', and
745 FEED-NAME is the name of the feed that the news were retrieved
746 from."
747 (let ((buf (get-buffer-create (concat " *newsticker-url-" feed-name "*")))
748 (result (string-to-multibyte (buffer-string))))
749 (set-buffer buf)
750 (erase-buffer)
751 (insert result)
752 ;; remove MIME header
753 (goto-char (point-min))
754 (search-forward "\n\n")
755 (delete-region (point-min) (point))
756 ;; read the rss/atom contents
757 (newsticker--sentinel-work nil t feed-name "url-retrieve" (current-buffer))
758 (when status
759 (let ((status-type (car status))
760 (status-details (cdr status)))
761 (cond ((eq status-type :redirect)
762 ;; don't care about redirects
764 ((eq status-type :error)
765 (message "%s: Error while retrieving news from %s: %s: \"%s\""
766 (format-time-string "%A, %H:%M" (current-time))
767 feed-name
768 (car status-details) (cdr status-details))))))))
770 (defun newsticker--get-news-by-wget (feed-name url wget-arguments)
771 "Get news for the site FEED-NAME from address URL using wget.
772 WGET-ARGUMENTS is a list of arguments for wget.
773 See `newsticker-get-news'."
774 (let ((buffername (concat " *newsticker-wget-" feed-name "*")))
775 (save-excursion
776 (set-buffer (get-buffer-create buffername))
777 (erase-buffer)
778 ;; throw an error if there is an old wget-process around
779 (if (get-process feed-name)
780 (error "Another wget-process is running for %s" feed-name))
781 ;; start wget
782 (let* ((args (append wget-arguments (list url)))
783 (proc (apply 'start-process feed-name buffername
784 newsticker-wget-name args)))
785 (set-process-coding-system proc 'no-conversion 'no-conversion)
786 (set-process-sentinel proc 'newsticker--sentinel)
787 (setq newsticker--process-ids (cons (process-id proc)
788 newsticker--process-ids))
789 (force-mode-line-update)))))
791 (defun newsticker-get-news (feed-name)
792 "Get news from the site FEED-NAME and load feed logo.
793 FEED-NAME must be a string which occurs as the label (i.e. the first element)
794 in an element of `newsticker-url-list' or `newsticker-url-list-defaults'."
795 (newsticker--debug-msg "%s: Getting news for %s"
796 (format-time-string "%A, %H:%M" (current-time))
797 feed-name)
798 (let* ((item (or (assoc feed-name newsticker-url-list)
799 (assoc feed-name newsticker-url-list-defaults)
800 (error
801 "Cannot get news for %s: Check newsticker-url-list"
802 feed-name)))
803 (url (cadr item))
804 (wget-arguments (or (car (cdr (cdr (cdr (cdr item)))))
805 newsticker-wget-arguments)))
806 (if (functionp url)
807 (newsticker--get-news-by-funcall feed-name url)
808 (if (eq newsticker-retrieval-method 'intern)
809 (newsticker--get-news-by-url feed-name url)
810 (newsticker--get-news-by-wget feed-name url wget-arguments)))))
812 ;; ======================================================================
813 ;; Parsing
814 ;; ======================================================================
816 (defun newsticker--sentinel (process event)
817 "Sentinel for extracting news titles from an RDF buffer.
818 Argument PROCESS is the process which has just changed its state.
819 Argument EVENT tells what has happened to the process."
820 (let ((p-status (process-status process))
821 (exit-status (process-exit-status process))
822 (name (process-name process))
823 (command (process-command process))
824 (buffer (process-buffer process)))
825 (newsticker--sentinel-work event
826 (and (eq p-status 'exit)
827 (= exit-status 0))
828 name command buffer)))
830 (defun newsticker--sentinel-work (event status-ok name command buffer)
831 "Actually do the sentinel work.
832 Argument EVENT tells what has happened to the retrieval process.
833 Argument STATUS-OK is the final status of the retrieval process,
834 non-nil meaning retrieval was successful.
835 Argument NAME is the name of the retrieval process.
836 Argument COMMAND is the command of the retrieval process.
837 Argument BUFFER is the buffer of the retrieval process."
838 (let ((time (current-time))
839 (name-symbol (intern name))
840 (something-was-added nil))
841 ;; catch known errors (zombie processes, rubbish-xml etc.
842 ;; if an error occurs the news feed is not updated!
843 (catch 'oops
844 (unless status-ok
845 (setq newsticker--cache
846 (newsticker--cache-add
847 newsticker--cache
848 name-symbol
849 newsticker--error-headline
850 (format
851 (concat "%s: Newsticker could not retrieve news from %s.\n"
852 "Return status: `%s'\n"
853 "Command was `%s'")
854 (format-time-string "%A, %H:%M" (current-time))
855 name event command)
857 (current-time)
858 'new
859 0 nil))
860 (message "%s: Error while retrieving news from %s"
861 (format-time-string "%A, %H:%M" (current-time))
862 name)
863 (throw 'oops nil))
864 (let* ((coding-system 'utf-8)
865 (node-list
866 (save-current-buffer
867 (set-buffer buffer)
868 ;; a very very dirty workaround to overcome the
869 ;; problems with the newest (20030621) xml.el:
870 ;; remove all unnecessary whitespace
871 (goto-char (point-min))
872 (while (re-search-forward ">[ \t\r\n]+<" nil t)
873 (replace-match "><" nil t))
874 ;; and another brutal workaround (20031105)! For some
875 ;; reason the xml parser does not like the colon in the
876 ;; doctype name "rdf:RDF"
877 (goto-char (point-min))
878 (if (re-search-forward "<!DOCTYPE[ \t\n]+rdf:RDF" nil t)
879 (replace-match "<!DOCTYPE rdfColonRDF" nil t))
880 ;; finally.... ~##^°!!!!!
881 (goto-char (point-min))
882 (while (search-forward "\r\n" nil t)
883 (replace-match "\n" nil t))
884 ;; still more brutal workarounds (20040309)! The xml
885 ;; parser does not like doctype rss
886 (goto-char (point-min))
887 (if (re-search-forward "<!DOCTYPE[ \t\n]+rss[ \t\n]*>" nil t)
888 (replace-match "" nil t))
889 ;; And another one (20050618)! (Fixed in GNU Emacs 22.0.50.18)
890 ;; Remove comments to avoid this xml-parsing bug:
891 ;; "XML files can have only one toplevel tag"
892 (goto-char (point-min))
893 (while (search-forward "<!--" nil t)
894 (let ((start (match-beginning 0)))
895 (unless (search-forward "-->" nil t)
896 (error "Can't find end of comment"))
897 (delete-region start (point))))
898 ;; And another one (20050702)! If description is HTML
899 ;; encoded and starts with a `<', wrap the whole
900 ;; description in a CDATA expression. This happened for
901 ;; http://www.thefreedictionary.com/_/WoD/rss.aspx?type=quote
902 (goto-char (point-min))
903 (while (re-search-forward
904 "<description>\\(<img.*?\\)</description>" nil t)
905 (replace-match
906 "<description><![CDATA[ \\1 ]]></description>"))
907 ;; And another one (20051123)! XML parser does not
908 ;; like this: <yweather:location city="Frankfurt/Main"
909 ;; region="" country="GM" />
910 ;; try to "fix" empty attributes
911 ;; This happened for
912 ;; http://xml.weather.yahoo.com/forecastrss?p=GMXX0040&u=f
913 (goto-char (point-min))
914 (while (re-search-forward "\\(<[^>]*\\)=\"\"" nil t)
915 (replace-match "\\1=\" \""))
917 (set-buffer-modified-p nil)
918 ;; check coding system
919 (goto-char (point-min))
920 (if (re-search-forward "encoding=\"\\([^\"]+\\)\""
921 nil t)
922 (setq coding-system (intern (downcase (match-string 1))))
923 (setq coding-system
924 (condition-case nil
925 (check-coding-system coding-system)
926 (coding-system-error
927 (message
928 "newsticker.el: ignoring coding system %s for %s"
929 coding-system name)
930 nil))))
931 ;; Decode if possible
932 (when coding-system
933 (decode-coding-region (point-min) (point-max)
934 coding-system))
935 (condition-case errordata
936 ;; The xml parser might fail
937 ;; or the xml might be bugged
938 (xml-parse-region (point-min) (point-max))
939 (error (message "Could not parse %s: %s"
940 (buffer-name) (cadr errordata))
941 (throw 'oops nil)))))
942 (topnode (car node-list))
943 (channelnode (car (xml-get-children topnode 'channel)))
944 (imageurl nil))
945 ;; mark all items as obsolete
946 (newsticker--cache-replace-age newsticker--cache
947 name-symbol
948 'new 'obsolete-new)
949 (newsticker--cache-replace-age newsticker--cache
950 name-symbol
951 'old 'obsolete-old)
952 (newsticker--cache-replace-age newsticker--cache
953 name-symbol
954 'feed 'obsolete-old)
956 ;; check Atom/RSS version and call corresponding parser
957 (condition-case error-data
958 (if (cond
959 ;; RSS 0.91
960 ((and (eq 'rss (xml-node-name topnode))
961 (string= "0.91" (xml-get-attribute topnode 'version)))
962 (setq imageurl (newsticker--get-logo-url-rss-0.91 topnode))
963 (newsticker--parse-rss-0.91 name time topnode))
964 ;; RSS 0.92
965 ((and (eq 'rss (xml-node-name topnode))
966 (string= "0.92" (xml-get-attribute topnode 'version)))
967 (setq imageurl (newsticker--get-logo-url-rss-0.92 topnode))
968 (newsticker--parse-rss-0.92 name time topnode))
969 ;; RSS 1.0
970 ((eq 'rdf:RDF (xml-node-name topnode))
971 (setq imageurl (newsticker--get-logo-url-rss-1.0 topnode))
972 (newsticker--parse-rss-1.0 name time topnode))
973 ;; RSS 2.0
974 ((and (eq 'rss (xml-node-name topnode))
975 (string= "2.0" (xml-get-attribute topnode 'version)))
976 (setq imageurl (newsticker--get-logo-url-rss-2.0 topnode))
977 (newsticker--parse-rss-2.0 name time topnode))
978 ;; Atom 0.3
979 ((and (eq 'feed (xml-node-name topnode))
980 (string= "http://purl.org/atom/ns#"
981 (xml-get-attribute topnode 'xmlns)))
982 (setq imageurl (newsticker--get-logo-url-atom-0.3 topnode))
983 (newsticker--parse-atom-0.3 name time topnode))
984 ;; Atom 1.0
985 ((and (eq 'feed (xml-node-name topnode))
986 (string= "http://www.w3.org/2005/Atom"
987 (xml-get-attribute topnode 'xmlns)))
988 (setq imageurl (newsticker--get-logo-url-atom-1.0 topnode))
989 (newsticker--parse-atom-1.0 name time topnode))
990 ;; unknown feed type
992 (newsticker--debug-msg "Feed type unknown: %s: %s"
993 (xml-node-name topnode) name)
994 nil))
995 (setq something-was-added t))
996 (error (message "sentinelerror in %s: %s" name error-data)))
998 ;; Remove those old items from cache which have been removed from
999 ;; the feed
1000 (newsticker--cache-replace-age newsticker--cache
1001 name-symbol 'obsolete-old 'deleteme)
1002 (newsticker--cache-remove newsticker--cache name-symbol
1003 'deleteme)
1004 ;; Remove those new items from cache which have been removed from
1005 ;; the feed. Or keep them as `obsolete'
1006 (if (not newsticker-keep-obsolete-items)
1007 (newsticker--cache-remove newsticker--cache
1008 name-symbol 'obsolete-new)
1009 (setq newsticker--cache
1010 (newsticker--cache-mark-expired
1011 newsticker--cache name-symbol 'obsolete 'obsolete-expired
1012 newsticker-obsolete-item-max-age))
1013 (newsticker--cache-remove newsticker--cache
1014 name-symbol 'obsolete-expired)
1015 (newsticker--cache-replace-age newsticker--cache
1016 name-symbol 'obsolete-new
1017 'obsolete))
1018 (newsticker--update-process-ids)
1019 ;; setup scrollable text
1020 (when (= 0 (length newsticker--process-ids))
1021 (when (fboundp 'newsticker--ticker-text-setup) ;silence
1022 ;compiler
1023 ;warnings
1024 (newsticker--ticker-text-setup)))
1025 (setq newsticker--latest-update-time (current-time))
1026 (when something-was-added
1027 ;; FIXME: should we care about removed items as well?
1028 (newsticker--cache-save-feed
1029 (newsticker--cache-get-feed name-symbol))
1030 (when (fboundp 'newsticker--buffer-set-uptodate) ;silence
1031 ;compiler
1032 ;warnings
1033 (newsticker--buffer-set-uptodate nil)))
1034 ;; kill the process buffer if wanted
1035 (unless newsticker-debug
1036 (kill-buffer buffer))
1037 ;; launch retrieval of image
1038 (when (and imageurl newsticker--download-logos)
1039 (newsticker--image-get name imageurl)))))
1040 (when newsticker--sentinel-callback
1041 (funcall newsticker--sentinel-callback)))
1043 (defun newsticker--get-logo-url-atom-1.0 (node)
1044 "Return logo URL from atom 1.0 data in NODE."
1045 (car (xml-node-children
1046 (car (xml-get-children node 'logo)))))
1048 (defun newsticker--get-logo-url-atom-0.3 (node)
1049 "Return logo URL from atom 0.3 data in NODE."
1050 (car (xml-node-children
1051 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1053 (defun newsticker--get-logo-url-rss-2.0 (node)
1054 "Return logo URL from RSS 2.0 data in NODE."
1055 (car (xml-node-children
1056 (car (xml-get-children
1057 (car (xml-get-children
1058 (car (xml-get-children node 'channel)) 'image)) 'url)))))
1060 (defun newsticker--get-logo-url-rss-1.0 (node)
1061 "Return logo URL from RSS 1.0 data in NODE."
1062 (car (xml-node-children
1063 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1065 (defun newsticker--get-logo-url-rss-0.92 (node)
1066 "Return logo URL from RSS 0.92 data in NODE."
1067 (car (xml-node-children
1068 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1070 (defun newsticker--get-logo-url-rss-0.91 (node)
1071 "Return logo URL from RSS 0.91 data in NODE."
1072 (car (xml-node-children
1073 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1075 (defun newsticker--parse-atom-0.3 (name time topnode)
1076 "Parse Atom 0.3 data.
1077 Return value as well as arguments NAME, TIME, and TOPNODE are the
1078 same as in `newsticker--parse-atom-1.0'."
1079 (newsticker--debug-msg "Parsing Atom 0.3 feed %s" name)
1080 (let (new-feed new-item)
1081 (setq new-feed (newsticker--parse-generic-feed
1082 name time
1083 ;; title
1084 (car (xml-node-children
1085 (car (xml-get-children topnode 'title))))
1086 ;; desc
1087 (car (xml-node-children
1088 (car (xml-get-children topnode 'content))))
1089 ;; link
1090 (xml-get-attribute
1091 (car (xml-get-children topnode 'link)) 'href)
1092 ;; extra-elements
1093 (xml-node-children topnode)))
1094 (setq new-item (newsticker--parse-generic-items
1095 name time (xml-get-children topnode 'entry)
1096 ;; title-fn
1097 (lambda (node)
1098 (car (xml-node-children
1099 (car (xml-get-children node 'title)))))
1100 ;; desc-fn
1101 (lambda (node)
1102 (or (car (xml-node-children
1103 (car (xml-get-children node 'content))))
1104 (car (xml-node-children
1105 (car (xml-get-children node 'summary))))))
1106 ;; link-fn
1107 (lambda (node)
1108 (xml-get-attribute
1109 (car (xml-get-children node 'link)) 'href))
1110 ;; time-fn
1111 (lambda (node)
1112 (newsticker--decode-rfc822-date
1113 (car (xml-node-children
1114 (car (xml-get-children node 'modified))))))
1115 ;; guid-fn
1116 (lambda (node)
1117 (newsticker--guid-to-string
1118 (assoc 'guid (xml-node-children node))))
1119 ;; extra-fn
1120 (lambda (node)
1121 (xml-node-children node))))
1122 (or new-item new-feed)))
1124 (defun newsticker--parse-atom-1.0 (name time topnode)
1125 "Parse Atom 1.0 data.
1126 Argument NAME gives the name of a news feed. TIME gives the
1127 system time at which the data have been retrieved. TOPNODE
1128 contains the feed data as returned by the xml parser.
1130 For the Atom 1.0 specification see
1131 URL `http://www.atompub.org/2005/08/17/draft-ietf-atompub-format-11.html'"
1132 (newsticker--debug-msg "Parsing Atom 1.0 feed %s" name)
1133 (let (new-feed new-item)
1134 (setq new-feed (newsticker--parse-generic-feed
1135 name time
1136 ;; title
1137 (car (xml-node-children
1138 (car (xml-get-children topnode 'title))))
1139 ;; desc
1140 (car (xml-node-children
1141 (car (xml-get-children topnode 'subtitle))))
1142 ;; link
1143 (lambda (node)
1144 (xml-get-attribute
1145 (car (xml-get-children node 'link)) 'href))
1146 ;; extra-elements
1147 (xml-node-children topnode)))
1148 (setq new-item (newsticker--parse-generic-items
1149 name time (xml-get-children topnode 'entry)
1150 ;; title-fn
1151 (lambda (node)
1152 (car (xml-node-children
1153 (car (xml-get-children node 'title)))))
1154 ;; desc-fn
1155 (lambda (node)
1156 (or (car (xml-node-children
1157 (car (xml-get-children node 'content))))
1158 (car (xml-node-children
1159 (car (xml-get-children node 'summary))))))
1160 ;; link-fn
1161 (lambda (node)
1162 (xml-get-attribute
1163 (car (xml-get-children node 'link)) 'href))
1164 ;; time-fn
1165 (lambda (node)
1166 (newsticker--decode-iso8601-date
1167 (or (car (xml-node-children
1168 (car (xml-get-children node 'updated))))
1169 (car (xml-node-children
1170 (car (xml-get-children node 'published)))))))
1171 ;; guid-fn
1172 (lambda (node)
1173 (car (xml-node-children
1174 (car (xml-get-children node 'id)))))
1175 ;; extra-fn
1176 (lambda (node)
1177 (xml-node-children node))))
1178 (or new-item new-feed)))
1180 (defun newsticker--parse-rss-0.91 (name time topnode)
1181 "Parse RSS 0.91 data.
1182 Return value as well as arguments NAME, TIME, and TOPNODE are the
1183 same as in `newsticker--parse-atom-1.0'.
1185 For the RSS 0.91 specification see URL `http://backend.userland.com/rss091'
1186 or URL `http://my.netscape.com/publish/formats/rss-spec-0.91.html'."
1187 (newsticker--debug-msg "Parsing RSS 0.91 feed %s" name)
1188 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1189 (pub-date (newsticker--decode-rfc822-date
1190 (car (xml-node-children
1191 (car (xml-get-children channelnode 'pubDate))))))
1192 is-new-feed has-new-items)
1193 (setq is-new-feed (newsticker--parse-generic-feed
1194 name time
1195 ;; title
1196 (car (xml-node-children
1197 (car (xml-get-children channelnode 'title))))
1198 ;; desc
1199 (car (xml-node-children
1200 (car (xml-get-children channelnode
1201 'description))))
1202 ;; link
1203 (car (xml-node-children
1204 (car (xml-get-children channelnode 'link))))
1205 ;; extra-elements
1206 (xml-node-children channelnode)))
1207 (setq has-new-items (newsticker--parse-generic-items
1208 name time (xml-get-children channelnode 'item)
1209 ;; title-fn
1210 (lambda (node)
1211 (car (xml-node-children
1212 (car (xml-get-children node 'title)))))
1213 ;; desc-fn
1214 (lambda (node)
1215 (car (xml-node-children
1216 (car (xml-get-children node 'description)))))
1217 ;; link-fn
1218 (lambda (node)
1219 (car (xml-node-children
1220 (car (xml-get-children node 'link)))))
1221 ;; time-fn
1222 (lambda (node)
1223 (newsticker--decode-rfc822-date
1224 (car (xml-node-children
1225 (car (xml-get-children node 'pubDate))))))
1226 ;; guid-fn
1227 (lambda (node)
1228 nil)
1229 ;; extra-fn
1230 (lambda (node)
1231 (xml-node-children node))))
1232 (or has-new-items is-new-feed)))
1234 (defun newsticker--parse-rss-0.92 (name time topnode)
1235 "Parse RSS 0.92 data.
1236 Return value as well as arguments NAME, TIME, and TOPNODE are the
1237 same as in `newsticker--parse-atom-1.0'.
1239 For the RSS 0.92 specification see URL `http://backend.userland.com/rss092'."
1240 (newsticker--debug-msg "Parsing RSS 0.92 feed %s" name)
1241 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1242 (pub-date (newsticker--decode-rfc822-date
1243 (car (xml-node-children
1244 (car (xml-get-children channelnode 'pubDate))))))
1245 is-new-feed has-new-items)
1246 (setq is-new-feed (newsticker--parse-generic-feed
1247 name time
1248 ;; title
1249 (car (xml-node-children
1250 (car (xml-get-children channelnode 'title))))
1251 ;; desc
1252 (car (xml-node-children
1253 (car (xml-get-children channelnode
1254 'description))))
1255 ;; link
1256 (car (xml-node-children
1257 (car (xml-get-children channelnode 'link))))
1258 ;; extra-elements
1259 (xml-node-children channelnode)))
1260 (setq has-new-items (newsticker--parse-generic-items
1261 name time (xml-get-children channelnode 'item)
1262 ;; title-fn
1263 (lambda (node)
1264 (car (xml-node-children
1265 (car (xml-get-children node 'title)))))
1266 ;; desc-fn
1267 (lambda (node)
1268 (car (xml-node-children
1269 (car (xml-get-children node 'description)))))
1270 ;; link-fn
1271 (lambda (node)
1272 (car (xml-node-children
1273 (car (xml-get-children node 'link)))))
1274 ;; time-fn
1275 (lambda (node)
1276 (newsticker--decode-rfc822-date
1277 (car (xml-node-children
1278 (car (xml-get-children node 'pubDate))))))
1279 ;; guid-fn
1280 (lambda (node)
1281 nil)
1282 ;; extra-fn
1283 (lambda (node)
1284 (xml-node-children node))))
1285 (or has-new-items is-new-feed)))
1287 (defun newsticker--parse-rss-1.0 (name time topnode)
1288 "Parse RSS 1.0 data.
1289 Return value as well as arguments NAME, TIME, and TOPNODE are the
1290 same as in `newsticker--parse-atom-1.0'.
1292 For the RSS 1.0 specification see URL `http://web.resource.org/rss/1.0/spec'."
1293 (newsticker--debug-msg "Parsing RSS 1.0 feed %s" name)
1294 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1295 is-new-feed has-new-items)
1296 (setq is-new-feed (newsticker--parse-generic-feed
1297 name time
1298 ;; title
1299 (car (xml-node-children
1300 (car (xml-get-children channelnode 'title))))
1301 ;; desc
1302 (car (xml-node-children
1303 (car (xml-get-children channelnode
1304 'description))))
1305 ;; link
1306 (car (xml-node-children
1307 (car (xml-get-children channelnode 'link))))
1308 ;; extra-elements
1309 (xml-node-children channelnode)))
1310 (setq has-new-items (newsticker--parse-generic-items
1311 name time (xml-get-children topnode 'item)
1312 ;; title-fn
1313 (lambda (node)
1314 (car (xml-node-children
1315 (car (xml-get-children node 'title)))))
1316 ;; desc-fn
1317 (lambda (node)
1318 (car (xml-node-children
1319 (car (xml-get-children node
1320 'description)))))
1321 ;; link-fn
1322 (lambda (node)
1323 (car (xml-node-children
1324 (car (xml-get-children node 'link)))))
1325 ;; time-fn
1326 (lambda (node)
1327 (newsticker--decode-iso8601-date
1328 (car (xml-node-children
1329 (car (xml-get-children node 'dc:date))))))
1330 ;; guid-fn
1331 (lambda (node)
1332 nil)
1333 ;; extra-fn
1334 (lambda (node)
1335 (xml-node-children node))))
1336 (or has-new-items is-new-feed)))
1338 (defun newsticker--parse-rss-2.0 (name time topnode)
1339 "Parse RSS 2.0 data.
1340 Return value as well as arguments NAME, TIME, and TOPNODE are the
1341 same as in `newsticker--parse-atom-1.0'.
1343 For the RSS 2.0 specification see URL `http://blogs.law.harvard.edu/tech/rss'."
1344 (newsticker--debug-msg "Parsing RSS 2.0 feed %s" name)
1345 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1346 is-new-feed has-new-items)
1347 (setq is-new-feed (newsticker--parse-generic-feed
1348 name time
1349 ;; title
1350 (car (xml-node-children
1351 (car (xml-get-children channelnode 'title))))
1352 ;; desc
1353 (car (xml-node-children
1354 (car (xml-get-children channelnode
1355 'description))))
1356 ;; link
1357 (car (xml-node-children
1358 (car (xml-get-children channelnode 'link))))
1359 ;; extra-elements
1360 (xml-node-children channelnode)))
1361 (setq has-new-items (newsticker--parse-generic-items
1362 name time (xml-get-children channelnode 'item)
1363 ;; title-fn
1364 (lambda (node)
1365 (car (xml-node-children
1366 (car (xml-get-children node 'title)))))
1367 ;; desc-fn
1368 (lambda (node)
1369 (or (car (xml-node-children
1370 (car (xml-get-children node
1371 'content:encoded))))
1372 (car (xml-node-children
1373 (car (xml-get-children node
1374 'description))))))
1375 ;; link-fn
1376 (lambda (node)
1377 (car (xml-node-children
1378 (car (xml-get-children node 'link)))))
1379 ;; time-fn
1380 (lambda (node)
1381 (newsticker--decode-rfc822-date
1382 (car (xml-node-children
1383 (car (xml-get-children node 'pubDate))))))
1384 ;; guid-fn
1385 (lambda (node)
1386 (newsticker--guid-to-string
1387 (assoc 'guid (xml-node-children node))))
1388 ;; extra-fn
1389 (lambda (node)
1390 (xml-node-children node))))
1391 (or has-new-items is-new-feed)))
1393 (defun newsticker--parse-generic-feed (name time title desc link
1394 extra-elements)
1395 "Parse generic news feed data.
1396 Argument NAME gives the name of a news feed. TIME gives the
1397 system time at which the data have been retrieved.
1399 The arguments TITLE, DESC, LINK, and EXTRA-ELEMENTS give the feed's title,
1400 description, link, and extra elements resp."
1401 (let ((title (or title "[untitled]"))
1402 (link (or link ""))
1403 (old-item nil)
1404 (position 0)
1405 (something-was-added nil))
1406 ;; decode numeric entities
1407 (setq title (newsticker--decode-numeric-entities title))
1408 (setq desc (newsticker--decode-numeric-entities desc))
1409 (setq link (newsticker--decode-numeric-entities link))
1410 ;; remove whitespace from title, desc, and link
1411 (setq title (newsticker--remove-whitespace title))
1412 (setq desc (newsticker--remove-whitespace desc))
1413 (setq link (newsticker--remove-whitespace link))
1415 ;; handle the feed itself
1416 (unless (newsticker--cache-contains newsticker--cache
1417 (intern name) title
1418 desc link 'feed)
1419 (setq something-was-added t))
1420 (setq newsticker--cache
1421 (newsticker--cache-add newsticker--cache (intern name)
1422 title desc link time 'feed position
1423 extra-elements time 'feed))
1424 something-was-added))
1426 (defun newsticker--parse-generic-items (name time itemlist
1427 title-fn desc-fn
1428 link-fn time-fn
1429 guid-fn extra-fn)
1430 "Parse generic news feed data.
1431 Argument NAME gives the name of a news feed. TIME gives the
1432 system time at which the data have been retrieved. ITEMLIST
1433 contains the news items returned by the xml parser.
1435 The arguments TITLE-FN, DESC-FN, LINK-FN, TIME-FN, GUID-FN, and
1436 EXTRA-FN give functions for extracting title, description, link,
1437 time, guid, and extra-elements resp. They are called with one
1438 argument, which is one of the items in ITEMLIST."
1439 (let (title desc link
1440 (old-item nil)
1441 (position 0)
1442 (something-was-added nil))
1443 ;; gather all items for this feed
1444 (mapc (lambda (node)
1445 (setq position (1+ position))
1446 (setq title (or (funcall title-fn node) "[untitled]"))
1447 (setq desc (funcall desc-fn node))
1448 (setq link (or (funcall link-fn node) ""))
1449 (setq time (or (funcall time-fn node) time))
1450 ;; It happened that the title or description
1451 ;; contained evil HTML code that confused the
1452 ;; xml parser. Therefore:
1453 (unless (stringp title)
1454 (setq title (prin1-to-string title)))
1455 (unless (or (stringp desc) (not desc))
1456 (setq desc (prin1-to-string desc)))
1457 ;; ignore items with empty title AND empty desc
1458 (when (or (> (length title) 0)
1459 (> (length desc) 0))
1460 ;; decode numeric entities
1461 (setq title (newsticker--decode-numeric-entities title))
1462 (when desc
1463 (setq desc (newsticker--decode-numeric-entities desc)))
1464 (setq link (newsticker--decode-numeric-entities link))
1465 ;; remove whitespace from title, desc, and link
1466 (setq title (newsticker--remove-whitespace title))
1467 (setq desc (newsticker--remove-whitespace desc))
1468 (setq link (newsticker--remove-whitespace link))
1469 ;; add data to cache
1470 ;; do we have this item already?
1471 (let* ((guid (funcall guid-fn node)))
1472 ;;(message "guid=%s" guid)
1473 (setq old-item
1474 (newsticker--cache-contains newsticker--cache
1475 (intern name) title
1476 desc link nil guid)))
1477 ;; add this item, or mark it as old, or do nothing
1478 (let ((age1 'new)
1479 (age2 'old)
1480 (item-new-p nil))
1481 (if old-item
1482 (let ((prev-age (newsticker--age old-item)))
1483 (unless newsticker-automatically-mark-items-as-old
1484 ;; Some feeds deliver items multiply, the
1485 ;; first time we find an 'obsolete-old one the
1486 ;; cache, the following times we find an 'old
1487 ;; one
1488 (if (memq prev-age '(obsolete-old old))
1489 (setq age2 'old)
1490 (setq age2 'new)))
1491 (if (eq prev-age 'immortal)
1492 (setq age2 'immortal))
1493 (setq time (newsticker--time old-item)))
1494 ;; item was not there
1495 (setq item-new-p t)
1496 (setq something-was-added t))
1497 (setq newsticker--cache
1498 (newsticker--cache-add
1499 newsticker--cache (intern name) title desc link
1500 time age1 position (funcall extra-fn node)
1501 time age2))
1502 (when item-new-p
1503 (let ((item (newsticker--cache-contains
1504 newsticker--cache (intern name) title
1505 desc link nil)))
1506 (if newsticker-auto-mark-filter-list
1507 (newsticker--run-auto-mark-filter name item))
1508 (run-hook-with-args
1509 'newsticker-new-item-functions name item))))))
1510 itemlist)
1511 something-was-added))
1513 ;; ======================================================================
1514 ;;; Misc
1515 ;; ======================================================================
1516 (defun newsticker--decode-numeric-entities (string)
1517 "Decode SGML numeric entities by their respective utf characters.
1518 This function replaces numeric entities in the input STRING and
1519 returns the modified string. For example \"&#42;\" gets replaced
1520 by \"*\"."
1521 (if (and string (stringp string))
1522 (let ((start 0))
1523 (while (string-match "&#\\([0-9]+\\);" string start)
1524 (condition-case nil
1525 (setq string (replace-match
1526 (string (read (substring string
1527 (match-beginning 1)
1528 (match-end 1))))
1529 nil nil string))
1530 (error nil))
1531 (setq start (1+ (match-beginning 0))))
1532 string)
1533 nil))
1535 (defun newsticker--remove-whitespace (string)
1536 "Remove leading and trailing whitespace from STRING."
1537 ;; we must have ...+ but not ...* in the regexps otherwise xemacs loops
1538 ;; endlessly...
1539 (when (and string (stringp string))
1540 (replace-regexp-in-string
1541 "[ \t\r\n]+$" ""
1542 (replace-regexp-in-string "^[ \t\r\n]+" "" string))))
1544 (defun newsticker--do-forget-preformatted (item)
1545 "Forget pre-formatted data for ITEM.
1546 Remove the pre-formatted from `newsticker--cache'."
1547 (if (nthcdr 7 item)
1548 (setcar (nthcdr 7 item) nil))
1549 (if (nthcdr 6 item)
1550 (setcar (nthcdr 6 item) nil)))
1552 (defun newsticker--forget-preformatted ()
1553 "Forget all cached pre-formatted data.
1554 Remove the pre-formatted from `newsticker--cache'."
1555 (mapc (lambda (feed)
1556 (mapc 'newsticker--do-forget-preformatted
1557 (cdr feed)))
1558 newsticker--cache)
1559 (when (fboundp 'newsticker--buffer-set-uptodate)
1560 (newsticker--buffer-set-uptodate nil)))
1562 (defun newsticker--debug-msg (string &rest args)
1563 "Print newsticker debug messages.
1564 This function calls `message' with arguments STRING and ARGS, if
1565 `newsticker-debug' is non-nil."
1566 (and newsticker-debug
1567 ;;(not (active-minibuffer-window))
1568 ;;(not (current-message))
1569 (apply 'message string args)))
1571 (defun newsticker--decode-iso8601-date (iso8601-string)
1572 "Return ISO8601-STRING in format like `decode-time'.
1573 Converts from ISO-8601 to Emacs representation.
1574 Examples:
1575 2004-09-17T05:09:49.001+00:00
1576 2004-09-17T05:09:49+00:00
1577 2004-09-17T05:09+00:00
1578 2004-09-17T05:09:49
1579 2004-09-17T05:09
1580 2004-09-17
1581 2004-09
1582 2004"
1583 (if iso8601-string
1584 (when (string-match
1585 (concat
1586 "^ *\\([0-9]\\{4\\}\\)" ;year
1587 "\\(-\\([0-9]\\{2\\}\\)" ;month
1588 "\\(-\\([0-9]\\{2\\}\\)" ;day
1589 "\\(T"
1590 "\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)" ;hour:minute
1591 "\\(:\\([0-9]\\{2\\}\\)\\(\\.[0-9]+\\)?\\)?" ;second
1592 ;timezone
1593 "\\(\\([-+Z]\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)?"
1594 "\\)?\\)?\\)? *$")
1595 iso8601-string)
1596 (let ((year (read (match-string 1 iso8601-string)))
1597 (month (read (or (match-string 3 iso8601-string)
1598 "1")))
1599 (day (read (or (match-string 5 iso8601-string)
1600 "1")))
1601 (hour (read (or (match-string 7 iso8601-string)
1602 "0")))
1603 (minute (read (or (match-string 8 iso8601-string)
1604 "0")))
1605 (second (read (or (match-string 10 iso8601-string)
1606 "0")))
1607 (sign (match-string 13 iso8601-string))
1608 (offset-hour (read (or (match-string 15 iso8601-string)
1609 "0")))
1610 (offset-minute (read (or (match-string 16 iso8601-string)
1611 "0"))))
1612 (cond ((string= sign "+")
1613 (setq hour (- hour offset-hour))
1614 (setq minute (- minute offset-minute)))
1615 ((string= sign "-")
1616 (setq hour (+ hour offset-hour))
1617 (setq minute (+ minute offset-minute))))
1618 ;; if UTC subtract current-time-zone offset
1619 ;;(setq second (+ (car (current-time-zone)) second)))
1621 (condition-case nil
1622 (encode-time second minute hour day month year t)
1623 (error
1624 (message "Cannot decode \"%s\"" iso8601-string)
1625 nil))))
1626 nil))
1628 (defun newsticker--decode-rfc822-date (rfc822-string)
1629 "Return RFC822-STRING in format like `decode-time'.
1630 Converts from RFC822 to Emacs representation.
1631 Examples:
1632 Sat, 07 September 2002 00:00:01 +0100
1633 Sat, 07 September 2002 00:00:01 MET
1634 Sat, 07 Sep 2002 00:00:01 GMT
1635 07 Sep 2002 00:00:01 GMT
1636 07 Sep 2002"
1637 (if (and rfc822-string (stringp rfc822-string))
1638 (when (string-match
1639 (concat
1640 "\\s-*"
1641 ;; week day
1642 "\\(\\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\)\\s-*,?\\)?\\s-*"
1643 ;; day
1644 "\\([0-9]\\{1,2\\}\\)\\s-+"
1645 ;; month
1646 "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|"
1647 "Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\).*?\\s-+"
1648 ;; year
1649 "\\([0-9]\\{2,4\\}\\)"
1650 ;; time may be missing
1651 "\\(\\s-+"
1652 ;; hour
1653 "\\([0-9]\\{2\\}\\)"
1654 ;; minute
1655 ":\\([0-9]\\{2\\}\\)"
1656 ;; second
1657 "\\(:\\([0-9]\\{2\\}\\)\\)?"
1658 ;; zone -- fixme
1659 "\\(\\s-+\\("
1660 "UT\\|GMT\\|EST\\|EDT\\|CST\\|CDT\\|MST\\|MDT\\|PST\\|PDT"
1661 "\\|\\([-+]\\)\\([0-9]\\{2\\}\\)\\([0-9]\\{2\\}\\)"
1662 "\\)\\)?"
1663 "\\)?")
1664 rfc822-string)
1665 (let ((day (read (match-string 3 rfc822-string)))
1666 (month-name (match-string 4 rfc822-string))
1667 (month 0)
1668 (year (read (match-string 5 rfc822-string)))
1669 (hour (read (or (match-string 7 rfc822-string) "0")))
1670 (minute (read (or (match-string 8 rfc822-string) "0")))
1671 (second (read (or (match-string 10 rfc822-string) "0")))
1672 (zone (match-string 12 rfc822-string))
1673 (sign (match-string 13 rfc822-string))
1674 (offset-hour (read (or (match-string 14 rfc822-string)
1675 "0")))
1676 (offset-minute (read (or (match-string 15 rfc822-string)
1677 "0")))
1678 ;;FIXME
1680 (when zone
1681 (cond ((string= sign "+")
1682 (setq hour (- hour offset-hour))
1683 (setq minute (- minute offset-minute)))
1684 ((string= sign "-")
1685 (setq hour (+ hour offset-hour))
1686 (setq minute (+ minute offset-minute)))))
1687 (condition-case error-data
1688 (let ((i 1))
1689 (mapc (lambda (m)
1690 (if (string= month-name m)
1691 (setq month i))
1692 (setq i (1+ i)))
1693 '("Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug"
1694 "Sep" "Oct" "Nov" "Dec"))
1695 (encode-time second minute hour day month year t))
1696 (error
1697 (message "Cannot decode \"%s\": %s %s" rfc822-string
1698 (car error-data) (cdr error-data))
1699 nil))))
1700 nil))
1702 (defun newsticker--lists-intersect-p (list1 list2)
1703 "Return t if LIST1 and LIST2 share elements."
1704 (let ((result nil))
1705 (mapc (lambda (elt)
1706 (if (memq elt list2)
1707 (setq result t)))
1708 list1)
1709 result))
1711 (defun newsticker--update-process-ids ()
1712 "Update list of ids of active newsticker processes.
1713 Checks list of active processes against list of newsticker processes."
1714 (let ((active-procs (process-list))
1715 (new-list nil))
1716 (mapc (lambda (proc)
1717 (let ((id (process-id proc)))
1718 (if (memq id newsticker--process-ids)
1719 (setq new-list (cons id new-list)))))
1720 active-procs)
1721 (setq newsticker--process-ids new-list))
1722 (force-mode-line-update))
1724 ;; ======================================================================
1725 ;;; Images
1726 ;; ======================================================================
1727 (defun newsticker--images-dir ()
1728 "Return directory where feed images are saved."
1729 (concat newsticker-dir "/images"))
1731 (defun newsticker--image-get (feed-name url)
1732 "Get image of the news site FEED-NAME from URL.
1733 If the image has been downloaded in the last 24h do nothing."
1734 (let ((image-name (concat (newsticker--images-dir) feed-name)))
1735 (if (and (file-exists-p image-name)
1736 (time-less-p (current-time)
1737 (time-add (nth 5 (file-attributes image-name))
1738 (seconds-to-time 86400))))
1739 (newsticker--debug-msg "%s: Getting image for %s skipped"
1740 (format-time-string "%A, %H:%M" (current-time))
1741 feed-name)
1742 ;; download
1743 (newsticker--debug-msg "%s: Getting image for %s"
1744 (format-time-string "%A, %H:%M" (current-time))
1745 feed-name)
1746 (let* ((buffername (concat " *newsticker-wget-image-" feed-name "*"))
1747 (item (or (assoc feed-name newsticker-url-list)
1748 (assoc feed-name newsticker-url-list-defaults)
1749 (error
1750 "Cannot get news for %s: Check newsticker-url-list"
1751 feed-name)))
1752 (wget-arguments (or (car (cdr (cdr (cdr (cdr item)))))
1753 newsticker-wget-arguments)))
1754 (save-excursion
1755 (set-buffer (get-buffer-create buffername))
1756 (erase-buffer)
1757 ;; throw an error if there is an old wget-process around
1758 (if (get-process feed-name)
1759 (error "Another wget-process is running for image %s"
1760 feed-name))
1761 ;; start wget
1762 (let* ((args (append wget-arguments (list url)))
1763 (proc (apply 'start-process feed-name buffername
1764 newsticker-wget-name args)))
1765 (set-process-coding-system proc 'no-conversion 'no-conversion)
1766 (set-process-sentinel proc 'newsticker--image-sentinel)))))))
1768 (defun newsticker--image-sentinel (process event)
1769 "Sentinel for image-retrieving PROCESS caused by EVENT."
1770 (let* ((p-status (process-status process))
1771 (exit-status (process-exit-status process))
1772 (feed-name (process-name process)))
1773 ;; catch known errors (zombie processes, rubbish-xml, etc.)
1774 ;; if an error occurs the news feed is not updated!
1775 (catch 'oops
1776 (unless (and (eq p-status 'exit)
1777 (= exit-status 0))
1778 (message "%s: Error while retrieving image from %s"
1779 (format-time-string "%A, %H:%M" (current-time))
1780 feed-name)
1781 (throw 'oops nil))
1782 (let (image-name)
1783 (save-excursion
1784 (set-buffer (process-buffer process))
1785 (setq image-name (concat (newsticker--images-dir) feed-name))
1786 (set-buffer-file-coding-system 'no-conversion)
1787 ;; make sure the cache dir exists
1788 (unless (file-directory-p (newsticker--images-dir))
1789 (make-directory (newsticker--images-dir)))
1790 ;; write and close buffer
1791 (let ((require-final-newline nil)
1792 (backup-inhibited t)
1793 (coding-system-for-write 'no-conversion))
1794 (write-region nil nil image-name nil 'quiet))
1795 (set-buffer-modified-p nil)
1796 (kill-buffer (current-buffer)))))))
1798 (defun newsticker--insert-image (img string)
1799 "Insert IMG with STRING at point."
1800 (insert-image img string))
1802 ;; ======================================================================
1803 ;;; HTML rendering
1804 ;; ======================================================================
1805 (defun newsticker-htmlr-render (pos1 pos2) ;
1806 "Replacement for `htmlr-render'.
1807 Renders the HTML code in the region POS1 to POS2 using htmlr."
1808 (let ((str (buffer-substring-no-properties pos1 pos2)))
1809 (delete-region pos1 pos2)
1810 (insert
1811 (with-temp-buffer
1812 (insert str)
1813 (goto-char (point-min))
1814 ;; begin original htmlr-render
1815 (when (fboundp 'htmlr-reset) (htmlr-reset))
1816 ;; something omitted here...
1817 (when (fboundp 'htmlr-step)
1818 (while (< (point) (point-max))
1819 (htmlr-step)))
1820 ;; end original htmlr-render
1821 (newsticker--remove-whitespace (buffer-string))))))
1823 ;; ======================================================================
1824 ;;; Manipulation of cached data
1825 ;; ======================================================================
1826 (defun newsticker--cache-set-preformatted-contents (item contents)
1827 "Set preformatted contents of ITEM to CONTENTS."
1828 (if (nthcdr 6 item)
1829 (setcar (nthcdr 6 item) contents)
1830 (setcdr (nthcdr 5 item) (list contents))))
1832 (defun newsticker--cache-set-preformatted-title (item title)
1833 "Set preformatted title of ITEM to TITLE."
1834 (if (nthcdr 7 item)
1835 (setcar (nthcdr 7 item) title)
1836 (setcdr (nthcdr 6 item) title)))
1838 (defun newsticker--cache-replace-age (data feed old-age new-age)
1839 "Mark all items in DATA in FEED which carry age OLD-AGE with NEW-AGE.
1840 If FEED is 'any it applies to all feeds. If OLD-AGE is 'any,
1841 all marks are replaced by NEW-AGE. Removes all pre-formatted contents."
1842 (mapc (lambda (a-feed)
1843 (when (or (eq feed 'any)
1844 (eq (car a-feed) feed))
1845 (let ((items (cdr a-feed)))
1846 (mapc (lambda (item)
1847 (when (or (eq old-age 'any)
1848 (eq (newsticker--age item) old-age))
1849 (setcar (nthcdr 4 item) new-age)
1850 (newsticker--do-forget-preformatted item)))
1851 items))))
1852 data)
1853 data)
1855 (defun newsticker--cache-mark-expired (data feed old-age new-age time)
1856 "Mark all expired entries.
1857 This function sets the age entries in DATA in the feed FEED. If
1858 an item's age is OLD-AGE it is set to NEW-AGE if the item is
1859 older than TIME."
1860 (mapc
1861 (lambda (a-feed)
1862 (when (or (eq feed 'any)
1863 (eq (car a-feed) feed))
1864 (let ((items (cdr a-feed)))
1865 (mapc
1866 (lambda (item)
1867 (when (eq (newsticker--age item) old-age)
1868 (let ((exp-time (time-add (newsticker--time item)
1869 (seconds-to-time time))))
1870 (when (time-less-p exp-time (current-time))
1871 (newsticker--debug-msg
1872 "Item `%s' from %s has expired on %s"
1873 (newsticker--title item)
1874 (format-time-string "%Y-%02m-%d, %H:%M"
1875 (newsticker--time item))
1876 (format-time-string "%Y-%02m-%d, %H:%M" exp-time))
1877 (setcar (nthcdr 4 item) new-age)))))
1878 items))))
1879 data)
1880 data)
1882 (defun newsticker--cache-contains (data feed title desc link age
1883 &optional guid)
1884 "Check DATA whether FEED contains an item with the given properties.
1885 This function returns the contained item or nil if it is not
1886 contained.
1887 The properties which are checked are TITLE, DESC, LINK, AGE, and
1888 GUID. In general all properties must match in order to return a
1889 certain item, except for the following cases.
1891 If AGE equals 'feed the TITLE, DESCription and LINK do not
1892 matter. If DESC is nil it is ignored as well. If
1893 `newsticker-desc-comp-max' is non-nil, only the first
1894 `newsticker-desc-comp-max' characters of DESC are taken into
1895 account.
1897 If GUID is non-nil it is sufficient to match this value, and the
1898 other properties are ignored."
1899 ;;(newsticker--debug-msg "Looking for %s guid=%s" title guid)
1900 (condition-case nil
1901 (catch 'found
1902 (when (and desc newsticker-desc-comp-max
1903 (> (length desc) newsticker-desc-comp-max))
1904 (setq desc (substring desc 0 newsticker-desc-comp-max)))
1905 (mapc
1906 (lambda (this-feed)
1907 (when (eq (car this-feed) feed)
1908 (mapc (lambda (anitem)
1909 (when (cond (guid
1910 ;; global unique id can match
1911 (string= guid (newsticker--guid anitem)))
1912 (t;;FIXME?
1914 ;; or title, desc, etc.
1915 (and
1916 ;;(or (not (eq age 'feed))
1917 ;; (eq (newsticker--age anitem) 'feed))
1918 (string= (newsticker--title anitem)
1919 title)
1920 (or (not link)
1921 (string= (newsticker--link anitem)
1922 link))
1923 (or (not desc)
1924 (if (and desc newsticker-desc-comp-max
1925 (> (length (newsticker--desc
1926 anitem))
1927 newsticker-desc-comp-max))
1928 (string= (substring
1929 (newsticker--desc anitem)
1931 newsticker-desc-comp-max)
1932 desc)
1933 (string= (newsticker--desc anitem)
1934 desc)))))))
1935 ;;(newsticker--debug-msg "Found %s guid=%s"
1936 ;; (newsticker--title anitem)
1937 ;; (newsticker--guid anitem))
1938 (throw 'found anitem)))
1939 (cdr this-feed))))
1940 data)
1941 ;;(newsticker--debug-msg "Found nothing")
1942 nil)
1943 (error nil)))
1945 (defun newsticker--cache-add (data feed-name-symbol title desc link time age
1946 position extra-elements
1947 &optional updated-time updated-age
1948 preformatted-contents
1949 preformatted-title)
1950 "Add another item to cache data.
1951 Add to DATA in the FEED-NAME-SYMBOL an item with TITLE, DESC,
1952 LINK, TIME, AGE, POSITION, and EXTRA-ELEMENTS. If this item is
1953 contained already, its time is set to UPDATED-TIME, its mark is
1954 set to UPDATED-AGE, and its pre-formatted contents is set to
1955 PREFORMATTED-CONTENTS and PREFORMATTED-TITLE. Returns the age
1956 which the item got."
1957 (let* ((guid (newsticker--guid-to-string (assoc 'guid extra-elements)))
1958 (item (newsticker--cache-contains data feed-name-symbol title desc link
1959 age guid)))
1960 ;;(message "guid=%s" guid)
1961 (if item
1962 ;; does exist already -- change age, update time and position
1963 (progn
1964 ;;(newsticker--debug-msg "Updating item %s %s %s %s %s -> %s %s
1965 ;; (guid %s -> %s)"
1966 ;; feed-name-symbol title link time age
1967 ;; updated-time updated-age
1968 ;; guid (newsticker--guid item))
1969 (if (nthcdr 5 item)
1970 (setcar (nthcdr 5 item) position)
1971 (setcdr (nthcdr 4 item) (list position)))
1972 (setcar (nthcdr 4 item) updated-age)
1973 (if updated-time
1974 (setcar (nthcdr 3 item) updated-time))
1975 ;; replace cached pre-formatted contents
1976 (newsticker--cache-set-preformatted-contents
1977 item preformatted-contents)
1978 (newsticker--cache-set-preformatted-title
1979 item preformatted-title))
1980 ;; did not exist or age equals 'feed-name-symbol
1981 (setq item (list title desc link time age position preformatted-contents
1982 preformatted-title extra-elements))
1983 ;;(newsticker--debug-msg "Adding item %s" item)
1984 (catch 'found
1985 (mapc (lambda (this-feed)
1986 (when (eq (car this-feed) feed-name-symbol)
1987 (setcdr this-feed (nconc (cdr this-feed) (list item)))
1988 (throw 'found this-feed)))
1989 data)
1990 ;; the feed is not contained
1991 (add-to-list 'data (list feed-name-symbol item) t))))
1992 data)
1994 (defun newsticker--cache-remove (data feed-symbol age)
1995 "Remove all entries from DATA in the feed FEED-SYMBOL with AGE.
1996 FEED-SYMBOL may be 'any. Entries from old feeds, which are no longer in
1997 `newsticker-url-list' or `newsticker-url-list-defaults', are removed as
1998 well."
1999 (let* ((pos data)
2000 (feed (car pos))
2001 (last-pos nil))
2002 (while feed
2003 (if (or (assoc (symbol-name (car feed)) newsticker-url-list)
2004 (assoc (symbol-name (car feed)) newsticker-url-list-defaults))
2005 ;; feed is still valid=active
2006 ;; (message "Keeping feed %s" (car feed))
2007 (if (or (eq feed-symbol 'any)
2008 (eq feed-symbol (car feed)))
2009 (let* ((item-pos (cdr feed))
2010 (item (car item-pos))
2011 (prev-pos nil))
2012 (while item
2013 ;;(message "%s" (car item))
2014 (if (eq age (newsticker--age item))
2015 ;; remove this item
2016 (progn
2017 ;;(message "Removing item %s" (car item))
2018 (if prev-pos
2019 (setcdr prev-pos (cdr item-pos))
2020 (setcdr feed (cdr item-pos))))
2021 ;;(message "Keeping item %s" (car item))
2022 (setq prev-pos item-pos))
2023 (setq item-pos (cdr item-pos))
2024 (setq item (car item-pos)))))
2025 ;; feed is not active anymore
2026 ;; (message "Removing feed %s" (car feed))
2027 (if last-pos
2028 (setcdr last-pos (cdr pos))
2029 (setq data (cdr pos))))
2030 (setq last-pos pos)
2031 (setq pos (cdr pos))
2032 (setq feed (car pos)))))
2034 ;; ======================================================================
2035 ;;; Sorting
2036 ;; ======================================================================
2037 (defun newsticker--cache-item-compare-by-time (item1 item2)
2038 "Compare two news items ITEM1 and ITEM2 by comparing their time values."
2039 (catch 'result
2040 (let ((age1 (newsticker--age item1))
2041 (age2 (newsticker--age item2)))
2042 (if (not (eq age1 age2))
2043 (cond ((eq age1 'obsolete)
2044 (throw 'result nil))
2045 ((eq age2 'obsolete)
2046 (throw 'result t)))))
2047 (let* ((time1 (newsticker--time item1))
2048 (time2 (newsticker--time item2)))
2049 (cond ((< (nth 0 time1) (nth 0 time2))
2050 nil)
2051 ((> (nth 0 time1) (nth 0 time2))
2053 ((< (nth 1 time1) (nth 1 time2))
2054 nil)
2055 ((> (nth 1 time1) (nth 1 time2))
2057 ((< (or (nth 2 time1) 0) (or (nth 2 time2) 0))
2058 nil)
2059 ((> (or (nth 2 time1) 0) (or (nth 2 time2) 0))
2062 nil)))))
2064 (defun newsticker--cache-item-compare-by-title (item1 item2)
2065 "Compare ITEM1 and ITEM2 by comparing their titles."
2066 (catch 'result
2067 (let ((age1 (newsticker--age item1))
2068 (age2 (newsticker--age item2)))
2069 (if (not (eq age1 age2))
2070 (cond ((eq age1 'obsolete)
2071 (throw 'result nil))
2072 ((eq age2 'obsolete)
2073 (throw 'result t)))))
2074 (string< (newsticker--title item1) (newsticker--title item2))))
2076 (defun newsticker--cache-item-compare-by-position (item1 item2)
2077 "Compare ITEM1 and ITEM2 by comparing their original positions."
2078 (catch 'result
2079 (let ((age1 (newsticker--age item1))
2080 (age2 (newsticker--age item2)))
2081 (if (not (eq age1 age2))
2082 (cond ((eq age1 'obsolete)
2083 (throw 'result nil))
2084 ((eq age2 'obsolete)
2085 (throw 'result t)))))
2086 (< (or (newsticker--pos item1) 0) (or (newsticker--pos item2) 0))))
2088 (defun newsticker--cache-save-version1 ()
2089 "Update and save newsticker cache file."
2090 (interactive)
2091 (newsticker--cache-update t))
2093 (defun newsticker--cache-update (&optional save)
2094 "Update newsticker cache file.
2095 If optional argument SAVE is not nil the cache file is saved to disk."
2096 (save-excursion
2097 (unless (file-directory-p newsticker-dir)
2098 (make-directory newsticker-dir t))
2099 (let ((coding-system-for-write 'utf-8)
2100 (buf (find-file-noselect newsticker-cache-filename)))
2101 (when buf
2102 (set-buffer buf)
2103 (setq buffer-undo-list t)
2104 (erase-buffer)
2105 (insert ";; -*- coding: utf-8 -*-\n")
2106 (insert (prin1-to-string newsticker--cache))
2107 (when save
2108 (save-buffer))))))
2110 (defun newsticker--cache-get-feed (feed)
2111 "Return the cached data for the feed FEED.
2112 FEED is a symbol!"
2113 (assoc feed newsticker--cache))
2115 (defun newsticker--cache-dir ()
2116 "Return directory for saving cache data."
2117 (concat newsticker-dir "/feeds"))
2119 (defun newsticker--cache-save ()
2120 "Save cache data for all feeds."
2121 (unless (file-directory-p newsticker-dir)
2122 (make-directory newsticker-dir t))
2123 (mapc 'newsticker--cache-save-feed newsticker--cache)
2124 nil)
2126 (defun newsticker--cache-save-feed (feed)
2127 "Save cache data for FEED."
2128 (let ((dir (concat (newsticker--cache-dir) "/" (symbol-name (car feed)))))
2129 (unless (file-directory-p dir)
2130 (make-directory dir t))
2131 (let ((coding-system-for-write 'utf-8))
2132 (with-temp-file (concat dir "/data")
2133 (insert ";; -*- coding: utf-8 -*-\n")
2134 (insert (prin1-to-string (cdr feed)))))))
2136 (defun newsticker--cache-read-version1 ()
2137 "Read version1 cache data."
2138 (let ((coding-system-for-read 'utf-8))
2139 (when (file-exists-p newsticker-cache-filename)
2140 (with-temp-buffer
2141 (insert-file-contents newsticker-cache-filename)
2142 (goto-char (point-min))
2143 (condition-case nil
2144 (setq newsticker--cache (read (current-buffer)))
2145 (error
2146 (message "Error while reading newsticker cache file!")
2147 (setq newsticker--cache nil)))))))
2149 (defun newsticker--cache-read ()
2150 "Read cache data."
2151 (setq newsticker--cache nil)
2152 (if (file-exists-p newsticker-cache-filename)
2153 (progn
2154 (when (y-or-n-p "Old newsticker cache file exists. Read it? ")
2155 (newsticker--cache-read-version1))
2156 (when (y-or-n-p (format "Delete old newsticker cache file? "))
2157 (delete-file newsticker-cache-filename)))
2158 (mapc (lambda (f)
2159 (newsticker--cache-read-feed (car f)))
2160 (append newsticker-url-list-defaults newsticker-url-list))))
2162 (defun newsticker--cache-read-feed (feed-name)
2163 "Read cache data for feed named FEED-NAME."
2164 (let ((file-name (concat (newsticker--cache-dir) "/" feed-name "/data"))
2165 (coding-system-for-read 'utf-8))
2166 (when (file-exists-p file-name)
2167 (with-temp-buffer
2168 (insert-file-contents file-name)
2169 (goto-char (point-min))
2170 (condition-case nil
2171 (add-to-list 'newsticker--cache (cons (intern feed-name)
2172 (read (current-buffer))))
2173 (error
2174 (message "Error while reading newsticker cache file %s!"
2175 file-name))
2176 (setq newsticker--cache nil))))))
2178 ;; ======================================================================
2179 ;;; Statistics
2180 ;; ======================================================================
2181 (defun newsticker--stat-num-items (feed &rest ages)
2182 "Return number of items in the given FEED which have one of the given AGES.
2183 If AGES is nil, the total number of items is returned."
2184 (let ((items (cdr (newsticker--cache-get-feed feed)))
2185 (num 0))
2186 (while items
2187 (if ages
2188 (if (memq (newsticker--age (car items)) ages)
2189 (setq num (1+ num)))
2190 (if (memq (newsticker--age (car items)) '(new old immortal obsolete))
2191 (setq num (1+ num))))
2192 (setq items (cdr items)))
2193 num))
2195 (defun newsticker--stat-num-items-total (&optional age)
2196 "Return total number of items in all feeds which have the given AGE.
2197 If AGE is nil, the total number of items is returned."
2198 (apply '+
2199 (mapcar (lambda (feed)
2200 (if age
2201 (newsticker--stat-num-items (intern (car feed)) age)
2202 (newsticker--stat-num-items (intern (car feed)))))
2203 (append newsticker-url-list-defaults newsticker-url-list))))
2205 ;; ======================================================================
2206 ;;; OPML
2207 ;; ======================================================================
2208 (defun newsticker-opml-export ()
2209 "OPML subscription export.
2210 Export subscriptions to a buffer in OPML Format."
2211 (interactive)
2212 (with-current-buffer (get-buffer-create "*OPML Export*")
2213 (set-buffer-file-coding-system 'utf-8)
2214 (insert (concat
2215 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
2216 "<!-- OPML generated by Emacs newsticker.el -->\n"
2217 "<opml version=\"1.0\">\n"
2218 " <head>\n"
2219 " <title>mySubscriptions</title>\n"
2220 " <dateCreated>" (format-time-string "%a, %d %b %Y %T %z")
2221 "</dateCreated>\n"
2222 " <ownerEmail>" user-mail-address "</ownerEmail>\n"
2223 " <ownerName>" (user-full-name) "</ownerName>\n"
2224 " </head>\n"
2225 " <body>\n"))
2226 (mapc (lambda (sub)
2227 (insert " <outline text=\"")
2228 (insert (newsticker--title sub))
2229 (insert "\" xmlUrl=\"")
2230 (insert (cadr sub))
2231 (insert "\"/>\n"))
2232 (append newsticker-url-list newsticker-url-list-defaults))
2233 (insert " </body>\n</opml>\n"))
2234 (pop-to-buffer "*OPML Export*")
2235 (when (fboundp 'sgml-mode)
2236 (sgml-mode)))
2238 (defun newsticker--opml-import-outlines (outlines)
2239 "Recursively import OUTLINES from OPML data.
2240 Note that nested outlines are currently flattened -- i.e. grouping is
2241 removed."
2242 (mapc (lambda (outline)
2243 (let ((name (xml-get-attribute outline 'text))
2244 (url (xml-get-attribute outline 'xmlUrl))
2245 (children (xml-get-children outline 'outline)))
2246 (unless (string= "" url)
2247 (add-to-list 'newsticker-url-list
2248 (list name url nil nil nil) t))
2249 (if children
2250 (newsticker--opml-import-outlines children))))
2251 outlines))
2253 (defun newsticker-opml-import (filename)
2254 "Import OPML data from FILENAME."
2255 (interactive "fOPML file: ")
2256 (set-buffer (find-file-noselect filename))
2257 (goto-char (point-min))
2258 (let* ((node-list (xml-parse-region (point-min) (point-max)))
2259 (body (car (xml-get-children (car node-list) 'body)))
2260 (outlines (xml-get-children body 'outline)))
2261 (newsticker--opml-import-outlines outlines))
2262 (customize-variable 'newsticker-url-list))
2264 ;; ======================================================================
2265 ;;; Auto marking
2266 ;; ======================================================================
2267 (defun newsticker--run-auto-mark-filter (feed item)
2268 "Automatically mark an item as old or immortal.
2269 This function checks the variable `newsticker-auto-mark-filter-list'
2270 for an entry that matches FEED and ITEM."
2271 (let ((case-fold-search t))
2272 (mapc (lambda (filter)
2273 (let ((filter-feed (car filter))
2274 (pattern-list (cadr filter)))
2275 (when (string-match filter-feed feed)
2276 (newsticker--do-run-auto-mark-filter item pattern-list))))
2277 newsticker-auto-mark-filter-list)))
2279 (defun newsticker--do-run-auto-mark-filter (item list)
2280 "Actually compare ITEM against the pattern-LIST.
2281 LIST must be an element of `newsticker-auto-mark-filter-list'."
2282 (mapc (lambda (pattern)
2283 (let ((age (nth 0 pattern))
2284 (place (nth 1 pattern))
2285 (regexp (nth 2 pattern))
2286 (title (newsticker--title item))
2287 (desc (newsticker--desc item)))
2288 (when (or (eq place 'title) (eq place 'all))
2289 (when (and title (string-match regexp title))
2290 (newsticker--debug-msg "Auto-marking as %s: `%s'"
2291 age (newsticker--title item))
2292 (setcar (nthcdr 4 item) age)))
2293 (when (or (eq place 'description) (eq place 'all))
2294 (when (and desc (string-match regexp desc))
2295 (newsticker--debug-msg "Auto-marking as %s: `%s'"
2296 age (newsticker--title item))
2297 (setcar (nthcdr 4 item) age)))))
2298 list))
2301 ;; ======================================================================
2302 ;;; Hook samples
2303 ;; ======================================================================
2304 (defun newsticker-new-item-functions-sample (feed item)
2305 "Demonstrate the use of the `newsticker-new-item-functions' hook.
2306 This function just prints out the values of the FEED and title of the ITEM."
2307 (message (concat "newsticker-new-item-functions-sample: feed=`%s', "
2308 "title=`%s'")
2309 feed (newsticker--title item)))
2311 (defun newsticker-download-images (feed item)
2312 "Download the first image.
2313 If FEED equals \"imagefeed\" download the first image URL found
2314 in the description=contents of ITEM to the directory
2315 \"~/tmp/newsticker/FEED/TITLE\" where TITLE is the title of the item."
2316 (when (string= feed "imagefeed")
2317 (let ((title (newsticker--title item))
2318 (desc (newsticker--desc item)))
2319 (when (string-match "<img src=\"\\(http://[^ \"]+\\)\"" desc)
2320 (let ((url (substring desc (match-beginning 1) (match-end 1)))
2321 (temp-dir (concat "~/tmp/newsticker/" feed "/" title))
2322 (org-dir default-directory))
2323 (unless (file-directory-p temp-dir)
2324 (make-directory temp-dir t))
2325 (cd temp-dir)
2326 (message "Getting image %s" url)
2327 (apply 'start-process "wget-image"
2328 " *newsticker-wget-download-images*"
2329 newsticker-wget-name
2330 (list url))
2331 (cd org-dir))))))
2333 (defun newsticker-download-enclosures (feed item)
2334 "In all FEEDs download the enclosed object of the news ITEM.
2335 The object is saved to the directory \"~/tmp/newsticker/FEED/TITLE\", which
2336 is created if it does not exist. TITLE is the title of the news
2337 item. Argument FEED is ignored.
2338 This function is suited for adding it to `newsticker-new-item-functions'."
2339 (let ((title (newsticker--title item))
2340 (enclosure (newsticker--enclosure item)))
2341 (when enclosure
2342 (let ((url (cdr (assoc 'url enclosure)))
2343 (temp-dir (concat "~/tmp/newsticker/" feed "/" title))
2344 (org-dir default-directory))
2345 (unless (file-directory-p temp-dir)
2346 (make-directory temp-dir t))
2347 (cd temp-dir)
2348 (message "Getting enclosure %s" url)
2349 (apply 'start-process "wget-enclosure"
2350 " *newsticker-wget-download-enclosures*"
2351 newsticker-wget-name
2352 (list url))
2353 (cd org-dir)))))
2355 ;; ======================================================================
2356 ;;; Retrieve samples
2357 ;; ======================================================================
2358 (defun newsticker-retrieve-random-message (feed-name)
2359 "Return an artificial RSS string under the name FEED-NAME."
2360 (concat "<?xml version=\"1.0\" encoding=\"iso-8859-1\" ?><rss version=\"0.91\">"
2361 "<channel>"
2362 "<title>newsticker-retrieve-random-message</title>"
2363 "<description>Sample retrieval function</description>"
2364 "<pubDate>FIXME Sat, 07 Sep 2005 00:00:01 GMT</pubDate>"
2365 "<item><title>" (format "Your lucky number is %d" (random 10000))
2366 "</title><description>" (format "Or maybe it is %d" (random 10000))
2367 "</description></item></channel></rss>"))
2369 (provide 'newsticker-backend)
2371 ;; arch-tag: 0e37b658-56e9-49ab-90f9-f2df57e1a659
2372 ;;; newst-backend.el ends here