1 ;;; newst-backend.el --- Retrieval backend for newsticker.
3 ;; Copyright (C) 2003-2017 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 ;; ======================================================================
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--sentinel-callback nil
51 "Function called at end of `newsticker--sentinel'.")
54 (defun newsticker-running-p ()
55 "Check whether newsticker is running.
56 Return t if newsticker is running, nil otherwise. Newsticker is
57 considered to be running if the newsticker timer list is not empty."
58 (> (length newsticker--retrieval-timer-list
) 0))
60 ;; ======================================================================
62 ;; ======================================================================
63 (defgroup newsticker nil
64 "Aggregator for RSS and Atom feeds."
67 (defconst newsticker--raw-url-list-defaults
69 "http://export.cnet.com/export/feeds/news/rss/1,11176,,00.xml")
70 ("Debian Security Advisories"
71 "http://www.debian.org/security/dsa.en.rdf")
72 ("Debian Security Advisories - Long format"
73 "http://www.debian.org/security/dsa-long.en.rdf")
75 "https://www.emacswiki.org/emacs?action=rss"
78 ("LWN (Linux Weekly News)"
79 "http://lwn.net/headlines/rss")
80 ("NY Times: Technology"
81 "http://partners.userland.com/nytRss/technology.xml")
83 "http://partners.userland.com/nytRss/nytHomepage.xml")
85 "http://www.quotationspage.com/data/qotd.rss"
89 "http://www.theregister.co.uk/tonys/slashdot.rdf")
91 "http://slashdot.org/index.rss"
93 3600) ;/. will ban you if under 3600 seconds!
95 "http://www.wired.com/news_drop/netcenter/netcenter.rdf")
96 ("Heise News (german)"
97 "http://www.heise.de/newsticker/heise.rdf")
98 ("Tagesschau (german)"
99 "http://www.tagesschau.de/newsticker.rdf"
102 "Default URL list in raw form.
103 This list is fed into defcustom via `newsticker--splicer'.")
105 (defun newsticker--splicer (item)
106 "Convert ITEM for splicing into `newsticker-url-list-defaults'."
107 (let ((result (list 'list
:tag
(nth 0 item
) (list 'const
(nth 0 item
))))
108 (element (cdr item
)))
110 (setq result
(append result
(list (list 'const
(car element
)))))
111 (setq element
(cdr element
)))
114 (defun newsticker--set-customvar-retrieval (symbol value
)
115 "Set retrieval related newsticker-variable SYMBOL value to VALUE.
116 Calls all actions which are necessary in order to make the new
118 (if (or (not (boundp symbol
))
119 (equal (symbol-value symbol
) value
))
121 ;; something must have changed
122 (let ((need-restart nil
)
123 (new-or-changed-feeds nil
)
125 (cond ((eq symbol
'newsticker-retrieval-interval
)
126 (setq need-restart t
))
127 ((memq symbol
'(newsticker-url-list-defaults newsticker-url-list
))
129 (unless (member elt
(symbol-value symbol
))
130 (setq new-or-changed-feeds
(cons elt new-or-changed-feeds
))))
131 (dolist (elt (symbol-value symbol
))
132 (unless (member elt value
)
133 (setq removed-feeds
(cons elt removed-feeds
))))))
136 (when (newsticker-running-p)
137 (message "Restarting newsticker")
141 (dolist (feed removed-feeds
)
142 (message "Stopping feed `%s'" (car feed
))
143 (newsticker--stop-feed (car feed
)))
144 (dolist (feed new-or-changed-feeds
)
145 (message "Starting feed `%s'" (car feed
))
146 (newsticker--stop-feed (car feed
))
147 (newsticker--start-feed feed
))
148 (unless new-or-changed-feeds
149 (when newsticker--sentinel-callback
150 (funcall newsticker--sentinel-callback
)))))
151 (set symbol value
))))
153 ;; ======================================================================
155 (defgroup newsticker-retrieval nil
156 "Settings for news retrieval."
159 (defcustom newsticker-url-list-defaults
161 "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
164 "A customizable list of news feeds to select from.
165 These were mostly extracted from the Radio Community Server at
166 http://subhonker6.userland.com/rcsPublic/rssHotlist.
168 You may add other entries in `newsticker-url-list'."
169 :type
`(set ,@(mapcar `newsticker--splicer
170 newsticker--raw-url-list-defaults
))
171 :set
'newsticker--set-customvar-retrieval
172 :group
'newsticker-retrieval
)
174 (defcustom newsticker-url-list nil
175 "The news feeds which you like to watch.
177 This alist will be used in addition to selection made customizing
178 `newsticker-url-list-defaults'.
180 This is an alist. Each element consists of two items: a LABEL and a URL,
181 optionally followed by a START-TIME, INTERVAL specifier and WGET-ARGUMENTS.
183 The LABEL gives the name of the news feed. It can be an arbitrary string.
185 The URL gives the location of the news feed. It must point to a valid
186 RSS or Atom file. The file is retrieved by calling wget, or whatever you
187 specify as `newsticker-wget-name'.
189 URL may also be a function which returns news data. In this case
190 `newsticker-retrieval-method' etc. are ignored for this feed.
192 The START-TIME can be either a string, or nil. If it is a string it
193 specifies a fixed time at which this feed shall be retrieved for the
194 first time. (Examples: \"11:00pm\", \"23:00\".) If it is nil (or
195 unspecified), this feed will be retrieved immediately after calling
198 The INTERVAL specifies the time between retrievals for this feed. If it
199 is nil (or unspecified) the default interval value as set in
200 `newsticker-retrieval-interval' is used.
202 \(newsticker.el calls `run-at-time'. The newsticker-parameters START-TIME
203 and INTERVAL correspond to the `run-at-time'-parameters TIME and REPEAT.)
205 WGET-ARGUMENTS specifies arguments for wget (see `newsticker-wget-name')
206 which apply for this feed only, overriding the value of
207 `newsticker-wget-arguments'."
208 :type
'(repeat (list :tag
"News feed"
209 (string :tag
"Label")
211 (string :tag
"String")
212 (function :tag
"Function"))
214 (const :tag
"Default" nil
)
215 (string :tag
"Fixed Time"))
216 (choice :tag
"Interval"
217 (const :tag
"Default" nil
)
218 (const :tag
"Hourly" 3600)
219 (const :tag
"Daily" 86400)
220 (const :tag
"Weekly" 604800)
221 (integer :tag
"Interval"))
222 (choice :tag
"Wget Arguments"
223 (const :tag
"Default arguments" nil
)
224 (repeat :tag
"Special arguments" string
))))
225 :set
'newsticker--set-customvar-retrieval
226 :group
'newsticker-retrieval
)
228 (defcustom newsticker-retrieval-method
230 "Method for retrieving news from the web, either `intern' or `extern'.
231 Default value `intern' uses Emacs' built-in asynchronous download
232 capabilities (`url-retrieve'). If set to `extern' the external
233 program wget is used, see `newsticker-wget-name'."
234 :type
'(choice :tag
"Method"
235 (const :tag
"Intern" intern
)
236 (const :tag
"Extern" extern
))
237 :group
'newsticker-retrieval
)
239 (defcustom newsticker-wget-name
241 "Name of the program which is called to retrieve news from the web.
242 The canonical choice is wget but you may take any other program which is
243 able to return the contents of a news feed file on stdout."
245 :group
'newsticker-retrieval
)
247 (defcustom newsticker-wget-arguments
249 "Arguments which are passed to wget.
250 There is probably no reason to change the default settings, unless you
251 are living behind a firewall."
252 :type
'(repeat (string :tag
"Argument"))
253 :group
'newsticker-retrieval
)
255 (defcustom newsticker-retrieval-interval
257 "Time interval for retrieving new news items (seconds).
258 If this value is not positive (i.e. less than or equal to 0)
259 items are retrieved only once!
260 Please note that some feeds, e.g. Slashdot, will ban you if you
261 make it less than 1800 seconds (30 minutes)!"
262 :type
'(choice :tag
"Interval"
263 (const :tag
"No automatic retrieval" 0)
264 (const :tag
"Hourly" 3600)
265 (const :tag
"Daily" 86400)
266 (const :tag
"Weekly" 604800)
267 (integer :tag
"Interval"))
268 :set
'newsticker--set-customvar-retrieval
269 :group
'newsticker-retrieval
)
271 (defcustom newsticker-desc-comp-max
273 "Relevant length of headline descriptions.
274 This value gives the maximum number of characters which will be
275 taken into account when newsticker compares two headline
278 :group
'newsticker-retrieval
)
280 ;; ======================================================================
281 ;; headline processing
282 (defgroup newsticker-headline-processing nil
283 "Settings for the automatic processing of headlines."
286 (defcustom newsticker-automatically-mark-items-as-old
288 "Decides whether to automatically mark items as old.
289 If t a new item is considered as new only after its first retrieval. As
290 soon as it is retrieved a second time, it becomes old. If not t all
291 items stay new until you mark them as old. This is done in the
292 *newsticker* buffer."
294 :group
'newsticker-headline-processing
)
296 (defcustom newsticker-automatically-mark-visited-items-as-old
298 "Decides whether to automatically mark visited items as old.
299 If t an item is marked as old as soon as the associated link is
300 visited, i.e. after pressing RET or mouse2 on the item's
304 :group
'newsticker-headline-processing
)
306 (defcustom newsticker-keep-obsolete-items
308 "Decides whether to keep unread items which have been removed from feed.
309 If t a new item, which has been removed from the feed, is kept in
310 the cache until it is marked as read."
312 :group
'newsticker-headline-processing
)
314 (defcustom newsticker-obsolete-item-max-age
316 "Maximal age of obsolete items, in seconds.
317 Obsolete items which are older than this value will be silently
318 deleted at the next retrieval."
320 :group
'newsticker-headline-processing
)
322 (defcustom newsticker-auto-mark-filter-list
324 "A list of filters for automatically marking headlines.
326 This is an alist of the form (FEED-NAME PATTERN-LIST). I.e. each
327 element consists of a FEED-NAME a PATTERN-LIST. Each element of
328 the pattern-list has the form (AGE TITLE-OR-DESCRIPTION REGEXP).
329 AGE must be one of the symbols `old' or `immortal'.
330 TITLE-OR-DESCRIPTION must be one of the symbols `title',
331 `description', or `all'. REGEXP is a regular expression, i.e., a
334 This filter is checked after a new headline has been retrieved.
335 If FEED-NAME matches the name of the corresponding news feed, the
336 pattern-list is checked: The new headline will be marked as AGE
337 if REGEXP matches the headline's TITLE-OR-DESCRIPTION.
339 If, for example, `newsticker-auto-mark-filter-list' looks like
340 ((slashdot (\\='old \\='title \"^Forget me!$\") (\\='immortal \\='title \"Read me\")
341 (\\='immortal \\='all \"important\"))))
343 then all articles from slashdot are marked as old if they have
344 the title \"Forget me!\". All articles with a title containing
345 the string \"Read me\" are marked as immortal. All articles which
346 contain the string \"important\" in their title or their
347 description are marked as immortal."
348 :type
'(repeat (list :tag
"Auto mark filter"
349 (string :tag
"Feed name")
351 (list :tag
"Filter element"
353 :tag
"Auto-assigned age"
354 (const :tag
"Old" old
)
355 (const :tag
"Immortal" immortal
))
357 :tag
"Title/Description"
358 (const :tag
"Title" title
)
359 (const :tag
"Description" description
)
360 (const :tag
"All" all
))
361 (string :tag
"Regexp")))))
362 :group
'newsticker-headline-processing
)
364 ;; ======================================================================
366 (defgroup newsticker-hooks nil
367 "Settings for newsticker hooks."
370 (defcustom newsticker-start-hook
372 "Hook run when starting newsticker.
373 This hook is run at the very end of `newsticker-start'."
374 :options
'(newsticker-start-ticker)
376 :group
'newsticker-hooks
)
378 (defcustom newsticker-stop-hook
380 "Hook run when stopping newsticker.
381 This hook is run at the very end of `newsticker-stop'."
384 :group
'newsticker-hooks
)
386 (defcustom newsticker-new-item-functions
388 "List of functions run after a new headline has been retrieved.
389 Each function is called with the following three arguments:
390 FEED the name of the corresponding news feed,
391 TITLE the title of the headline,
392 DESC the decoded description of the headline.
394 See `newsticker-download-images', and
395 `newsticker-download-enclosures' for sample functions.
397 Please note that these functions are called only once for a
398 headline after it has been retrieved for the first time."
400 :options
'(newsticker-download-images
401 newsticker-download-enclosures
)
402 :group
'newsticker-hooks
)
404 ;; ======================================================================
406 (defgroup newsticker-miscellaneous nil
407 "Miscellaneous newsticker settings."
410 (defcustom newsticker-cache-filename
411 "~/.newsticker-cache"
412 "Name of the newsticker cache file."
414 :group
'newsticker-miscellaneous
)
415 (make-obsolete-variable 'newsticker-cache-filename
'newsticker-dir
"23.1")
417 (defcustom newsticker-dir
418 (locate-user-emacs-file "newsticker/" ".newsticker/")
419 "Directory where newsticker saves data."
421 :group
'newsticker-miscellaneous
)
424 (defcustom newsticker-debug
426 "Enables some features needed for debugging newsticker.el.
428 If set to t newsticker.el will print lots of debugging messages, and the
429 buffers *newsticker-wget-<feed>* will not be closed."
431 :group
'newsticker-miscellaneous
)
433 ;; ======================================================================
434 ;;; Compatibility section, XEmacs, Emacs
435 ;; ======================================================================
437 ;; FIXME It is bad practice to define compat functions with such generic names.
439 (unless (fboundp 'match-string-no-properties
)
440 (defalias 'match-string-no-properties
'match-string
))
442 (when (featurep 'xemacs
)
443 (unless (fboundp 'replace-regexp-in-string
)
444 (defun replace-regexp-in-string (re rp st
)
445 (save-match-data ;; apparently XEmacs needs save-match-data
446 (replace-in-string st re rp
)))))
448 ;; copied from subr.el
449 (unless (fboundp 'add-to-invisibility-spec
)
450 (defun add-to-invisibility-spec (arg)
451 "Add elements to `buffer-invisibility-spec'.
452 See documentation for `buffer-invisibility-spec' for the kind of elements
454 (if (eq buffer-invisibility-spec t
)
455 (setq buffer-invisibility-spec
(list t
)))
456 (setq buffer-invisibility-spec
457 (cons arg buffer-invisibility-spec
))))
459 ;; copied from subr.el
460 (unless (fboundp 'remove-from-invisibility-spec
)
461 (defun remove-from-invisibility-spec (arg)
462 "Remove elements from `buffer-invisibility-spec'."
463 (if (consp buffer-invisibility-spec
)
464 (setq buffer-invisibility-spec
465 (delete arg buffer-invisibility-spec
)))))
467 ;; ======================================================================
468 ;;; Internal variables
469 ;; ======================================================================
470 (defvar newsticker--buffer-uptodate-p nil
471 "Tells whether the newsticker buffer is up to date.")
472 (defvar newsticker--latest-update-time
(current-time)
473 "The time at which the latest news arrived.")
474 (defvar newsticker--process-ids nil
475 "List of PIDs of active newsticker processes.")
477 (defvar newsticker--cache nil
"Cached newsticker data.
478 This is a list of the form
481 (title description link time age index preformatted-contents
482 preformatted-title extra-elements)
485 (title description link time age index preformatted-contents
486 preformatted-title extra-elements)
490 where LABEL is a symbol. TITLE, DESCRIPTION, and LINK are
491 strings. TIME is a time value as returned by `current-time'.
492 AGE is a symbol: `new', `old', `immortal', and `obsolete' denote
493 ordinary news items, whereas `feed' denotes an item which is not a
494 headline but describes the feed itself. INDEX denotes the
495 original position of the item -- used for restoring the original
496 order. PREFORMATTED-CONTENTS and PREFORMATTED-TITLE hold the
497 formatted contents of the item's description and title. This
498 speeds things up if HTML rendering is used, which is rather
499 slow. EXTRA-ELEMENTS is an alist containing additional elements.")
501 (defvar newsticker--auto-narrow-to-feed nil
502 "Automatically narrow to current news feed.
503 If non-nil only the items of the current news feed are visible.")
505 (defvar newsticker--auto-narrow-to-item nil
506 "Automatically narrow to current news item.
507 If non-nil only the current headline is visible.")
509 (defconst newsticker--error-headline
510 "[COULD NOT DOWNLOAD HEADLINES!]"
511 "Title of error headline which will be inserted if news retrieval fails.")
513 ;; ======================================================================
515 ;; ======================================================================
516 (defsubst newsticker--title
(item)
517 "Return title of ITEM."
519 (defsubst newsticker--desc
(item)
520 "Return description of ITEM."
522 (defsubst newsticker--link
(item)
523 "Return link of ITEM."
525 (defsubst newsticker--time
(item)
526 "Return time of ITEM."
528 (defsubst newsticker--age
(item)
529 "Return age of ITEM."
531 (defsubst newsticker--pos
(item)
532 "Return position/index of ITEM."
534 (defsubst newsticker--preformatted-contents
(item)
535 "Return pre-formatted text of ITEM."
537 (defsubst newsticker--preformatted-title
(item)
538 "Return pre-formatted title of ITEM."
540 (defsubst newsticker--extra
(item)
541 "Return extra attributes of ITEM."
543 (defsubst newsticker--guid-to-string
(guid)
544 "Return string representation of GUID."
547 (car (xml-node-children guid
))))
548 (defsubst newsticker--guid
(item)
549 "Return guid of ITEM."
550 (newsticker--guid-to-string (assoc 'guid
(newsticker--extra item
))))
551 (defsubst newsticker--enclosure
(item)
552 "Return enclosure element of ITEM in the form (...FIXME...) or nil."
553 (let ((enclosure (assoc 'enclosure
(newsticker--extra item
))))
555 (xml-node-attributes enclosure
))))
556 (defun newsticker--real-feed-name (feed)
557 "Return real name of FEED."
560 (if (eq (newsticker--age item
) 'feed
)
561 (throw 'name
(newsticker--title item
))))
562 (cdr (newsticker--cache-get-feed feed
)))
566 ;; ======================================================================
568 ;; ======================================================================
570 (defun newsticker--start-feed (feed &optional do-not-complain-if-running
)
571 "Start retrieval timer for FEED.
572 If timer is running already a warning message is printed unless
573 DO-NOT-COMPLAIN-IF-RUNNING is not nil. Add the started
574 name/timer pair to `newsticker--retrieval-timer-list'."
575 (let* ((feed-name (car feed
))
576 (start-time (nth 2 feed
))
577 (interval (or (nth 3 feed
)
578 newsticker-retrieval-interval
))
579 (timer (assoc (car feed
)
580 newsticker--retrieval-timer-list
)))
582 (or do-not-complain-if-running
583 (message "Timer for %s is running already!"
585 (newsticker--debug-msg "Starting timer for %s: %s, %d"
586 feed-name start-time interval
)
587 ;; do not repeat retrieval if interval not positive
590 ;; Suddenly XEmacs doesn't like start-time 0
591 (if (or (not start-time
)
592 (and (numberp start-time
) (= start-time
0)))
594 ;; (message "start-time %s" start-time)
595 (setq timer
(run-at-time start-time interval
596 'newsticker-get-news feed-name
))
598 (add-to-list 'newsticker--retrieval-timer-list
599 (cons feed-name timer
))))))
602 (defun newsticker-start (&optional do-not-complain-if-running
)
603 "Start the newsticker.
604 Start the timers for display and retrieval. If the newsticker, i.e. the
605 timers, are running already a warning message is printed unless
606 DO-NOT-COMPLAIN-IF-RUNNING is not nil.
607 Run `newsticker-start-hook' if newsticker was not running already."
609 (let ((running (newsticker-running-p)))
610 ;; read old cache if it exists and newsticker is not running
612 (newsticker--cache-read))
613 ;; start retrieval timers -- one timer for each feed
614 (dolist (feed (append newsticker-url-list-defaults newsticker-url-list
))
615 (newsticker--start-feed feed
))
617 (run-hooks 'newsticker-start-hook
)
618 (message "Newsticker started!"))))
620 (defun newsticker--stop-feed (feed-name)
621 "Stop retrieval for feed FEED-NAME.
622 Delete the stopped name/timer pair from `newsticker--retrieval-timer-list'."
623 (let ((name-and-timer (assoc feed-name newsticker--retrieval-timer-list
)))
625 (cancel-timer (cdr name-and-timer
))
626 (setq newsticker--retrieval-timer-list
627 (delete name-and-timer newsticker--retrieval-timer-list
)))))
629 (defun newsticker-stop ()
630 "Stop the newsticker and the newsticker-ticker.
631 Cancel the timers for display and retrieval. Run `newsticker-stop-hook'
632 if newsticker has been running."
634 (newsticker--cache-save)
635 (when (fboundp 'newsticker-stop-ticker
) ; silence compiler warnings
636 (newsticker-stop-ticker))
637 (when (newsticker-running-p)
638 (mapc (lambda (name-and-timer)
639 (newsticker--stop-feed (car name-and-timer
)))
640 newsticker--retrieval-timer-list
)
641 (setq newsticker--retrieval-timer-list nil
)
642 (run-hooks 'newsticker-stop-hook
)
643 (message "Newsticker stopped!")))
645 (defun newsticker-get-all-news ()
646 "Launch retrieval of news from all configured newsticker sites.
647 This does NOT start the retrieval timers."
649 ;; launch retrieval of news
651 (newsticker-get-news (car item
)))
652 (append newsticker-url-list-defaults newsticker-url-list
)))
654 (defun newsticker-save-item (feed item
)
657 (let ((filename (read-string "Filename: "
659 (replace-regexp-in-string
660 " " "_" (newsticker--title item
))
663 (insert (newsticker--desc item
))
664 (write-file filename t
))))
666 (defun newsticker-add-url (url name
)
667 "Add given URL under given NAME to `newsticker-url-list'.
668 If URL is nil it is searched at point."
677 (if (> (point) (+ (point-min) 100))
682 "http://[-a-zA-Z0-9&/_.]*"
683 (if (< (point) (- (point-max) 200))
687 (buffer-substring-no-properties (match-beginning 0)
689 (read-string "Name: ")))
690 (add-to-list 'newsticker-url-list
(list name url nil nil nil
) t
)
691 (customize-variable 'newsticker-url-list
))
693 (defun newsticker-customize ()
694 "Open the newsticker customization group."
696 (delete-other-windows)
697 (customize-group "newsticker"))
699 ;; ======================================================================
701 ;; ======================================================================
702 (defun newsticker--get-news-by-funcall (feed-name function
)
703 "Get news for the site FEED-NAME by calling FUNCTION.
704 See `newsticker-get-news'."
705 (let ((buffername (concat " *newsticker-funcall-" feed-name
"*")))
706 (with-current-buffer (get-buffer-create buffername
)
708 (insert (string-to-multibyte (funcall function feed-name
)))
709 (newsticker--sentinel-work nil t feed-name function
712 (defun newsticker--get-news-by-url (feed-name url
)
713 "Get news for the site FEED-NAME from address URL using `url-retrieve'.
714 See `newsticker-get-news'."
715 (let ((coding-system-for-read 'no-conversion
))
716 (condition-case error-data
717 (url-retrieve url
'newsticker--get-news-by-url-callback
719 (error (message "Error retrieving news from %s: %s" feed-name
721 (force-mode-line-update))
723 (defun newsticker--get-news-by-url-callback (status feed-name
)
724 "Callback function for `newsticker--get-news-by-url'.
725 STATUS is the return status as delivered by `url-retrieve', and
726 FEED-NAME is the name of the feed that the news were retrieved
728 (let ((buf (get-buffer-create (concat " *newsticker-url-" feed-name
"*")))
729 (result (string-to-multibyte (buffer-string))))
733 ;; remove MIME header
734 (goto-char (point-min))
735 (search-forward "\n\n" nil t
)
736 (delete-region (point-min) (point))
737 ;; read the rss/atom contents
738 (newsticker--sentinel-work nil
740 (not (eq (car status
) :error
)))
741 feed-name
"url-retrieve"
744 (let ((status-type (car status
))
745 (status-details (cdr status
)))
746 (cond ((eq status-type
:redirect
)
747 ;; don't care about redirects
749 ((eq status-type
:error
)
750 (message "%s: Error while retrieving news from %s: %s: \"%s\""
751 (format-time-string "%A, %H:%M")
753 (car status-details
) (cdr status-details
))))))))
755 (defun newsticker--get-news-by-wget (feed-name url wget-arguments
)
756 "Get news for the site FEED-NAME from address URL using wget.
757 WGET-ARGUMENTS is a list of arguments for wget.
758 See `newsticker-get-news'."
759 (let ((buffername (concat " *newsticker-wget-" feed-name
"*")))
760 (with-current-buffer (get-buffer-create buffername
)
762 ;; throw an error if there is an old wget-process around
763 (if (get-process feed-name
)
764 (error "Another wget-process is running for %s" feed-name
))
766 (let* ((args (append wget-arguments
(list url
)))
767 (proc (apply 'start-process feed-name buffername
768 newsticker-wget-name args
)))
769 (set-process-coding-system proc
'no-conversion
'no-conversion
)
770 (set-process-sentinel proc
'newsticker--sentinel
)
771 (process-put proc
'nt-feed-name feed-name
)
772 (setq newsticker--process-ids
(cons (process-id proc
)
773 newsticker--process-ids
))
774 (force-mode-line-update)))))
776 (defun newsticker-get-news (feed-name)
777 "Get news from the site FEED-NAME and load feed logo.
778 FEED-NAME must be a string which occurs as the label (i.e. the first element)
779 in an element of `newsticker-url-list' or `newsticker-url-list-defaults'."
780 (newsticker--debug-msg "%s: Getting news for %s"
781 (format-time-string "%A, %H:%M")
783 (let* ((item (or (assoc feed-name newsticker-url-list
)
784 (assoc feed-name newsticker-url-list-defaults
)
786 "Cannot get news for %s: Check newsticker-url-list"
789 (wget-arguments (or (car (cdr (cdr (cdr (cdr item
)))))
790 newsticker-wget-arguments
)))
792 (newsticker--get-news-by-funcall feed-name url
)
793 (if (eq newsticker-retrieval-method
'intern
)
794 (newsticker--get-news-by-url feed-name url
)
795 (newsticker--get-news-by-wget feed-name url wget-arguments
)))))
797 ;; ======================================================================
799 ;; ======================================================================
801 (defun newsticker--sentinel (process event
)
802 "Sentinel for extracting news titles from an RDF buffer.
803 Argument PROCESS is the process which has just changed its state.
804 Argument EVENT tells what has happened to the process."
805 (let ((p-status (process-status process
))
806 (exit-status (process-exit-status process
))
807 (feed-name (process-get process
'nt-feed-name
))
808 (command (process-command process
))
809 (buffer (process-buffer process
)))
810 (newsticker--sentinel-work event
811 (and (eq p-status
'exit
)
813 feed-name command buffer
)))
815 (defun newsticker--sentinel-work (event status-ok feed-name command buffer
)
816 "Actually do the sentinel work.
817 Argument EVENT tells what has happened to the retrieval process.
818 Argument STATUS-OK is the final status of the retrieval process,
819 non-nil meaning retrieval was successful.
820 Argument FEED-NAME is the name of the retrieved feed.
821 Argument COMMAND is the command of the retrieval process.
822 Argument BUFFER is the buffer of the retrieval process."
823 (let ((time (current-time))
824 (name-symbol (intern feed-name
))
825 (something-was-added nil
)
827 ;; catch known errors (zombie processes, rubbish-xml etc.
828 ;; if an error occurs the news feed is not updated!
831 (setq newsticker--cache
832 (newsticker--cache-add
835 newsticker--error-headline
837 (concat "%s: Newsticker could not retrieve news from %s.\n"
838 "Return status: `%s'\n"
840 (format-time-string "%A, %H:%M")
841 feed-name event command
)
845 0 '((guid nil
"newsticker--download-error"))
847 (message "%s: Error while retrieving news from %s"
848 (format-time-string "%A, %H:%M")
851 (let* ((coding-system 'utf-8
)
855 (unless (fboundp 'libxml-parse-xml-region
)
856 (newsticker--do-xml-workarounds))
857 ;; check coding system
858 (goto-char (point-min))
859 (if (re-search-forward "encoding=['\"]\\([^\"]+?\\)['\"]"
861 (setq coding-system
(intern (downcase (match-string 1))))
864 (check-coding-system coding-system
)
867 "newsticker.el: ignoring coding system %s for %s"
868 coding-system feed-name
)
870 ;; Decode if possible
872 (decode-coding-region (point-min) (point-max)
874 (condition-case errordata
875 ;; The xml parser might fail or the xml might be
877 (if (fboundp 'libxml-parse-xml-region
)
878 (list (libxml-parse-xml-region (point-min) (point-max)
880 (xml-parse-region (point-min) (point-max)))
881 (error (message "Could not parse %s: %s"
882 (buffer-name) (cadr errordata
))
883 (throw 'oops nil
)))))
884 (topnode (car node-list
))
887 ;; mark all items as obsolete
888 (newsticker--cache-replace-age newsticker--cache
891 (newsticker--cache-replace-age newsticker--cache
894 (newsticker--cache-replace-age newsticker--cache
898 ;; check Atom/RSS version and call corresponding parser
899 (condition-case error-data
902 ((and (eq 'rss
(xml-node-name topnode
))
903 (string= "0.91" (xml-get-attribute topnode
'version
)))
904 (setq image-url
(newsticker--get-logo-url-rss-0.91 topnode
))
905 (newsticker--parse-rss-0.91 feed-name time topnode
))
907 ((and (eq 'rss
(xml-node-name topnode
))
908 (string= "0.92" (xml-get-attribute topnode
'version
)))
909 (setq image-url
(newsticker--get-logo-url-rss-0.92 topnode
))
910 (newsticker--parse-rss-0.92 feed-name time topnode
))
912 ((or (eq 'RDF
(xml-node-name topnode
))
913 (eq 'rdf
:RDF
(xml-node-name topnode
)))
914 (setq image-url
(newsticker--get-logo-url-rss-1.0 topnode
))
915 (newsticker--parse-rss-1.0 feed-name time topnode
))
917 ((and (eq 'rss
(xml-node-name topnode
))
918 (string= "2.0" (xml-get-attribute topnode
'version
)))
919 (setq image-url
(newsticker--get-logo-url-rss-2.0 topnode
))
920 (newsticker--parse-rss-2.0 feed-name time topnode
))
922 ((and (eq 'feed
(xml-node-name topnode
))
923 (string= "http://purl.org/atom/ns#"
924 (xml-get-attribute topnode
'xmlns
)))
925 (setq image-url
(newsticker--get-logo-url-atom-0.3 topnode
))
926 (newsticker--parse-atom-0.3 feed-name time topnode
))
929 ;; The test for Atom 1.0 does not work when using
930 ;; libxml, as with libxml the namespace attribute is
931 ;; not in the xml tree. For the time being we skip
932 ;; the check and assume that we are dealing with an
935 ;; (and (eq 'feed (xml-node-name topnode))
936 ;; (string= "http://www.w3.org/2005/Atom"
937 ;; (xml-get-attribute topnode 'xmlns)))
938 (setq image-url
(newsticker--get-logo-url-atom-1.0 topnode
))
939 (setq icon-url
(newsticker--get-icon-url-atom-1.0 topnode
))
940 (newsticker--parse-atom-1.0 feed-name time topnode
))
943 ;; (newsticker--debug-msg "Feed type unknown: %s: %s"
944 ;; (xml-node-name topnode) feed-name)
947 (setq something-was-added t
))
948 (error (message "sentinelerror in %s: %s" feed-name error-data
)))
950 ;; Remove those old items from cache which have been removed from
952 (newsticker--cache-replace-age newsticker--cache
953 name-symbol
'obsolete-old
'deleteme
)
954 (newsticker--cache-remove newsticker--cache name-symbol
956 ;; Remove those new items from cache which have been removed from
957 ;; the feed. Or keep them as `obsolete'
958 (if (not newsticker-keep-obsolete-items
)
959 (newsticker--cache-remove newsticker--cache
960 name-symbol
'obsolete-new
)
961 (setq newsticker--cache
962 (newsticker--cache-mark-expired
963 newsticker--cache name-symbol
'obsolete
'obsolete-expired
964 newsticker-obsolete-item-max-age
))
965 (newsticker--cache-remove newsticker--cache
966 name-symbol
'obsolete-expired
)
967 (newsticker--cache-replace-age newsticker--cache
968 name-symbol
'obsolete-new
970 (newsticker--update-process-ids)
971 ;; setup scrollable text
972 (when (= 0 (length newsticker--process-ids
))
973 (when (fboundp 'newsticker--ticker-text-setup
) ;silence
976 (newsticker--ticker-text-setup)))
977 (setq newsticker--latest-update-time
(current-time))
978 (when something-was-added
979 ;; FIXME: should we care about removed items as well?
980 (newsticker--cache-save-feed
981 (newsticker--cache-get-feed name-symbol
))
982 (when (fboundp 'newsticker--buffer-set-uptodate
) ;silence
985 (newsticker--buffer-set-uptodate nil
)))
986 ;; kill the process buffer if wanted
987 (unless newsticker-debug
988 (kill-buffer buffer
))
989 ;; launch retrieval of images
990 (when (and (boundp 'newsticker-download-logos
)
991 newsticker-download-logos
)
994 (newsticker--image-get feed-name feed-name
(newsticker--images-dir)
999 (let* ((feed-url (newsticker--link (cadr (newsticker--cache-get-feed
1000 (intern feed-name
)))))
1001 (uri (url-generic-parse-url feed-url
)))
1002 (when (and feed-url uri
)
1003 (setf (url-filename uri
) nil
)
1004 (setf (url-target uri
) nil
)
1005 (concat (url-recreate-url uri
) "favicon.ico")))))
1007 (newsticker--image-get feed-name
1008 (concat feed-name
"."
1009 (file-name-extension icon-url
))
1010 (newsticker--icons-dir)
1012 (when newsticker--sentinel-callback
1013 (funcall newsticker--sentinel-callback
)))
1015 (defun newsticker--do-xml-workarounds ()
1016 "Fix all issues which `xml-parse-region' could be choking on."
1018 ;; a very very dirty workaround to overcome the
1019 ;; problems with the newest (20030621) xml.el:
1020 ;; remove all unnecessary whitespace
1021 (goto-char (point-min))
1022 (while (re-search-forward ">[ \t\r\n]+<" nil t
)
1023 (replace-match "><" nil t
))
1024 ;; and another brutal workaround (20031105)! For some
1025 ;; reason the xml parser does not like the colon in the
1026 ;; doctype name "rdf:RDF"
1027 (goto-char (point-min))
1028 (if (re-search-forward "<!DOCTYPE[ \t\n]+rdf:RDF" nil t
)
1029 (replace-match "<!DOCTYPE rdfColonRDF" nil t
))
1030 ;; finally.... ~##^°!!!!!
1031 (goto-char (point-min))
1032 (while (search-forward "\r\n" nil t
)
1033 (replace-match "\n" nil t
))
1034 ;; still more brutal workarounds (20040309)! The xml
1035 ;; parser does not like doctype rss
1036 (goto-char (point-min))
1037 (if (re-search-forward "<!DOCTYPE[ \t\n]+rss[ \t\n]*>" nil t
)
1038 (replace-match "" nil t
))
1039 ;; And another one (20050618)! (Fixed in GNU Emacs 22.0.50.18)
1040 ;; Remove comments to avoid this xml-parsing bug:
1041 ;; "XML files can have only one toplevel tag"
1042 (goto-char (point-min))
1043 (while (search-forward "<!--" nil t
)
1044 (let ((start (match-beginning 0)))
1045 (unless (search-forward "-->" nil t
)
1046 (error "Can't find end of comment"))
1047 (delete-region start
(point))))
1048 ;; And another one (20050702)! If description is HTML
1049 ;; encoded and starts with a `<', wrap the whole
1050 ;; description in a CDATA expression. This happened for
1051 ;; http://www.thefreedictionary.com/_/WoD/rss.aspx?type=quote
1052 (goto-char (point-min))
1053 (while (re-search-forward
1054 "<description>\\(<img.*?\\)</description>" nil t
)
1056 "<description><![CDATA[ \\1 ]]></description>"))
1057 ;; And another one (20051123)! XML parser does not
1058 ;; like this: <yweather:location city="Frankfurt/Main"
1059 ;; region="" country="GM" />
1060 ;; try to "fix" empty attributes
1061 ;; This happened for
1062 ;; http://xml.weather.yahoo.com/forecastrss?p=GMXX0040&u=f
1063 (goto-char (point-min))
1064 (while (re-search-forward "\\(<[^>]*\\)=\"\"" nil t
)
1065 (replace-match "\\1=\" \""))
1067 (set-buffer-modified-p nil
))
1070 (defun newsticker--get-logo-url-atom-1.0
(node)
1071 "Return logo URL from atom 1.0 data in NODE."
1072 (car (xml-node-children
1073 (car (xml-get-children node
'logo
)))))
1075 (defun newsticker--get-icon-url-atom-1.0
(node)
1076 "Return icon URL from atom 1.0 data in NODE."
1077 (car (xml-node-children
1078 (car (xml-get-children node
'icon
)))))
1080 (defun newsticker--get-logo-url-atom-0.3
(node)
1081 "Return logo URL from atom 0.3 data in NODE."
1082 (car (xml-node-children
1083 (car (xml-get-children (car (xml-get-children node
'image
)) 'url
)))))
1085 (defun newsticker--get-logo-url-rss-2.0
(node)
1086 "Return logo URL from RSS 2.0 data in NODE."
1087 (car (xml-node-children
1088 (car (xml-get-children
1089 (car (xml-get-children
1090 (car (xml-get-children node
'channel
)) 'image
)) 'url
)))))
1092 (defun newsticker--get-logo-url-rss-1.0
(node)
1093 "Return logo URL from RSS 1.0 data in NODE."
1094 (car (xml-node-children
1095 (car (xml-get-children (car (xml-get-children node
'image
)) 'url
)))))
1097 (defun newsticker--get-logo-url-rss-0.92
(node)
1098 "Return logo URL from RSS 0.92 data in NODE."
1099 (car (xml-node-children
1100 (car (xml-get-children (car (xml-get-children node
'image
)) 'url
)))))
1102 (defun newsticker--get-logo-url-rss-0.91
(node)
1103 "Return logo URL from RSS 0.91 data in NODE."
1104 (car (xml-node-children
1105 (car (xml-get-children (car (xml-get-children node
'image
)) 'url
)))))
1107 (defun newsticker--parse-atom-0.3
(name time topnode
)
1108 "Parse Atom 0.3 data.
1109 Return value as well as arguments NAME, TIME, and TOPNODE are the
1110 same as in `newsticker--parse-atom-1.0'."
1111 (newsticker--debug-msg "Parsing Atom 0.3 feed %s" name
)
1112 (let (new-feed new-item
)
1113 (setq new-feed
(newsticker--parse-generic-feed
1116 (car (xml-node-children
1117 (car (xml-get-children topnode
'title
))))
1119 (car (xml-node-children
1120 (car (xml-get-children topnode
'content
))))
1123 (car (xml-get-children topnode
'link
)) 'href
)
1125 (xml-node-children topnode
)))
1126 (setq new-item
(newsticker--parse-generic-items
1127 name time
(xml-get-children topnode
'entry
)
1130 (car (xml-node-children
1131 (car (xml-get-children node
'title
)))))
1134 (or (car (xml-node-children
1135 (car (xml-get-children node
'content
))))
1136 (car (xml-node-children
1137 (car (xml-get-children node
'summary
))))))
1141 (car (xml-get-children node
'link
)) 'href
))
1144 (newsticker--decode-rfc822-date
1145 (car (xml-node-children
1146 (car (xml-get-children node
'modified
))))))
1149 (newsticker--guid-to-string
1150 (assoc 'guid
(xml-node-children node
))))
1153 (xml-node-children node
))))
1154 (or new-item new-feed
)))
1156 (defun newsticker--unxml (node)
1157 "Reverse parsing of an xml string.
1158 Restore an xml-string from a an xml NODE that was returned by xml-parse..."
1159 (if (or (not node
) (stringp node
))
1161 (newsticker--unxml-node node
)))
1163 (defun newsticker--unxml-node (node)
1164 "Actually restore xml-string of an xml NODE."
1165 (let ((qname (symbol-name (car node
)))
1166 (att-list (cadr node
))
1167 (children (cddr node
)))
1170 (mapconcat 'newsticker--unxml-attribute att-list
" ")
1172 (mapconcat 'newsticker--unxml children
"") "</" qname
">")))
1174 (defun newsticker--unxml-attribute (attribute)
1175 "Actually restore xml-string of an ATTRIBUTE of an xml node."
1176 (let ((name (symbol-name (car attribute
)))
1177 (value (cdr attribute
)))
1178 (concat name
"=\"" value
"\"")))
1180 (defun newsticker--parse-atom-1.0
(name time topnode
)
1181 "Parse Atom 1.0 data.
1182 Argument NAME gives the name of a news feed. TIME gives the
1183 system time at which the data have been retrieved. TOPNODE
1184 contains the feed data as returned by the xml parser.
1186 For the Atom 1.0 specification see
1187 URL `http://www.atompub.org/2005/08/17/draft-ietf-atompub-format-11.html'"
1188 (newsticker--debug-msg "Parsing Atom 1.0 feed %s" name
)
1189 (let (new-feed new-item
)
1190 (setq new-feed
(newsticker--parse-generic-feed
1193 (car (xml-node-children
1194 (car (xml-get-children topnode
'title
))))
1196 (car (xml-node-children
1197 (car (xml-get-children topnode
'subtitle
))))
1201 (car (xml-get-children node
'link
)) 'href
))
1203 (xml-node-children topnode
)))
1204 (setq new-item
(newsticker--parse-generic-items
1205 name time
(xml-get-children topnode
'entry
)
1208 (car (xml-node-children
1209 (car (xml-get-children node
'title
)))))
1212 ;; unxml the content or the summary node. Atom
1213 ;; allows for integrating (x)html into the atom
1214 ;; structure but we need the raw html string.
1215 ;; e.g. http://www.heise.de/open/news/news-atom.xml
1216 ;; http://feeds.feedburner.com/ru_nix_blogs
1217 (or (newsticker--unxml
1218 (car (xml-node-children
1219 (car (xml-get-children node
'content
)))))
1221 (car (xml-node-children
1222 (car (xml-get-children node
'summary
)))))
1223 (car (xml-node-children
1224 (car (xml-get-children node
'summary
))))))
1228 (car (xml-get-children node
'link
)) 'href
))
1231 (newsticker--decode-iso8601-date
1232 (or (car (xml-node-children
1233 (car (xml-get-children node
'updated
))))
1234 (car (xml-node-children
1235 (car (xml-get-children node
'published
)))))))
1238 (car (xml-node-children
1239 (car (xml-get-children node
'id
)))))
1242 (xml-node-children node
))))
1243 (or new-item new-feed
)))
1245 (defun newsticker--parse-rss-0.91
(name time topnode
)
1246 "Parse RSS 0.91 data.
1247 Return value as well as arguments NAME, TIME, and TOPNODE are the
1248 same as in `newsticker--parse-atom-1.0'.
1250 For the RSS 0.91 specification see URL `http://backend.userland.com/rss091'
1251 or URL `http://my.netscape.com/publish/formats/rss-spec-0.91.html'."
1252 (newsticker--debug-msg "Parsing RSS 0.91 feed %s" name
)
1253 (let* ((channelnode (car (xml-get-children topnode
'channel
)))
1254 (pub-date (newsticker--decode-rfc822-date
1255 (car (xml-node-children
1256 (car (xml-get-children channelnode
'pubDate
))))))
1257 is-new-feed has-new-items
)
1258 (setq is-new-feed
(newsticker--parse-generic-feed
1261 (car (xml-node-children
1262 (car (xml-get-children channelnode
'title
))))
1264 (car (xml-node-children
1265 (car (xml-get-children channelnode
1268 (car (xml-node-children
1269 (car (xml-get-children channelnode
'link
))))
1271 (xml-node-children channelnode
)))
1272 (setq has-new-items
(newsticker--parse-generic-items
1273 name time
(xml-get-children channelnode
'item
)
1276 (car (xml-node-children
1277 (car (xml-get-children node
'title
)))))
1280 (car (xml-node-children
1281 (car (xml-get-children node
'description
)))))
1284 (car (xml-node-children
1285 (car (xml-get-children node
'link
)))))
1288 (newsticker--decode-rfc822-date
1289 (car (xml-node-children
1290 (car (xml-get-children node
'pubDate
))))))
1296 (xml-node-children node
))))
1297 (or has-new-items is-new-feed
)))
1299 (defun newsticker--parse-rss-0.92
(name time topnode
)
1300 "Parse RSS 0.92 data.
1301 Return value as well as arguments NAME, TIME, and TOPNODE are the
1302 same as in `newsticker--parse-atom-1.0'.
1304 For the RSS 0.92 specification see URL `http://backend.userland.com/rss092'."
1305 (newsticker--debug-msg "Parsing RSS 0.92 feed %s" name
)
1306 (let* ((channelnode (car (xml-get-children topnode
'channel
)))
1307 (pub-date (newsticker--decode-rfc822-date
1308 (car (xml-node-children
1309 (car (xml-get-children channelnode
'pubDate
))))))
1310 is-new-feed has-new-items
)
1311 (setq is-new-feed
(newsticker--parse-generic-feed
1314 (car (xml-node-children
1315 (car (xml-get-children channelnode
'title
))))
1317 (car (xml-node-children
1318 (car (xml-get-children channelnode
1321 (car (xml-node-children
1322 (car (xml-get-children channelnode
'link
))))
1324 (xml-node-children channelnode
)))
1325 (setq has-new-items
(newsticker--parse-generic-items
1326 name time
(xml-get-children channelnode
'item
)
1329 (car (xml-node-children
1330 (car (xml-get-children node
'title
)))))
1333 (car (xml-node-children
1334 (car (xml-get-children node
'description
)))))
1337 (car (xml-node-children
1338 (car (xml-get-children node
'link
)))))
1341 (newsticker--decode-rfc822-date
1342 (car (xml-node-children
1343 (car (xml-get-children node
'pubDate
))))))
1349 (xml-node-children node
))))
1350 (or has-new-items is-new-feed
)))
1352 (defun newsticker--parse-rss-1.0
(name time topnode
)
1353 "Parse RSS 1.0 data.
1354 Return value as well as arguments NAME, TIME, and TOPNODE are the
1355 same as in `newsticker--parse-atom-1.0'.
1357 For the RSS 1.0 specification see URL `http://web.resource.org/rss/1.0/spec'."
1358 (newsticker--debug-msg "Parsing RSS 1.0 feed %s" name
)
1359 (let* ((channelnode (car (xml-get-children topnode
'channel
)))
1360 is-new-feed has-new-items
)
1361 (setq is-new-feed
(newsticker--parse-generic-feed
1364 (car (xml-node-children
1365 (car (xml-get-children channelnode
'title
))))
1367 (or (car (xml-node-children
1368 (car (xml-get-children channelnode
1370 (car (xml-node-children
1371 (car (xml-get-children channelnode
1372 'content
:encoded
))))
1373 (car (xml-node-children
1374 (car (xml-get-children channelnode
1377 (car (xml-node-children
1378 (car (xml-get-children channelnode
'link
))))
1380 (xml-node-children channelnode
)))
1381 (setq has-new-items
(newsticker--parse-generic-items
1382 name time
(xml-get-children topnode
'item
)
1385 (car (xml-node-children
1386 (car (xml-get-children node
'title
)))))
1389 (car (xml-node-children
1390 (car (xml-get-children node
1394 (car (xml-node-children
1395 (car (xml-get-children node
'link
)))))
1398 (newsticker--decode-iso8601-date
1399 (or (car (xml-node-children
1400 (car (xml-get-children node
'dc
:date
))))
1401 (car (xml-node-children
1402 (car (xml-get-children node
'date
)))))))
1408 (xml-node-children node
))))
1409 (or has-new-items is-new-feed
)))
1411 (defun newsticker--parse-rss-2.0
(name time topnode
)
1412 "Parse RSS 2.0 data.
1413 Return value as well as arguments NAME, TIME, and TOPNODE are the
1414 same as in `newsticker--parse-atom-1.0'.
1416 For the RSS 2.0 specification see URL `http://blogs.law.harvard.edu/tech/rss'."
1417 (newsticker--debug-msg "Parsing RSS 2.0 feed %s" name
)
1418 (let* ((channelnode (car (xml-get-children topnode
'channel
)))
1419 is-new-feed has-new-items
)
1420 (setq is-new-feed
(newsticker--parse-generic-feed
1423 (car (xml-node-children
1424 (car (xml-get-children channelnode
'title
))))
1426 (or (car (xml-node-children
1427 (car (xml-get-children channelnode
1429 (car (xml-node-children
1430 (car (xml-get-children channelnode
1431 'content
:encoded
))))
1432 (car (xml-node-children
1433 (car (xml-get-children channelnode
1436 (car (xml-node-children
1437 (car (xml-get-children channelnode
'link
))))
1439 (xml-node-children channelnode
)))
1440 (setq has-new-items
(newsticker--parse-generic-items
1441 name time
(xml-get-children channelnode
'item
)
1444 (car (xml-node-children
1445 (car (xml-get-children node
'title
)))))
1448 (or (car (xml-node-children
1449 (car (xml-get-children node
1451 (car (xml-node-children
1452 (car (xml-get-children node
1453 'content
:encoded
))))
1454 (car (xml-node-children
1455 (car (xml-get-children node
1459 (car (xml-node-children
1460 (car (xml-get-children node
'link
)))))
1463 (newsticker--decode-rfc822-date
1464 (car (xml-node-children
1465 (car (xml-get-children node
'pubDate
))))))
1468 (newsticker--guid-to-string
1469 (assoc 'guid
(xml-node-children node
))))
1472 (xml-node-children node
))))
1473 (or has-new-items is-new-feed
)))
1475 (defun newsticker--parse-generic-feed (name time title desc link
1477 "Parse generic news feed data.
1478 Argument NAME gives the name of a news feed. TIME gives the
1479 system time at which the data have been retrieved.
1481 The arguments TITLE, DESC, LINK, and EXTRA-ELEMENTS give the feed's title,
1482 description, link, and extra elements resp."
1483 (let ((title (or title
"[untitled]"))
1487 (something-was-added nil
))
1488 ;; decode numeric entities
1489 (setq title
(xml-substitute-numeric-entities title
))
1490 (setq desc
(xml-substitute-numeric-entities desc
))
1491 (setq link
(xml-substitute-numeric-entities link
))
1492 ;; remove whitespace from title, desc, and link
1493 (setq title
(newsticker--remove-whitespace title
))
1494 (setq desc
(newsticker--remove-whitespace desc
))
1495 (setq link
(newsticker--remove-whitespace link
))
1497 ;; handle the feed itself
1498 (unless (newsticker--cache-contains newsticker--cache
1501 (setq something-was-added t
))
1502 (setq newsticker--cache
1503 (newsticker--cache-add newsticker--cache
(intern name
)
1504 title desc link time
'feed position
1505 extra-elements time
'feed
))
1506 something-was-added
))
1508 (defun newsticker--parse-generic-items (name time itemlist
1512 "Parse generic news feed data.
1513 Argument NAME gives the name of a news feed. TIME gives the
1514 system time at which the data have been retrieved. ITEMLIST
1515 contains the news items returned by the xml parser.
1517 The arguments TITLE-FN, DESC-FN, LINK-FN, TIME-FN, GUID-FN, and
1518 EXTRA-FN give functions for extracting title, description, link,
1519 time, guid, and extra-elements resp. They are called with one
1520 argument, which is one of the items in ITEMLIST."
1521 (let (title desc link
1524 (something-was-added nil
))
1525 ;; gather all items for this feed
1526 (mapc (lambda (node)
1527 (setq position
(1+ position
))
1528 (setq title
(or (funcall title-fn node
) "[untitled]"))
1529 (setq desc
(funcall desc-fn node
))
1530 (setq link
(or (funcall link-fn node
) ""))
1531 (setq time
(or (funcall time-fn node
) time
))
1532 ;; It happened that the title or description
1533 ;; contained evil HTML code that confused the
1534 ;; xml parser. Therefore:
1535 (unless (stringp title
)
1536 (setq title
(prin1-to-string title
)))
1537 (unless (or (stringp desc
) (not desc
))
1538 (setq desc
(prin1-to-string desc
)))
1539 ;; ignore items with empty title AND empty desc
1540 (when (or (> (length title
) 0)
1541 (> (length desc
) 0))
1542 ;; decode numeric entities
1543 (setq title
(xml-substitute-numeric-entities title
))
1545 (setq desc
(xml-substitute-numeric-entities desc
)))
1546 (setq link
(xml-substitute-numeric-entities link
))
1547 ;; remove whitespace from title, desc, and link
1548 (setq title
(newsticker--remove-whitespace title
))
1549 (setq desc
(newsticker--remove-whitespace desc
))
1550 (setq link
(newsticker--remove-whitespace link
))
1551 ;; add data to cache
1552 ;; do we have this item already?
1553 (let* ((guid (funcall guid-fn node
)))
1554 ;;(message "guid=%s" guid)
1556 (newsticker--cache-contains newsticker--cache
1558 desc link nil guid
)))
1559 ;; add this item, or mark it as old, or do nothing
1564 (let ((prev-age (newsticker--age old-item
)))
1565 (unless newsticker-automatically-mark-items-as-old
1566 ;; Some feeds deliver items multiply, the
1567 ;; first time we find an 'obsolete-old one in
1568 ;; the cache, the following times we find an
1570 (if (memq prev-age
'(obsolete-old old
))
1573 (if (eq prev-age
'immortal
)
1574 (setq age2
'immortal
))
1575 (setq time
(newsticker--time old-item
)))
1576 ;; item was not there
1578 (setq something-was-added t
))
1579 (let ((extra-elements-with-guid (funcall extra-fn node
)))
1580 (unless (assoc 'guid extra-elements-with-guid
)
1581 (setq extra-elements-with-guid
1582 (cons `(guid nil
,(funcall guid-fn node
))
1583 extra-elements-with-guid
)))
1584 (setq newsticker--cache
1585 (newsticker--cache-add
1586 newsticker--cache
(intern name
) title desc link
1587 time age1 position extra-elements-with-guid
1590 (let ((item (newsticker--cache-contains
1591 newsticker--cache
(intern name
) title
1593 (if newsticker-auto-mark-filter-list
1594 (newsticker--run-auto-mark-filter name item
))
1596 'newsticker-new-item-functions name item
))))))
1598 something-was-added
))
1600 ;; ======================================================================
1602 ;; ======================================================================
1604 (defun newsticker--remove-whitespace (string)
1605 "Remove leading and trailing whitespace from STRING."
1606 ;; we must have ...+ but not ...* in the regexps otherwise xemacs loops
1608 (when (and string
(stringp string
))
1609 (replace-regexp-in-string
1611 (replace-regexp-in-string "^[ \t\r\n]+" "" string
))))
1613 (defun newsticker--do-forget-preformatted (item)
1614 "Forget pre-formatted data for ITEM.
1615 Remove the pre-formatted from `newsticker--cache'."
1617 (setcar (nthcdr 7 item
) nil
))
1619 (setcar (nthcdr 6 item
) nil
)))
1621 (defun newsticker--forget-preformatted ()
1622 "Forget all cached pre-formatted data.
1623 Remove the pre-formatted from `newsticker--cache'."
1624 (mapc (lambda (feed)
1625 (mapc 'newsticker--do-forget-preformatted
1628 (when (fboundp 'newsticker--buffer-set-uptodate
)
1629 (newsticker--buffer-set-uptodate nil
)))
1631 (defun newsticker--debug-msg (string &rest args
)
1632 "Print newsticker debug messages.
1633 This function calls `message' with arguments STRING and ARGS, if
1634 `newsticker-debug' is non-nil."
1635 (and newsticker-debug
1636 ;;(not (active-minibuffer-window))
1637 ;;(not (current-message))
1638 (apply 'message string args
)))
1640 (defun newsticker--decode-iso8601-date (iso8601-string)
1641 "Return ISO8601-STRING in format like `decode-time'.
1642 Converts from ISO-8601 to Emacs representation.
1644 2004-09-17T05:09:49.001+00:00
1645 2004-09-17T05:09:49+00:00
1646 2004-09-17T05:09+00:00
1655 "^ *\\([0-9]\\{4\\}\\)" ;year
1656 "\\(-\\([0-9]\\{2\\}\\)" ;month
1657 "\\(-\\([0-9]\\{2\\}\\)" ;day
1659 "\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)" ;hour:minute
1660 "\\(:\\([0-9]\\{2\\}\\)\\(\\.[0-9]+\\)?\\)?" ;second
1662 "\\(\\([-+Z]\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)?"
1665 (let ((year (read (match-string 1 iso8601-string
)))
1666 (month (read (or (match-string 3 iso8601-string
)
1668 (day (read (or (match-string 5 iso8601-string
)
1670 (hour (read (or (match-string 7 iso8601-string
)
1672 (minute (read (or (match-string 8 iso8601-string
)
1674 (second (read (or (match-string 10 iso8601-string
)
1676 (sign (match-string 13 iso8601-string
))
1677 (offset-hour (read (or (match-string 15 iso8601-string
)
1679 (offset-minute (read (or (match-string 16 iso8601-string
)
1681 (cond ((string= sign
"+")
1682 (setq hour
(- hour offset-hour
))
1683 (setq minute
(- minute offset-minute
)))
1685 (setq hour
(+ hour offset-hour
))
1686 (setq minute
(+ minute offset-minute
))))
1687 ;; if UTC subtract current-time-zone offset
1688 ;;(setq second (+ (car (current-time-zone)) second)))
1691 (encode-time second minute hour day month year t
)
1693 (message "Cannot decode \"%s\"" iso8601-string
)
1697 (defun newsticker--decode-rfc822-date (rfc822-string)
1698 "Return RFC822-STRING in format like `decode-time'.
1699 Converts from RFC822 to Emacs representation.
1701 Sat, 07 September 2002 00:00:01 +0100
1702 Sat, 07 September 2002 00:00:01 MET
1703 Sat, 07 Sep 2002 00:00:01 GMT
1704 07 Sep 2002 00:00:01 GMT
1706 (if (and rfc822-string
(stringp rfc822-string
))
1711 "\\(\\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\)\\s-*,?\\)?\\s-*"
1713 "\\([0-9]\\{1,2\\}\\)\\s-+"
1715 "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|"
1716 "Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\).*?\\s-+"
1718 "\\([0-9]\\{2,4\\}\\)"
1719 ;; time may be missing
1722 "\\([0-9]\\{2\\}\\)"
1724 ":\\([0-9]\\{2\\}\\)"
1726 "\\(:\\([0-9]\\{2\\}\\)\\)?"
1729 "UT\\|GMT\\|EST\\|EDT\\|CST\\|CDT\\|MST\\|MDT\\|PST\\|PDT"
1730 "\\|\\([-+]\\)\\([0-9]\\{2\\}\\)\\([0-9]\\{2\\}\\)"
1734 (let ((day (read (match-string 3 rfc822-string
)))
1735 (month-name (match-string 4 rfc822-string
))
1737 (year (read (match-string 5 rfc822-string
)))
1738 (hour (read (or (match-string 7 rfc822-string
) "0")))
1739 (minute (read (or (match-string 8 rfc822-string
) "0")))
1740 (second (read (or (match-string 10 rfc822-string
) "0")))
1741 (zone (match-string 12 rfc822-string
))
1742 (sign (match-string 13 rfc822-string
))
1743 (offset-hour (read (or (match-string 14 rfc822-string
)
1745 (offset-minute (read (or (match-string 15 rfc822-string
)
1750 (cond ((string= sign
"+")
1751 (setq hour
(- hour offset-hour
))
1752 (setq minute
(- minute offset-minute
)))
1754 (setq hour
(+ hour offset-hour
))
1755 (setq minute
(+ minute offset-minute
)))))
1756 (condition-case error-data
1759 (if (string= month-name m
)
1762 '("Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug"
1763 "Sep" "Oct" "Nov" "Dec"))
1764 (encode-time second minute hour day month year t
))
1766 (message "Cannot decode \"%s\": %s %s" rfc822-string
1767 (car error-data
) (cdr error-data
))
1771 (defun newsticker--lists-intersect-p (list1 list2
)
1772 "Return t if LIST1 and LIST2 share elements."
1775 (if (memq elt list2
)
1780 (defun newsticker--update-process-ids ()
1781 "Update list of ids of active newsticker processes.
1782 Checks list of active processes against list of newsticker processes."
1783 (let ((active-procs (process-list))
1785 (mapc (lambda (proc)
1786 (let ((id (process-id proc
)))
1787 (if (memq id newsticker--process-ids
)
1788 (setq new-list
(cons id new-list
)))))
1790 (setq newsticker--process-ids new-list
))
1791 (force-mode-line-update))
1793 ;; ======================================================================
1795 ;; ======================================================================
1796 (defun newsticker--images-dir ()
1797 "Return directory where feed images are saved."
1798 (concat newsticker-dir
"/images/"))
1800 (defun newsticker--icons-dir ()
1801 "Return directory where feed icons are saved."
1802 (concat newsticker-dir
"/icons/"))
1804 (defun newsticker--image-get (feed-name filename directory url
)
1805 "Get image for FEED-NAME by returning FILENAME from DIRECTORY.
1806 If the file does no exist or if it is older than 24 hours
1807 download it from URL first."
1808 (let ((image-name (concat directory feed-name
)))
1809 (if (and (file-exists-p image-name
)
1810 (time-less-p (current-time)
1811 (time-add (nth 5 (file-attributes image-name
))
1812 (seconds-to-time 86400))))
1813 (newsticker--debug-msg "%s: Getting image for %s skipped"
1814 (format-time-string "%A, %H:%M")
1817 (newsticker--debug-msg "%s: Getting image for %s"
1818 (format-time-string "%A, %H:%M")
1820 (if (eq newsticker-retrieval-method
'intern
)
1821 (newsticker--image-download-by-url feed-name filename directory url
)
1822 (newsticker--image-download-by-wget feed-name filename directory url
)))))
1824 (defun newsticker--image-download-by-wget (feed-name filename directory url
)
1825 "Download image for FEED-NAME using external program.
1826 Save image as FILENAME in DIRECTORY, download it from URL."
1827 (let* ((proc-name (concat feed-name
"-" filename
))
1828 (buffername (concat " *newsticker-wget-image-" proc-name
"*"))
1829 (item (or (assoc feed-name newsticker-url-list
)
1830 (assoc feed-name newsticker-url-list-defaults
)
1832 "Cannot get image for %s: Check newsticker-url-list"
1834 (wget-arguments (or (car (cdr (cdr (cdr (cdr item
)))))
1835 newsticker-wget-arguments
)))
1836 (with-current-buffer (get-buffer-create buffername
)
1838 ;; throw an error if there is an old wget-process around
1839 (if (get-process feed-name
)
1840 (error "Another wget-process is running for image %s"
1843 (let* ((args (append wget-arguments
(list url
)))
1844 (proc (apply 'start-process proc-name buffername
1845 newsticker-wget-name args
)))
1846 (set-process-coding-system proc
'no-conversion
'no-conversion
)
1847 (set-process-sentinel proc
'newsticker--image-sentinel
)
1848 (process-put proc
'nt-directory directory
)
1849 (process-put proc
'nt-feed-name feed-name
)
1850 (process-put proc
'nt-filename filename
)))))
1852 (defun newsticker--image-sentinel (process event
)
1853 "Sentinel for image-retrieving PROCESS caused by EVENT."
1854 (let* ((p-status (process-status process
))
1855 (exit-status (process-exit-status process
))
1856 (feed-name (process-get process
'nt-feed-name
))
1857 (directory (process-get process
'nt-directory
))
1858 (filename (process-get process
'nt-filename
)))
1859 ;; catch known errors (zombie processes, rubbish-xml, etc.)
1860 ;; if an error occurs the news feed is not updated!
1862 (unless (and (eq p-status
'exit
)
1864 (message "%s: Error while retrieving image from %s"
1865 (format-time-string "%A, %H:%M")
1867 (newsticker--image-remove directory feed-name
)
1869 (newsticker--image-save (process-buffer process
) directory filename
))))
1871 (defun newsticker--image-save (buffer directory file-name
)
1872 "Save contents of BUFFER in DIRECTORY as FILE-NAME.
1873 Finally kill buffer."
1874 (with-current-buffer buffer
1875 (let ((image-name (concat directory file-name
)))
1876 (set-buffer-file-coding-system 'no-conversion
)
1877 ;; make sure the cache dir exists
1878 (unless (file-directory-p directory
)
1879 (make-directory directory
))
1880 ;; write and close buffer
1881 (let ((require-final-newline nil
)
1882 (backup-inhibited t
)
1883 (coding-system-for-write 'no-conversion
))
1884 (write-region nil nil image-name nil
'quiet
))
1885 (set-buffer-modified-p nil
)
1886 (kill-buffer buffer
))))
1888 (defun newsticker--image-remove (directory file-name
)
1889 "In DIRECTORY remove FILE-NAME."
1890 (let ((image-name (concat directory file-name
)))
1891 (when (file-exists-p file-name
)
1892 (delete-file image-name
))))
1894 (defun newsticker--image-download-by-url (feed-name filename directory url
)
1895 "Download image for FEED-NAME using `url-retrieve'.
1896 Save image as FILENAME in DIRECTORY, download it from URL."
1897 (let ((coding-system-for-read 'no-conversion
))
1898 (condition-case error-data
1899 (url-retrieve url
'newsticker--image-download-by-url-callback
1900 (list feed-name directory filename
))
1901 (error (message "Error retrieving image from %s: %s" feed-name
1903 (force-mode-line-update))
1905 (defun newsticker--image-download-by-url-callback (status feed-name directory filename
)
1906 "Callback function for `newsticker--image-download-by-url'.
1907 STATUS is the return status as delivered by `url-retrieve'.
1908 FEED-NAME is the name of the feed that the news were retrieved
1910 The image is saved in DIRECTORY as FILENAME."
1913 (let ((status-type (car status
))
1914 (status-details (cdr status
)))
1915 (cond ((eq status-type
:redirect
)
1916 ;; don't care about redirects
1918 ((eq status-type
:error
)
1919 ;; silently ignore errors
1922 (let ((buf (get-buffer-create (concat " *newsticker-url-image-" feed-name
"-"
1924 (result (string-to-multibyte (buffer-string))))
1928 ;; remove MIME header
1929 (goto-char (point-min))
1930 (search-forward "\n\n")
1931 (delete-region (point-min) (point))
1933 (newsticker--image-save buf directory filename
)))))
1935 (defun newsticker--insert-image (img string
)
1936 "Insert IMG with STRING at point."
1937 (insert-image img string
))
1939 ;; ======================================================================
1941 ;; ======================================================================
1942 (defun newsticker-htmlr-render (pos1 pos2
) ;
1943 "Replacement for `htmlr-render'.
1944 Renders the HTML code in the region POS1 to POS2 using htmlr."
1945 (let ((str (buffer-substring-no-properties pos1 pos2
)))
1946 (delete-region pos1 pos2
)
1950 (goto-char (point-min))
1951 ;; begin original htmlr-render
1952 (when (fboundp 'htmlr-reset
) (htmlr-reset))
1953 ;; something omitted here...
1954 (when (fboundp 'htmlr-step
)
1955 (while (< (point) (point-max))
1957 ;; end original htmlr-render
1958 (newsticker--remove-whitespace (buffer-string))))))
1960 ;; ======================================================================
1961 ;;; Manipulation of cached data
1962 ;; ======================================================================
1963 (defun newsticker--cache-set-preformatted-contents (item contents
)
1964 "Set preformatted contents of ITEM to CONTENTS."
1966 (setcar (nthcdr 6 item
) contents
)
1967 (setcdr (nthcdr 5 item
) (list contents
))))
1969 (defun newsticker--cache-set-preformatted-title (item title
)
1970 "Set preformatted title of ITEM to TITLE."
1972 (setcar (nthcdr 7 item
) title
)
1973 (setcdr (nthcdr 6 item
) title
)))
1975 (defun newsticker--cache-replace-age (data feed old-age new-age
)
1976 "Mark all items in DATA in FEED which carry age OLD-AGE with NEW-AGE.
1977 If FEED is `any' it applies to all feeds. If OLD-AGE is `any',
1978 all marks are replaced by NEW-AGE. Removes all pre-formatted contents."
1979 (mapc (lambda (a-feed)
1980 (when (or (eq feed
'any
)
1981 (eq (car a-feed
) feed
))
1982 (let ((items (cdr a-feed
)))
1983 (mapc (lambda (item)
1984 (when (or (eq old-age
'any
)
1985 (eq (newsticker--age item
) old-age
))
1986 (setcar (nthcdr 4 item
) new-age
)
1987 (newsticker--do-forget-preformatted item
)))
1992 (defun newsticker--cache-mark-expired (data feed old-age new-age time
)
1993 "Mark all expired entries.
1994 This function sets the age entries in DATA in the feed FEED. If
1995 an item's age is OLD-AGE it is set to NEW-AGE if the item is
1999 (when (or (eq feed
'any
)
2000 (eq (car a-feed
) feed
))
2001 (let ((items (cdr a-feed
)))
2004 (when (eq (newsticker--age item
) old-age
)
2005 (let ((exp-time (time-add (newsticker--time item
)
2006 (seconds-to-time time
))))
2007 (when (time-less-p exp-time
(current-time))
2008 (newsticker--debug-msg
2009 "Item `%s' from %s has expired on %s"
2010 (newsticker--title item
)
2011 (format-time-string "%Y-%02m-%d, %H:%M"
2012 (newsticker--time item
))
2013 (format-time-string "%Y-%02m-%d, %H:%M" exp-time
))
2014 (setcar (nthcdr 4 item
) new-age
)))))
2019 (defun newsticker--cache-contains (data feed title desc link age
2021 "Check DATA whether FEED contains an item with the given properties.
2022 This function returns the contained item or nil if it is not
2024 The properties which are checked are TITLE, DESC, LINK, AGE, and
2025 GUID. In general all properties must match in order to return a
2026 certain item, except for the following cases.
2028 If AGE equals `feed' the TITLE, DESCription and LINK do not
2029 matter. If DESC is nil it is ignored as well. If
2030 `newsticker-desc-comp-max' is non-nil, only the first
2031 `newsticker-desc-comp-max' characters of DESC are taken into
2034 If GUID is non-nil it is sufficient to match this value, and the
2035 other properties are ignored."
2036 ;;(newsticker--debug-msg "Looking for %s guid=%s" title guid)
2039 (when (and desc newsticker-desc-comp-max
2040 (> (length desc
) newsticker-desc-comp-max
))
2041 (setq desc
(substring desc
0 newsticker-desc-comp-max
)))
2044 (when (eq (car this-feed
) feed
)
2045 (mapc (lambda (anitem)
2047 ;; global unique id can match
2048 (string= guid
(newsticker--guid anitem
)))
2051 ;; or title, desc, etc.
2053 ;;(or (not (eq age 'feed))
2054 ;; (eq (newsticker--age anitem) 'feed))
2055 (string= (newsticker--title anitem
)
2058 (string= (newsticker--link anitem
)
2061 (if (and desc newsticker-desc-comp-max
2062 (> (length (newsticker--desc
2064 newsticker-desc-comp-max
))
2066 (newsticker--desc anitem
)
2068 newsticker-desc-comp-max
)
2070 (string= (newsticker--desc anitem
)
2072 ;;(newsticker--debug-msg "Found %s guid=%s"
2073 ;; (newsticker--title anitem)
2074 ;; (newsticker--guid anitem))
2075 (throw 'found anitem
)))
2078 ;;(newsticker--debug-msg "Found nothing")
2082 (defun newsticker--cache-add (data feed-name-symbol title desc link time age
2083 position extra-elements
2084 &optional updated-time updated-age
2085 preformatted-contents
2087 "Add another item to cache data.
2088 Add to DATA in the FEED-NAME-SYMBOL an item with TITLE, DESC,
2089 LINK, TIME, AGE, POSITION, and EXTRA-ELEMENTS. If this item is
2090 contained already, its time is set to UPDATED-TIME, its mark is
2091 set to UPDATED-AGE, and its pre-formatted contents is set to
2092 PREFORMATTED-CONTENTS and PREFORMATTED-TITLE. Returns the age
2093 which the item got."
2094 (let* ((guid (newsticker--guid-to-string (assoc 'guid extra-elements
)))
2095 (item (newsticker--cache-contains data feed-name-symbol title desc link
2097 ;;(message "guid=%s" guid)
2099 ;; does exist already -- change age, update time and position
2101 ;;(newsticker--debug-msg "Updating item %s %s %s %s %s -> %s %s
2103 ;; feed-name-symbol title link time age
2104 ;; updated-time updated-age
2105 ;; guid (newsticker--guid item))
2107 (setcar (nthcdr 5 item
) position
)
2108 (setcdr (nthcdr 4 item
) (list position
)))
2109 (setcar (nthcdr 4 item
) updated-age
)
2111 (setcar (nthcdr 3 item
) updated-time
))
2112 ;; replace cached pre-formatted contents
2113 (newsticker--cache-set-preformatted-contents
2114 item preformatted-contents
)
2115 (newsticker--cache-set-preformatted-title
2116 item preformatted-title
))
2117 ;; did not exist or age equals 'feed-name-symbol
2118 (setq item
(list title desc link time age position preformatted-contents
2119 preformatted-title extra-elements
))
2120 ;;(newsticker--debug-msg "Adding item %s" item)
2121 (let ((this-feed (assq feed-name-symbol data
)))
2123 (setcdr this-feed
(nconc (cdr this-feed
) (list item
)))
2124 ;; The feed is not contained.
2125 (setq data
(append data
(list (list feed-name-symbol item
)))))))
2128 (defun newsticker--cache-remove (data feed-symbol age
)
2129 "Remove all entries from DATA in the feed FEED-SYMBOL with AGE.
2130 FEED-SYMBOL may be `any'. Entries from old feeds, which are no longer in
2131 `newsticker-url-list' or `newsticker-url-list-defaults', are removed as
2137 (if (or (assoc (symbol-name (car feed
)) newsticker-url-list
)
2138 (assoc (symbol-name (car feed
)) newsticker-url-list-defaults
))
2139 ;; feed is still valid=active
2140 ;; (message "Keeping feed %s" (car feed))
2141 (if (or (eq feed-symbol
'any
)
2142 (eq feed-symbol
(car feed
)))
2143 (let* ((item-pos (cdr feed
))
2144 (item (car item-pos
))
2147 ;;(message "%s" (car item))
2148 (if (eq age
(newsticker--age item
))
2151 ;;(message "Removing item %s" (car item))
2153 (setcdr prev-pos
(cdr item-pos
))
2154 (setcdr feed
(cdr item-pos
))))
2155 ;;(message "Keeping item %s" (car item))
2156 (setq prev-pos item-pos
))
2157 (setq item-pos
(cdr item-pos
))
2158 (setq item
(car item-pos
)))))
2159 ;; feed is not active anymore
2160 ;; (message "Removing feed %s" (car feed))
2162 (setcdr last-pos
(cdr pos
))
2163 (setq data
(cdr pos
))))
2165 (setq pos
(cdr pos
))
2166 (setq feed
(car pos
)))))
2168 ;; ======================================================================
2170 ;; ======================================================================
2171 (defun newsticker--cache-item-compare-by-time (item1 item2
)
2172 "Compare two news items ITEM1 and ITEM2 by comparing their time values."
2174 (let ((age1 (newsticker--age item1
))
2175 (age2 (newsticker--age item2
)))
2176 (if (not (eq age1 age2
))
2177 (cond ((eq age1
'obsolete
)
2178 (throw 'result nil
))
2179 ((eq age2
'obsolete
)
2180 (throw 'result t
)))))
2181 (let* ((time1 (newsticker--time item1
))
2182 (time2 (newsticker--time item2
)))
2183 (cond ((< (nth 0 time1
) (nth 0 time2
))
2185 ((> (nth 0 time1
) (nth 0 time2
))
2187 ((< (nth 1 time1
) (nth 1 time2
))
2189 ((> (nth 1 time1
) (nth 1 time2
))
2191 ((< (or (nth 2 time1
) 0) (or (nth 2 time2
) 0))
2193 ((> (or (nth 2 time1
) 0) (or (nth 2 time2
) 0))
2198 (defun newsticker--cache-item-compare-by-title (item1 item2
)
2199 "Compare ITEM1 and ITEM2 by comparing their titles."
2201 (let ((age1 (newsticker--age item1
))
2202 (age2 (newsticker--age item2
)))
2203 (if (not (eq age1 age2
))
2204 (cond ((eq age1
'obsolete
)
2205 (throw 'result nil
))
2206 ((eq age2
'obsolete
)
2207 (throw 'result t
)))))
2208 (string< (newsticker--title item1
) (newsticker--title item2
))))
2210 (defun newsticker--cache-item-compare-by-position (item1 item2
)
2211 "Compare ITEM1 and ITEM2 by comparing their original positions."
2213 (let ((age1 (newsticker--age item1
))
2214 (age2 (newsticker--age item2
)))
2215 (if (not (eq age1 age2
))
2216 (cond ((eq age1
'obsolete
)
2217 (throw 'result nil
))
2218 ((eq age2
'obsolete
)
2219 (throw 'result t
)))))
2220 (< (or (newsticker--pos item1
) 0) (or (newsticker--pos item2
) 0))))
2222 (defun newsticker--cache-save-version1 ()
2223 "Update and save newsticker cache file."
2225 (newsticker--cache-update t
))
2227 (defun newsticker--cache-update (&optional save
)
2228 "Update newsticker cache file.
2229 If optional argument SAVE is not nil the cache file is saved to disk."
2231 (unless (file-directory-p newsticker-dir
)
2232 (make-directory newsticker-dir t
))
2233 (let ((coding-system-for-write 'utf-8
)
2234 (buf (find-file-noselect newsticker-cache-filename
)))
2237 (setq buffer-undo-list t
)
2239 (insert ";; -*- coding: utf-8 -*-\n")
2240 (insert (prin1-to-string newsticker--cache
))
2244 (defun newsticker--cache-get-feed (feed)
2245 "Return the cached data for the feed FEED.
2247 (assoc feed newsticker--cache
))
2249 (defun newsticker--cache-dir ()
2250 "Return directory for saving cache data."
2251 (concat newsticker-dir
"/feeds"))
2253 (defun newsticker--cache-save ()
2254 "Save cache data for all feeds."
2255 (unless (file-directory-p newsticker-dir
)
2256 (make-directory newsticker-dir t
))
2257 (mapc 'newsticker--cache-save-feed newsticker--cache
)
2260 (defun newsticker--cache-save-feed (feed)
2261 "Save cache data for FEED."
2262 (let ((dir (concat (newsticker--cache-dir) "/" (symbol-name (car feed
)))))
2263 (unless (file-directory-p dir
)
2264 (make-directory dir t
))
2265 (let ((coding-system-for-write 'utf-8
))
2266 (with-temp-file (concat dir
"/data")
2267 (insert ";; -*- coding: utf-8 -*-\n")
2268 (insert (prin1-to-string (cdr feed
)))))))
2270 (defun newsticker--cache-read-version1 ()
2271 "Read version1 cache data."
2272 (let ((coding-system-for-read 'utf-8
))
2273 (when (file-exists-p newsticker-cache-filename
)
2275 (insert-file-contents newsticker-cache-filename
)
2276 (goto-char (point-min))
2278 (setq newsticker--cache
(read (current-buffer)))
2280 (message "Error while reading newsticker cache file!")
2281 (setq newsticker--cache nil
)))))))
2283 (defun newsticker--cache-read ()
2285 (setq newsticker--cache nil
)
2286 (if (file-exists-p newsticker-cache-filename
)
2288 (when (y-or-n-p "Old newsticker cache file exists. Read it? ")
2289 (newsticker--cache-read-version1))
2290 (when (y-or-n-p (format "Delete old newsticker cache file? "))
2291 (delete-file newsticker-cache-filename
)))
2293 (newsticker--cache-read-feed (car f
)))
2294 (append newsticker-url-list-defaults newsticker-url-list
))))
2296 (defun newsticker--cache-read-feed (feed-name)
2297 "Read cache data for feed named FEED-NAME."
2298 (let ((file-name (concat (newsticker--cache-dir) "/" feed-name
"/data"))
2299 (coding-system-for-read 'utf-8
))
2300 (when (file-exists-p file-name
)
2302 (insert-file-contents file-name
)
2303 (goto-char (point-min))
2305 (add-to-list 'newsticker--cache
(cons (intern feed-name
)
2306 (read (current-buffer))))
2308 (message "Error while reading newsticker cache file %s!"
2310 (setq newsticker--cache nil
)))))))
2312 ;; ======================================================================
2314 ;; ======================================================================
2315 (defun newsticker--stat-num-items (feed &rest ages
)
2316 "Return number of items in the given FEED which have one of the given AGES.
2317 If AGES is nil, the total number of items is returned."
2318 (let ((items (cdr (newsticker--cache-get-feed feed
)))
2322 (if (memq (newsticker--age (car items
)) ages
)
2323 (setq num
(1+ num
)))
2324 (if (memq (newsticker--age (car items
)) '(new old immortal obsolete
))
2325 (setq num
(1+ num
))))
2326 (setq items
(cdr items
)))
2329 (defun newsticker--stat-num-items-total (&optional age
)
2330 "Return total number of items in all feeds which have the given AGE.
2331 If AGE is nil, the total number of items is returned."
2333 (mapcar (lambda (feed)
2335 (newsticker--stat-num-items (intern (car feed
)) age
)
2336 (newsticker--stat-num-items (intern (car feed
)))))
2337 (append newsticker-url-list-defaults newsticker-url-list
))))
2339 ;; ======================================================================
2341 ;; ======================================================================
2342 (defun newsticker-opml-export ()
2343 "OPML subscription export.
2344 Export subscriptions to a buffer in OPML Format."
2345 ;; FIXME: use newsticker-groups
2347 (with-current-buffer (get-buffer-create "*OPML Export*")
2348 (set-buffer-file-coding-system 'utf-8
)
2350 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
2351 "<!-- OPML generated by Emacs newsticker.el -->\n"
2352 "<opml version=\"1.0\">\n"
2354 " <title>mySubscriptions</title>\n"
2355 " <dateCreated>" (format-time-string "%a, %d %b %Y %T %z")
2357 " <ownerEmail>" user-mail-address
"</ownerEmail>\n"
2358 " <ownerName>" (user-full-name) "</ownerName>\n"
2362 (insert " <outline text=\"")
2363 (insert (newsticker--title sub
))
2364 (insert "\" xmlUrl=\"")
2365 (insert (xml-escape-string (let ((url (cadr sub
)))
2366 (if (stringp url
) url
(prin1-to-string url
)))))
2368 (append newsticker-url-list newsticker-url-list-defaults
))
2369 (insert " </body>\n</opml>\n"))
2370 (pop-to-buffer "*OPML Export*")
2371 (when (fboundp 'sgml-mode
)
2374 (defun newsticker--opml-import-outlines (outlines)
2375 "Recursively import OUTLINES from OPML data.
2376 Note that nested outlines are currently flattened -- i.e. grouping is
2378 (mapc (lambda (outline)
2379 (let ((name (xml-get-attribute outline
'text
))
2380 (url (xml-get-attribute outline
'xmlUrl
))
2381 (children (xml-get-children outline
'outline
)))
2382 (unless (string= "" url
)
2383 (add-to-list 'newsticker-url-list
2384 (list name url nil nil nil
) t
))
2386 (newsticker--opml-import-outlines children
))))
2389 (defun newsticker-opml-import (filename)
2390 "Import OPML data from FILENAME."
2391 (interactive "fOPML file: ")
2392 (set-buffer (find-file-noselect filename
))
2393 (goto-char (point-min))
2394 (let* ((node-list (xml-parse-region (point-min) (point-max)))
2395 (body (car (xml-get-children (car node-list
) 'body
)))
2396 (outlines (xml-get-children body
'outline
)))
2397 (newsticker--opml-import-outlines outlines
))
2398 (customize-variable 'newsticker-url-list
))
2400 ;; ======================================================================
2402 ;; ======================================================================
2403 (defun newsticker--run-auto-mark-filter (feed item
)
2404 "Automatically mark an item as old or immortal.
2405 This function checks the variable `newsticker-auto-mark-filter-list'
2406 for an entry that matches FEED and ITEM."
2407 (let ((case-fold-search t
))
2408 (mapc (lambda (filter)
2409 (let ((filter-feed (car filter
))
2410 (pattern-list (cadr filter
)))
2411 (when (string-match filter-feed feed
)
2412 (newsticker--do-run-auto-mark-filter item pattern-list
))))
2413 newsticker-auto-mark-filter-list
)))
2415 (defun newsticker--do-run-auto-mark-filter (item list
)
2416 "Actually compare ITEM against the pattern-LIST.
2417 LIST must be an element of `newsticker-auto-mark-filter-list'."
2418 (mapc (lambda (pattern)
2419 (let ((place (nth 1 pattern
))
2420 (regexp (nth 2 pattern
))
2421 (title (newsticker--title item
))
2422 (desc (newsticker--desc item
)))
2423 (when (or (eq place
'title
) (eq place
'all
))
2424 (when (and title
(string-match regexp title
))
2425 (newsticker--process-auto-mark-filter-match item pattern
)))
2426 (when (or (eq place
'description
) (eq place
'all
))
2427 (when (and desc
(string-match regexp desc
))
2428 (newsticker--process-auto-mark-filter-match item pattern
)))))
2431 (defun newsticker--process-auto-mark-filter-match (item pattern
)
2432 "Process ITEM that matches an auto-mark-filter PATTERN."
2433 (let ((age (nth 0 pattern
))
2434 (place (nth 1 pattern
))
2435 (regexp (nth 2 pattern
)))
2436 (newsticker--debug-msg "Auto-mark-filter %s matches `%s'"
2437 pattern
(newsticker--title item
))
2438 (setcar (nthcdr 4 item
) age
)
2439 (nconc (newsticker--extra item
)
2440 (list (list 'newsticker-auto-mark nil
2441 (format "age=%s, title/desc=%s, regexp=%s"
2442 age place regexp
))))))
2444 ;; ======================================================================
2446 ;; ======================================================================
2447 (defun newsticker-new-item-functions-sample (feed item
)
2448 "Demonstrate the use of the `newsticker-new-item-functions' hook.
2449 This function just prints out the values of the FEED and title of the ITEM."
2450 (message (concat "newsticker-new-item-functions-sample: feed=`%s', "
2452 feed
(newsticker--title item
)))
2454 (defun newsticker-download-images (feed item
)
2455 "Download the first image.
2456 If FEED equals \"imagefeed\" download the first image URL found
2457 in the description=contents of ITEM to the directory
2458 \"~/tmp/newsticker/FEED/TITLE\" where TITLE is the title of the item."
2459 (when (string= feed
"imagefeed")
2460 (let ((title (newsticker--title item
))
2461 (desc (newsticker--desc item
)))
2462 (when (string-match "<img src=\"\\(http://[^ \"]+\\)\"" desc
)
2463 (let ((url (substring desc
(match-beginning 1) (match-end 1)))
2464 (temp-dir (concat "~/tmp/newsticker/" feed
"/" title
))
2465 (org-dir default-directory
))
2466 (unless (file-directory-p temp-dir
)
2467 (make-directory temp-dir t
))
2469 (message "Getting image %s" url
)
2470 (apply 'start-process
"wget-image"
2471 " *newsticker-wget-download-images*"
2472 newsticker-wget-name
2476 (defun newsticker-download-enclosures (feed item
)
2477 "In all FEEDs download the enclosed object of the news ITEM.
2478 The object is saved to the directory \"~/tmp/newsticker/FEED/TITLE\", which
2479 is created if it does not exist. TITLE is the title of the news
2480 item. Argument FEED is ignored.
2481 This function is suited for adding it to `newsticker-new-item-functions'."
2482 (let ((title (newsticker--title item
))
2483 (enclosure (newsticker--enclosure item
)))
2485 (let ((url (cdr (assoc 'url enclosure
)))
2486 (temp-dir (concat "~/tmp/newsticker/" feed
"/" title
))
2487 (org-dir default-directory
))
2488 (unless (file-directory-p temp-dir
)
2489 (make-directory temp-dir t
))
2491 (message "Getting enclosure %s" url
)
2492 (apply 'start-process
"wget-enclosure"
2493 " *newsticker-wget-download-enclosures*"
2494 newsticker-wget-name
2498 ;; ======================================================================
2499 ;;; Retrieve samples
2500 ;; ======================================================================
2501 (defun newsticker-retrieve-random-message (feed-name)
2502 "Return an artificial RSS string under the name FEED-NAME."
2503 (concat "<?xml version=\"1.0\" encoding=\"iso-8859-1\" ?><rss version=\"0.91\">"
2505 "<title>newsticker-retrieve-random-message</title>"
2506 "<description>Sample retrieval function</description>"
2507 "<pubDate>FIXME Sat, 07 Sep 2005 00:00:01 GMT</pubDate>"
2508 "<item><title>" (format "Your lucky number is %d" (random 10000))
2509 "</title><description>" (format "Or maybe it is %d" (random 10000))
2510 "</description></item></channel></rss>"))
2512 (provide 'newst-backend
)
2514 ;;; newst-backend.el ends here