1 ;;; newst-backend.el --- Retrieval backend for newsticker.
3 ;; Copyright (C) 2003-2014 Free Software Foundation, Inc.
5 ;; Author: Ulf Jasper <ulf.jasper@web.de>
6 ;; Filename: newst-backend.el
7 ;; URL: http://www.nongnu.org/newsticker
8 ;; Keywords: News, RSS, Atom
11 ;; ======================================================================
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; ======================================================================
34 ;; ======================================================================
42 (defvar w3m-minor-mode-map)
45 (defvar newsticker--retrieval-timer-list nil
46 "List of timers for news retrieval.
47 This is an alist, each element consisting of (feed-name . timer).")
49 (defvar newsticker--sentinel-callback nil
50 "Function called at end of `newsticker--sentinel'.")
53 (defun newsticker-running-p ()
54 "Check whether newsticker is running.
55 Return t if newsticker is running, nil otherwise. Newsticker is
56 considered to be running if the newsticker timer list is not empty."
57 (> (length newsticker--retrieval-timer-list) 0))
59 ;; ======================================================================
61 ;; ======================================================================
62 (defgroup newsticker nil
63 "Aggregator for RSS and Atom feeds."
66 (defconst newsticker--raw-url-list-defaults
68 "http://export.cnet.com/export/feeds/news/rss/1,11176,,00.xml")
69 ("Debian Security Advisories"
70 "http://www.debian.org/security/dsa.en.rdf")
71 ("Debian Security Advisories - Long format"
72 "http://www.debian.org/security/dsa-long.en.rdf")
74 "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
78 "http://freshmeat.net/index.atom")
80 "http://www.kuro5hin.org/backend.rdf")
81 ("LWN (Linux Weekly News)"
82 "http://lwn.net/headlines/rss")
83 ("NY Times: Technology"
84 "http://partners.userland.com/nytRss/technology.xml")
86 "http://partners.userland.com/nytRss/nytHomepage.xml")
88 "http://www.quotationspage.com/data/qotd.rss"
92 "http://www.theregister.co.uk/tonys/slashdot.rdf")
94 "http://slashdot.org/index.rss"
96 3600) ;/. will ban you if under 3600 seconds!
98 "http://www.wired.com/news_drop/netcenter/netcenter.rdf")
99 ("Heise News (german)"
100 "http://www.heise.de/newsticker/heise.rdf")
101 ("Tagesschau (german)"
102 "http://www.tagesschau.de/newsticker.rdf"
105 ("Telepolis (german)"
106 "http://www.heise.de/tp/news.rdf"))
107 "Default URL list in raw form.
108 This list is fed into defcustom via `newsticker--splicer'.")
110 (defun newsticker--splicer (item)
111 "Convert ITEM for splicing into `newsticker-url-list-defaults'."
112 (let ((result (list 'list :tag (nth 0 item) (list 'const (nth 0 item))))
113 (element (cdr item)))
115 (setq result (append result (list (list 'const (car element)))))
116 (setq element (cdr element)))
119 (defun newsticker--set-customvar-retrieval (symbol value)
120 "Set retrieval related newsticker-variable SYMBOL value to VALUE.
121 Calls all actions which are necessary in order to make the new
123 (if (or (not (boundp symbol))
124 (equal (symbol-value symbol) value))
126 ;; something must have changed
127 (let ((need-restart nil)
128 (new-or-changed-feeds nil)
130 (cond ((eq symbol 'newsticker-retrieval-interval)
131 (setq need-restart t))
132 ((memq symbol '(newsticker-url-list-defaults newsticker-url-list))
134 (unless (member elt (symbol-value symbol))
135 (setq new-or-changed-feeds (cons elt new-or-changed-feeds))))
136 (dolist (elt (symbol-value symbol))
137 (unless (member elt value)
138 (setq removed-feeds (cons elt removed-feeds))))))
141 (when (newsticker-running-p)
142 (message "Restarting newsticker")
146 (dolist (feed removed-feeds)
147 (message "Stopping feed `%s'" (car feed))
148 (newsticker--stop-feed (car feed)))
149 (dolist (feed new-or-changed-feeds)
150 (message "Starting feed `%s'" (car feed))
151 (newsticker--stop-feed (car feed))
152 (newsticker--start-feed feed))
153 (unless new-or-changed-feeds
154 (when newsticker--sentinel-callback
155 (funcall newsticker--sentinel-callback)))))
156 (set symbol value))))
158 ;; ======================================================================
160 (defgroup newsticker-retrieval nil
161 "Settings for news retrieval."
164 (defcustom newsticker-url-list-defaults
166 "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
169 "A customizable list of news feeds to select from.
170 These were mostly extracted from the Radio Community Server at
171 http://subhonker6.userland.com/rcsPublic/rssHotlist.
173 You may add other entries in `newsticker-url-list'."
174 :type `(set ,@(mapcar `newsticker--splicer
175 newsticker--raw-url-list-defaults))
176 :set 'newsticker--set-customvar-retrieval
177 :group 'newsticker-retrieval)
179 (defcustom newsticker-url-list nil
180 "The news feeds which you like to watch.
182 This alist will be used in addition to selection made customizing
183 `newsticker-url-list-defaults'.
185 This is an alist. Each element consists of two items: a LABEL and a URL,
186 optionally followed by a START-TIME, INTERVAL specifier and WGET-ARGUMENTS.
188 The LABEL gives the name of the news feed. It can be an arbitrary string.
190 The URL gives the location of the news feed. It must point to a valid
191 RSS or Atom file. The file is retrieved by calling wget, or whatever you
192 specify as `newsticker-wget-name'.
194 URL may also be a function which returns news data. In this case
195 `newsticker-retrieval-method' etc. are ignored for this feed.
197 The START-TIME can be either a string, or nil. If it is a string it
198 specifies a fixed time at which this feed shall be retrieved for the
199 first time. (Examples: \"11:00pm\", \"23:00\".) If it is nil (or
200 unspecified), this feed will be retrieved immediately after calling
203 The INTERVAL specifies the time between retrievals for this feed. If it
204 is nil (or unspecified) the default interval value as set in
205 `newsticker-retrieval-interval' is used.
207 \(newsticker.el calls `run-at-time'. The newsticker-parameters START-TIME
208 and INTERVAL correspond to the `run-at-time'-parameters TIME and REPEAT.)
210 WGET-ARGUMENTS specifies arguments for wget (see `newsticker-wget-name')
211 which apply for this feed only, overriding the value of
212 `newsticker-wget-arguments'."
213 :type '(repeat (list :tag "News feed"
214 (string :tag "Label")
216 (string :tag "String")
217 (function :tag "Function"))
219 (const :tag "Default" nil)
220 (string :tag "Fixed Time"))
221 (choice :tag "Interval"
222 (const :tag "Default" nil)
223 (const :tag "Hourly" 3600)
224 (const :tag "Daily" 86400)
225 (const :tag "Weekly" 604800)
226 (integer :tag "Interval"))
227 (choice :tag "Wget Arguments"
228 (const :tag "Default arguments" nil)
229 (repeat :tag "Special arguments" string))))
230 :set 'newsticker--set-customvar-retrieval
231 :group 'newsticker-retrieval)
233 (defcustom newsticker-retrieval-method
235 "Method for retrieving news from the web, either `intern' or `extern'.
236 Default value `intern' uses Emacs' built-in asynchronous download
237 capabilities ('url-retrieve'). If set to `extern' the external
238 program wget is used, see `newsticker-wget-name'."
239 :type '(choice :tag "Method"
240 (const :tag "Intern" intern)
241 (const :tag "Extern" extern))
242 :group 'newsticker-retrieval)
244 (defcustom newsticker-wget-name
246 "Name of the program which is called to retrieve news from the web.
247 The canonical choice is wget but you may take any other program which is
248 able to return the contents of a news feed file on stdout."
250 :group 'newsticker-retrieval)
252 (defcustom newsticker-wget-arguments
254 "Arguments which are passed to wget.
255 There is probably no reason to change the default settings, unless you
256 are living behind a firewall."
257 :type '(repeat (string :tag "Argument"))
258 :group 'newsticker-retrieval)
260 (defcustom newsticker-retrieval-interval
262 "Time interval for retrieving new news items (seconds).
263 If this value is not positive (i.e. less than or equal to 0)
264 items are retrieved only once!
265 Please note that some feeds, e.g. Slashdot, will ban you if you
266 make it less than 1800 seconds (30 minutes)!"
267 :type '(choice :tag "Interval"
268 (const :tag "No automatic retrieval" 0)
269 (const :tag "Hourly" 3600)
270 (const :tag "Daily" 86400)
271 (const :tag "Weekly" 604800)
272 (integer :tag "Interval"))
273 :set 'newsticker--set-customvar-retrieval
274 :group 'newsticker-retrieval)
276 (defcustom newsticker-desc-comp-max
278 "Relevant length of headline descriptions.
279 This value gives the maximum number of characters which will be
280 taken into account when newsticker compares two headline
283 :group 'newsticker-retrieval)
285 ;; ======================================================================
286 ;; headline processing
287 (defgroup newsticker-headline-processing nil
288 "Settings for the automatic processing of headlines."
291 (defcustom newsticker-automatically-mark-items-as-old
293 "Decides whether to automatically mark items as old.
294 If t a new item is considered as new only after its first retrieval. As
295 soon as it is retrieved a second time, it becomes old. If not t all
296 items stay new until you mark them as old. This is done in the
297 *newsticker* buffer."
299 :group 'newsticker-headline-processing)
301 (defcustom newsticker-automatically-mark-visited-items-as-old
303 "Decides whether to automatically mark visited items as old.
304 If t an item is marked as old as soon as the associated link is
305 visited, i.e. after pressing RET or mouse2 on the item's
309 :group 'newsticker-headline-processing)
311 (defcustom newsticker-keep-obsolete-items
313 "Decides whether to keep unread items which have been removed from feed.
314 If t a new item, which has been removed from the feed, is kept in
315 the cache until it is marked as read."
317 :group 'newsticker-headline-processing)
319 (defcustom newsticker-obsolete-item-max-age
321 "Maximal age of obsolete items, in seconds.
322 Obsolete items which are older than this value will be silently
323 deleted at the next retrieval."
325 :group 'newsticker-headline-processing)
327 (defcustom newsticker-auto-mark-filter-list
329 "A list of filters for automatically marking headlines.
331 This is an alist of the form (FEED-NAME PATTERN-LIST). I.e. each
332 element consists of a FEED-NAME a PATTERN-LIST. Each element of
333 the pattern-list has the form (AGE TITLE-OR-DESCRIPTION REGEXP).
334 AGE must be one of the symbols 'old or 'immortal.
335 TITLE-OR-DESCRIPTION must be on of the symbols 'title,
336 'description, or 'all. REGEXP is a regular expression, i.e. a
339 This filter is checked after a new headline has been retrieved.
340 If FEED-NAME matches the name of the corresponding news feed, the
341 pattern-list is checked: The new headline will be marked as AGE
342 if REGEXP matches the headline's TITLE-OR-DESCRIPTION.
344 If, for example, `newsticker-auto-mark-filter-list' looks like
345 \((slashdot ('old 'title \"^Forget me!$\") ('immortal 'title \"Read me\")
346 \('immortal 'all \"important\"))))
348 then all articles from slashdot are marked as old if they have
349 the title \"Forget me!\". All articles with a title containing
350 the string \"Read me\" are marked as immortal. All articles which
351 contain the string \"important\" in their title or their
352 description are marked as immortal."
353 :type '(repeat (list :tag "Auto mark filter"
354 (string :tag "Feed name")
356 (list :tag "Filter element"
358 :tag "Auto-assigned age"
359 (const :tag "Old" old)
360 (const :tag "Immortal" immortal))
362 :tag "Title/Description"
363 (const :tag "Title" title)
364 (const :tag "Description" description)
365 (const :tag "All" all))
366 (string :tag "Regexp")))))
367 :group 'newsticker-headline-processing)
369 ;; ======================================================================
371 (defgroup newsticker-hooks nil
372 "Settings for newsticker hooks."
375 (defcustom newsticker-start-hook
377 "Hook run when starting newsticker.
378 This hook is run at the very end of `newsticker-start'."
379 :options '(newsticker-start-ticker)
381 :group 'newsticker-hooks)
383 (defcustom newsticker-stop-hook
385 "Hook run when stopping newsticker.
386 This hook is run at the very end of `newsticker-stop'."
389 :group 'newsticker-hooks)
391 (defcustom newsticker-new-item-functions
393 "List of functions run after a new headline has been retrieved.
394 Each function is called with the following three arguments:
395 FEED the name of the corresponding news feed,
396 TITLE the title of the headline,
397 DESC the decoded description of the headline.
399 See `newsticker-download-images', and
400 `newsticker-download-enclosures' for sample functions.
402 Please note that these functions are called only once for a
403 headline after it has been retrieved for the first time."
405 :options '(newsticker-download-images
406 newsticker-download-enclosures)
407 :group 'newsticker-hooks)
409 ;; ======================================================================
411 (defgroup newsticker-miscellaneous nil
412 "Miscellaneous newsticker settings."
415 (defcustom newsticker-cache-filename
416 "~/.newsticker-cache"
417 "Name of the newsticker cache file."
419 :group 'newsticker-miscellaneous)
420 (make-obsolete-variable 'newsticker-cache-filename 'newsticker-dir "23.1")
422 (defcustom newsticker-dir
423 (locate-user-emacs-file "newsticker/" ".newsticker/")
424 "Directory where newsticker saves data."
426 :group 'newsticker-miscellaneous)
429 (defcustom newsticker-debug
431 "Enables some features needed for debugging newsticker.el.
433 If set to t newsticker.el will print lots of debugging messages, and the
434 buffers *newsticker-wget-<feed>* will not be closed."
436 :group 'newsticker-miscellaneous)
438 ;; ======================================================================
439 ;;; Compatibility section, XEmacs, Emacs
440 ;; ======================================================================
442 ;; FIXME It is bad practice to define compat functions with such generic names.
444 ;; This is not needed in Emacs >= 22.1.
445 (unless (fboundp 'time-add)
446 (require 'time-date);;FIXME
447 (defun time-add (t1 t2)
448 (with-no-warnings ; don't warn about obsolete time-to-seconds in 23.2
449 (seconds-to-time (+ (time-to-seconds t1) (time-to-seconds t2))))))
451 (unless (fboundp 'match-string-no-properties)
452 (defalias 'match-string-no-properties 'match-string))
454 (when (featurep 'xemacs)
455 (unless (fboundp 'replace-regexp-in-string)
456 (defun replace-regexp-in-string (re rp st)
457 (save-match-data ;; apparently XEmacs needs save-match-data
458 (replace-in-string st re rp)))))
460 ;; copied from subr.el
461 (unless (fboundp 'add-to-invisibility-spec)
462 (defun add-to-invisibility-spec (arg)
463 "Add elements to `buffer-invisibility-spec'.
464 See documentation for `buffer-invisibility-spec' for the kind of elements
466 (if (eq buffer-invisibility-spec t)
467 (setq buffer-invisibility-spec (list t)))
468 (setq buffer-invisibility-spec
469 (cons arg buffer-invisibility-spec))))
471 ;; copied from subr.el
472 (unless (fboundp 'remove-from-invisibility-spec)
473 (defun remove-from-invisibility-spec (arg)
474 "Remove elements from `buffer-invisibility-spec'."
475 (if (consp buffer-invisibility-spec)
476 (setq buffer-invisibility-spec
477 (delete arg buffer-invisibility-spec)))))
479 ;; ======================================================================
480 ;;; Internal variables
481 ;; ======================================================================
482 (defvar newsticker--buffer-uptodate-p nil
483 "Tells whether the newsticker buffer is up to date.")
484 (defvar newsticker--latest-update-time (current-time)
485 "The time at which the latest news arrived.")
486 (defvar newsticker--process-ids nil
487 "List of PIDs of active newsticker processes.")
489 (defvar newsticker--cache nil "Cached newsticker data.
490 This is a list of the form
493 (title description link time age index preformatted-contents
494 preformatted-title extra-elements)
497 (title description link time age index preformatted-contents
498 preformatted-title extra-elements)
502 where LABEL is a symbol. TITLE, DESCRIPTION, and LINK are
503 strings. TIME is a time value as returned by `current-time'.
504 AGE is a symbol: 'new, 'old, 'immortal, and 'obsolete denote
505 ordinary news items, whereas 'feed denotes an item which is not a
506 headline but describes the feed itself. INDEX denotes the
507 original position of the item -- used for restoring the original
508 order. PREFORMATTED-CONTENTS and PREFORMATTED-TITLE hold the
509 formatted contents of the item's description and title. This
510 speeds things up if HTML rendering is used, which is rather
511 slow. EXTRA-ELEMENTS is an alist containing additional elements.")
513 (defvar newsticker--auto-narrow-to-feed nil
514 "Automatically narrow to current news feed.
515 If non-nil only the items of the current news feed are visible.")
517 (defvar newsticker--auto-narrow-to-item nil
518 "Automatically narrow to current news item.
519 If non-nil only the current headline is visible.")
521 (defconst newsticker--error-headline
522 "[COULD NOT DOWNLOAD HEADLINES!]"
523 "Title of error headline which will be inserted if news retrieval fails.")
525 ;; ======================================================================
527 ;; ======================================================================
528 (defsubst newsticker--title (item)
529 "Return title of ITEM."
531 (defsubst newsticker--desc (item)
532 "Return description of ITEM."
534 (defsubst newsticker--link (item)
535 "Return link of ITEM."
537 (defsubst newsticker--time (item)
538 "Return time of ITEM."
540 (defsubst newsticker--age (item)
541 "Return age of ITEM."
543 (defsubst newsticker--pos (item)
544 "Return position/index of ITEM."
546 (defsubst newsticker--preformatted-contents (item)
547 "Return pre-formatted text of ITEM."
549 (defsubst newsticker--preformatted-title (item)
550 "Return pre-formatted title of ITEM."
552 (defsubst newsticker--extra (item)
553 "Return extra attributes of ITEM."
555 (defsubst newsticker--guid-to-string (guid)
556 "Return string representation of GUID."
559 (car (xml-node-children guid))))
560 (defsubst newsticker--guid (item)
561 "Return guid of ITEM."
562 (newsticker--guid-to-string (assoc 'guid (newsticker--extra item))))
563 (defsubst newsticker--enclosure (item)
564 "Return enclosure element of ITEM in the form \(...FIXME...\) or nil."
565 (let ((enclosure (assoc 'enclosure (newsticker--extra item))))
567 (xml-node-attributes enclosure))))
568 (defun newsticker--real-feed-name (feed)
569 "Return real name of FEED."
572 (if (eq (newsticker--age item) 'feed)
573 (throw 'name (newsticker--title item))))
574 (cdr (newsticker--cache-get-feed feed)))
578 ;; ======================================================================
580 ;; ======================================================================
582 (defun newsticker--start-feed (feed &optional do-not-complain-if-running)
583 "Start retrieval timer for FEED.
584 If timer is running already a warning message is printed unless
585 DO-NOT-COMPLAIN-IF-RUNNING is not nil. Add the started
586 name/timer pair to `newsticker--retrieval-timer-list'."
587 (let* ((feed-name (car feed))
588 (start-time (nth 2 feed))
589 (interval (or (nth 3 feed)
590 newsticker-retrieval-interval))
591 (timer (assoc (car feed)
592 newsticker--retrieval-timer-list)))
594 (or do-not-complain-if-running
595 (message "Timer for %s is running already!"
597 (newsticker--debug-msg "Starting timer for %s: %s, %d"
598 feed-name start-time interval)
599 ;; do not repeat retrieval if interval not positive
602 ;; Suddenly XEmacs doesn't like start-time 0
603 (if (or (not start-time)
604 (and (numberp start-time) (= start-time 0)))
606 ;; (message "start-time %s" start-time)
607 (setq timer (run-at-time start-time interval
608 'newsticker-get-news feed-name))
610 (add-to-list 'newsticker--retrieval-timer-list
611 (cons feed-name timer))))))
614 (defun newsticker-start (&optional do-not-complain-if-running)
615 "Start the newsticker.
616 Start the timers for display and retrieval. If the newsticker, i.e. the
617 timers, are running already a warning message is printed unless
618 DO-NOT-COMPLAIN-IF-RUNNING is not nil.
619 Run `newsticker-start-hook' if newsticker was not running already."
621 (let ((running (newsticker-running-p)))
622 ;; read old cache if it exists and newsticker is not running
624 (newsticker--cache-read))
625 ;; start retrieval timers -- one timer for each feed
626 (dolist (feed (append newsticker-url-list-defaults newsticker-url-list))
627 (newsticker--start-feed feed))
629 (run-hooks 'newsticker-start-hook)
630 (message "Newsticker started!"))))
632 (defun newsticker--stop-feed (feed-name)
633 "Stop retrieval for feed FEED-NAME.
634 Delete the stopped name/timer pair from `newsticker--retrieval-timer-list'."
635 (let ((name-and-timer (assoc feed-name newsticker--retrieval-timer-list)))
637 (cancel-timer (cdr name-and-timer))
638 (setq newsticker--retrieval-timer-list
639 (delete name-and-timer newsticker--retrieval-timer-list)))))
641 (defun newsticker-stop ()
642 "Stop the newsticker and the newsticker-ticker.
643 Cancel the timers for display and retrieval. Run `newsticker-stop-hook'
644 if newsticker has been running."
646 (newsticker--cache-save)
647 (when (fboundp 'newsticker-stop-ticker) ; silence compiler warnings
648 (newsticker-stop-ticker))
649 (when (newsticker-running-p)
650 (mapc (lambda (name-and-timer)
651 (newsticker--stop-feed (car name-and-timer)))
652 newsticker--retrieval-timer-list)
653 (setq newsticker--retrieval-timer-list nil)
654 (run-hooks 'newsticker-stop-hook)
655 (message "Newsticker stopped!")))
657 (defun newsticker-get-all-news ()
658 "Launch retrieval of news from all configured newsticker sites.
659 This does NOT start the retrieval timers."
661 ;; launch retrieval of news
663 (newsticker-get-news (car item)))
664 (append newsticker-url-list-defaults newsticker-url-list)))
666 (defun newsticker-save-item (feed item)
669 (let ((filename (read-string "Filename: "
671 (replace-regexp-in-string
672 " " "_" (newsticker--title item))
675 (insert (newsticker--desc item))
676 (write-file filename t))))
678 (defun newsticker-add-url (url name)
679 "Add given URL under given NAME to `newsticker-url-list'.
680 If URL is nil it is searched at point."
689 (if (> (point) (+ (point-min) 100))
694 "http://[-a-zA-Z0-9&/_.]*"
695 (if (< (point) (- (point-max) 200))
699 (buffer-substring-no-properties (match-beginning 0)
701 (read-string "Name: ")))
702 (add-to-list 'newsticker-url-list (list name url nil nil nil) t)
703 (customize-variable 'newsticker-url-list))
705 (defun newsticker-customize ()
706 "Open the newsticker customization group."
708 (delete-other-windows)
709 (customize-group "newsticker"))
711 ;; ======================================================================
713 ;; ======================================================================
714 (defun newsticker--get-news-by-funcall (feed-name function)
715 "Get news for the site FEED-NAME by calling FUNCTION.
716 See `newsticker-get-news'."
717 (let ((buffername (concat " *newsticker-funcall-" feed-name "*")))
718 (with-current-buffer (get-buffer-create buffername)
720 (insert (string-to-multibyte (funcall function feed-name)))
721 (newsticker--sentinel-work nil t feed-name function
724 (defun newsticker--get-news-by-url (feed-name url)
725 "Get news for the site FEED-NAME from address URL using `url-retrieve'.
726 See `newsticker-get-news'."
727 (let ((coding-system-for-read 'no-conversion))
728 (condition-case error-data
729 (url-retrieve url 'newsticker--get-news-by-url-callback
731 (error (message "Error retrieving news from %s: %s" feed-name
733 (force-mode-line-update))
735 (defun newsticker--get-news-by-url-callback (status feed-name)
736 "Callback function for `newsticker--get-news-by-url'.
737 STATUS is the return status as delivered by `url-retrieve', and
738 FEED-NAME is the name of the feed that the news were retrieved
740 (let ((buf (get-buffer-create (concat " *newsticker-url-" feed-name "*")))
741 (result (string-to-multibyte (buffer-string))))
745 ;; remove MIME header
746 (goto-char (point-min))
747 (search-forward "\n\n")
748 (delete-region (point-min) (point))
749 ;; read the rss/atom contents
750 (newsticker--sentinel-work nil t feed-name "url-retrieve" (current-buffer))
752 (let ((status-type (car status))
753 (status-details (cdr status)))
754 (cond ((eq status-type :redirect)
755 ;; don't care about redirects
757 ((eq status-type :error)
758 (message "%s: Error while retrieving news from %s: %s: \"%s\""
759 (format-time-string "%A, %H:%M" (current-time))
761 (car status-details) (cdr status-details))))))))
763 (defun newsticker--get-news-by-wget (feed-name url wget-arguments)
764 "Get news for the site FEED-NAME from address URL using wget.
765 WGET-ARGUMENTS is a list of arguments for wget.
766 See `newsticker-get-news'."
767 (let ((buffername (concat " *newsticker-wget-" feed-name "*")))
768 (with-current-buffer (get-buffer-create buffername)
770 ;; throw an error if there is an old wget-process around
771 (if (get-process feed-name)
772 (error "Another wget-process is running for %s" feed-name))
774 (let* ((args (append wget-arguments (list url)))
775 (proc (apply 'start-process feed-name buffername
776 newsticker-wget-name args)))
777 (set-process-coding-system proc 'no-conversion 'no-conversion)
778 (set-process-sentinel proc 'newsticker--sentinel)
779 (setq newsticker--process-ids (cons (process-id proc)
780 newsticker--process-ids))
781 (force-mode-line-update)))))
783 (defun newsticker-get-news (feed-name)
784 "Get news from the site FEED-NAME and load feed logo.
785 FEED-NAME must be a string which occurs as the label (i.e. the first element)
786 in an element of `newsticker-url-list' or `newsticker-url-list-defaults'."
787 (newsticker--debug-msg "%s: Getting news for %s"
788 (format-time-string "%A, %H:%M" (current-time))
790 (let* ((item (or (assoc feed-name newsticker-url-list)
791 (assoc feed-name newsticker-url-list-defaults)
793 "Cannot get news for %s: Check newsticker-url-list"
796 (wget-arguments (or (car (cdr (cdr (cdr (cdr item)))))
797 newsticker-wget-arguments)))
799 (newsticker--get-news-by-funcall feed-name url)
800 (if (eq newsticker-retrieval-method 'intern)
801 (newsticker--get-news-by-url feed-name url)
802 (newsticker--get-news-by-wget feed-name url wget-arguments)))))
804 ;; ======================================================================
806 ;; ======================================================================
808 (defun newsticker--sentinel (process event)
809 "Sentinel for extracting news titles from an RDF buffer.
810 Argument PROCESS is the process which has just changed its state.
811 Argument EVENT tells what has happened to the process."
812 (let ((p-status (process-status process))
813 (exit-status (process-exit-status process))
814 (name (process-name process))
815 (command (process-command process))
816 (buffer (process-buffer process)))
817 (newsticker--sentinel-work event
818 (and (eq p-status 'exit)
820 name command buffer)))
822 (defun newsticker--sentinel-work (event status-ok name command buffer)
823 "Actually do the sentinel work.
824 Argument EVENT tells what has happened to the retrieval process.
825 Argument STATUS-OK is the final status of the retrieval process,
826 non-nil meaning retrieval was successful.
827 Argument NAME is the name of the retrieval process.
828 Argument COMMAND is the command of the retrieval process.
829 Argument BUFFER is the buffer of the retrieval process."
830 (let ((time (current-time))
831 (name-symbol (intern name))
832 (something-was-added nil))
833 ;; catch known errors (zombie processes, rubbish-xml etc.
834 ;; if an error occurs the news feed is not updated!
837 (setq newsticker--cache
838 (newsticker--cache-add
841 newsticker--error-headline
843 (concat "%s: Newsticker could not retrieve news from %s.\n"
844 "Return status: `%s'\n"
846 (format-time-string "%A, %H:%M" (current-time))
852 (message "%s: Error while retrieving news from %s"
853 (format-time-string "%A, %H:%M" (current-time))
856 (let* ((coding-system 'utf-8)
860 (unless (fboundp 'libxml-parse-xml-region)
861 (newsticker--do-xml-workarounds))
862 ;; check coding system
863 (goto-char (point-min))
864 (if (re-search-forward "encoding=['\"]\\([^\"]+?\\)['\"]"
866 (setq coding-system (intern (downcase (match-string 1))))
869 (check-coding-system coding-system)
872 "newsticker.el: ignoring coding system %s for %s"
875 ;; Decode if possible
877 (decode-coding-region (point-min) (point-max)
879 (condition-case errordata
880 ;; The xml parser might fail
881 ;; or the xml might be bugged
882 (if (fboundp 'libxml-parse-xml-region)
883 (list (libxml-parse-xml-region (point-min) (point-max)))
884 (xml-parse-region (point-min) (point-max)))
885 (error (message "Could not parse %s: %s"
886 (buffer-name) (cadr errordata))
887 (throw 'oops nil)))))
888 (topnode (car node-list))
890 ;; mark all items as obsolete
891 (newsticker--cache-replace-age newsticker--cache
894 (newsticker--cache-replace-age newsticker--cache
897 (newsticker--cache-replace-age newsticker--cache
901 ;; check Atom/RSS version and call corresponding parser
902 (condition-case error-data
905 ((and (eq 'rss (xml-node-name topnode))
906 (string= "0.91" (xml-get-attribute topnode 'version)))
907 (setq imageurl (newsticker--get-logo-url-rss-0.91 topnode))
908 (newsticker--parse-rss-0.91 name time topnode))
910 ((and (eq 'rss (xml-node-name topnode))
911 (string= "0.92" (xml-get-attribute topnode 'version)))
912 (setq imageurl (newsticker--get-logo-url-rss-0.92 topnode))
913 (newsticker--parse-rss-0.92 name time topnode))
915 ((or (eq 'RDF (xml-node-name topnode))
916 (eq 'rdf:RDF (xml-node-name topnode)))
917 (setq imageurl (newsticker--get-logo-url-rss-1.0 topnode))
918 (newsticker--parse-rss-1.0 name time topnode))
920 ((and (eq 'rss (xml-node-name topnode))
921 (string= "2.0" (xml-get-attribute topnode 'version)))
922 (setq imageurl (newsticker--get-logo-url-rss-2.0 topnode))
923 (newsticker--parse-rss-2.0 name time topnode))
925 ((and (eq 'feed (xml-node-name topnode))
926 (string= "http://purl.org/atom/ns#"
927 (xml-get-attribute topnode 'xmlns)))
928 (setq imageurl (newsticker--get-logo-url-atom-0.3 topnode))
929 (newsticker--parse-atom-0.3 name time topnode))
932 ;; The test for Atom 1.0 does not work when using
933 ;; libxml, as with libxml the namespace attribute is
934 ;; not in the xml tree. For the time being we skip
935 ;; the check and assume that we are dealing with an
938 ;; (and (eq 'feed (xml-node-name topnode))
939 ;; (string= "http://www.w3.org/2005/Atom"
940 ;; (xml-get-attribute topnode 'xmlns)))
941 (setq imageurl (newsticker--get-logo-url-atom-1.0 topnode))
942 (newsticker--parse-atom-1.0 name time topnode))
945 ;; (newsticker--debug-msg "Feed type unknown: %s: %s"
946 ;; (xml-node-name topnode) name)
949 (setq something-was-added t))
950 (error (message "sentinelerror in %s: %s" name error-data)))
952 ;; Remove those old items from cache which have been removed from
954 (newsticker--cache-replace-age newsticker--cache
955 name-symbol 'obsolete-old 'deleteme)
956 (newsticker--cache-remove newsticker--cache name-symbol
958 ;; Remove those new items from cache which have been removed from
959 ;; the feed. Or keep them as `obsolete'
960 (if (not newsticker-keep-obsolete-items)
961 (newsticker--cache-remove newsticker--cache
962 name-symbol 'obsolete-new)
963 (setq newsticker--cache
964 (newsticker--cache-mark-expired
965 newsticker--cache name-symbol 'obsolete 'obsolete-expired
966 newsticker-obsolete-item-max-age))
967 (newsticker--cache-remove newsticker--cache
968 name-symbol 'obsolete-expired)
969 (newsticker--cache-replace-age newsticker--cache
970 name-symbol 'obsolete-new
972 (newsticker--update-process-ids)
973 ;; setup scrollable text
974 (when (= 0 (length newsticker--process-ids))
975 (when (fboundp 'newsticker--ticker-text-setup) ;silence
978 (newsticker--ticker-text-setup)))
979 (setq newsticker--latest-update-time (current-time))
980 (when something-was-added
981 ;; FIXME: should we care about removed items as well?
982 (newsticker--cache-save-feed
983 (newsticker--cache-get-feed name-symbol))
984 (when (fboundp 'newsticker--buffer-set-uptodate) ;silence
987 (newsticker--buffer-set-uptodate nil)))
988 ;; kill the process buffer if wanted
989 (unless newsticker-debug
990 (kill-buffer buffer))
991 ;; launch retrieval of image
992 (when (and imageurl (boundp 'newsticker-download-logos)
993 newsticker-download-logos)
994 (newsticker--image-get name imageurl)))))
995 (when newsticker--sentinel-callback
996 (funcall newsticker--sentinel-callback)))
998 (defun newsticker--do-xml-workarounds ()
999 "Fix all issues which `xml-parse-region' could be choking on."
1001 ;; a very very dirty workaround to overcome the
1002 ;; problems with the newest (20030621) xml.el:
1003 ;; remove all unnecessary whitespace
1004 (goto-char (point-min))
1005 (while (re-search-forward ">[ \t\r\n]+<" nil t)
1006 (replace-match "><" nil t))
1007 ;; and another brutal workaround (20031105)! For some
1008 ;; reason the xml parser does not like the colon in the
1009 ;; doctype name "rdf:RDF"
1010 (goto-char (point-min))
1011 (if (re-search-forward "<!DOCTYPE[ \t\n]+rdf:RDF" nil t)
1012 (replace-match "<!DOCTYPE rdfColonRDF" nil t))
1013 ;; finally.... ~##^°!!!!!
1014 (goto-char (point-min))
1015 (while (search-forward "\r\n" nil t)
1016 (replace-match "\n" nil t))
1017 ;; still more brutal workarounds (20040309)! The xml
1018 ;; parser does not like doctype rss
1019 (goto-char (point-min))
1020 (if (re-search-forward "<!DOCTYPE[ \t\n]+rss[ \t\n]*>" nil t)
1021 (replace-match "" nil t))
1022 ;; And another one (20050618)! (Fixed in GNU Emacs 22.0.50.18)
1023 ;; Remove comments to avoid this xml-parsing bug:
1024 ;; "XML files can have only one toplevel tag"
1025 (goto-char (point-min))
1026 (while (search-forward "<!--" nil t)
1027 (let ((start (match-beginning 0)))
1028 (unless (search-forward "-->" nil t)
1029 (error "Can't find end of comment"))
1030 (delete-region start (point))))
1031 ;; And another one (20050702)! If description is HTML
1032 ;; encoded and starts with a `<', wrap the whole
1033 ;; description in a CDATA expression. This happened for
1034 ;; http://www.thefreedictionary.com/_/WoD/rss.aspx?type=quote
1035 (goto-char (point-min))
1036 (while (re-search-forward
1037 "<description>\\(<img.*?\\)</description>" nil t)
1039 "<description><![CDATA[ \\1 ]]></description>"))
1040 ;; And another one (20051123)! XML parser does not
1041 ;; like this: <yweather:location city="Frankfurt/Main"
1042 ;; region="" country="GM" />
1043 ;; try to "fix" empty attributes
1044 ;; This happened for
1045 ;; http://xml.weather.yahoo.com/forecastrss?p=GMXX0040&u=f
1046 (goto-char (point-min))
1047 (while (re-search-forward "\\(<[^>]*\\)=\"\"" nil t)
1048 (replace-match "\\1=\" \""))
1050 (set-buffer-modified-p nil))
1053 (defun newsticker--get-logo-url-atom-1.0 (node)
1054 "Return logo URL from atom 1.0 data in NODE."
1055 (car (xml-node-children
1056 (car (xml-get-children node 'logo)))))
1058 (defun newsticker--get-logo-url-atom-0.3 (node)
1059 "Return logo URL from atom 0.3 data in NODE."
1060 (car (xml-node-children
1061 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1063 (defun newsticker--get-logo-url-rss-2.0 (node)
1064 "Return logo URL from RSS 2.0 data in NODE."
1065 (car (xml-node-children
1066 (car (xml-get-children
1067 (car (xml-get-children
1068 (car (xml-get-children node 'channel)) 'image)) 'url)))))
1070 (defun newsticker--get-logo-url-rss-1.0 (node)
1071 "Return logo URL from RSS 1.0 data in NODE."
1072 (car (xml-node-children
1073 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1075 (defun newsticker--get-logo-url-rss-0.92 (node)
1076 "Return logo URL from RSS 0.92 data in NODE."
1077 (car (xml-node-children
1078 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1080 (defun newsticker--get-logo-url-rss-0.91 (node)
1081 "Return logo URL from RSS 0.91 data in NODE."
1082 (car (xml-node-children
1083 (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
1085 (defun newsticker--parse-atom-0.3 (name time topnode)
1086 "Parse Atom 0.3 data.
1087 Return value as well as arguments NAME, TIME, and TOPNODE are the
1088 same as in `newsticker--parse-atom-1.0'."
1089 (newsticker--debug-msg "Parsing Atom 0.3 feed %s" name)
1090 (let (new-feed new-item)
1091 (setq new-feed (newsticker--parse-generic-feed
1094 (car (xml-node-children
1095 (car (xml-get-children topnode 'title))))
1097 (car (xml-node-children
1098 (car (xml-get-children topnode 'content))))
1101 (car (xml-get-children topnode 'link)) 'href)
1103 (xml-node-children topnode)))
1104 (setq new-item (newsticker--parse-generic-items
1105 name time (xml-get-children topnode 'entry)
1108 (car (xml-node-children
1109 (car (xml-get-children node 'title)))))
1112 (or (car (xml-node-children
1113 (car (xml-get-children node 'content))))
1114 (car (xml-node-children
1115 (car (xml-get-children node 'summary))))))
1119 (car (xml-get-children node 'link)) 'href))
1122 (newsticker--decode-rfc822-date
1123 (car (xml-node-children
1124 (car (xml-get-children node 'modified))))))
1127 (newsticker--guid-to-string
1128 (assoc 'guid (xml-node-children node))))
1131 (xml-node-children node))))
1132 (or new-item new-feed)))
1134 (defun newsticker--unxml (node)
1135 "Reverse parsing of an xml string.
1136 Restore an xml-string from a an xml-node that was returned by xml-parse..."
1137 (if (or (not node) (stringp node))
1139 (newsticker--unxml-node node)))
1141 (defun newsticker--unxml-node (node)
1142 "Actually restore xml-string of an xml node."
1143 (let ((qname (symbol-name (car node)))
1144 (att-list (cadr node))
1145 (children (cddr node)))
1148 (mapconcat 'newsticker--unxml-attribute att-list " ")
1150 (mapconcat 'newsticker--unxml children "") "</" qname ">")))
1152 (defun newsticker--unxml-attribute (att)
1153 "Actually restore xml-string of an attribute of an xml node."
1154 (let ((name (symbol-name (car att)))
1156 (concat name "=\"" value "\"")))
1158 (defun newsticker--parse-atom-1.0 (name time topnode)
1159 "Parse Atom 1.0 data.
1160 Argument NAME gives the name of a news feed. TIME gives the
1161 system time at which the data have been retrieved. TOPNODE
1162 contains the feed data as returned by the xml parser.
1164 For the Atom 1.0 specification see
1165 URL `http://www.atompub.org/2005/08/17/draft-ietf-atompub-format-11.html'"
1166 (newsticker--debug-msg "Parsing Atom 1.0 feed %s" name)
1167 (let (new-feed new-item)
1168 (setq new-feed (newsticker--parse-generic-feed
1171 (car (xml-node-children
1172 (car (xml-get-children topnode 'title))))
1174 (car (xml-node-children
1175 (car (xml-get-children topnode 'subtitle))))
1179 (car (xml-get-children node 'link)) 'href))
1181 (xml-node-children topnode)))
1182 (setq new-item (newsticker--parse-generic-items
1183 name time (xml-get-children topnode 'entry)
1186 (car (xml-node-children
1187 (car (xml-get-children node 'title)))))
1190 ;; unxml the content node. Atom allows for
1191 ;; integrating (x)html into the atom structure
1192 ;; but we need the raw html string.
1193 ;; e.g. http://www.heise.de/open/news/news-atom.xml
1194 (or (newsticker--unxml
1195 (car (xml-node-children
1196 (car (xml-get-children node 'content)))))
1197 (car (xml-node-children
1198 (car (xml-get-children node 'summary))))))
1202 (car (xml-get-children node 'link)) 'href))
1205 (newsticker--decode-iso8601-date
1206 (or (car (xml-node-children
1207 (car (xml-get-children node 'updated))))
1208 (car (xml-node-children
1209 (car (xml-get-children node 'published)))))))
1212 (car (xml-node-children
1213 (car (xml-get-children node 'id)))))
1216 (xml-node-children node))))
1217 (or new-item new-feed)))
1219 (defun newsticker--parse-rss-0.91 (name time topnode)
1220 "Parse RSS 0.91 data.
1221 Return value as well as arguments NAME, TIME, and TOPNODE are the
1222 same as in `newsticker--parse-atom-1.0'.
1224 For the RSS 0.91 specification see URL `http://backend.userland.com/rss091'
1225 or URL `http://my.netscape.com/publish/formats/rss-spec-0.91.html'."
1226 (newsticker--debug-msg "Parsing RSS 0.91 feed %s" name)
1227 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1228 (pub-date (newsticker--decode-rfc822-date
1229 (car (xml-node-children
1230 (car (xml-get-children channelnode 'pubDate))))))
1231 is-new-feed has-new-items)
1232 (setq is-new-feed (newsticker--parse-generic-feed
1235 (car (xml-node-children
1236 (car (xml-get-children channelnode 'title))))
1238 (car (xml-node-children
1239 (car (xml-get-children channelnode
1242 (car (xml-node-children
1243 (car (xml-get-children channelnode 'link))))
1245 (xml-node-children channelnode)))
1246 (setq has-new-items (newsticker--parse-generic-items
1247 name time (xml-get-children channelnode 'item)
1250 (car (xml-node-children
1251 (car (xml-get-children node 'title)))))
1254 (car (xml-node-children
1255 (car (xml-get-children node 'description)))))
1258 (car (xml-node-children
1259 (car (xml-get-children node 'link)))))
1262 (newsticker--decode-rfc822-date
1263 (car (xml-node-children
1264 (car (xml-get-children node 'pubDate))))))
1270 (xml-node-children node))))
1271 (or has-new-items is-new-feed)))
1273 (defun newsticker--parse-rss-0.92 (name time topnode)
1274 "Parse RSS 0.92 data.
1275 Return value as well as arguments NAME, TIME, and TOPNODE are the
1276 same as in `newsticker--parse-atom-1.0'.
1278 For the RSS 0.92 specification see URL `http://backend.userland.com/rss092'."
1279 (newsticker--debug-msg "Parsing RSS 0.92 feed %s" name)
1280 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1281 (pub-date (newsticker--decode-rfc822-date
1282 (car (xml-node-children
1283 (car (xml-get-children channelnode 'pubDate))))))
1284 is-new-feed has-new-items)
1285 (setq is-new-feed (newsticker--parse-generic-feed
1288 (car (xml-node-children
1289 (car (xml-get-children channelnode 'title))))
1291 (car (xml-node-children
1292 (car (xml-get-children channelnode
1295 (car (xml-node-children
1296 (car (xml-get-children channelnode 'link))))
1298 (xml-node-children channelnode)))
1299 (setq has-new-items (newsticker--parse-generic-items
1300 name time (xml-get-children channelnode 'item)
1303 (car (xml-node-children
1304 (car (xml-get-children node 'title)))))
1307 (car (xml-node-children
1308 (car (xml-get-children node 'description)))))
1311 (car (xml-node-children
1312 (car (xml-get-children node 'link)))))
1315 (newsticker--decode-rfc822-date
1316 (car (xml-node-children
1317 (car (xml-get-children node 'pubDate))))))
1323 (xml-node-children node))))
1324 (or has-new-items is-new-feed)))
1326 (defun newsticker--parse-rss-1.0 (name time topnode)
1327 "Parse RSS 1.0 data.
1328 Return value as well as arguments NAME, TIME, and TOPNODE are the
1329 same as in `newsticker--parse-atom-1.0'.
1331 For the RSS 1.0 specification see URL `http://web.resource.org/rss/1.0/spec'."
1332 (newsticker--debug-msg "Parsing RSS 1.0 feed %s" name)
1333 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1334 is-new-feed has-new-items)
1335 (setq is-new-feed (newsticker--parse-generic-feed
1338 (car (xml-node-children
1339 (car (xml-get-children channelnode 'title))))
1341 (or (car (xml-node-children
1342 (car (xml-get-children channelnode
1344 (car (xml-node-children
1345 (car (xml-get-children channelnode
1346 'content:encoded))))
1347 (car (xml-node-children
1348 (car (xml-get-children channelnode
1351 (car (xml-node-children
1352 (car (xml-get-children channelnode 'link))))
1354 (xml-node-children channelnode)))
1355 (setq has-new-items (newsticker--parse-generic-items
1356 name time (xml-get-children topnode 'item)
1359 (car (xml-node-children
1360 (car (xml-get-children node 'title)))))
1363 (car (xml-node-children
1364 (car (xml-get-children node
1368 (car (xml-node-children
1369 (car (xml-get-children node 'link)))))
1372 (newsticker--decode-iso8601-date
1373 (or (car (xml-node-children
1374 (car (xml-get-children node 'dc:date))))
1375 (car (xml-node-children
1376 (car (xml-get-children node 'date)))))))
1382 (xml-node-children node))))
1383 (or has-new-items is-new-feed)))
1385 (defun newsticker--parse-rss-2.0 (name time topnode)
1386 "Parse RSS 2.0 data.
1387 Return value as well as arguments NAME, TIME, and TOPNODE are the
1388 same as in `newsticker--parse-atom-1.0'.
1390 For the RSS 2.0 specification see URL `http://blogs.law.harvard.edu/tech/rss'."
1391 (newsticker--debug-msg "Parsing RSS 2.0 feed %s" name)
1392 (let* ((channelnode (car (xml-get-children topnode 'channel)))
1393 is-new-feed has-new-items)
1394 (setq is-new-feed (newsticker--parse-generic-feed
1397 (car (xml-node-children
1398 (car (xml-get-children channelnode 'title))))
1400 (or (car (xml-node-children
1401 (car (xml-get-children channelnode
1403 (car (xml-node-children
1404 (car (xml-get-children channelnode
1405 'content:encoded))))
1406 (car (xml-node-children
1407 (car (xml-get-children channelnode
1410 (car (xml-node-children
1411 (car (xml-get-children channelnode 'link))))
1413 (xml-node-children channelnode)))
1414 (setq has-new-items (newsticker--parse-generic-items
1415 name time (xml-get-children channelnode 'item)
1418 (car (xml-node-children
1419 (car (xml-get-children node 'title)))))
1422 (or (car (xml-node-children
1423 (car (xml-get-children node
1425 (car (xml-node-children
1426 (car (xml-get-children node
1427 'content:encoded))))
1428 (car (xml-node-children
1429 (car (xml-get-children node
1433 (car (xml-node-children
1434 (car (xml-get-children node 'link)))))
1437 (newsticker--decode-rfc822-date
1438 (car (xml-node-children
1439 (car (xml-get-children node 'pubDate))))))
1442 (newsticker--guid-to-string
1443 (assoc 'guid (xml-node-children node))))
1446 (xml-node-children node))))
1447 (or has-new-items is-new-feed)))
1449 (defun newsticker--parse-generic-feed (name time title desc link
1451 "Parse generic news feed data.
1452 Argument NAME gives the name of a news feed. TIME gives the
1453 system time at which the data have been retrieved.
1455 The arguments TITLE, DESC, LINK, and EXTRA-ELEMENTS give the feed's title,
1456 description, link, and extra elements resp."
1457 (let ((title (or title "[untitled]"))
1461 (something-was-added nil))
1462 ;; decode numeric entities
1463 (setq title (xml-substitute-numeric-entities title))
1464 (setq desc (xml-substitute-numeric-entities desc))
1465 (setq link (xml-substitute-numeric-entities link))
1466 ;; remove whitespace from title, desc, and link
1467 (setq title (newsticker--remove-whitespace title))
1468 (setq desc (newsticker--remove-whitespace desc))
1469 (setq link (newsticker--remove-whitespace link))
1471 ;; handle the feed itself
1472 (unless (newsticker--cache-contains newsticker--cache
1475 (setq something-was-added t))
1476 (setq newsticker--cache
1477 (newsticker--cache-add newsticker--cache (intern name)
1478 title desc link time 'feed position
1479 extra-elements time 'feed))
1480 something-was-added))
1482 (defun newsticker--parse-generic-items (name time itemlist
1486 "Parse generic news feed data.
1487 Argument NAME gives the name of a news feed. TIME gives the
1488 system time at which the data have been retrieved. ITEMLIST
1489 contains the news items returned by the xml parser.
1491 The arguments TITLE-FN, DESC-FN, LINK-FN, TIME-FN, GUID-FN, and
1492 EXTRA-FN give functions for extracting title, description, link,
1493 time, guid, and extra-elements resp. They are called with one
1494 argument, which is one of the items in ITEMLIST."
1495 (let (title desc link
1498 (something-was-added nil))
1499 ;; gather all items for this feed
1500 (mapc (lambda (node)
1501 (setq position (1+ position))
1502 (setq title (or (funcall title-fn node) "[untitled]"))
1503 (setq desc (funcall desc-fn node))
1504 (setq link (or (funcall link-fn node) ""))
1505 (setq time (or (funcall time-fn node) time))
1506 ;; It happened that the title or description
1507 ;; contained evil HTML code that confused the
1508 ;; xml parser. Therefore:
1509 (unless (stringp title)
1510 (setq title (prin1-to-string title)))
1511 (unless (or (stringp desc) (not desc))
1512 (setq desc (prin1-to-string desc)))
1513 ;; ignore items with empty title AND empty desc
1514 (when (or (> (length title) 0)
1515 (> (length desc) 0))
1516 ;; decode numeric entities
1517 (setq title (xml-substitute-numeric-entities title))
1519 (setq desc (xml-substitute-numeric-entities desc)))
1520 (setq link (xml-substitute-numeric-entities link))
1521 ;; remove whitespace from title, desc, and link
1522 (setq title (newsticker--remove-whitespace title))
1523 (setq desc (newsticker--remove-whitespace desc))
1524 (setq link (newsticker--remove-whitespace link))
1525 ;; add data to cache
1526 ;; do we have this item already?
1527 (let* ((guid (funcall guid-fn node)))
1528 ;;(message "guid=%s" guid)
1530 (newsticker--cache-contains newsticker--cache
1532 desc link nil guid)))
1533 ;; add this item, or mark it as old, or do nothing
1538 (let ((prev-age (newsticker--age old-item)))
1539 (unless newsticker-automatically-mark-items-as-old
1540 ;; Some feeds deliver items multiply, the
1541 ;; first time we find an 'obsolete-old one in
1542 ;; the cache, the following times we find an
1544 (if (memq prev-age '(obsolete-old old))
1547 (if (eq prev-age 'immortal)
1548 (setq age2 'immortal))
1549 (setq time (newsticker--time old-item)))
1550 ;; item was not there
1552 (setq something-was-added t))
1553 (setq newsticker--cache
1554 (newsticker--cache-add
1555 newsticker--cache (intern name) title desc link
1556 time age1 position (funcall extra-fn node)
1559 (let ((item (newsticker--cache-contains
1560 newsticker--cache (intern name) title
1562 (if newsticker-auto-mark-filter-list
1563 (newsticker--run-auto-mark-filter name item))
1565 'newsticker-new-item-functions name item))))))
1567 something-was-added))
1569 ;; ======================================================================
1571 ;; ======================================================================
1573 (defun newsticker--remove-whitespace (string)
1574 "Remove leading and trailing whitespace from STRING."
1575 ;; we must have ...+ but not ...* in the regexps otherwise xemacs loops
1577 (when (and string (stringp string))
1578 (replace-regexp-in-string
1580 (replace-regexp-in-string "^[ \t\r\n]+" "" string))))
1582 (defun newsticker--do-forget-preformatted (item)
1583 "Forget pre-formatted data for ITEM.
1584 Remove the pre-formatted from `newsticker--cache'."
1586 (setcar (nthcdr 7 item) nil))
1588 (setcar (nthcdr 6 item) nil)))
1590 (defun newsticker--forget-preformatted ()
1591 "Forget all cached pre-formatted data.
1592 Remove the pre-formatted from `newsticker--cache'."
1593 (mapc (lambda (feed)
1594 (mapc 'newsticker--do-forget-preformatted
1597 (when (fboundp 'newsticker--buffer-set-uptodate)
1598 (newsticker--buffer-set-uptodate nil)))
1600 (defun newsticker--debug-msg (string &rest args)
1601 "Print newsticker debug messages.
1602 This function calls `message' with arguments STRING and ARGS, if
1603 `newsticker-debug' is non-nil."
1604 (and newsticker-debug
1605 ;;(not (active-minibuffer-window))
1606 ;;(not (current-message))
1607 (apply 'message string args)))
1609 (defun newsticker--decode-iso8601-date (iso8601-string)
1610 "Return ISO8601-STRING in format like `decode-time'.
1611 Converts from ISO-8601 to Emacs representation.
1613 2004-09-17T05:09:49.001+00:00
1614 2004-09-17T05:09:49+00:00
1615 2004-09-17T05:09+00:00
1624 "^ *\\([0-9]\\{4\\}\\)" ;year
1625 "\\(-\\([0-9]\\{2\\}\\)" ;month
1626 "\\(-\\([0-9]\\{2\\}\\)" ;day
1628 "\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)" ;hour:minute
1629 "\\(:\\([0-9]\\{2\\}\\)\\(\\.[0-9]+\\)?\\)?" ;second
1631 "\\(\\([-+Z]\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)?"
1634 (let ((year (read (match-string 1 iso8601-string)))
1635 (month (read (or (match-string 3 iso8601-string)
1637 (day (read (or (match-string 5 iso8601-string)
1639 (hour (read (or (match-string 7 iso8601-string)
1641 (minute (read (or (match-string 8 iso8601-string)
1643 (second (read (or (match-string 10 iso8601-string)
1645 (sign (match-string 13 iso8601-string))
1646 (offset-hour (read (or (match-string 15 iso8601-string)
1648 (offset-minute (read (or (match-string 16 iso8601-string)
1650 (cond ((string= sign "+")
1651 (setq hour (- hour offset-hour))
1652 (setq minute (- minute offset-minute)))
1654 (setq hour (+ hour offset-hour))
1655 (setq minute (+ minute offset-minute))))
1656 ;; if UTC subtract current-time-zone offset
1657 ;;(setq second (+ (car (current-time-zone)) second)))
1660 (encode-time second minute hour day month year t)
1662 (message "Cannot decode \"%s\"" iso8601-string)
1666 (defun newsticker--decode-rfc822-date (rfc822-string)
1667 "Return RFC822-STRING in format like `decode-time'.
1668 Converts from RFC822 to Emacs representation.
1670 Sat, 07 September 2002 00:00:01 +0100
1671 Sat, 07 September 2002 00:00:01 MET
1672 Sat, 07 Sep 2002 00:00:01 GMT
1673 07 Sep 2002 00:00:01 GMT
1675 (if (and rfc822-string (stringp rfc822-string))
1680 "\\(\\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\)\\s-*,?\\)?\\s-*"
1682 "\\([0-9]\\{1,2\\}\\)\\s-+"
1684 "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|"
1685 "Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\).*?\\s-+"
1687 "\\([0-9]\\{2,4\\}\\)"
1688 ;; time may be missing
1691 "\\([0-9]\\{2\\}\\)"
1693 ":\\([0-9]\\{2\\}\\)"
1695 "\\(:\\([0-9]\\{2\\}\\)\\)?"
1698 "UT\\|GMT\\|EST\\|EDT\\|CST\\|CDT\\|MST\\|MDT\\|PST\\|PDT"
1699 "\\|\\([-+]\\)\\([0-9]\\{2\\}\\)\\([0-9]\\{2\\}\\)"
1703 (let ((day (read (match-string 3 rfc822-string)))
1704 (month-name (match-string 4 rfc822-string))
1706 (year (read (match-string 5 rfc822-string)))
1707 (hour (read (or (match-string 7 rfc822-string) "0")))
1708 (minute (read (or (match-string 8 rfc822-string) "0")))
1709 (second (read (or (match-string 10 rfc822-string) "0")))
1710 (zone (match-string 12 rfc822-string))
1711 (sign (match-string 13 rfc822-string))
1712 (offset-hour (read (or (match-string 14 rfc822-string)
1714 (offset-minute (read (or (match-string 15 rfc822-string)
1719 (cond ((string= sign "+")
1720 (setq hour (- hour offset-hour))
1721 (setq minute (- minute offset-minute)))
1723 (setq hour (+ hour offset-hour))
1724 (setq minute (+ minute offset-minute)))))
1725 (condition-case error-data
1728 (if (string= month-name m)
1731 '("Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug"
1732 "Sep" "Oct" "Nov" "Dec"))
1733 (encode-time second minute hour day month year t))
1735 (message "Cannot decode \"%s\": %s %s" rfc822-string
1736 (car error-data) (cdr error-data))
1740 (defun newsticker--lists-intersect-p (list1 list2)
1741 "Return t if LIST1 and LIST2 share elements."
1744 (if (memq elt list2)
1749 (defun newsticker--update-process-ids ()
1750 "Update list of ids of active newsticker processes.
1751 Checks list of active processes against list of newsticker processes."
1752 (let ((active-procs (process-list))
1754 (mapc (lambda (proc)
1755 (let ((id (process-id proc)))
1756 (if (memq id newsticker--process-ids)
1757 (setq new-list (cons id new-list)))))
1759 (setq newsticker--process-ids new-list))
1760 (force-mode-line-update))
1762 ;; ======================================================================
1764 ;; ======================================================================
1765 (defun newsticker--images-dir ()
1766 "Return directory where feed images are saved."
1767 (concat newsticker-dir "/images/"))
1769 (defun newsticker--image-get (feed-name url)
1770 "Get image of the news site FEED-NAME from URL.
1771 If the image has been downloaded in the last 24h do nothing."
1772 (let ((image-name (concat (newsticker--images-dir) feed-name)))
1773 (if (and (file-exists-p image-name)
1774 (time-less-p (current-time)
1775 (time-add (nth 5 (file-attributes image-name))
1776 (seconds-to-time 86400))))
1777 (newsticker--debug-msg "%s: Getting image for %s skipped"
1778 (format-time-string "%A, %H:%M" (current-time))
1781 (newsticker--debug-msg "%s: Getting image for %s"
1782 (format-time-string "%A, %H:%M" (current-time))
1784 (let* ((buffername (concat " *newsticker-wget-image-" feed-name "*"))
1785 (item (or (assoc feed-name newsticker-url-list)
1786 (assoc feed-name newsticker-url-list-defaults)
1788 "Cannot get image for %s: Check newsticker-url-list"
1790 (wget-arguments (or (car (cdr (cdr (cdr (cdr item)))))
1791 newsticker-wget-arguments)))
1792 (with-current-buffer (get-buffer-create buffername)
1794 ;; throw an error if there is an old wget-process around
1795 (if (get-process feed-name)
1796 (error "Another wget-process is running for image %s"
1799 (let* ((args (append wget-arguments (list url)))
1800 (proc (apply 'start-process feed-name buffername
1801 newsticker-wget-name args)))
1802 (set-process-coding-system proc 'no-conversion 'no-conversion)
1803 (set-process-sentinel proc 'newsticker--image-sentinel)))))))
1805 (defun newsticker--image-sentinel (process event)
1806 "Sentinel for image-retrieving PROCESS caused by EVENT."
1807 (let* ((p-status (process-status process))
1808 (exit-status (process-exit-status process))
1809 (feed-name (process-name process)))
1810 ;; catch known errors (zombie processes, rubbish-xml, etc.)
1811 ;; if an error occurs the news feed is not updated!
1813 (unless (and (eq p-status 'exit)
1815 (message "%s: Error while retrieving image from %s"
1816 (format-time-string "%A, %H:%M" (current-time))
1820 (with-current-buffer (process-buffer process)
1821 (setq image-name (concat (newsticker--images-dir) feed-name))
1822 (set-buffer-file-coding-system 'no-conversion)
1823 ;; make sure the cache dir exists
1824 (unless (file-directory-p (newsticker--images-dir))
1825 (make-directory (newsticker--images-dir)))
1826 ;; write and close buffer
1827 (let ((require-final-newline nil)
1828 (backup-inhibited t)
1829 (coding-system-for-write 'no-conversion))
1830 (write-region nil nil image-name nil 'quiet))
1831 (set-buffer-modified-p nil)
1832 (kill-buffer (current-buffer)))))))
1834 (defun newsticker--insert-image (img string)
1835 "Insert IMG with STRING at point."
1836 (insert-image img string))
1838 ;; ======================================================================
1840 ;; ======================================================================
1841 (defun newsticker-htmlr-render (pos1 pos2) ;
1842 "Replacement for `htmlr-render'.
1843 Renders the HTML code in the region POS1 to POS2 using htmlr."
1844 (let ((str (buffer-substring-no-properties pos1 pos2)))
1845 (delete-region pos1 pos2)
1849 (goto-char (point-min))
1850 ;; begin original htmlr-render
1851 (when (fboundp 'htmlr-reset) (htmlr-reset))
1852 ;; something omitted here...
1853 (when (fboundp 'htmlr-step)
1854 (while (< (point) (point-max))
1856 ;; end original htmlr-render
1857 (newsticker--remove-whitespace (buffer-string))))))
1859 ;; ======================================================================
1860 ;;; Manipulation of cached data
1861 ;; ======================================================================
1862 (defun newsticker--cache-set-preformatted-contents (item contents)
1863 "Set preformatted contents of ITEM to CONTENTS."
1865 (setcar (nthcdr 6 item) contents)
1866 (setcdr (nthcdr 5 item) (list contents))))
1868 (defun newsticker--cache-set-preformatted-title (item title)
1869 "Set preformatted title of ITEM to TITLE."
1871 (setcar (nthcdr 7 item) title)
1872 (setcdr (nthcdr 6 item) title)))
1874 (defun newsticker--cache-replace-age (data feed old-age new-age)
1875 "Mark all items in DATA in FEED which carry age OLD-AGE with NEW-AGE.
1876 If FEED is 'any it applies to all feeds. If OLD-AGE is 'any,
1877 all marks are replaced by NEW-AGE. Removes all pre-formatted contents."
1878 (mapc (lambda (a-feed)
1879 (when (or (eq feed 'any)
1880 (eq (car a-feed) feed))
1881 (let ((items (cdr a-feed)))
1882 (mapc (lambda (item)
1883 (when (or (eq old-age 'any)
1884 (eq (newsticker--age item) old-age))
1885 (setcar (nthcdr 4 item) new-age)
1886 (newsticker--do-forget-preformatted item)))
1891 (defun newsticker--cache-mark-expired (data feed old-age new-age time)
1892 "Mark all expired entries.
1893 This function sets the age entries in DATA in the feed FEED. If
1894 an item's age is OLD-AGE it is set to NEW-AGE if the item is
1898 (when (or (eq feed 'any)
1899 (eq (car a-feed) feed))
1900 (let ((items (cdr a-feed)))
1903 (when (eq (newsticker--age item) old-age)
1904 (let ((exp-time (time-add (newsticker--time item)
1905 (seconds-to-time time))))
1906 (when (time-less-p exp-time (current-time))
1907 (newsticker--debug-msg
1908 "Item `%s' from %s has expired on %s"
1909 (newsticker--title item)
1910 (format-time-string "%Y-%02m-%d, %H:%M"
1911 (newsticker--time item))
1912 (format-time-string "%Y-%02m-%d, %H:%M" exp-time))
1913 (setcar (nthcdr 4 item) new-age)))))
1918 (defun newsticker--cache-contains (data feed title desc link age
1920 "Check DATA whether FEED contains an item with the given properties.
1921 This function returns the contained item or nil if it is not
1923 The properties which are checked are TITLE, DESC, LINK, AGE, and
1924 GUID. In general all properties must match in order to return a
1925 certain item, except for the following cases.
1927 If AGE equals 'feed the TITLE, DESCription and LINK do not
1928 matter. If DESC is nil it is ignored as well. If
1929 `newsticker-desc-comp-max' is non-nil, only the first
1930 `newsticker-desc-comp-max' characters of DESC are taken into
1933 If GUID is non-nil it is sufficient to match this value, and the
1934 other properties are ignored."
1935 ;;(newsticker--debug-msg "Looking for %s guid=%s" title guid)
1938 (when (and desc newsticker-desc-comp-max
1939 (> (length desc) newsticker-desc-comp-max))
1940 (setq desc (substring desc 0 newsticker-desc-comp-max)))
1943 (when (eq (car this-feed) feed)
1944 (mapc (lambda (anitem)
1946 ;; global unique id can match
1947 (string= guid (newsticker--guid anitem)))
1950 ;; or title, desc, etc.
1952 ;;(or (not (eq age 'feed))
1953 ;; (eq (newsticker--age anitem) 'feed))
1954 (string= (newsticker--title anitem)
1957 (string= (newsticker--link anitem)
1960 (if (and desc newsticker-desc-comp-max
1961 (> (length (newsticker--desc
1963 newsticker-desc-comp-max))
1965 (newsticker--desc anitem)
1967 newsticker-desc-comp-max)
1969 (string= (newsticker--desc anitem)
1971 ;;(newsticker--debug-msg "Found %s guid=%s"
1972 ;; (newsticker--title anitem)
1973 ;; (newsticker--guid anitem))
1974 (throw 'found anitem)))
1977 ;;(newsticker--debug-msg "Found nothing")
1981 (defun newsticker--cache-add (data feed-name-symbol title desc link time age
1982 position extra-elements
1983 &optional updated-time updated-age
1984 preformatted-contents
1986 "Add another item to cache data.
1987 Add to DATA in the FEED-NAME-SYMBOL an item with TITLE, DESC,
1988 LINK, TIME, AGE, POSITION, and EXTRA-ELEMENTS. If this item is
1989 contained already, its time is set to UPDATED-TIME, its mark is
1990 set to UPDATED-AGE, and its pre-formatted contents is set to
1991 PREFORMATTED-CONTENTS and PREFORMATTED-TITLE. Returns the age
1992 which the item got."
1993 (let* ((guid (newsticker--guid-to-string (assoc 'guid extra-elements)))
1994 (item (newsticker--cache-contains data feed-name-symbol title desc link
1996 ;;(message "guid=%s" guid)
1998 ;; does exist already -- change age, update time and position
2000 ;;(newsticker--debug-msg "Updating item %s %s %s %s %s -> %s %s
2002 ;; feed-name-symbol title link time age
2003 ;; updated-time updated-age
2004 ;; guid (newsticker--guid item))
2006 (setcar (nthcdr 5 item) position)
2007 (setcdr (nthcdr 4 item) (list position)))
2008 (setcar (nthcdr 4 item) updated-age)
2010 (setcar (nthcdr 3 item) updated-time))
2011 ;; replace cached pre-formatted contents
2012 (newsticker--cache-set-preformatted-contents
2013 item preformatted-contents)
2014 (newsticker--cache-set-preformatted-title
2015 item preformatted-title))
2016 ;; did not exist or age equals 'feed-name-symbol
2017 (setq item (list title desc link time age position preformatted-contents
2018 preformatted-title extra-elements))
2019 ;;(newsticker--debug-msg "Adding item %s" item)
2021 (mapc (lambda (this-feed)
2022 (when (eq (car this-feed) feed-name-symbol)
2023 (setcdr this-feed (nconc (cdr this-feed) (list item)))
2024 (throw 'found this-feed)))
2026 ;; the feed is not contained
2027 (add-to-list 'data (list feed-name-symbol item) t))))
2030 (defun newsticker--cache-remove (data feed-symbol age)
2031 "Remove all entries from DATA in the feed FEED-SYMBOL with AGE.
2032 FEED-SYMBOL may be 'any. Entries from old feeds, which are no longer in
2033 `newsticker-url-list' or `newsticker-url-list-defaults', are removed as
2039 (if (or (assoc (symbol-name (car feed)) newsticker-url-list)
2040 (assoc (symbol-name (car feed)) newsticker-url-list-defaults))
2041 ;; feed is still valid=active
2042 ;; (message "Keeping feed %s" (car feed))
2043 (if (or (eq feed-symbol 'any)
2044 (eq feed-symbol (car feed)))
2045 (let* ((item-pos (cdr feed))
2046 (item (car item-pos))
2049 ;;(message "%s" (car item))
2050 (if (eq age (newsticker--age item))
2053 ;;(message "Removing item %s" (car item))
2055 (setcdr prev-pos (cdr item-pos))
2056 (setcdr feed (cdr item-pos))))
2057 ;;(message "Keeping item %s" (car item))
2058 (setq prev-pos item-pos))
2059 (setq item-pos (cdr item-pos))
2060 (setq item (car item-pos)))))
2061 ;; feed is not active anymore
2062 ;; (message "Removing feed %s" (car feed))
2064 (setcdr last-pos (cdr pos))
2065 (setq data (cdr pos))))
2067 (setq pos (cdr pos))
2068 (setq feed (car pos)))))
2070 ;; ======================================================================
2072 ;; ======================================================================
2073 (defun newsticker--cache-item-compare-by-time (item1 item2)
2074 "Compare two news items ITEM1 and ITEM2 by comparing their time values."
2076 (let ((age1 (newsticker--age item1))
2077 (age2 (newsticker--age item2)))
2078 (if (not (eq age1 age2))
2079 (cond ((eq age1 'obsolete)
2080 (throw 'result nil))
2081 ((eq age2 'obsolete)
2082 (throw 'result t)))))
2083 (let* ((time1 (newsticker--time item1))
2084 (time2 (newsticker--time item2)))
2085 (cond ((< (nth 0 time1) (nth 0 time2))
2087 ((> (nth 0 time1) (nth 0 time2))
2089 ((< (nth 1 time1) (nth 1 time2))
2091 ((> (nth 1 time1) (nth 1 time2))
2093 ((< (or (nth 2 time1) 0) (or (nth 2 time2) 0))
2095 ((> (or (nth 2 time1) 0) (or (nth 2 time2) 0))
2100 (defun newsticker--cache-item-compare-by-title (item1 item2)
2101 "Compare ITEM1 and ITEM2 by comparing their titles."
2103 (let ((age1 (newsticker--age item1))
2104 (age2 (newsticker--age item2)))
2105 (if (not (eq age1 age2))
2106 (cond ((eq age1 'obsolete)
2107 (throw 'result nil))
2108 ((eq age2 'obsolete)
2109 (throw 'result t)))))
2110 (string< (newsticker--title item1) (newsticker--title item2))))
2112 (defun newsticker--cache-item-compare-by-position (item1 item2)
2113 "Compare ITEM1 and ITEM2 by comparing their original positions."
2115 (let ((age1 (newsticker--age item1))
2116 (age2 (newsticker--age item2)))
2117 (if (not (eq age1 age2))
2118 (cond ((eq age1 'obsolete)
2119 (throw 'result nil))
2120 ((eq age2 'obsolete)
2121 (throw 'result t)))))
2122 (< (or (newsticker--pos item1) 0) (or (newsticker--pos item2) 0))))
2124 (defun newsticker--cache-save-version1 ()
2125 "Update and save newsticker cache file."
2127 (newsticker--cache-update t))
2129 (defun newsticker--cache-update (&optional save)
2130 "Update newsticker cache file.
2131 If optional argument SAVE is not nil the cache file is saved to disk."
2133 (unless (file-directory-p newsticker-dir)
2134 (make-directory newsticker-dir t))
2135 (let ((coding-system-for-write 'utf-8)
2136 (buf (find-file-noselect newsticker-cache-filename)))
2139 (setq buffer-undo-list t)
2141 (insert ";; -*- coding: utf-8 -*-\n")
2142 (insert (prin1-to-string newsticker--cache))
2146 (defun newsticker--cache-get-feed (feed)
2147 "Return the cached data for the feed FEED.
2149 (assoc feed newsticker--cache))
2151 (defun newsticker--cache-dir ()
2152 "Return directory for saving cache data."
2153 (concat newsticker-dir "/feeds"))
2155 (defun newsticker--cache-save ()
2156 "Save cache data for all feeds."
2157 (unless (file-directory-p newsticker-dir)
2158 (make-directory newsticker-dir t))
2159 (mapc 'newsticker--cache-save-feed newsticker--cache)
2162 (defun newsticker--cache-save-feed (feed)
2163 "Save cache data for FEED."
2164 (let ((dir (concat (newsticker--cache-dir) "/" (symbol-name (car feed)))))
2165 (unless (file-directory-p dir)
2166 (make-directory dir t))
2167 (let ((coding-system-for-write 'utf-8))
2168 (with-temp-file (concat dir "/data")
2169 (insert ";; -*- coding: utf-8 -*-\n")
2170 (insert (prin1-to-string (cdr feed)))))))
2172 (defun newsticker--cache-read-version1 ()
2173 "Read version1 cache data."
2174 (let ((coding-system-for-read 'utf-8))
2175 (when (file-exists-p newsticker-cache-filename)
2177 (insert-file-contents newsticker-cache-filename)
2178 (goto-char (point-min))
2180 (setq newsticker--cache (read (current-buffer)))
2182 (message "Error while reading newsticker cache file!")
2183 (setq newsticker--cache nil)))))))
2185 (defun newsticker--cache-read ()
2187 (setq newsticker--cache nil)
2188 (if (file-exists-p newsticker-cache-filename)
2190 (when (y-or-n-p "Old newsticker cache file exists. Read it? ")
2191 (newsticker--cache-read-version1))
2192 (when (y-or-n-p (format "Delete old newsticker cache file? "))
2193 (delete-file newsticker-cache-filename)))
2195 (newsticker--cache-read-feed (car f)))
2196 (append newsticker-url-list-defaults newsticker-url-list))))
2198 (defun newsticker--cache-read-feed (feed-name)
2199 "Read cache data for feed named FEED-NAME."
2200 (let ((file-name (concat (newsticker--cache-dir) "/" feed-name "/data"))
2201 (coding-system-for-read 'utf-8))
2202 (when (file-exists-p file-name)
2204 (insert-file-contents file-name)
2205 (goto-char (point-min))
2207 (add-to-list 'newsticker--cache (cons (intern feed-name)
2208 (read (current-buffer))))
2210 (message "Error while reading newsticker cache file %s!"
2212 (setq newsticker--cache nil)))))))
2214 ;; ======================================================================
2216 ;; ======================================================================
2217 (defun newsticker--stat-num-items (feed &rest ages)
2218 "Return number of items in the given FEED which have one of the given AGES.
2219 If AGES is nil, the total number of items is returned."
2220 (let ((items (cdr (newsticker--cache-get-feed feed)))
2224 (if (memq (newsticker--age (car items)) ages)
2225 (setq num (1+ num)))
2226 (if (memq (newsticker--age (car items)) '(new old immortal obsolete))
2227 (setq num (1+ num))))
2228 (setq items (cdr items)))
2231 (defun newsticker--stat-num-items-total (&optional age)
2232 "Return total number of items in all feeds which have the given AGE.
2233 If AGE is nil, the total number of items is returned."
2235 (mapcar (lambda (feed)
2237 (newsticker--stat-num-items (intern (car feed)) age)
2238 (newsticker--stat-num-items (intern (car feed)))))
2239 (append newsticker-url-list-defaults newsticker-url-list))))
2241 ;; ======================================================================
2243 ;; ======================================================================
2244 (defun newsticker-opml-export ()
2245 "OPML subscription export.
2246 Export subscriptions to a buffer in OPML Format."
2248 (with-current-buffer (get-buffer-create "*OPML Export*")
2249 (set-buffer-file-coding-system 'utf-8)
2251 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
2252 "<!-- OPML generated by Emacs newsticker.el -->\n"
2253 "<opml version=\"1.0\">\n"
2255 " <title>mySubscriptions</title>\n"
2256 " <dateCreated>" (format-time-string "%a, %d %b %Y %T %z")
2258 " <ownerEmail>" user-mail-address "</ownerEmail>\n"
2259 " <ownerName>" (user-full-name) "</ownerName>\n"
2263 (insert " <outline text=\"")
2264 (insert (newsticker--title sub))
2265 (insert "\" xmlUrl=\"")
2268 (append newsticker-url-list newsticker-url-list-defaults))
2269 (insert " </body>\n</opml>\n"))
2270 (pop-to-buffer "*OPML Export*")
2271 (when (fboundp 'sgml-mode)
2274 (defun newsticker--opml-import-outlines (outlines)
2275 "Recursively import OUTLINES from OPML data.
2276 Note that nested outlines are currently flattened -- i.e. grouping is
2278 (mapc (lambda (outline)
2279 (let ((name (xml-get-attribute outline 'text))
2280 (url (xml-get-attribute outline 'xmlUrl))
2281 (children (xml-get-children outline 'outline)))
2282 (unless (string= "" url)
2283 (add-to-list 'newsticker-url-list
2284 (list name url nil nil nil) t))
2286 (newsticker--opml-import-outlines children))))
2289 (defun newsticker-opml-import (filename)
2290 "Import OPML data from FILENAME."
2291 (interactive "fOPML file: ")
2292 (set-buffer (find-file-noselect filename))
2293 (goto-char (point-min))
2294 (let* ((node-list (xml-parse-region (point-min) (point-max)))
2295 (body (car (xml-get-children (car node-list) 'body)))
2296 (outlines (xml-get-children body 'outline)))
2297 (newsticker--opml-import-outlines outlines))
2298 (customize-variable 'newsticker-url-list))
2300 ;; ======================================================================
2302 ;; ======================================================================
2303 (defun newsticker--run-auto-mark-filter (feed item)
2304 "Automatically mark an item as old or immortal.
2305 This function checks the variable `newsticker-auto-mark-filter-list'
2306 for an entry that matches FEED and ITEM."
2307 (let ((case-fold-search t))
2308 (mapc (lambda (filter)
2309 (let ((filter-feed (car filter))
2310 (pattern-list (cadr filter)))
2311 (when (string-match filter-feed feed)
2312 (newsticker--do-run-auto-mark-filter item pattern-list))))
2313 newsticker-auto-mark-filter-list)))
2315 (defun newsticker--do-run-auto-mark-filter (item list)
2316 "Actually compare ITEM against the pattern-LIST.
2317 LIST must be an element of `newsticker-auto-mark-filter-list'."
2318 (mapc (lambda (pattern)
2319 (let ((place (nth 1 pattern))
2320 (regexp (nth 2 pattern))
2321 (title (newsticker--title item))
2322 (desc (newsticker--desc item)))
2323 (when (or (eq place 'title) (eq place 'all))
2324 (when (and title (string-match regexp title))
2325 (newsticker--process-auto-mark-filter-match item pattern)))
2326 (when (or (eq place 'description) (eq place 'all))
2327 (when (and desc (string-match regexp desc))
2328 (newsticker--process-auto-mark-filter-match item pattern)))))
2331 (defun newsticker--process-auto-mark-filter-match (item pattern)
2332 "Process ITEM that matches an auto-mark-filter PATTERN."
2333 (let ((age (nth 0 pattern))
2334 (place (nth 1 pattern))
2335 (regexp (nth 2 pattern)))
2336 (newsticker--debug-msg "Auto-mark-filter %s matches `%s'"
2337 pattern (newsticker--title item))
2338 (setcar (nthcdr 4 item) age)
2339 (nconc (newsticker--extra item)
2340 (list (list 'newsticker-auto-mark nil
2341 (format "age=%s, title/desc=%s, regexp=%s"
2342 age place regexp))))))
2344 ;; ======================================================================
2346 ;; ======================================================================
2347 (defun newsticker-new-item-functions-sample (feed item)
2348 "Demonstrate the use of the `newsticker-new-item-functions' hook.
2349 This function just prints out the values of the FEED and title of the ITEM."
2350 (message (concat "newsticker-new-item-functions-sample: feed=`%s', "
2352 feed (newsticker--title item)))
2354 (defun newsticker-download-images (feed item)
2355 "Download the first image.
2356 If FEED equals \"imagefeed\" download the first image URL found
2357 in the description=contents of ITEM to the directory
2358 \"~/tmp/newsticker/FEED/TITLE\" where TITLE is the title of the item."
2359 (when (string= feed "imagefeed")
2360 (let ((title (newsticker--title item))
2361 (desc (newsticker--desc item)))
2362 (when (string-match "<img src=\"\\(http://[^ \"]+\\)\"" desc)
2363 (let ((url (substring desc (match-beginning 1) (match-end 1)))
2364 (temp-dir (concat "~/tmp/newsticker/" feed "/" title))
2365 (org-dir default-directory))
2366 (unless (file-directory-p temp-dir)
2367 (make-directory temp-dir t))
2369 (message "Getting image %s" url)
2370 (apply 'start-process "wget-image"
2371 " *newsticker-wget-download-images*"
2372 newsticker-wget-name
2376 (defun newsticker-download-enclosures (feed item)
2377 "In all FEEDs download the enclosed object of the news ITEM.
2378 The object is saved to the directory \"~/tmp/newsticker/FEED/TITLE\", which
2379 is created if it does not exist. TITLE is the title of the news
2380 item. Argument FEED is ignored.
2381 This function is suited for adding it to `newsticker-new-item-functions'."
2382 (let ((title (newsticker--title item))
2383 (enclosure (newsticker--enclosure item)))
2385 (let ((url (cdr (assoc 'url enclosure)))
2386 (temp-dir (concat "~/tmp/newsticker/" feed "/" title))
2387 (org-dir default-directory))
2388 (unless (file-directory-p temp-dir)
2389 (make-directory temp-dir t))
2391 (message "Getting enclosure %s" url)
2392 (apply 'start-process "wget-enclosure"
2393 " *newsticker-wget-download-enclosures*"
2394 newsticker-wget-name
2398 ;; ======================================================================
2399 ;;; Retrieve samples
2400 ;; ======================================================================
2401 (defun newsticker-retrieve-random-message (feed-name)
2402 "Return an artificial RSS string under the name FEED-NAME."
2403 (concat "<?xml version=\"1.0\" encoding=\"iso-8859-1\" ?><rss version=\"0.91\">"
2405 "<title>newsticker-retrieve-random-message</title>"
2406 "<description>Sample retrieval function</description>"
2407 "<pubDate>FIXME Sat, 07 Sep 2005 00:00:01 GMT</pubDate>"
2408 "<item><title>" (format "Your lucky number is %d" (random 10000))
2409 "</title><description>" (format "Or maybe it is %d" (random 10000))
2410 "</description></item></channel></rss>"))
2412 (provide 'newst-backend)
2414 ;;; newst-backend.el ends here