lisp/net/newsticker.el

   1 ;;; newsticker.el --- A Newsticker for Emacs.
   2
   3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   4
   5 ;; This file is part of GNU Emacs.
   6
   7 ;; Author:      Ulf Jasper <ulf.jasper@web.de>
   8 ;; Filename:    newsticker.el
   9 ;; URL:         http://www.nongnu.org/newsticker
  10 ;; Created:     17. June 2003
  11 ;; Keywords:    News, RSS, Atom
  12 ;; Time-stamp:  "29. Januar 2007, 21:05:09 (ulf)"
  13
  14 ;; ======================================================================
  15
  16 ;; GNU Emacs is free software; you can redistribute it and/or modify
  17 ;; it under the terms of the GNU General Public License as published by
  18 ;; the Free Software Foundation; either version 3, or (at your option)
  19 ;; any later version.
  20
  21 ;; This program is distributed in the hope that it will be useful, but
  22 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24 ;; General Public License for more details.
  25
  26 ;; You should have received a copy of the GNU General Public License
  27 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  28 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  29 ;; Boston, MA 02110-1301, USA.
  30
  31 (defconst newsticker-version "1.10" "Version number of newsticker.el.")
  32
  33 ;; ======================================================================
  34 ;;; Commentary:
  35
  36 ;; Overview
  37 ;; --------
  38
  39 ;; Newsticker provides a newsticker for Emacs.  A newsticker is a thing
  40 ;; that asynchronously retrieves headlines from a list of news sites,
  41 ;; prepares these headlines for reading, and allows for loading the
  42 ;; corresponding articles in a web browser.
  43
  44 ;; Headlines consist of a title and (possibly) a small description.  They
  45 ;; are contained in "RSS" (RDF Site Summary) or "Atom" files.  Newsticker
  46 ;; should work with the following RSS formats:
  47 ;;  * RSS 0.91
  48 ;;    (see http://backend.userland.com/rss091 or
  49 ;;    http://my.netscape.com/publish/formats/rss-spec-0.91.html)
  50 ;;  * RSS 0.92
  51 ;;    (see http://backend.userland.com/rss092)
  52 ;;  * RSS 1.0
  53 ;;    (see http://purl.org/rss/1.0/spec)
  54 ;;  * RSS 2.0
  55 ;;    (see http://blogs.law.harvard.edu/tech/rss)
  56 ;; as well as the following Atom formats:
  57 ;;  * Atom 0.3
  58 ;;  * Atom 1.0
  59 ;;    (see http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt)
  60 ;; That makes Newsticker.el an "Atom aggregator, "RSS reader", "RSS
  61 ;; aggregator", and "Feed Reader".
  62
  63 ;; Newsticker provides several commands for reading headlines, navigating
  64 ;; through them, marking them as read/unread, hiding old headlines
  65 ;; etc.  Headlines can be displayed as plain text or as rendered HTML.
  66
  67 ;; Headlines can be displayed in the echo area, either scrolling like
  68 ;; messages in a stock-quote ticker, or just changing.
  69
  70 ;; Newsticker allows for automatic processing of headlines by providing
  71 ;; hooks and (sample) functions for automatically downloading images and
  72 ;; enclosed files (as delivered by podcasts, e.g.).
  73
  74 ;; Requirements
  75 ;; ------------
  76 ;; Newsticker can be used with GNU Emacs version 21.1 or later as well as
  77 ;; XEmacs.  It requires an XML-parser (`xml.el') which is part of GNU
  78 ;; Emacs.  If you are using XEmacs you want to get the `net-utils' package
  79 ;; which contains `xml.el' for XEmacs.
  80
  81 ;; Newsticker requires a program which can retrieve files via http and
  82 ;; prints them to stdout.  By default Newsticker will use wget for this
  83 ;; task.
  84
  85 ;; Installation
  86 ;; ------------
  87
  88 ;; If you are using Newsticker as part of GNU Emacs there is no need to
  89 ;; perform any installation steps in order to use Newsticker.  Otherwise
  90 ;; place Newsticker in a directory where Emacs can find it.  Add the
  91 ;; following line to your Emacs startup file (`~/.emacs').
  92 ;;   (add-to-list 'load-path "/path/to/newsticker/")
  93 ;;   (autoload 'newsticker-start "newsticker" "Emacs Newsticker" t)
  94 ;;   (autoload 'newsticker-show-news "newsticker" "Emacs Newsticker" t)
  95
  96 ;; If you are using `imenu', which allows for navigating with the help of a
  97 ;; menu, you should add the following to your Emacs startup file
  98 ;; (`~/.emacs').
  99 ;;   (add-hook 'newsticker-mode-hook 'imenu-add-menubar-index)
 100
 101 ;; That's it.
 102
 103 ;; Usage
 104 ;; -----
 105 ;; The command newsticker-show-news will display all available headlines in
 106 ;; a special buffer, called `*newsticker*'.  It will also start the
 107 ;; asynchronous download of headlines.  The modeline in the `*newsticker*'
 108 ;; buffer informs whenever new headlines have arrived.  Clicking
 109 ;; mouse-button 2 or pressing RET in this buffer on a headline will call
 110 ;; browse-url to load the corresponding news story in your favourite web
 111 ;; browser.
 112
 113 ;; The scrolling, or flashing of headlines in the echo area, can be started
 114 ;; with the command newsticker-start-ticker.  It can be stopped with
 115 ;; newsticker-stop-ticker.
 116
 117 ;; If you just want to start the periodic download of headlines use the
 118 ;; command newsticker-start.  Calling newsticker-stop will stop the
 119 ;; periodic download, but will call newsticker-stop-ticker as well.
 120
 121 ;; Configuration
 122 ;; -------------
 123 ;; All Newsticker options are customizable, i.e. they can be changed with
 124 ;; Emacs customization methods: Call the command customize-group and enter
 125 ;; `newsticker' for the customization group.
 126
 127 ;; All Newsticker options have reasonable default values, so that in most
 128 ;; cases it is not necessary to customize settings before starting
 129 ;; Newsticker for the first time.
 130
 131 ;; Newsticker options are organized in the following groups.
 132
 133 ;; * newsticker-feed contains options that define which news
 134 ;;   feeds are retrieved and how this is done.
 135 ;;   o newsticker-url-list defines the list of headlines which are
 136 ;;     retrieved.
 137 ;;   o newsticker-retrieval-interval defines how often headlines are
 138 ;;     retrieved.
 139 ;; * newsticker-headline-processing contains options that define how the
 140 ;;   retrieved headlines are processed.
 141 ;;   o newsticker-keep-obsolete-items decides whether unread headlines that
 142 ;;     have been removed from the feed are kept in the Newsticker cache.
 143 ;; * newsticker-layout contains options that define how the buffer for
 144 ;;   reading news headlines is formatted.
 145 ;;   o newsticker-item-format defines how the title of a headline is
 146 ;;     formatted.
 147 ;; * newsticker-ticker contains options that define how headlines are shown
 148 ;;   in the echo area.
 149 ;;   o newsticker-display-interval and newsticker-scroll-smoothly define
 150 ;;     how headlines are shown in the echo area.
 151 ;; * newsticker-hooks contains options for hooking other Emacs commands to
 152 ;;   newsticker functions.
 153 ;;   o newsticker-new-item-functions allows for automatic processing of
 154 ;;     headlines.  See `newsticker-download-images', and
 155 ;;     `newsticker-download-enclosures' for sample functions.
 156 ;; * newsticker-miscellaneous contains other Newsticker options.
 157
 158 ;; Please have a look at the customization buffers for the complete list of
 159 ;; options.
 160
 161 ;; Remarks
 162 ;; -------
 163 ;; This newsticker is designed do its job silently in the background
 164 ;; without disturbing you.  However, it is probably impossible to prevent
 165 ;; such a tool from slightly attenuating your Editor's responsiveness every
 166 ;; once in a while.
 167
 168 ;; Byte-compiling newsticker.el is recommended.
 169
 170 ;; ======================================================================
 171 ;;; History:
 172
 173 ;; 1.10 (2007-01-29)
 174 ;;     * Bugfixes mostly: `newsticker--decode-iso8601-date',
 175 ;;       `newsticker--sentinel', and others.
 176 ;;     * Renamed `newsticker--retrieval-timer-list' to
 177 ;;       `newsticker-retrieval-timer-list'.  Removed
 178 ;;       `newsticker-running-p' -- check newsticker-retrieval-timer-list
 179 ;;       to find out whether newsticker is running.  Removed
 180 ;;       `newsticker-ticker-running-p'.
 181 ;;     * Try to cache images in w3m-rendered HTML text.
 182 ;;     * Other minor changes.
 183
 184 ;; 1.9 (2005-11-01)
 185 ;;     * Rewrote feed parsing part.  Newsticker now supports RSS 0.91,
 186 ;;       0.92, 1.0, 2.0 as well as Atom 0.3 and 1.0 -- thanks to Thien-Thi
 187 ;;       Nguyen.
 188 ;;     * Changed auto-marking mechanism: Replaced variable
 189 ;;       `newsticker-auto-mark-filter' with new variable
 190 ;;       `newsticker-auto-mark-filter-list', which allows for looking not
 191 ;;       only at the title but also at the description of a headline.
 192 ;;     * Call `newsticker--ticker-text-setup' only after all pending
 193 ;;       downloads processes have finished.
 194 ;;     * Improved handling of coding systems.
 195 ;;     * Added magic autoload comments.
 196 ;;     * Bugfixes:
 197 ;;       - `hide-entry' was hiding too much when called for the last
 198 ;;          headline,
 199 ;;       - update mode-line and menu-bar when necessary,
 200 ;;       - repaired `newsticker--imenu-goto',
 201 ;;       - other minor things.
 202
 203 ;; 1.8 (2005-08-26)
 204 ;;     * Added commands `newsticker-show-extra' and `newsticker-hide-extra'
 205 ;;       to show and hide extra RSS elements, bound to "sx" and "hx"
 206 ;;       resp. Changed default value of `newsticker-show-all-rss-elements'
 207 ;;       to nil.
 208 ;;     * mode-line: Introduced special mode-line-format for newsticker.
 209 ;;     * Get feed logos only once every 24 h.
 210 ;;     * Default faces changed.
 211 ;;     * Minor fixes.
 212
 213 ;; 1.7 (2005-06-25)
 214 ;;     * Tool-bar support: most important commands can be called from
 215 ;;       tool-bar buttons.
 216 ;;     * Auto-Narrowing introduced: *newsticker* buffer can be narrowed to
 217 ;;       a single item (bound to key `xi') or a single feed (bound to
 218 ;;       `xf').
 219 ;;     * Enclosure support: enclosed items are shown (see
 220 ;;       `newsticker-enclosure-face') and can be (automatically) downloaded
 221 ;;       (see below). For those of you who read "podcasts".
 222 ;;     * Added variable `newsticker-auto-mark-filter' for automatically
 223 ;;       marking items as immortal or old.
 224 ;;     * Added hook variable `newsticker-new-item-functions' for handling
 225 ;;       new items.  Added sample functions `newsticker-download-images',
 226 ;;       and `newsticker-download-enclosures'.
 227 ;;     * Added hook variable `newsticker-select-item-hook' which is run
 228 ;;       after `newsticker-(next|previous)-(new-)?-item'.
 229 ;;     * Added hook variable `newsticker-select-feed-hook' which is run
 230 ;;       after `newsticker-(next|previous)-feed'.
 231 ;;     * Added hook variable `newsticker-buffer-change-hook' which is run
 232 ;;       after the contents or visibility of the newsticker buffer has
 233 ;;       changed, e.g. after `newsticker-buffer-update' or
 234 ;;       `newsticker-show-feed-desc'.
 235 ;;     * Added command `newsticker-handle-url' for interactively launching
 236 ;;       arbitrary programs for URLs, bound to `C-RET'.
 237 ;;     * URLs in extra elements are clickable.
 238 ;;     * Better support for w3, added command
 239 ;;       `newsticker-w3m-show-inline-images' for displaying all inline
 240 ;;       images.
 241 ;;     * Insert an artificial headline which notifies about failed
 242 ;;       retrievals.
 243 ;;     * Use pubDate element (RSS 2.0) instead of retrieval time when
 244 ;;       available.
 245 ;;     * Customizable options grouped.
 246 ;;     * Bugfixes: `newsticker--imenu-create-index'; strip whitespace
 247 ;;       from links; apply coding-system to extra-elements; time-comparison
 248 ;;       for obsolete items; and others which I have forgotten.
 249 ;;     * Workaround for another bug in xml-parse-region -- thanks to
 250 ;;       anonymous for sending patch.
 251 ;;     * Renamed invisible buffers ` *wget-newsticker-<feed>*' to
 252 ;;       ` *newsticker-wget-<feed>*'.
 253 ;;     * Tested with GNU Emacs versions 21.3 and 22.0 and XEmacs
 254 ;;       21.something.
 255
 256 ;; 1.6 * Support for (some) optional RSS elements: guid, dc:date. See
 257 ;;       `newsticker-show-all-rss-elements' `newsticker-extra-face'.
 258 ;;     * Better support for w3m -- `newsticker-default-face' is obsolete
 259 ;;       now, removed `newsticker-w3m-toggle-inline-image'.
 260 ;;     * Added `newsticker-desc-comp-max' -- comparison of item
 261 ;;       descriptions can take quite some time.
 262 ;;     * Added `newsticker--buffer-make-item-completely-visible' to
 263 ;;       ensure that the current item is fully visible.
 264 ;;     * Allow for non-positive retrieval-interval, which make newsticker
 265 ;;       get news only once.
 266 ;;     * Use :set for customizable variables.
 267 ;;     * Added `newsticker-buffer-force-update', bound to key `U'.
 268 ;;     * Added concept of obsolete items, see
 269 ;;       `newsticker-keep-obsolete-items', `newsticker-obsolete-item-face',
 270 ;;       `newsticker-obsolete-item-max-age'.
 271 ;;     * Added `newsticker-add-url'.
 272 ;;     * OPML export.
 273 ;;     * Save pre-formatted titles => even better performance!!
 274 ;;     * `newsticker-*-new-item' wraps at beginning/end of buffer.
 275 ;;     * Always sort obsolete items to end of item list.
 276 ;;     * Bugfixes:
 277 ;;       - newsticker-hide-entry,
 278 ;;       - changes of feed-titles led to duplicate feed items,
 279 ;;       - faces for rendered HTML texts,
 280 ;;       - length of ticker-text (for "exotic"/multibyte texts),
 281 ;;         Thanks to Hiroshi Maruyama.
 282 ;;       - suppress items with empty title and description
 283 ;;       - newsticker-sort-method was ignored!
 284 ;;       - prevent call of fill-region on HTML-rendered descriptions.
 285
 286 ;; 1.5 * Rewrote the visibility stuff. newsticker does not inherit
 287 ;;       outline anymore.  Now you have complete freedom for
 288 ;;       `newsticker-*-format'.
 289 ;;     * Save pre-formatted descriptions => incredible performance boost!!
 290 ;;     * Introduced `newsticker-(start|stop)-ticker'.
 291 ;;     * Introduced statistics for heading-format and
 292 ;;       `newsticker-statistics-face'.
 293 ;;     * Introduced `newsticker-enable-logo-manipulations'.
 294 ;;     * Compare link of items (as well as title and desc).
 295 ;;     * Added `newsticker-start-hook' and `newsticker-stop-hook', thanks
 296 ;;       to mace.
 297 ;;     * Bugfixes -- thanks to Ryan Yeske, Jari Aalto, Bruce Ingalls.
 298 ;;     * Tested with Emacs 21.3.50, 21.3.1, 21.2, 21.1; XEmacs 21.4.15
 299
 300 ;; 1.4 * Enabled HTML rendering, added `newsticker-html-renderer' to
 301 ;;       choose a HTML rendering engine, thanks to Greg Scott for testing
 302 ;;     * New Outline handling using text properties instead of "**"
 303 ;;       prefixes.
 304 ;;     * Added possibility to mark single item as old (bound to key
 305 ;;       `o' (`newsticker-mark-item-at-point-as-read').
 306 ;;     * Added possibility to mark single item as immortal (bound to key
 307 ;;       `i' (`newsticker-mark-item-at-point-as-immortal').
 308 ;;     * Added possibility to display feed logos.
 309 ;;     * Added `newsticker-heading-format', `newsticker-item-format'.
 310 ;;     * Added `newsticker-date-format'.
 311 ;;     * Added `newsticker-justification'.
 312 ;;     * Added `newsticker-automatically-mark-visited-items-as-old'.
 313 ;;     * Added `newsticker-w3m-toggle-inline-image' which calls
 314 ;;       `w3m-toggle-inline-image' if `newsticker-html-renderer' is
 315 ;;       `w3m-region'. Exists for convenience only (bound to key
 316 ;;       `RET').
 317
 318 ;; 1.3 * Compare title AND desc to check whether item is old, except
 319 ;;       for feed desc
 320 ;;     * Mark as not-up-to-date only after new items have arrived.
 321 ;;     * Added XEmacs compatibility code, tested with XEmacs 21.4.13.
 322 ;;     * Tested with Emacs 21.3.50 and Emacs 21.2.something.
 323 ;;     * Bugfix: Apply coding-systems to feed title and description,
 324 ;;       thanks to OHASHI Akira
 325 ;;     * Bugfix: xml-parser-workaround did not work for japanese texts,
 326 ;;       thanks to OHASHI Akira
 327 ;;     * Kill wget-buffers unless newsticker-debug is not nil.
 328 ;;     * Bugfix: xml-parser-workaround for "DOCTYPE rdf:RDF"
 329
 330 ;; 1.2 Peter S Galbraith <psg@debian.org>
 331 ;;     * Added `newsticker-url-list-defaults', splitting the URLs into
 332 ;;       a customizable selection list, and a user add-on list.
 333 ;;     * Minor checkdoc fixes.
 334
 335 ;; 1.1 * Introduced optional feed-specific wget-arguments.
 336 ;;     * Keep order of feeds as given in `newsticker-url-list' in
 337 ;;       *newsticker* buffer.
 338 ;;     * Ignore unsupported coding systems.
 339
 340 ;; 1.0 * Introduced feed-specific retrieval-timers.
 341 ;;     * Removed dependency on 'cl (cddddr).
 342 ;;     * Thanks to Kevin Rodgers and T.V.  Raman for their help.
 343 ;;     * Use utf-8 for reading and writing cache data.
 344 ;;     * Reported to work with Emacs 21.3.50.
 345
 346 ;; 0.99 * Minor tweaks.
 347 ;;      * Tested with Emacs 21.3.2
 348
 349 ;; 0.98 * Check exit status of wget processes.  Keep cache data if
 350 ;;        something went wrong.  Throw error when old wget-processes
 351 ;;        are hanging around.
 352 ;;      * Introduced newsticker-specific faces.
 353 ;;      * Added `newsticker-show-descriptions-of-new-items'.
 354 ;;      * Added `newsticker-hide-old-items-in-newsticker-buffer'.
 355 ;;      * Added `newsticker-(hide|show)-old-items'.
 356
 357 ;; 0.97 * Minor tweaks.
 358
 359 ;; 0.96 * Added caching.
 360 ;;      * newsticker-mode inherits outline-mode.
 361 ;;      * newsticker-mode supports imenu.
 362 ;;      * Easy buffer-navigation with newsticker-mode's keymap.
 363 ;;      * Some bugs fixed.
 364 ;;      * Thanks to Moritz Epple for documentation tips.
 365
 366 ;; 0.95 * Added newsticker-mode -- Thanks to T.V.  Raman.
 367 ;;      * Catch xml-parser errors -- Thanks to T.V.  Raman.
 368 ;;      * Remove stupid newlines in titles (headlines) -- Thanks to
 369 ;;        Jeff Rancier.
 370
 371 ;; 0.94 * Added clickerability and description for channel headings.
 372 ;;      * Made it work for (at least some) rss 0.9<something> feeds.
 373
 374 ;; 0.93 * Added some more sites.
 375 ;;      * Do not flood the *Messages* buffer.
 376 ;;      * First attempt at handling coding systems.
 377
 378 ;; 0.92 * Added `newsticker-wget-name'.
 379 ;;      * Try to display message only if minibuffer and echo area are
 380 ;;        not in use already.
 381 ;;      * Dirty workaround for newer versions of xml.el: Remove
 382 ;;        whitespace in rdf.
 383 ;;      * Tested with Emacs 21.3.2 and CVS-snapshot of 2003-06-21.
 384
 385 ;; 0.91 * First bugfix: *newsticker* is read-only.
 386
 387 ;; 0.9  * First release.
 388 ;;      * Tested with Emacs 21.3.2 and wget 1.8.2.
 389
 390 ;; ======================================================================
 391 ;;; To Do:
 392
 393 ;; * Image handling for XEmacs (create-image does not exist)
 394
 395 ;; ======================================================================
 396 ;;; Code:
 397
 398 (require 'derived)
 399 (require 'xml)
 400
 401 ;; Silence warnings
 402 (defvar tool-bar-map)
 403 (defvar w3-mode-map)
 404 (defvar w3m-minor-mode-map)
 405
 406 ;; ======================================================================
 407 ;;; Newsticker status
 408 ;; ======================================================================
 409
 410 (defvar newsticker--retrieval-timer-list nil
 411   "List of timers for news retrieval.
 412 This is an alist, each element consisting of (feed-name . timer).")
 413
 414 (defvar newsticker--display-timer nil
 415   "Timer for newsticker display.")
 416
 417 ;;;###autoload
 418 (defun newsticker-running-p ()
 419   "Check whether newsticker is running.
 420 Return t if newsticker is running, nil otherwise.  Newsticker is
 421 considered to be running if the newsticker timer list is not empty."
 422   (> (length newsticker--retrieval-timer-list) 0))
 423
 424 ;;;###autoload
 425 (defun newsticker-ticker-running-p ()
 426   "Check whether newsticker's actual ticker is running.
 427 Return t if ticker is running, nil otherwise.  Newsticker is
 428 considered to be running if the newsticker timer list is not
 429 empty."
 430   (timerp newsticker--display-timer))
 431
 432 ;; ======================================================================
 433 ;;; Customizables
 434 ;; ======================================================================
 435 (defgroup newsticker nil
 436   "Aggregator for RSS and Atom feeds."
 437   :group 'applications)
 438
 439 (defconst newsticker--raw-url-list-defaults
 440   '(("CNET News.com"
 441      "http://export.cnet.com/export/feeds/news/rss/1,11176,,00.xml")
 442     ("Debian Security Advisories"
 443     "http://www.debian.org/security/dsa.en.rdf")
 444     ("Debian Security Advisories - Long format"
 445     "http://www.debian.org/security/dsa-long.en.rdf")
 446     ("Emacs Wiki"
 447     "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
 448     nil
 449     3600)
 450     ("Freshmeat.net"
 451     "http://freshmeat.net/backend/fm.rdf")
 452     ("Kuro5hin.org"
 453     "http://www.kuro5hin.org/backend.rdf")
 454     ("LWN (Linux Weekly News)"
 455     "http://lwn.net/headlines/rss")
 456     ("NewsForge"
 457     "http://newsforge.com/index.rss")
 458     ("NY Times: Technology"
 459     "http://partners.userland.com/nytRss/technology.xml")
 460     ("NY Times"
 461     "http://partners.userland.com/nytRss/nytHomepage.xml")
 462     ("Quote of the day"
 463     "http://www.quotationspage.com/data/qotd.rss"
 464     "07:00"
 465     86400)
 466     ("The Register"
 467     "http://www.theregister.co.uk/tonys/slashdot.rdf")
 468     ("slashdot"
 469     "http://slashdot.org/index.rss"
 470     nil
 471     3600)                        ;/. will ban you if under 3600 seconds!
 472     ("Wired News"
 473     "http://www.wired.com/news_drop/netcenter/netcenter.rdf")
 474     ("Heise News (german)"
 475     "http://www.heise.de/newsticker/heise.rdf")
 476     ("Tagesschau (german)"
 477     "http://www.tagesschau.de/newsticker.rdf"
 478     nil
 479     1800)
 480     ("Telepolis (german)"
 481     "http://www.heise.de/tp/news.rdf"))
 482   "Default URL list in raw form.
 483 This list is fed into defcustom via `newsticker--splicer'.")
 484
 485 (defun newsticker--splicer (item)
 486   "Convert ITEM for splicing into `newsticker-url-list-defaults'."
 487   (let ((result (list 'list :tag (nth 0 item) (list 'const (nth 0 item))))
 488         (element (cdr item)))
 489     (while element
 490       (setq result (append result (list (list 'const (car element)))))
 491       (setq element (cdr element)))
 492     result))
 493
 494 ;; ======================================================================
 495 ;;; Customization
 496 ;; ======================================================================
 497 (defun newsticker--set-customvar (symbol value)
 498   "Set newsticker-variable SYMBOL value to VALUE.
 499
 500 Calls all necessary actions which are necessary in order to make
 501 the new value effective.  Changing `newsticker-url-list', for example,
 502 will re-start the retrieval-timers."
 503   (unless (condition-case nil
 504               (eq (symbol-value symbol) value)
 505             (error nil))
 506     (set symbol value)
 507     (cond ((eq symbol 'newsticker-sort-method)
 508            (when (fboundp 'newsticker--cache-sort)
 509              (message "Applying new sort method...")
 510              (newsticker--cache-sort)
 511              (newsticker--buffer-set-uptodate nil)
 512              (message "Applying new sort method...done")))
 513           ((memq symbol '(newsticker-url-list-defaults
 514                           newsticker-url-list
 515                           newsticker-retrieval-interval))
 516            (when (and (fboundp 'newsticker-running-p)
 517                       (newsticker-running-p))
 518              (message "Restarting newsticker")
 519              (newsticker-stop)
 520              (newsticker-start)))
 521           ((eq symbol 'newsticker-display-interval)
 522            (when (and (fboundp 'newsticker-running-p)
 523                       (newsticker-running-p))
 524              (message "Restarting ticker")
 525              (newsticker-stop-ticker)
 526              (newsticker-start-ticker)
 527              (message "")))
 528           ((memq symbol '(newsticker-hide-old-items-in-echo-area
 529                           newsticker-hide-obsolete-items-in-echo-area
 530                           newsticker-hide-immortal-items-in-echo-area))
 531            (when (and (fboundp 'newsticker-running-p)
 532                       (newsticker-running-p))
 533              (message "Restarting newsticker")
 534              (newsticker-stop-ticker)
 535              (newsticker--ticker-text-setup)
 536              (newsticker-start-ticker)
 537              (message "")))
 538           ((memq symbol '(newsticker-hide-old-items-in-newsticker-buffer
 539                           newsticker-show-descriptions-of-new-items))
 540            (when (fboundp 'newsticker--buffer-set-uptodate)
 541              (newsticker--buffer-set-uptodate nil)))
 542           ((memq symbol '(newsticker-heading-format
 543                           newsticker-item-format
 544                           newsticker-desc-format
 545                           newsticker-date-format
 546                           newsticker-statistics-format
 547                           newsticker-justification
 548                           newsticker-use-full-width
 549                           newsticker-html-renderer
 550                           newsticker-feed-face
 551                           newsticker-new-item-face
 552                           newsticker-old-item-face
 553                           newsticker-immortal-item-face
 554                           newsticker-obsolete-item-face
 555                           newsticker-date-face
 556                           newsticker-statistics-face
 557                           ;;newsticker-default-face
 558                           ))
 559            (when (fboundp 'newsticker--forget-preformatted)
 560              (newsticker--forget-preformatted)))
 561           (t
 562            (error "Ooops %s" symbol)))))
 563
 564 ;; customization group feed
 565 (defgroup newsticker-feed nil
 566   "Settings for news feeds."
 567   :group 'newsticker)
 568
 569 (defcustom newsticker-url-list-defaults
 570  '(("Emacs Wiki"
 571     "http://www.emacswiki.org/cgi-bin/wiki.pl?action=rss"
 572     nil
 573     3600))
 574   "A customizable list of news feeds to select from.
 575 These were mostly extracted from the Radio Community Server at
 576 http://subhonker6.userland.com/rcsPublic/rssHotlist.
 577
 578 You may add other entries in `newsticker-url-list'."
 579   :type `(set ,@(mapcar `newsticker--splicer
 580                         newsticker--raw-url-list-defaults))
 581   :set 'newsticker--set-customvar
 582   :group 'newsticker-feed)
 583
 584 (defcustom newsticker-url-list nil
 585   "The news feeds which you like to watch.
 586
 587 This alist will be used in addition to selection made customizing
 588 `newsticker-url-list-defaults'.
 589
 590 This is an alist.  Each element consists of two items: a LABEL and a URL,
 591 optionally followed by a START-TIME, INTERVAL specifier and WGET-ARGUMENTS.
 592
 593 The LABEL gives the name of the news feed.  It can be an arbitrary string.
 594
 595 The URL gives the location of the news feed.  It must point to a valid
 596 RSS or Atom file.  The file is retrieved by calling wget, or whatever you
 597 specify as `newsticker-wget-name'.
 598
 599 The START-TIME can be either a string, or nil.  If it is a string it
 600 specifies a fixed time at which this feed shall be retrieved for the
 601 first time.  (Examples: \"11:00pm\", \"23:00\".)  If it is nil (or
 602 unspecified), this feed will be retrieved immediately after calling
 603 `newsticker-start'.
 604
 605 The INTERVAL specifies the time between retrievals for this feed.  If it
 606 is nil (or unspecified) the default interval value as set in
 607 `newsticker-retrieval-interval' is used.
 608
 609 \(newsticker.el calls `run-at-time'. The newsticker-parameters START-TIME
 610 and INTERVAL correspond to the `run-at-time'-parameters TIME and REPEAT.)
 611
 612 WGET-ARGUMENTS specifies arguments for wget (see `newsticker-wget-name')
 613 which apply for this feed only, overriding the value of
 614 `newsticker-wget-arguments'."
 615   :type '(repeat (list :tag "News feed"
 616                        (string :tag "Label")
 617                        (string :tag "URI")
 618                        (choice :tag "Start"
 619                                (const   :tag "Default" nil)
 620                                (string  :tag "Fixed Time"))
 621                        (choice :tag "Interval"
 622                                (const   :tag "Default" nil)
 623                                (const   :tag "Hourly" 3600)
 624                                (const   :tag "Daily" 86400)
 625                                (const   :tag "Weekly" 604800)
 626                                (integer :tag "Interval"))
 627                        (choice :tag "Wget Arguments"
 628                                (const  :tag "Default arguments" nil)
 629                                (repeat :tag "Special arguments" string))))
 630   :set 'newsticker--set-customvar
 631   :group 'newsticker-feed)
 632
 633 (defcustom newsticker-wget-name
 634   "wget"
 635   "Name of the program which is called to retrieve news from the web.
 636 The canonical choice is wget but you may take any other program which is
 637 able to return the contents of a news feed file on stdout."
 638   :type 'string
 639   :group 'newsticker-feed)
 640
 641 (defcustom newsticker-wget-arguments
 642   '("-q" "-O" "-")
 643   "Arguments which are passed to wget.
 644 There is probably no reason to change the default settings, unless you
 645 are living behind a firewall."
 646   :type '(repeat (string :tag "Argument"))
 647   :group 'newsticker-feed)
 648
 649 (defcustom newsticker-retrieval-interval
 650   3600
 651   "Time interval for retrieving new news items (seconds).
 652 If this value is not positive (i.e. less than or equal to 0)
 653 items are retrieved only once!
 654 Please note that some feeds, e.g. Slashdot, will ban you if you
 655 make it less than 1800 seconds (30 minutes)!"
 656   :type '(choice :tag "Interval"
 657                  (const   :tag "No automatic retrieval" 0)
 658                  (const   :tag "Hourly" 3600)
 659                  (const   :tag "Daily" 86400)
 660                  (const   :tag "Weekly" 604800)
 661                  (integer :tag "Interval"))
 662   :set 'newsticker--set-customvar
 663   :group 'newsticker-feed)
 664
 665 (defcustom newsticker-desc-comp-max
 666   100
 667   "Relevant length of headline descriptions.
 668 This value gives the maximum number of characters which will be
 669 taken into account when newsticker compares two headline
 670 descriptions."
 671   :type 'integer
 672   :group 'newsticker-feed)
 673
 674 ;; customization group behaviour
 675 (defgroup newsticker-headline-processing nil
 676   "Settings for the automatic processing of headlines."
 677   :group 'newsticker)
 678
 679 (defcustom newsticker-automatically-mark-items-as-old
 680   t
 681   "Decides whether to automatically mark items as old.
 682 If t a new item is considered as new only after its first retrieval.  As
 683 soon as it is retrieved a second time, it becomes old.  If not t all
 684 items stay new until you mark them as old.  This is done in the
 685 *newsticker* buffer."
 686   :type 'boolean
 687   :group 'newsticker-headline-processing)
 688
 689 (defcustom newsticker-automatically-mark-visited-items-as-old
 690   t
 691   "Decides whether to automatically mark visited items as old.
 692 If t an item is marked as old as soon as the associated link is
 693 visited, i.e. after pressing RET or mouse2 on the item's
 694 headline."
 695
 696   :type 'boolean
 697   :group 'newsticker-headline-processing)
 698
 699 (defcustom newsticker-keep-obsolete-items
 700   t
 701   "Decides whether to keep unread items which have been removed from feed.
 702 If t a new item, which has been removed from the feed, is kept in
 703 the cache until it is marked as read."
 704   :type 'boolean
 705   :group 'newsticker-headline-processing)
 706
 707 (defcustom newsticker-obsolete-item-max-age
 708   (* 60 60 24)
 709   "Maximal age of obsolete items, in seconds.
 710 Obsolete items which are older than this value will be silently
 711 deleted at the next retrieval."
 712   :type 'integer
 713   :group 'newsticker-headline-processing)
 714
 715 (defcustom newsticker-auto-mark-filter-list
 716   nil
 717   "A list of filters for automatically marking headlines.
 718
 719 This is an alist of the form (FEED-NAME PATTERN-LIST).  I.e. each
 720 element consists of a FEED-NAME a PATTERN-LIST.  Each element of
 721 the pattern-list has the form (AGE TITLE-OR-DESCRIPTION REGEXP).
 722 AGE must be one of the symbols 'old or 'immortal.
 723 TITLE-OR-DESCRIPTION must be on of the symbols 'title,
 724 'description, or 'all.  REGEXP is a regular expression, i.e. a
 725 string.
 726
 727 This filter is checked after a new headline has been retrieved.
 728 If FEED-NAME matches the name of the corresponding news feed, the
 729 pattern-list is checked: The new headline will be marked as AGE
 730 if REGEXP matches the headline's TITLE-OR-DESCRIPTION.
 731
 732 If, for example, `newsticker-auto-mark-filter-list' looks like
 733  \((slashdot ('old 'title \"^Forget me!$\") ('immortal 'title \"Read me\")
 734   \('immortal 'all \"important\"))))
 735
 736 then all articles from slashdot are marked as old if they have
 737 the title \"Forget me!\".  All articles with a title containing
 738 the string \"Read me\" are marked as immortal.  All articles which
 739 contain the string \"important\" in their title or their
 740 description are marked as immortal."
 741   :type '(repeat (list :tag "Auto mark filter"
 742                        (string :tag "Feed name")
 743                        (repeat
 744                         (list :tag "Filter element"
 745                               (choice
 746                                :tag "Auto-assigned age"
 747                                (const :tag "Old" old)
 748                                (const :tag "Immortal" immortal))
 749                               (choice
 750                                :tag "Title/Description"
 751                                (const :tag "Title" title)
 752                                (const :tag "Description" description)
 753                                (const :tag "All" all))
 754                               (string :tag "Regexp")))))
 755   :group 'newsticker-headline-processing)
 756
 757 ;; customization group layout
 758 (defgroup newsticker-layout nil
 759   "Settings for layout of the feed reader."
 760   :group 'newsticker)
 761
 762 (defcustom newsticker-sort-method
 763   'sort-by-original-order
 764   "Sort method for news items.
 765 The following sort methods are available:
 766 * `sort-by-original-order' keeps the order in which the items
 767   appear in the headline file (please note that for immortal items,
 768   which have been removed from the news feed, there is no original
 769   order),
 770 * `sort-by-time' looks at the time at which an item has been seen
 771   the first time.  The most recent item is put at top,
 772 * `sort-by-title' will put the items in an alphabetical order."
 773   :type '(choice
 774           (const :tag "Keep original order" sort-by-original-order)
 775           (const :tag "Sort by time"        sort-by-time)
 776           (const :tag "Sort by title"       sort-by-title))
 777   :set 'newsticker--set-customvar
 778   :group 'newsticker-layout)
 779
 780 (defcustom newsticker-hide-old-items-in-newsticker-buffer
 781   nil
 782   "Decides whether to automatically hide old items in the *newsticker* buffer.
 783 If set to t old items will be completely folded and only new
 784 items will show up in the *newsticker* buffer.  Otherwise old as
 785 well as new items will be visible."
 786   :type 'boolean
 787   :set 'newsticker--set-customvar
 788   :group 'newsticker-layout)
 789
 790 (defcustom newsticker-show-descriptions-of-new-items
 791   t
 792   "Whether to automatically show descriptions of new items in *newsticker*.
 793 If set to t old items will be folded and new items will be
 794 unfolded.  Otherwise old as well as new items will be folded."
 795   :type 'boolean
 796   :set 'newsticker--set-customvar
 797   :group 'newsticker-layout)
 798
 799 (defcustom newsticker-heading-format
 800   "%l
 801 %t %d %s"
 802   "Format string for feed headings.
 803 The following printf-like specifiers can be used:
 804 %d  The date the feed was retrieved.  See `newsticker-date-format'.
 805 %l  The logo (image) of the feed.  Most news feeds provide a small
 806     image as logo.  Newsticker can display them, if Emacs can --
 807     see `image-types' for a list of supported image types.
 808 %L  The logo (image) of the feed.  If the logo is not available
 809     the title of the feed is used.
 810 %s  The statistical data of the feed.  See `newsticker-statistics-format'.
 811 %t  The title of the feed, i.e. its name."
 812   :type 'string
 813   :set 'newsticker--set-customvar
 814   :group 'newsticker-layout)
 815
 816 (defcustom newsticker-item-format
 817   "%t %d"
 818   "Format string for news item headlines.
 819 The following printf-like specifiers can be used:
 820 %d  The date the item was (first) retrieved.  See `newsticker-date-format'.
 821 %l  The logo (image) of the feed.  Most news feeds provide a small
 822     image as logo.  Newsticker can display them, if Emacs can --
 823     see `image-types' for a list of supported image types.
 824 %L  The logo (image) of the feed.  If the logo is not available
 825     the title of the feed is used.
 826 %t  The title of the item."
 827   :type 'string
 828   :set 'newsticker--set-customvar
 829   :group 'newsticker-layout)
 830
 831 (defcustom newsticker-desc-format
 832   "%d %c"
 833   "Format string for news descriptions (contents).
 834 The following printf-like specifiers can be used:
 835 %c  The contents (description) of the item.
 836 %d  The date the item was (first) retrieved.  See
 837     `newsticker-date-format'."
 838   :type 'string
 839   :set 'newsticker--set-customvar
 840   :group 'newsticker-layout)
 841
 842 (defcustom newsticker-date-format
 843   "(%A, %H:%M)"
 844   "Format for the date part in item and feed lines.
 845 See `format-time-string' for a list of valid specifiers."
 846   :type 'string
 847   :set 'newsticker--set-customvar
 848   :group 'newsticker-layout)
 849
 850 (defcustom newsticker-statistics-format
 851   "[%n + %i + %o + %O = %a]"
 852   "Format for the statistics part in feed lines.
 853 The following printf-like specifiers can be used:
 854 %a  The number of all items in the feed.
 855 %i  The number of immortal items in the feed.
 856 %n  The number of new items in the feed.
 857 %o  The number of old items in the feed.
 858 %O  The number of obsolete items in the feed."
 859   :type 'string
 860   :set 'newsticker--set-customvar
 861   :group 'newsticker-layout)
 862
 863 (defcustom newsticker-show-all-news-elements
 864   nil
 865   "Show all news elements."
 866   :type 'boolean
 867   ;;:set 'newsticker--set-customvar
 868   :group 'newsticker-layout)
 869
 870 ;; image related things
 871 (defcustom newsticker-enable-logo-manipulations
 872   t
 873   "If non-nil newsticker manipulates logo images.
 874 This enables the following image properties: heuristic mask for all
 875 logos, and laplace-conversion for images without new items."
 876   :type 'boolean
 877   :group 'newsticker-layout)
 878
 879
 880 ;; rendering
 881 (defcustom newsticker-justification
 882   'left
 883   "How to fill item descriptions.
 884 If non-nil newsticker calls `fill-region' to wrap long lines in
 885 item descriptions.  However, if an item description contains HTML
 886 text and `newsticker-html-renderer' is non-nil, filling is not
 887 done."
 888   :type '(choice :tag "Justification"
 889                  (const :tag "No filling" nil)
 890                  (const :tag "Left"       left)
 891                  (const :tag "Right"      right)
 892                  (const :tag "Center"     center)
 893                  (const :tag "Full"       full))
 894   :set 'newsticker--set-customvar
 895   :group 'newsticker-layout)
 896
 897 (defcustom newsticker-use-full-width
 898   t
 899   "Decides whether to use the full window width when filling.
 900 If non-nil newsticker sets `fill-column' so that the whole
 901 window is used when filling.  See also `newsticker-justification'."
 902   :type 'boolean
 903   :set 'newsticker--set-customvar
 904   :group 'newsticker-layout)
 905
 906 (defcustom newsticker-html-renderer
 907   nil
 908   "Function for rendering HTML contents.
 909 If non-nil, newsticker.el will call this function whenever it finds
 910 HTML-like tags in item descriptions.  Possible functions are, for
 911 example, `w3m-region', `w3-region', and (if you have htmlr.el installed)
 912 `newsticker-htmlr-render'.
 913
 914 In order to make sure that the HTML renderer is loaded when you
 915 run newsticker, you should add one of the following statements to
 916 your .emacs.  If you use w3m,
 917
 918   (autoload 'w3m-region \"w3m\"
 919     \"Render region in current buffer and replace with result.\" t)
 920
 921 or, if you use w3,
 922
 923   (require 'w3-auto)
 924
 925 or, if you use htmlr
 926
 927   (require 'htmlr)"
 928   :type '(choice :tag "Function"
 929                  (const :tag "None" nil)
 930                  (const :tag "w3" w3-region)
 931                  (const :tag "w3m" w3m-region)
 932                  (const :tag "htmlr" newsticker-htmlr-render))
 933   :set 'newsticker--set-customvar
 934   :group 'newsticker-layout)
 935
 936
 937 ;; faces
 938 (defgroup newsticker-faces nil
 939   "Settings for the faces of the feed reader."
 940   :group 'newsticker-layout)
 941
 942 (defface newsticker-feed-face
 943   '((((class color) (background dark))
 944      (:family "helvetica" :bold t :height 1.2 :foreground "misty rose"))
 945     (((class color) (background light))
 946      (:family "helvetica" :bold t :height 1.2 :foreground "black")))
 947   "Face for news feeds."
 948   :group 'newsticker-faces)
 949
 950 (defface newsticker-new-item-face
 951   '((((class color) (background dark))
 952      (:family "helvetica" :bold t))
 953     (((class color) (background light))
 954      (:family "helvetica" :bold t)))
 955   "Face for new news items."
 956   :group 'newsticker-faces)
 957
 958 (defface newsticker-old-item-face
 959   '((((class color) (background dark))
 960      (:family "helvetica" :bold t :foreground "orange3"))
 961     (((class color) (background light))
 962      (:family "helvetica" :bold t :foreground "red4")))
 963   "Face for old news items."
 964   :group 'newsticker-faces)
 965
 966 (defface newsticker-immortal-item-face
 967   '((((class color) (background dark))
 968      (:family "helvetica" :bold t :italic t :foreground "orange"))
 969     (((class color) (background light))
 970      (:family "helvetica" :bold t :italic t :foreground "blue")))
 971   "Face for immortal news items."
 972   :group 'newsticker-faces)
 973
 974 (defface newsticker-obsolete-item-face
 975   '((((class color) (background dark))
 976      (:family "helvetica" :bold t :strike-through t))
 977     (((class color) (background light))
 978      (:family "helvetica" :bold t :strike-through t)))
 979   "Face for old news items."
 980   :group 'newsticker-faces)
 981
 982 (defface newsticker-date-face
 983   '((((class color) (background dark))
 984      (:family "helvetica" :italic t :height 0.8))
 985     (((class color) (background light))
 986      (:family "helvetica" :italic t :height 0.8)))
 987   "Face for newsticker dates."
 988   :group 'newsticker-faces)
 989
 990 (defface newsticker-statistics-face
 991   '((((class color) (background dark))
 992      (:family "helvetica" :italic t :height 0.8))
 993     (((class color) (background light))
 994      (:family "helvetica" :italic t :height 0.8)))
 995   "Face for newsticker dates."
 996   :group 'newsticker-faces)
 997
 998 (defface newsticker-enclosure-face
 999   '((((class color) (background dark))
1000      (:bold t :background "orange"))
1001     (((class color) (background light))
1002      (:bold t :background "orange")))
1003   "Face for enclosed elements."
1004   :group 'newsticker-faces)
1005
1006 (defface newsticker-extra-face
1007   '((((class color) (background dark))
1008      (:italic t :foreground "gray50" :height 0.8))
1009     (((class color) (background light))
1010      (:italic t :foreground "gray50" :height 0.8)))
1011   "Face for newsticker dates."
1012   :group 'newsticker-faces)
1013
1014 ;; (defface newsticker-default-face
1015 ;;   '((((class color) (background dark))
1016 ;;      (:inherit default))
1017 ;;     (((class color) (background light))
1018 ;;      (:inherit default)))
1019 ;;   "Face for the description of news items."
1020 ;;   ;;:set 'newsticker--set-customvar
1021 ;;   :group 'newsticker-faces)
1022
1023
1024 ;; customization group ticker
1025 (defgroup newsticker-ticker nil
1026   "Settings for the headline ticker."
1027   :group 'newsticker)
1028
1029 (defcustom newsticker-display-interval
1030   0.3
1031   "Time interval for displaying news items in the echo area (seconds).
1032 If equal or less than 0 no messages are shown in the echo area.  For
1033 smooth display (see `newsticker-scroll-smoothly') a value of 0.3 seems
1034 reasonable.  For non-smooth display a value of 10 is a good starting
1035 point."
1036   :type 'number
1037   :set 'newsticker--set-customvar
1038   :group 'newsticker-ticker)
1039
1040 (defcustom newsticker-scroll-smoothly
1041   t
1042   "Decides whether to flash or scroll news items.
1043 If t the news headlines are scrolled (more-or-less) smoothly in the echo
1044 area.  If nil one headline after another is displayed in the echo area.
1045 The variable `newsticker-display-interval' determines how fast this
1046 display moves/changes and whether headlines are shown in the echo area
1047 at all.  If you change `newsticker-scroll-smoothly' you should also change
1048 `newsticker-display-interval'."
1049   :type 'boolean
1050   :group 'newsticker-ticker)
1051
1052 (defcustom newsticker-hide-immortal-items-in-echo-area
1053   t
1054   "Decides whether to show immortal/non-expiring news items in the ticker.
1055 If t the echo area will not show immortal items.  See also
1056 `newsticker-hide-old-items-in-echo-area'."
1057   :type 'boolean
1058   :set 'newsticker--set-customvar
1059   :group 'newsticker-ticker)
1060
1061 (defcustom newsticker-hide-old-items-in-echo-area
1062   t
1063   "Decides whether to show only the newest news items in the ticker.
1064 If t the echo area will show only new items, i.e. only items which have
1065 been added between the last two retrievals."
1066   :type 'boolean
1067   :set 'newsticker--set-customvar
1068   :group 'newsticker-ticker)
1069
1070 (defcustom newsticker-hide-obsolete-items-in-echo-area
1071   t
1072   "Decides whether to show obsolete items items in the ticker.
1073 If t the echo area will not show obsolete items.  See also
1074 `newsticker-hide-old-items-in-echo-area'."
1075   :type 'boolean
1076   :set 'newsticker--set-customvar
1077   :group 'newsticker-ticker)
1078
1079 (defgroup newsticker-hooks nil
1080   "Settings for newsticker hooks."
1081   :group 'newsticker)
1082
1083 (defcustom newsticker-start-hook
1084   nil
1085   "Hook run when starting newsticker.
1086 This hook is run at the very end of `newsticker-start'."
1087   :options '(newsticker-start-ticker)
1088   :type 'hook
1089   :group 'newsticker-hooks)
1090
1091 (defcustom newsticker-stop-hook
1092   nil
1093   "Hook run when stopping newsticker.
1094 This hook is run at the very end of `newsticker-stop'."
1095   :options nil
1096   :type 'hook
1097   :group 'newsticker-hooks)
1098
1099 (defcustom newsticker-new-item-functions
1100   nil
1101   "List of functions run after a new headline has been retrieved.
1102 Each function is called with the following three arguments:
1103 FEED  the name of the corresponding news feed,
1104 TITLE the title of the headline,
1105 DESC  the decoded description of the headline.
1106
1107 See `newsticker-download-images', and
1108 `newsticker-download-enclosures' for sample functions.
1109
1110 Please note that these functions are called only once for a
1111 headline after it has been retrieved for the first time."
1112   :type 'hook
1113   :options '(newsticker-download-images
1114              newsticker-download-enclosures)
1115   :group 'newsticker-hooks)
1116
1117 (defcustom newsticker-select-item-hook
1118   'newsticker--buffer-make-item-completely-visible
1119   "List of functions run after a headline has been selected.
1120 Each function is called after one of `newsticker-next-item',
1121 `newsticker-next-new-item', `newsticker-previous-item',
1122 `newsticker-previous-new-item' has been called.
1123
1124 The default value 'newsticker--buffer-make-item-completely-visible
1125 assures that the current item is always completely visible."
1126   :type 'hook
1127   :options '(newsticker--buffer-make-item-completely-visible)
1128   :group 'newsticker-hooks)
1129
1130 (defcustom newsticker-select-feed-hook
1131   'newsticker--buffer-make-item-completely-visible
1132   "List of functions run after a feed has been selected.
1133 Each function is called after one of `newsticker-next-feed', and
1134 `newsticker-previous-feed' has been called.
1135
1136 The default value 'newsticker--buffer-make-item-completely-visible
1137 assures that the current feed is completely visible."
1138   :type 'hook
1139   :options '(newsticker--buffer-make-item-completely-visible)
1140   :group 'newsticker-hooks)
1141
1142 (defcustom newsticker-buffer-change-hook
1143   'newsticker-w3m-show-inline-images
1144   "List of functions run after the newsticker buffer has been updated.
1145 Each function is called after `newsticker-buffer-update' has been called.
1146
1147 The default value '`newsticker-w3m-show-inline-images' loads inline
1148 images."
1149   :type 'hook
1150   :group 'newsticker-hooks)
1151
1152 (defcustom newsticker-narrow-hook
1153   'newsticker-w3m-show-inline-images
1154   "List of functions run after narrowing in newsticker buffer has changed.
1155 Each function is called after
1156 `newsticker-toggle-auto-narrow-to-feed' or
1157 `newsticker-toggle-auto-narrow-to-item' has been called.
1158
1159 The default value '`newsticker-w3m-show-inline-images' loads inline
1160 images."
1161   :type 'hook
1162   :group 'newsticker-hooks)
1163
1164 (defgroup newsticker-miscellaneous nil
1165   "Miscellaneous newsticker settings."
1166   :group 'newsticker)
1167
1168 (defcustom newsticker-cache-filename
1169   "~/.newsticker-cache"
1170   "Name of the newsticker cache file."
1171   :type 'string
1172   :group 'newsticker-miscellaneous)
1173
1174 (defcustom newsticker-imagecache-dirname
1175   "~/.newsticker-images"
1176   "Name of the directory where newsticker stores cached images."
1177   :type 'string
1178   :group 'newsticker-miscellaneous)
1179
1180 ;; debugging
1181 (defcustom newsticker-debug
1182   nil
1183   "Enables some features needed for debugging newsticker.el.
1184
1185 If set to t newsticker.el will print lots of debugging messages, and the
1186 buffers *newsticker-wget-<feed>* will not be closed."
1187   :type 'boolean
1188   ;;:set 'newsticker--set-customvar
1189   :group 'newsticker-miscellaneous)
1190
1191 ;; ======================================================================
1192 ;;; Compatibility section, XEmacs, Emacs
1193 ;; ======================================================================
1194 (unless (fboundp 'time-add)
1195   (require 'time-date);;FIXME
1196   (defun time-add (t1 t2)
1197     (seconds-to-time (+ (time-to-seconds t1) (time-to-seconds t2)))))
1198
1199 (unless (fboundp 'match-string-no-properties)
1200   (defalias 'match-string-no-properties 'match-string))
1201
1202 (when (featurep 'xemacs)
1203   (unless (fboundp 'replace-regexp-in-string)
1204     (defun replace-regexp-in-string (re rp st)
1205       (save-match-data ;; apparently XEmacs needs save-match-data
1206         (replace-in-string st re rp)))))
1207
1208 ;; copied from subr.el
1209 (unless (fboundp 'add-to-invisibility-spec)
1210   (defun add-to-invisibility-spec (arg)
1211     "Add elements to `buffer-invisibility-spec'.
1212 See documentation for `buffer-invisibility-spec' for the kind of elements
1213 that can be added."
1214     (if (eq buffer-invisibility-spec t)
1215         (setq buffer-invisibility-spec (list t)))
1216     (setq buffer-invisibility-spec
1217           (cons arg buffer-invisibility-spec))))
1218
1219 ;; copied from subr.el
1220 (unless (fboundp 'remove-from-invisibility-spec)
1221   (defun remove-from-invisibility-spec (arg)
1222     "Remove elements from `buffer-invisibility-spec'."
1223     (if (consp buffer-invisibility-spec)
1224         (setq buffer-invisibility-spec
1225               (delete arg buffer-invisibility-spec)))))
1226
1227 ;; ======================================================================
1228 ;;; Internal variables
1229 ;; ======================================================================
1230 (defvar newsticker--item-list nil
1231   "List of newsticker items.")
1232 (defvar newsticker--item-position 0
1233   "Actual position in list of newsticker items.")
1234 (defvar newsticker--prev-message "There was no previous message yet!"
1235   "Last message that the newsticker displayed.")
1236 (defvar newsticker--scrollable-text ""
1237   "The text which is scrolled smoothly in the echo area.")
1238 (defvar newsticker--buffer-uptodate-p nil
1239   "Tells whether the newsticker buffer is up to date.")
1240 (defvar newsticker--latest-update-time (current-time)
1241   "The time at which the latest news arrived.")
1242 (defvar newsticker--process-ids nil
1243   "List of PIDs of active newsticker processes.")
1244
1245 (defvar newsticker--cache nil "Cached newsticker data.
1246 This is a list of the form
1247
1248  ((label1
1249    (title description link time age index preformatted-contents
1250     preformatted-title)
1251    ...)
1252   (label2
1253    (title description link time age index preformatted-contents
1254     preformatted-title)
1255    ...)
1256   ...)
1257
1258 where LABEL is a symbol.  TITLE, DESCRIPTION, and LINK are
1259 strings.  TIME is a time value as returned by `current-time'.
1260 AGE is a symbol: 'new, 'old, 'immortal, and 'obsolete denote
1261 ordinary news items, whereas 'feed denotes an item which is not a
1262 headline but describes the feed itself.  INDEX denotes the
1263 original position of the item -- used for restoring the original
1264 order.  PREFORMATTED-CONTENTS and PREFORMATTED-TITLE hold the
1265 formatted contents of the item's description and title.  This
1266 speeds things up if HTML rendering is used, which is rather
1267 slow.")
1268
1269 (defvar newsticker--auto-narrow-to-feed nil
1270   "Automatically narrow to current news feed.
1271 If non-nil only the items of the current news feed are visible.")
1272
1273 (defvar newsticker--auto-narrow-to-item nil
1274   "Automatically narrow to current news item.
1275 If non-nil only the current headline is visible.")
1276
1277 (defconst newsticker--error-headline
1278   "[COULD NOT DOWNLOAD HEADLINES!]"
1279   "Title of error headline which will be inserted if news retrieval fails.")
1280
1281 ;; ======================================================================
1282 ;;; Toolbar
1283 ;; ======================================================================
1284 (defconst newsticker--next-item-image
1285   (if (fboundp 'create-image)
1286       (create-image "/* XPM */
1287 static char * next_xpm[] = {
1288 \"24 24 42 1\",
1289 \"      c None\",
1290 \".     c #000000\",
1291 \"+     c #7EB6DE\",
1292 \"@     c #82BBE2\",
1293 \"#     c #85BEE4\",
1294 \"$     c #88C1E7\",
1295 \"%     c #8AC3E8\",
1296 \"&     c #87C1E6\",
1297 \"*     c #8AC4E9\",
1298 \"=     c #8CC6EA\",
1299 \"-     c #8CC6EB\",
1300 \";     c #88C2E7\",
1301 \">     c #8BC5E9\",
1302 \",     c #8DC7EB\",
1303 \"'     c #87C0E6\",
1304 \")     c #8AC4E8\",
1305 \"!     c #8BC5EA\",
1306 \"~     c #8BC4E9\",
1307 \"{     c #88C1E6\",
1308 \"]     c #89C3E8\",
1309 \"^     c #86BFE5\",
1310 \"/     c #83BBE2\",
1311 \"(     c #82BBE1\",
1312 \"_     c #86C0E5\",
1313 \":     c #87C0E5\",
1314 \"<     c #83BCE2\",
1315 \"[     c #81B9E0\",
1316 \"}     c #81BAE1\",
1317 \"|     c #78B0D9\",
1318 \"1     c #7BB3DB\",
1319 \"2     c #7DB5DD\",
1320 \"3     c #7DB6DD\",
1321 \"4     c #72A9D4\",
1322 \"5     c #75ACD6\",
1323 \"6     c #76AED7\",
1324 \"7     c #77AFD8\",
1325 \"8     c #6BA1CD\",
1326 \"9     c #6EA4CF\",
1327 \"0     c #6FA6D1\",
1328 \"a     c #6298C6\",
1329 \"b     c #659BC8\",
1330 \"c     c #5C91C0\",
1331 \"                        \",
1332 \"                        \",
1333 \"       .                \",
1334 \"       ..               \",
1335 \"       .+.              \",
1336 \"       .@#.             \",
1337 \"       .#$%.            \",
1338 \"       .&*=-.           \",
1339 \"       .;>,,,.          \",
1340 \"       .;>,,,=.         \",
1341 \"       .')!==~;.        \",
1342 \"       .#{]*%;^/.       \",
1343 \"       .(#_':#<.        \",
1344 \"       .+[@</}.         \",
1345 \"       .|1232.          \",
1346 \"       .4567.           \",
1347 \"       .890.            \",
1348 \"       .ab.             \",
1349 \"       .c.              \",
1350 \"       ..               \",
1351 \"       .                \",
1352 \"                        \",
1353 \"                        \",
1354 \"                        \"};
1355 "
1356                  'xpm t)
1357    "Image for the next item button."))
1358
1359 (defconst newsticker--previous-item-image
1360   (if (fboundp 'create-image)
1361       (create-image "/* XPM */
1362 static char * previous_xpm[] = {
1363 \"24 24 39 1\",
1364 \"      c None\",
1365 \".     c #000000\",
1366 \"+     c #7BB3DB\",
1367 \"@     c #83BCE2\",
1368 \"#     c #7FB8DF\",
1369 \"$     c #89C2E7\",
1370 \"%     c #86BFE5\",
1371 \"&     c #83BBE2\",
1372 \"*     c #8CC6EA\",
1373 \"=     c #8BC4E9\",
1374 \"-     c #88C2E7\",
1375 \";     c #85BEE4\",
1376 \">     c #8DC7EB\",
1377 \",     c #89C3E8\",
1378 \"'     c #8AC4E8\",
1379 \")     c #8BC5EA\",
1380 \"!     c #88C1E6\",
1381 \"~     c #8AC4E9\",
1382 \"{     c #8AC3E8\",
1383 \"]     c #86C0E5\",
1384 \"^     c #87C0E6\",
1385 \"/     c #87C0E5\",
1386 \"(     c #82BBE2\",
1387 \"_     c #81BAE1\",
1388 \":     c #7FB7DF\",
1389 \"<     c #7DB6DD\",
1390 \"[     c #7DB5DD\",
1391 \"}     c #7CB4DC\",
1392 \"|     c #79B1DA\",
1393 \"1     c #76ADD7\",
1394 \"2     c #77AFD8\",
1395 \"3     c #73AAD4\",
1396 \"4     c #70A7D1\",
1397 \"5     c #6EA5D0\",
1398 \"6     c #6CA2CE\",
1399 \"7     c #689ECB\",
1400 \"8     c #6399C7\",
1401 \"9     c #6095C4\",
1402 \"0     c #5C90C0\",
1403 \"                        \",
1404 \"                        \",
1405 \"                .       \",
1406 \"               ..       \",
1407 \"              .+.       \",
1408 \"             .@#.       \",
1409 \"            .$%&.       \",
1410 \"           .*=-;.       \",
1411 \"          .>>*,%.       \",
1412 \"         .>>>*,%.       \",
1413 \"        .')**=-;.       \",
1414 \"       .;!,~{-%&.       \",
1415 \"        .;]^/;@#.       \",
1416 \"         .(@&_:+.       \",
1417 \"          .<[}|1.       \",
1418 \"           .2134.       \",
1419 \"            .567.       \",
1420 \"             .89.       \",
1421 \"              .0.       \",
1422 \"               ..       \",
1423 \"                .       \",
1424 \"                        \",
1425 \"                        \",
1426 \"                        \"};
1427 "
1428                  'xpm t)
1429    "Image for the previous item button."))
1430
1431 (defconst newsticker--previous-feed-image
1432   (if (fboundp 'create-image)
1433       (create-image "/* XPM */
1434 static char * prev_feed_xpm[] = {
1435 \"24 24 52 1\",
1436 \"      c None\",
1437 \".     c #000000\",
1438 \"+     c #70A7D2\",
1439 \"@     c #75ADD6\",
1440 \"#     c #71A8D3\",
1441 \"$     c #79B1DA\",
1442 \"%     c #7BB3DB\",
1443 \"&     c #7DB5DD\",
1444 \"*     c #83BBE2\",
1445 \"=     c #7EB6DE\",
1446 \"-     c #78B0D9\",
1447 \";     c #7FB7DE\",
1448 \">     c #88C2E7\",
1449 \",     c #85BEE4\",
1450 \"'     c #80B9E0\",
1451 \")     c #80B8DF\",
1452 \"!     c #8CC6EA\",
1453 \"~     c #89C3E8\",
1454 \"{     c #86BFE5\",
1455 \"]     c #81BAE1\",
1456 \"^     c #7CB4DC\",
1457 \"/     c #7FB8DF\",
1458 \"(     c #8DC7EB\",
1459 \"_     c #7BB3DC\",
1460 \":     c #7EB7DE\",
1461 \"<     c #8BC4E9\",
1462 \"[     c #8AC4E9\",
1463 \"}     c #8AC3E8\",
1464 \"|     c #87C0E6\",
1465 \"1     c #87C0E5\",
1466 \"2     c #83BCE2\",
1467 \"3     c #75ACD6\",
1468 \"4     c #7FB7DF\",
1469 \"5     c #77AED8\",
1470 \"6     c #71A8D2\",
1471 \"7     c #70A7D1\",
1472 \"8     c #76ADD7\",
1473 \"9     c #6CA2CE\",
1474 \"0     c #699FCC\",
1475 \"a     c #73AAD4\",
1476 \"b     c #6BA1CD\",
1477 \"c     c #669CC9\",
1478 \"d     c #6298C5\",
1479 \"e     c #689ECB\",
1480 \"f     c #6499C7\",
1481 \"g     c #6095C3\",
1482 \"h     c #5C91C0\",
1483 \"i     c #5E93C2\",
1484 \"j     c #5B90C0\",
1485 \"k     c #588CBC\",
1486 \"l     c #578CBC\",
1487 \"m     c #5589BA\",
1488 \"                        \",
1489 \"                        \",
1490 \"     ...          .     \",
1491 \"     .+.         ..     \",
1492 \"     .@.        .#.     \",
1493 \"     .$.       .%@.     \",
1494 \"     .&.      .*=-.     \",
1495 \"     .;.     .>,'%.     \",
1496 \"     .).    .!~{]^.     \",
1497 \"     ./.   .(!~{]_.     \",
1498 \"     .:.  .!!<>,'%.     \",
1499 \"     .&. .~[}>{*=-.     \",
1500 \"     .$.  .|1,2/%@.     \",
1501 \"     .3.   .*]4%56.     \",
1502 \"     .7.    .^$8#9.     \",
1503 \"     .0.     .a7bc.     \",
1504 \"     .d.      .efg.     \",
1505 \"     .h.       .ij.     \",
1506 \"     .k.        .l.     \",
1507 \"     .m.         ..     \",
1508 \"     ...          .     \",
1509 \"                        \",
1510 \"                        \",
1511 \"                        \"};
1512 "
1513                  'xpm t)
1514    "Image for the previous feed button."))
1515
1516 (defconst newsticker--next-feed-image
1517   (if (fboundp 'create-image)
1518       (create-image "/* XPM */
1519 static char * next_feed_xpm[] = {
1520 \"24 24 57 1\",
1521 \"      c None\",
1522 \".     c #000000\",
1523 \"+     c #6CA2CE\",
1524 \"@     c #75ADD6\",
1525 \"#     c #71A8D3\",
1526 \"$     c #79B1DA\",
1527 \"%     c #7EB7DE\",
1528 \"&     c #7DB5DD\",
1529 \"*     c #81BAE1\",
1530 \"=     c #85BEE4\",
1531 \"-     c #78B0D9\",
1532 \";     c #7FB7DE\",
1533 \">     c #83BCE3\",
1534 \",     c #87C1E6\",
1535 \"'     c #8AC4E9\",
1536 \")     c #7BB3DB\",
1537 \"!     c #80B8DF\",
1538 \"~     c #88C2E7\",
1539 \"{     c #8BC5E9\",
1540 \"]     c #8DC7EB\",
1541 \"^     c #7CB4DC\",
1542 \"/     c #7FB8DF\",
1543 \"(     c #84BDE3\",
1544 \"_     c #7BB3DC\",
1545 \":     c #83BCE2\",
1546 \"<     c #87C0E6\",
1547 \"[     c #8AC4E8\",
1548 \"}     c #8BC5EA\",
1549 \"|     c #8CC6EA\",
1550 \"1     c #88C1E6\",
1551 \"2     c #89C3E8\",
1552 \"3     c #8AC3E8\",
1553 \"4     c #7EB6DE\",
1554 \"5     c #82BBE1\",
1555 \"6     c #86C0E5\",
1556 \"7     c #87C0E5\",
1557 \"8     c #75ACD6\",
1558 \"9     c #7AB2DA\",
1559 \"0     c #81B9E0\",
1560 \"a     c #82BBE2\",
1561 \"b     c #71A8D2\",
1562 \"c     c #70A7D1\",
1563 \"d     c #74ACD6\",
1564 \"e     c #699FCC\",
1565 \"f     c #6EA5D0\",
1566 \"g     c #72A9D4\",
1567 \"h     c #669CC9\",
1568 \"i     c #6298C5\",
1569 \"j     c #679DCA\",
1570 \"k     c #6BA1CD\",
1571 \"l     c #6095C3\",
1572 \"m     c #5C91C0\",
1573 \"n     c #5F94C2\",
1574 \"o     c #5B90C0\",
1575 \"p     c #588CBC\",
1576 \"q     c #578CBC\",
1577 \"r     c #5589BA\",
1578 \"                        \",
1579 \"                        \",
1580 \"     .          ...     \",
1581 \"     ..         .+.     \",
1582 \"     .@.        .#.     \",
1583 \"     .$%.       .@.     \",
1584 \"     .&*=.      .-.     \",
1585 \"     .;>,'.     .).     \",
1586 \"     .!=~{].    .^.     \",
1587 \"     ./(~{]].   ._.     \",
1588 \"     .%:<[}||.  .).     \",
1589 \"     .&*=12'3~. .-.     \",
1590 \"     .$45=6<7.  .@.     \",
1591 \"     .8940a:.   .b.     \",
1592 \"     .cd-)&.    .+.     \",
1593 \"     .efg8.     .h.     \",
1594 \"     .ijk.      .l.     \",
1595 \"     .mn.       .o.     \",
1596 \"     .p.        .q.     \",
1597 \"     ..         .r.     \",
1598 \"     .          ...     \",
1599 \"                        \",
1600 \"                        \",
1601 \"                        \"};
1602 "
1603                  'xpm t)
1604    "Image for the next feed button."))
1605
1606 (defconst newsticker--mark-read-image
1607   (if (fboundp 'create-image)
1608       (create-image "/* XPM */
1609 static char * mark_read_xpm[] = {
1610 \"24 24 44 1\",
1611 \"      c None\",
1612 \".     c #C20000\",
1613 \"+     c #BE0000\",
1614 \"@     c #C70000\",
1615 \"#     c #CE0000\",
1616 \"$     c #C90000\",
1617 \"%     c #BD0000\",
1618 \"&     c #CB0000\",
1619 \"*     c #D10000\",
1620 \"=     c #D70000\",
1621 \"-     c #D30000\",
1622 \";     c #CD0000\",
1623 \">     c #C60000\",
1624 \",     c #D40000\",
1625 \"'     c #DA0000\",
1626 \")     c #DE0000\",
1627 \"!     c #DB0000\",
1628 \"~     c #D60000\",
1629 \"{     c #D00000\",
1630 \"]     c #DC0000\",
1631 \"^     c #E00000\",
1632 \"/     c #E40000\",
1633 \"(     c #E10000\",
1634 \"_     c #DD0000\",
1635 \":     c #D80000\",
1636 \"<     c #E50000\",
1637 \"[     c #E70000\",
1638 \"}     c #E60000\",
1639 \"|     c #E20000\",
1640 \"1     c #E90000\",
1641 \"2     c #E80000\",
1642 \"3     c #E30000\",
1643 \"4     c #DF0000\",
1644 \"5     c #D90000\",
1645 \"6     c #CC0000\",
1646 \"7     c #C10000\",
1647 \"8     c #C30000\",
1648 \"9     c #BF0000\",
1649 \"0     c #B90000\",
1650 \"a     c #BC0000\",
1651 \"b     c #BB0000\",
1652 \"c     c #B80000\",
1653 \"d     c #B50000\",
1654 \"e     c #B70000\",
1655 \"                        \",
1656 \"                        \",
1657 \"                        \",
1658 \"    .              +    \",
1659 \"   +@#            $.%   \",
1660 \"    &*=          -;>    \",
1661 \"     ,')        !~{     \",
1662 \"      ]^/      (_:      \",
1663 \"       (<[    }|)       \",
1664 \"        <[1  2<|        \",
1665 \"         }222[<         \",
1666 \"          }}}<          \",
1667 \"          333|          \",
1668 \"         _4^4)]         \",
1669 \"        ~:'  5=-        \",
1670 \"       6{-    *#$       \",
1671 \"      7>$      @89      \",
1672 \"     0a+        %bc     \",
1673 \"    ddc          edd    \",
1674 \"   ddd            ddd   \",
1675 \"    d              d    \",
1676 \"                        \",
1677 \"                        \",
1678 \"                        \"};
1679 "
1680                  'xpm t)
1681    "Image for the next feed button."))
1682
1683 (defconst newsticker--mark-immortal-image
1684   (if (fboundp 'create-image)
1685       (create-image "/* XPM */
1686 static char * mark_immortal_xpm[] = {
1687 \"24 24 93 2\",
1688 \"      c None\",
1689 \".     c #171717\",
1690 \"+     c #030303\",
1691 \"@     c #000000\",
1692 \"#     c #181818\",
1693 \"$     c #090909\",
1694 \"%     c #FFC960\",
1695 \"&     c #FFCB61\",
1696 \"*     c #FFCB62\",
1697 \"=     c #FFC961\",
1698 \"-     c #FFC75F\",
1699 \";     c #FFC65E\",
1700 \">     c #FFCA61\",
1701 \",     c #FFCD63\",
1702 \"'     c #FFCF65\",
1703 \")     c #FFD065\",
1704 \"!     c #FFCE64\",
1705 \"~     c #FFC35C\",
1706 \"{     c #FFC45D\",
1707 \"]     c #FFD166\",
1708 \"^     c #FFD267\",
1709 \"/     c #FFD368\",
1710 \"(     c #FFD167\",
1711 \"_     c #FFC05A\",
1712 \":     c #010101\",
1713 \"<     c #040404\",
1714 \"[     c #FFCC62\",
1715 \"}     c #FFD569\",
1716 \"|     c #FFD56A\",
1717 \"1     c #FFC860\",
1718 \"2     c #FFC25B\",
1719 \"3     c #FFBB56\",
1720 \"4     c #020202\",
1721 \"5     c #060606\",
1722 \"6     c #FFC15B\",
1723 \"7     c #FFC85F\",
1724 \"8     c #FFD469\",
1725 \"9     c #FFD66A\",
1726 \"0     c #FFBC57\",
1727 \"a     c #1B1B1B\",
1728 \"b     c #070707\",
1729 \"c     c #FFBA55\",
1730 \"d     c #FFB451\",
1731 \"e     c #FFB954\",
1732 \"f     c #FFB350\",
1733 \"g     c #FFB652\",
1734 \"h     c #FFBE58\",
1735 \"i     c #FFCD64\",
1736 \"j     c #FFD066\",
1737 \"k     c #FFC059\",
1738 \"l     c #FFB14E\",
1739 \"m     c #0B0B0B\",
1740 \"n     c #FFBB55\",
1741 \"o     c #FFC15A\",
1742 \"p     c #FFB552\",
1743 \"q     c #FFAD4B\",
1744 \"r     c #080808\",
1745 \"s     c #FFAF4C\",
1746 \"t     c #FFB853\",
1747 \"u     c #FFA948\",
1748 \"v     c #050505\",
1749 \"w     c #FFB04E\",
1750 \"x     c #FFB753\",
1751 \"y     c #FFBC56\",
1752 \"z     c #FFC55D\",
1753 \"A     c #FFC55E\",
1754 \"B     c #FFC45C\",
1755 \"C     c #FFBD57\",
1756 \"D     c #FFB854\",
1757 \"E     c #FFB34F\",
1758 \"F     c #FFAB4A\",
1759 \"G     c #FFA545\",
1760 \"H     c #FFAA49\",
1761 \"I     c #FFB04D\",
1762 \"J     c #FFB551\",
1763 \"K     c #FFBF58\",
1764 \"L     c #FFB24F\",
1765 \"M     c #FFAC4A\",
1766 \"N     c #FFA646\",
1767 \"O     c #FFA344\",
1768 \"P     c #FFA848\",
1769 \"Q     c #FFB14F\",
1770 \"R     c #FFAF4D\",
1771 \"S     c #FFA546\",
1772 \"T     c #FFA243\",
1773 \"U     c #FFA445\",
1774 \"V     c #FFAE4C\",
1775 \"W     c #FFA444\",
1776 \"X     c #FFA142\",
1777 \"Y     c #FF9F41\",
1778 \"Z     c #0A0A0A\",
1779 \"`     c #FF9E40\",
1780 \" .    c #FF9F40\",
1781 \"                                                \",
1782 \"                                                \",
1783 \"                                                \",
1784 \"                  . + @ @ + #                   \",
1785 \"              $ @ % & * * = - + +               \",
1786 \"            @ ; > , ' ) ' ! * - ~ @             \",
1787 \"          @ { > ! ] ^ / / ( ' * ; _ :           \",
1788 \"        < _ ; [ ) / } | } / ] , 1 2 3 4         \",
1789 \"        5 6 7 , ] 8 9 9 9 } ^ ! = ~ 0 a         \",
1790 \"      b c 6 - , ] 8 9 9 9 } ^ ! % ~ 0 d 5       \",
1791 \"      : e _ ; * ) / 8 } } / ] , 1 2 3 f 5       \",
1792 \"      : g h { = i j ^ / ^ ] ! * ; k e l m       \",
1793 \"      : f n o ; > , ' ) ' ! * - 2 0 p q r       \",
1794 \"      : s g 0 6 ; % > * * = - ~ h t l u r       \",
1795 \"      v u w x y k ~ z A z B o C D E F G b       \",
1796 \"        5 H I J e 0 h K h C c x L M N .         \",
1797 \"        4 O P q Q d g x g J L R H S T <         \",
1798 \"          @ T U P F q V q M H N W X +           \",
1799 \"            @ Y T O W G G W O X Y @             \",
1800 \"              4 Z ` Y Y Y  .` 4 4               \",
1801 \"                  5 : : @ @ Z                   \",
1802 \"                                                \",
1803 \"                                                \",
1804 \"                                                \"};
1805 "
1806                  'xpm t)
1807    "Image for the next feed button."))
1808
1809
1810 (defconst newsticker--narrow-image
1811   (if (fboundp 'create-image)
1812       (create-image "/* XPM */
1813 static char * narrow_xpm[] = {
1814 \"24 24 48 1\",
1815 \"      c None\",
1816 \".     c #000000\",
1817 \"+     c #969696\",
1818 \"@     c #9E9E9E\",
1819 \"#     c #A4A4A4\",
1820 \"$     c #AAAAAA\",
1821 \"%     c #AEAEAE\",
1822 \"&     c #B1B1B1\",
1823 \"*     c #B3B3B3\",
1824 \"=     c #B4B4B4\",
1825 \"-     c #B2B2B2\",
1826 \";     c #AFAFAF\",
1827 \">     c #ABABAB\",
1828 \",     c #A6A6A6\",
1829 \"'     c #A0A0A0\",
1830 \")     c #989898\",
1831 \"!     c #909090\",
1832 \"~     c #73AAD4\",
1833 \"{     c #7AB2DA\",
1834 \"]     c #7FB8DF\",
1835 \"^     c #84BDE3\",
1836 \"/     c #88C2E7\",
1837 \"(     c #8BC5E9\",
1838 \"_     c #8DC7EB\",
1839 \":     c #8CC6EA\",
1840 \"<     c #89C3E8\",
1841 \"[     c #86BFE5\",
1842 \"}     c #81BAE1\",
1843 \"|     c #7BB3DC\",
1844 \"1     c #75ACD6\",
1845 \"2     c #6DA4CF\",
1846 \"3     c #979797\",
1847 \"4     c #A3A3A3\",
1848 \"5     c #A8A8A8\",
1849 \"6     c #ADADAD\",
1850 \"7     c #ACACAC\",
1851 \"8     c #A9A9A9\",
1852 \"9     c #A5A5A5\",
1853 \"0     c #9A9A9A\",
1854 \"a     c #929292\",
1855 \"b     c #8C8C8C\",
1856 \"c     c #808080\",
1857 \"d     c #818181\",
1858 \"e     c #838383\",
1859 \"f     c #848484\",
1860 \"g     c #858585\",
1861 \"h     c #868686\",
1862 \"i     c #828282\",
1863 \"                        \",
1864 \"                        \",
1865 \"                        \",
1866 \"   ..................   \",
1867 \"   .+@#$%&*=*-;>,')!.   \",
1868 \"   ..................   \",
1869 \"                        \",
1870 \"                        \",
1871 \"   ..................   \",
1872 \"   .~{]^/(___:<[}|12.   \",
1873 \"   ..................   \",
1874 \"                        \",
1875 \"                        \",
1876 \"   ..................   \",
1877 \"   .!3@45>666789'0ab.   \",
1878 \"   ..................   \",
1879 \"                        \",
1880 \"                        \",
1881 \"   ..................   \",
1882 \"   .cccdefghhgficccc.   \",
1883 \"   ..................   \",
1884 \"                        \",
1885 \"                        \",
1886 \"                        \"};
1887 "
1888                  'xpm t)
1889    "Image for the next feed button."))
1890
1891 (defconst newsticker--get-all-image
1892   (if (fboundp 'create-image)
1893       (create-image "/* XPM */
1894 static char * get_all_xpm[] = {
1895 \"24 24 70 1\",
1896 \"      c None\",
1897 \".     c #000000\",
1898 \"+     c #F3DA00\",
1899 \"@     c #F5DF00\",
1900 \"#     c #F7E300\",
1901 \"$     c #F9E700\",
1902 \"%     c #FAEA00\",
1903 \"&     c #FBEC00\",
1904 \"*     c #FBED00\",
1905 \"=     c #FCEE00\",
1906 \"-     c #FAEB00\",
1907 \";     c #F9E800\",
1908 \">     c #F8E500\",
1909 \",     c #F6E000\",
1910 \"'     c #F4DB00\",
1911 \")     c #F1D500\",
1912 \"!     c #EFD000\",
1913 \"~     c #B7CA00\",
1914 \"{     c #BFD100\",
1915 \"]     c #C5D700\",
1916 \"^     c #CBDB00\",
1917 \"/     c #CFDF00\",
1918 \"(     c #D2E200\",
1919 \"_     c #D4E400\",
1920 \":     c #D3E300\",
1921 \"<     c #D0E000\",
1922 \"[     c #CCDD00\",
1923 \"}     c #C7D800\",
1924 \"|     c #C1D300\",
1925 \"1     c #BACC00\",
1926 \"2     c #B1C500\",
1927 \"3     c #A8BC00\",
1928 \"4     c #20A900\",
1929 \"5     c #22AF00\",
1930 \"6     c #24B500\",
1931 \"7     c #26B900\",
1932 \"8     c #27BC00\",
1933 \"9     c #27BE00\",
1934 \"0     c #28BF00\",
1935 \"a     c #27BD00\",
1936 \"b     c #26BA00\",
1937 \"c     c #25B600\",
1938 \"d     c #23B100\",
1939 \"e     c #21AB00\",
1940 \"f     c #1FA400\",
1941 \"g     c #1C9B00\",
1942 \"h     c #21AA00\",
1943 \"i     c #24B300\",
1944 \"j     c #25B800\",
1945 \"k     c #25B700\",
1946 \"l     c #24B400\",
1947 \"m     c #23B000\",
1948 \"n     c #1FA500\",
1949 \"o     c #1D9E00\",
1950 \"p     c #20A800\",
1951 \"q     c #21AC00\",
1952 \"r     c #23B200\",
1953 \"s     c #22AD00\",
1954 \"t     c #1D9F00\",
1955 \"u     c #20A700\",
1956 \"v     c #1EA100\",
1957 \"w     c #1C9C00\",
1958 \"x     c #1DA000\",
1959 \"y     c #1B9800\",
1960 \"z     c #1A9600\",
1961 \"A     c #1A9700\",
1962 \"B     c #1A9500\",
1963 \"C     c #199200\",
1964 \"D     c #189100\",
1965 \"E     c #178C00\",
1966 \"                        \",
1967 \"                        \",
1968 \"                        \",
1969 \"                        \",
1970 \"   ...................  \",
1971 \"   .+@#$%&*=*&-;>,')!.  \",
1972 \"   ...................  \",
1973 \"                        \",
1974 \"   ...................  \",
1975 \"   .~{]^/(___:<[}|123.  \",
1976 \"   ...................  \",
1977 \"                        \",
1978 \"   ...................  \",
1979 \"    .45678909abcdefg.   \",
1980 \"     .h5icj7jklmeno.    \",
1981 \"      .pq5drrmshft.     \",
1982 \"       .fu4h4pnvw.      \",
1983 \"        .oxvxtwy.       \",
1984 \"         .zAAzB.        \",
1985 \"          .CCD.         \",
1986 \"           .E.          \",
1987 \"            .           \",
1988 \"                        \",
1989 \"                        \"};
1990 "
1991                  'xpm t)
1992    "Image for the next feed button."))
1993
1994
1995 (defconst newsticker--update-image
1996   (if (fboundp 'create-image)
1997       (create-image "/* XPM */
1998 static char * update_xpm[] = {
1999 \"24 24 37 1\",
2000 \"      c None\",
2001 \".     c #076D00\",
2002 \"+     c #0A8600\",
2003 \"@     c #0A8800\",
2004 \"#     c #098400\",
2005 \"$     c #087200\",
2006 \"%     c #087900\",
2007 \"&     c #098500\",
2008 \"*     c #098100\",
2009 \"=     c #087600\",
2010 \"-     c #097E00\",
2011 \";     c #097F00\",
2012 \">     c #0A8700\",
2013 \",     c #0A8C00\",
2014 \"'     c #097C00\",
2015 \")     c #098300\",
2016 \"!     c #0A8900\",
2017 \"~     c #0A8E00\",
2018 \"{     c #0B9200\",
2019 \"]     c #087700\",
2020 \"^     c #076E00\",
2021 \"/     c #076C00\",
2022 \"(     c #076B00\",
2023 \"_     c #076A00\",
2024 \":     c #076900\",
2025 \"<     c #076800\",
2026 \"[     c #066700\",
2027 \"}     c #066500\",
2028 \"|     c #066400\",
2029 \"1     c #066300\",
2030 \"2     c #066600\",
2031 \"3     c #066200\",
2032 \"4     c #076700\",
2033 \"5     c #065E00\",
2034 \"6     c #066100\",
2035 \"7     c #065F00\",
2036 \"8     c #066000\",
2037 \"                        \",
2038 \"                        \",
2039 \"                        \",
2040 \"    .    +@@@+#         \",
2041 \"    $% &@      +*       \",
2042 \"    =-#          ;      \",
2043 \"    %*>,          '     \",
2044 \"    ')!~{          =    \",
2045 \"                   ]$   \",
2046 \"   ^                ^   \",
2047 \"   .                .   \",
2048 \"   /                (   \",
2049 \"   _                :   \",
2050 \"   <                [   \",
2051 \"   }                |   \",
2052 \"   [[                   \",
2053 \"    1          $.:23    \",
2054 \"     3          4}35    \",
2055 \"      6          655    \",
2056 \"       76      85 55    \",
2057 \"        5555555    5    \",
2058 \"                        \",
2059 \"                        \",
2060 \"                        \"};
2061 "
2062                  'xpm t)
2063    "Image for the update button."))
2064
2065 (defconst newsticker--browse-image
2066   (if (fboundp 'create-image)
2067       (create-image "/* XPM */
2068 static char * visit_xpm[] = {
2069 \"24 24 39 1\",
2070 \"      c None\",
2071 \".     c #000000\",
2072 \"+     c #FFFFFF\",
2073 \"@     c #00E63D\",
2074 \"#     c #00E83E\",
2075 \"$     c #00E73D\",
2076 \"%     c #00E93E\",
2077 \"&     c #00E63C\",
2078 \"*     c #00E53C\",
2079 \"=     c #00E23B\",
2080 \"-     c #00E33B\",
2081 \";     c #00E83D\",
2082 \">     c #00E13A\",
2083 \",     c #00DD38\",
2084 \"'     c #00DE38\",
2085 \")     c #00E23A\",
2086 \"!     c #00E43C\",
2087 \"~     c #00DF39\",
2088 \"{     c #00DB37\",
2089 \"]     c #00D634\",
2090 \"^     c #00D734\",
2091 \"/     c #00E039\",
2092 \"(     c #00DC37\",
2093 \"_     c #00D835\",
2094 \":     c #00D332\",
2095 \"<     c #00CD2F\",
2096 \"[     c #00DB36\",
2097 \"}     c #00D433\",
2098 \"|     c #00CF30\",
2099 \"1     c #00DA36\",
2100 \"2     c #00D936\",
2101 \"3     c #00D533\",
2102 \"4     c #00D131\",
2103 \"5     c #00CE2F\",
2104 \"6     c #00CC2F\",
2105 \"7     c #00CA2D\",
2106 \"8     c #00C62B\",
2107 \"9     c #00C52A\",
2108 \"0     c #00BE27\",
2109 \"                        \",
2110 \"                        \",
2111 \"            .           \",
2112 \"           .+.          \",
2113 \"          .+++.         \",
2114 \"         .++.++.        \",
2115 \"        .++.@.++.       \",
2116 \"       .++.##$.++.      \",
2117 \"      .++.%%%#&.++.     \",
2118 \"     .++.$%%%#*=.++.    \",
2119 \"    .++.-@;##$*>,.++.   \",
2120 \"   .++.')!&@@*=~{].++.  \",
2121 \"  .++.^{~>---)/(_:<.++. \",
2122 \"   .++.^[,~/~'(_}|.++.  \",
2123 \"    .++.]_1[12^:|.++.   \",
2124 \"     .++.:}33:45.++.    \",
2125 \"      .++.<5567.++.     \",
2126 \"       .++.889.++.      \",
2127 \"        .++.0.++.       \",
2128 \"         .++.++.        \",
2129 \"          .+++.         \",
2130 \"           .+.          \",
2131 \"            .           \",
2132 \"                        \"};
2133 "
2134                  'xpm t)
2135    "Image for the browse button."))
2136
2137
2138 (defvar newsticker-tool-bar-map
2139   (if (featurep 'xemacs)
2140       nil
2141     (let ((tool-bar-map (make-sparse-keymap)))
2142       (define-key tool-bar-map [newsticker-sep-1]
2143         (list 'menu-item "--double-line"))
2144       (define-key tool-bar-map [newsticker-browse-url]
2145         (list 'menu-item "newsticker-browse-url" 'newsticker-browse-url
2146               :visible t
2147               :help "Browse URL for item at point"
2148               :image newsticker--browse-image))
2149       (define-key tool-bar-map [newsticker-buffer-force-update]
2150         (list 'menu-item "newsticker-buffer-force-update"
2151               'newsticker-buffer-force-update
2152               :visible t
2153               :help "Update newsticker buffer"
2154               :image newsticker--update-image
2155               :enable '(not newsticker--buffer-uptodate-p)))
2156       (define-key tool-bar-map [newsticker-get-all-news]
2157         (list 'menu-item "newsticker-get-all-news" 'newsticker-get-all-news
2158               :visible t
2159               :help "Get news for all feeds"
2160               :image newsticker--get-all-image))
2161       (define-key tool-bar-map [newsticker-mark-item-at-point-as-read]
2162         (list 'menu-item "newsticker-mark-item-at-point-as-read"
2163               'newsticker-mark-item-at-point-as-read
2164               :visible t
2165               :image newsticker--mark-read-image
2166               :help "Mark current item as read"
2167               :enable '(newsticker-item-not-old-p)))
2168       (define-key tool-bar-map [newsticker-mark-item-at-point-as-immortal]
2169         (list 'menu-item "newsticker-mark-item-at-point-as-immortal"
2170               'newsticker-mark-item-at-point-as-immortal
2171               :visible t
2172               :image newsticker--mark-immortal-image
2173               :help "Mark current item as immortal"
2174               :enable '(newsticker-item-not-immortal-p)))
2175       (define-key tool-bar-map [newsticker-toggle-auto-narrow-to-feed]
2176         (list 'menu-item "newsticker-toggle-auto-narrow-to-feed"
2177               'newsticker-toggle-auto-narrow-to-feed
2178               :visible t
2179               :help "Toggle visibility of other feeds"
2180               :image newsticker--narrow-image))
2181       (define-key tool-bar-map [newsticker-next-feed]
2182         (list 'menu-item "newsticker-next-feed" 'newsticker-next-feed
2183               :visible t
2184               :help "Go to next feed"
2185               :image newsticker--next-feed-image
2186               :enable '(newsticker-next-feed-available-p)))
2187       (define-key tool-bar-map [newsticker-next-item]
2188         (list 'menu-item "newsticker-next-item" 'newsticker-next-item
2189               :visible t
2190               :help "Go to next item"
2191               :image newsticker--next-item-image
2192               :enable '(newsticker-next-item-available-p)))
2193       (define-key tool-bar-map [newsticker-previous-item]
2194         (list 'menu-item "newsticker-previous-item" 'newsticker-previous-item
2195               :visible t
2196               :help "Go to previous item"
2197               :image newsticker--previous-item-image
2198               :enable '(newsticker-previous-item-available-p)))
2199       (define-key tool-bar-map [newsticker-previous-feed]
2200         (list 'menu-item "newsticker-previous-feed" 'newsticker-previous-feed
2201               :visible t
2202               :help "Go to previous feed"
2203               :image newsticker--previous-feed-image
2204               :enable '(newsticker-previous-feed-available-p)))
2205       ;; standard icons / actions
2206       (tool-bar-add-item "close"
2207                          'newsticker-close-buffer
2208                          'newsticker-close-buffer
2209                          :help "Close newsticker buffer")
2210       (tool-bar-add-item "preferences"
2211                          'newsticker-customize
2212                          'newsticker-customize
2213                          :help "Customize newsticker")
2214       tool-bar-map)))
2215
2216 ;; ======================================================================
2217 ;;; Newsticker mode
2218 ;; ======================================================================
2219
2220 (define-derived-mode newsticker-mode fundamental-mode
2221   "NewsTicker"
2222   "Viewing news feeds in Emacs."
2223   (set (make-local-variable 'tool-bar-map) newsticker-tool-bar-map)
2224   (set (make-local-variable 'imenu-sort-function) nil)
2225   (set (make-local-variable 'scroll-conservatively) 999)
2226   (setq imenu-create-index-function 'newsticker--imenu-create-index)
2227   (setq imenu-default-goto-function 'newsticker--imenu-goto)
2228   (setq buffer-read-only t)
2229   (auto-fill-mode -1) ;; turn auto-fill off!
2230   (font-lock-mode -1) ;; turn off font-lock!!
2231   (set (make-local-variable 'font-lock-defaults) nil)
2232   (set (make-local-variable 'line-move-ignore-invisible) t)
2233   (setq mode-line-format
2234         (list "-"
2235               'mode-line-mule-info
2236               'mode-line-modified
2237               'mode-line-frame-identification
2238               " Newsticker ("
2239               '(newsticker--buffer-uptodate-p
2240                 "up to date"
2241                 "NEED UPDATE")
2242               ") "
2243               '(:eval (format "[%d]" (length newsticker--process-ids)))
2244               " -- "
2245               '(:eval (newsticker--buffer-get-feed-title-at-point))
2246               ": "
2247               '(:eval (newsticker--buffer-get-item-title-at-point))
2248               " %-"))
2249   (add-to-invisibility-spec 't)
2250   (unless newsticker-show-all-news-elements
2251     (add-to-invisibility-spec 'extra))
2252   (newsticker--buffer-set-uptodate nil))
2253
2254 ;; refine its mode-map
2255 (define-key newsticker-mode-map "sO" 'newsticker-show-old-items)
2256 (define-key newsticker-mode-map "hO" 'newsticker-hide-old-items)
2257 (define-key newsticker-mode-map "sa" 'newsticker-show-all-desc)
2258 (define-key newsticker-mode-map "ha" 'newsticker-hide-all-desc)
2259 (define-key newsticker-mode-map "sf" 'newsticker-show-feed-desc)
2260 (define-key newsticker-mode-map "hf" 'newsticker-hide-feed-desc)
2261 (define-key newsticker-mode-map "so" 'newsticker-show-old-item-desc)
2262 (define-key newsticker-mode-map "ho" 'newsticker-hide-old-item-desc)
2263 (define-key newsticker-mode-map "sn" 'newsticker-show-new-item-desc)
2264 (define-key newsticker-mode-map "hn" 'newsticker-hide-new-item-desc)
2265 (define-key newsticker-mode-map "se" 'newsticker-show-entry)
2266 (define-key newsticker-mode-map "he" 'newsticker-hide-entry)
2267 (define-key newsticker-mode-map "sx" 'newsticker-show-extra)
2268 (define-key newsticker-mode-map "hx" 'newsticker-hide-extra)
2269
2270 (define-key newsticker-mode-map " "  'scroll-up)
2271 (define-key newsticker-mode-map "q"  'newsticker-close-buffer)
2272 (define-key newsticker-mode-map "p"  'newsticker-previous-item)
2273 (define-key newsticker-mode-map "P"  'newsticker-previous-new-item)
2274 (define-key newsticker-mode-map "F"  'newsticker-previous-feed)
2275 (define-key newsticker-mode-map "\t" 'newsticker-next-item)
2276 (define-key newsticker-mode-map "n"  'newsticker-next-item)
2277 (define-key newsticker-mode-map "N"  'newsticker-next-new-item)
2278 (define-key newsticker-mode-map "f"  'newsticker-next-feed)
2279 (define-key newsticker-mode-map "M"  'newsticker-mark-all-items-as-read)
2280 (define-key newsticker-mode-map "m"
2281   'newsticker-mark-all-items-at-point-as-read-and-redraw)
2282 (define-key newsticker-mode-map "o"
2283   'newsticker-mark-item-at-point-as-read)
2284 (define-key newsticker-mode-map "O"
2285   'newsticker-mark-all-items-at-point-as-read)
2286 (define-key newsticker-mode-map "G"  'newsticker-get-all-news)
2287 (define-key newsticker-mode-map "g"  'newsticker-get-news-at-point)
2288 (define-key newsticker-mode-map "u"  'newsticker-buffer-update)
2289 (define-key newsticker-mode-map "U"  'newsticker-buffer-force-update)
2290 (define-key newsticker-mode-map "a"  'newsticker-add-url)
2291
2292 (define-key newsticker-mode-map "i"
2293   'newsticker-mark-item-at-point-as-immortal)
2294
2295 (define-key newsticker-mode-map "xf"
2296   'newsticker-toggle-auto-narrow-to-feed)
2297 (define-key newsticker-mode-map "xi"
2298   'newsticker-toggle-auto-narrow-to-item)
2299
2300 ;; maps for the clickable portions
2301 (defvar newsticker--url-keymap (make-sparse-keymap)
2302   "Key map for click-able headings in the newsticker buffer.")
2303 (define-key newsticker--url-keymap [mouse-2]
2304   'newsticker-mouse-browse-url)
2305 (define-key newsticker--url-keymap "\n"
2306   'newsticker-browse-url)
2307 (define-key newsticker--url-keymap "\C-m"
2308   'newsticker-browse-url)
2309 (define-key newsticker--url-keymap [(control return)]
2310   'newsticker-handle-url)
2311
2312 ;; newsticker menu
2313 (defvar newsticker-menu (make-sparse-keymap "Newsticker"))
2314
2315 (define-key newsticker-menu [newsticker-browse-url]
2316   '("Browse URL for item at point" . newsticker-browse-url))
2317 (define-key newsticker-menu [newsticker-separator-1]
2318   '("--"))
2319 (define-key newsticker-menu [newsticker-buffer-update]
2320   '("Update buffer" . newsticker-buffer-update))
2321 (define-key newsticker-menu [newsticker-separator-2]
2322   '("--"))
2323 (define-key newsticker-menu [newsticker-get-all-news]
2324   '("Get news from all feeds" . newsticker-get-all-news))
2325 (define-key newsticker-menu [newsticker-get-news-at-point]
2326   '("Get news from feed at point" . newsticker-get-news-at-point))
2327 (define-key newsticker-menu [newsticker-separator-3]
2328   '("--"))
2329 (define-key newsticker-menu [newsticker-mark-all-items-as-read]
2330   '("Mark all items as read" . newsticker-mark-all-items-as-read))
2331 (define-key newsticker-menu [newsticker-mark-all-items-at-point-as-read]
2332   '("Mark all items in feed at point as read" .
2333     newsticker-mark-all-items-at-point-as-read))
2334 (define-key newsticker-menu [newsticker-mark-item-at-point-as-read]
2335   '("Mark item at point as read" .
2336     newsticker-mark-item-at-point-as-read))
2337 (define-key newsticker-menu [newsticker-mark-item-at-point-as-immortal]
2338   '("Toggle immortality for item at point" .
2339     newsticker-mark-item-at-point-as-immortal))
2340 (define-key newsticker-menu [newsticker-separator-4]
2341   '("--"))
2342 (define-key newsticker-menu [newsticker-toggle-auto-narrow-to-item]
2343   '("Narrow to single item" . newsticker-toggle-auto-narrow-to-item))
2344 (define-key newsticker-menu [newsticker-toggle-auto-narrow-to-feed]
2345   '("Narrow to single news feed" . newsticker-toggle-auto-narrow-to-feed))
2346 (define-key newsticker-menu [newsticker-hide-old-items]
2347   '("Hide old items" . newsticker-hide-old-items))
2348 (define-key newsticker-menu [newsticker-show-old-items]
2349   '("Show old items" . newsticker-show-old-items))
2350 (define-key newsticker-menu [newsticker-next-item]
2351   '("Go to next item" . newsticker-next-item))
2352 (define-key newsticker-menu [newsticker-previous-item]
2353   '("Go to previous item" . newsticker-previous-item))
2354
2355 ;; bind menu to mouse
2356 (define-key newsticker-mode-map [down-mouse-3] newsticker-menu)
2357 ;; Put menu in menu-bar
2358 (define-key newsticker-mode-map [menu-bar Newsticker]
2359   (cons "Newsticker" newsticker-menu))
2360
2361
2362 ;; ======================================================================
2363 ;;; shortcuts
2364 ;; ======================================================================
2365 (defsubst newsticker--title (item)
2366   "Return title of ITEM."
2367   (nth 0 item))
2368 (defsubst newsticker--desc (item)
2369   "Return description of ITEM."
2370   (nth 1 item))
2371 (defsubst newsticker--link (item)
2372   "Return link of ITEM."
2373   (nth 2 item))
2374 (defsubst newsticker--time (item)
2375   "Return time of ITEM."
2376   (nth 3 item))
2377 (defsubst newsticker--age (item)
2378   "Return age of ITEM."
2379   (nth 4 item))
2380 (defsubst newsticker--pos (item)
2381   "Return position/index of ITEM."
2382   (nth 5 item))
2383 (defsubst newsticker--preformatted-contents (item)
2384   "Return pre-formatted text of ITEM."
2385   (nth 6 item))
2386 (defsubst newsticker--preformatted-title (item)
2387   "Return pre-formatted title of ITEM."
2388   (nth 7 item))
2389 (defsubst newsticker--extra (item)
2390   "Return extra attributes of ITEM."
2391   (nth 8 item))
2392 (defsubst newsticker--guid (item)
2393   "Return guid of ITEM."
2394   (let ((guid (assoc 'guid (newsticker--extra item))))
2395     (if (stringp guid)
2396         guid
2397       (car (xml-node-children guid)))))
2398 (defsubst newsticker--enclosure (item)
2399   "Return enclosure element of ITEM in the form \(...FIXME...\) or nil."
2400   (let ((enclosure (assoc 'enclosure (newsticker--extra item))))
2401     (if enclosure
2402         (xml-node-attributes enclosure))))
2403
2404 ;; ======================================================================
2405 ;;; User fun
2406 ;; ======================================================================
2407
2408 ;;;###autoload
2409 (defun newsticker-start (&optional do-not-complain-if-running)
2410   "Start the newsticker.
2411 Start the timers for display and retrieval.  If the newsticker, i.e. the
2412 timers, are running already a warning message is printed unless
2413 DO-NOT-COMPLAIN-IF-RUNNING is not nil.
2414 Run `newsticker-start-hook' if newsticker was not running already."
2415   (interactive)
2416   (let ((running (newsticker-running-p)))
2417     ;; read old cache if it exists and newsticker is not running
2418     (unless running
2419       (let* ((coding-system-for-read 'utf-8)
2420              (buf (find-file-noselect newsticker-cache-filename)))
2421         (when buf
2422           (set-buffer buf)
2423           (goto-char (point-min))
2424           (condition-case nil
2425               (setq newsticker--cache (read buf))
2426             (error
2427              (message "Error while reading newsticker cache file!")
2428              (setq newsticker--cache nil))))))
2429     ;; start retrieval timers -- for sake of simplicity we will start
2430     ;; one timer for each feed
2431     (mapc (lambda (item)
2432             (let* ((feed-name (car item))
2433                    (start-time (nth 2 item))
2434                    (interval (or (nth 3 item)
2435                                  newsticker-retrieval-interval))
2436                    (timer (assoc (car item)
2437                                  newsticker--retrieval-timer-list)))
2438               (if timer
2439                   (or do-not-complain-if-running
2440                       (message "Timer for %s is running already!"
2441                                feed-name))
2442                 (newsticker--debug-msg "Starting timer for %s: %s, %d"
2443                                        feed-name start-time interval)
2444                 ;; do not repeat retrieval if interval not positive
2445                 (if (<= interval 0)
2446                     (setq interval nil))
2447                 ;; Suddenly XEmacs doesn't like start-time 0
2448                 (if (or (not start-time)
2449                         (and (numberp start-time) (= start-time 0)))
2450                     (setq start-time 1))
2451                 ;; (message "start-time %s" start-time)
2452                 (setq timer (run-at-time start-time interval
2453                                          'newsticker-get-news feed-name))
2454                 (if interval
2455                     (add-to-list 'newsticker--retrieval-timer-list
2456                                  (cons feed-name timer))))))
2457           (append newsticker-url-list-defaults newsticker-url-list))
2458     (unless running
2459       (run-hooks 'newsticker-start-hook)
2460       (message "Newsticker started!"))))
2461
2462 ;;;###autoload
2463 (defun newsticker-start-ticker ()
2464   "Start newsticker's ticker (but not the news retrieval).
2465 Start display timer for the actual ticker if wanted and not
2466 running already."
2467   (interactive)
2468   (if (and (> newsticker-display-interval 0)
2469            (not newsticker--display-timer))
2470       (setq newsticker--display-timer
2471             (run-at-time newsticker-display-interval
2472                          newsticker-display-interval
2473                          'newsticker--display-tick))))
2474
2475 (defun newsticker-stop ()
2476   "Stop the newsticker and the newsticker-ticker.
2477 Cancel the timers for display and retrieval.  Run `newsticker-stop-hook'
2478 if newsticker has been running."
2479   (interactive)
2480   (newsticker--cache-update t)
2481   (newsticker-stop-ticker)
2482   (when (newsticker-running-p)
2483     (mapc (lambda (name-and-timer)
2484             (cancel-timer (cdr name-and-timer)))
2485           newsticker--retrieval-timer-list)
2486     (setq newsticker--retrieval-timer-list nil)
2487     (run-hooks 'newsticker-stop-hook)
2488     (message "Newsticker stopped!")))
2489
2490 (defun newsticker-stop-ticker ()
2491   "Stop newsticker's ticker (but not the news retrieval)."
2492   (interactive)
2493   (when newsticker--display-timer
2494     (cancel-timer newsticker--display-timer)
2495     (setq newsticker--display-timer nil)))
2496
2497 ;; the functions we need for retrieval and display
2498 ;;;###autoload
2499 (defun newsticker-show-news ()
2500   "Switch to newsticker buffer.  You may want to bind this to a key."
2501   (interactive)
2502   (newsticker-start t) ;; will start only if not running
2503   (newsticker-buffer-update)
2504   (switch-to-buffer "*newsticker*"))
2505
2506 (defun newsticker-buffer-force-update ()
2507   "Update the newsticker buffer, even if not necessary."
2508   (interactive)
2509   (newsticker-buffer-update t))
2510
2511 (defun newsticker-buffer-update (&optional force)
2512   "Update the *newsticker* buffer.
2513 Unless FORCE is t this is done only if necessary, i.e. when the
2514 *newsticker* buffer is not up-to-date."
2515   (interactive)
2516   ;; bring cache data into proper order....
2517   (newsticker--cache-sort)
2518   ;; fill buffer
2519   (save-excursion
2520     (let ((buf (get-buffer "*newsticker*")))
2521       (if buf
2522           (switch-to-buffer buf)
2523         (switch-to-buffer (get-buffer-create "*newsticker*"))
2524         (newsticker--buffer-set-uptodate nil)))
2525    (when (or force
2526              (not newsticker--buffer-uptodate-p))
2527      (message "Preparing newsticker buffer...")
2528      (setq buffer-undo-list t)
2529      (let ((inhibit-read-only t))
2530        (set-buffer-modified-p nil)
2531        (erase-buffer)
2532        (newsticker-mode)
2533        ;; Emacs 21.3.50 does not care if we turn off auto-fill in the
2534        ;; definition of newsticker-mode, so we do it here (again)
2535        (auto-fill-mode -1)
2536
2537        (set-buffer-file-coding-system 'utf-8)
2538
2539        (if newsticker-use-full-width
2540            (set (make-local-variable 'fill-column) (1- (window-width))))
2541        (newsticker--buffer-insert-all-items)
2542
2543        ;; FIXME: needed for methods buffer in ecb
2544        ;; (set-visited-file-name "*newsticker*")
2545
2546        (set-buffer-modified-p nil)
2547         (newsticker-hide-all-desc)
2548         (if newsticker-hide-old-items-in-newsticker-buffer
2549             (newsticker-hide-old-items))
2550         (if newsticker-show-descriptions-of-new-items
2551             (newsticker-show-new-item-desc))
2552        )
2553      (message ""))
2554    (newsticker--buffer-set-uptodate t)
2555    (run-hooks 'newsticker-buffer-change-hook)))
2556
2557 (defun newsticker-get-all-news ()
2558   "Launch retrieval of news from all configured newsticker sites.
2559 This does NOT start the retrieval timers."
2560   (interactive)
2561   ;; launch retrieval of news
2562   (mapc (lambda (item)
2563           (newsticker-get-news (car item)))
2564         (append newsticker-url-list-defaults newsticker-url-list)))
2565
2566 (defun newsticker-get-news-at-point ()
2567   "Launch retrieval of news for the feed point is in.
2568 This does NOT start the retrieval timers."
2569   (interactive)
2570   ;; launch retrieval of news
2571   (let ((feed (get-text-property (point) 'feed)))
2572       (when feed
2573         (newsticker--debug-msg "Getting news for %s" (symbol-name feed))
2574         (newsticker-get-news (symbol-name feed)))))
2575
2576 (defun newsticker-add-url (url name)
2577   "Add given URL under given NAME to `newsticker-url-list'.
2578 If URL is nil it is searched at point."
2579   (interactive
2580    (list
2581     (read-string "URL: "
2582                  (save-excursion
2583                    (end-of-line)
2584                    (and
2585                     (re-search-backward
2586                      "http://"
2587                      (if (> (point) (+ (point-min) 100))
2588                          (- (point) 100)
2589                        (point-min))
2590                      t)
2591                     (re-search-forward
2592                      "http://[-a-zA-Z0-9&/_.]*"
2593                      (if (< (point) (- (point-max) 200))
2594                          (+ (point) 200)
2595                        (point-max))
2596                      t)
2597                     (buffer-substring-no-properties (match-beginning 0)
2598                                                     (match-end 0)))))
2599     (read-string "Name: ")))
2600   (add-to-list 'newsticker-url-list (list name url nil nil nil) t)
2601   (customize-variable 'newsticker-url-list))
2602
2603 (defun newsticker-w3m-show-inline-images ()
2604   "Show inline images in visible text ranges.
2605 In-line images in invisible text ranges are hidden.  This function
2606 calls `w3m-toggle-inline-image'.  It works only if
2607 `newsticker-html-renderer' is set to `w3m-region'."
2608   (interactive)
2609   (if (eq newsticker-html-renderer 'w3m-region)
2610       (let ((inhibit-read-only t))
2611         (save-excursion
2612           (save-restriction
2613             (widen)
2614             (goto-char (point-min))
2615             (let ((pos (point)))
2616               (while pos
2617                 (setq pos (next-single-property-change pos 'w3m-image))
2618                 (when pos
2619                   (goto-char pos)
2620                   (when (get-text-property pos 'w3m-image)
2621                     (let ((invis (newsticker--lists-intersect-p
2622                                   (get-text-property (1- (point))
2623                                                      'invisible)
2624                                   buffer-invisibility-spec)))
2625                       (unless  (car (get-text-property (1- (point))
2626                                                        'display))
2627                         (unless invis
2628                           (w3m-toggle-inline-image t)))))))))))))
2629
2630 (defadvice w3m-insert-image (after newsticker activate)
2631   (newsticker--buffer-after-w3m-insert-image (ad-get-arg 0) (ad-get-arg 1)))
2632
2633 (defun newsticker--buffer-after-w3m-insert-image (beg end)
2634   "Save preformatted contents after an image has been inserted
2635 between BEG and END."
2636   (when (string= (buffer-name) "*newsticker*")
2637     (save-excursion
2638       (newsticker--buffer-beginning-of-item)
2639       (let* ((pos     (point))
2640              (feed    (get-text-property pos 'feed))
2641              (age     (get-text-property pos 'nt-age))
2642              (title   (get-text-property pos 'nt-title))
2643              (guid    (get-text-property pos 'nt-guid))
2644              (nt-desc (get-text-property pos 'nt-desc))
2645              (item    (newsticker--cache-contains newsticker--cache
2646                                                   feed title nt-desc
2647                                                   nil nil guid))
2648              (desc-beg (newsticker--buffer-goto '(desc)))
2649              (desc-end (newsticker--buffer-end-of-item)))
2650         ;;(add-text-properties beg end (list nt-type desc))
2651         (add-text-properties beg end (list 'invisible
2652                                            (get-text-property end 'invisible)))
2653         ;;(message "newsticker--buffer-after-w3m-insert-image at %s, %s: `%s'"
2654         ;;         beg feed title)
2655         (if item
2656             (newsticker--cache-set-preformatted-contents
2657              item (buffer-substring desc-beg desc-end))
2658           (message "ooops in newsticker--buffer-after-w3m-insert-image at %s, %s: `%s'"
2659                    beg feed title))))))
2660
2661 ;; ======================================================================
2662 ;;; keymap stuff
2663 ;; ======================================================================
2664 (defun newsticker-close-buffer ()
2665   "Close the newsticker buffer."
2666   (interactive)
2667   (newsticker--cache-update t)
2668   (bury-buffer))
2669
2670 (defun newsticker-next-new-item (&optional do-not-wrap-at-eob)
2671   "Go to next new news item.
2672 If no new item is found behind point, search is continued at
2673 beginning of buffer unless optional argument DO-NOT-WRAP-AT-EOB
2674 is non-nil."
2675   (interactive)
2676   (widen)
2677   (let ((go-ahead t))
2678     (while go-ahead
2679       (unless (newsticker--buffer-goto '(item) 'new)
2680         ;; found nothing -- wrap
2681         (unless do-not-wrap-at-eob
2682           (goto-char (point-min))
2683           (newsticker-next-new-item t))
2684         (setq go-ahead nil))
2685       (unless (newsticker--lists-intersect-p
2686                (get-text-property (point) 'invisible)
2687                buffer-invisibility-spec)
2688         ;; this item is invisible -- continue search
2689         (setq go-ahead nil))))
2690   (run-hooks 'newsticker-select-item-hook)
2691   (point))
2692
2693 (defun newsticker-previous-new-item (&optional do-not-wrap-at-bob)
2694   "Go to previous new news item.
2695 If no new item is found before point, search is continued at
2696 beginning of buffer unless optional argument DO-NOT-WRAP-AT-BOB
2697 is non-nil."
2698   (interactive)
2699   (widen)
2700   (let ((go-ahead t))
2701     (while go-ahead
2702       (unless (newsticker--buffer-goto '(item) 'new t)
2703         (unless do-not-wrap-at-bob
2704           (goto-char (point-max))
2705           (newsticker--buffer-goto '(item) 'new t)))
2706       (unless (newsticker--lists-intersect-p
2707                (get-text-property (point) 'invisible)
2708                     buffer-invisibility-spec)
2709         (setq go-ahead nil))))
2710   (run-hooks 'newsticker-select-item-hook)
2711   (point))
2712
2713 (defun newsticker-next-item (&optional do-not-wrap-at-eob)
2714   "Go to next news item.
2715 Return new buffer position.
2716 If no item is found below point, search is continued at beginning
2717 of buffer unless optional argument DO-NOT-WRAP-AT-EOB is
2718 non-nil."
2719   (interactive)
2720   (widen)
2721   (let ((go-ahead t)
2722         (search-list '(item)))
2723     (if newsticker--auto-narrow-to-item
2724         (setq search-list '(item feed)))
2725     (while go-ahead
2726       (unless (newsticker--buffer-goto search-list)
2727         ;; found nothing -- wrap
2728         (unless do-not-wrap-at-eob
2729           (goto-char (point-min)))
2730         (setq go-ahead nil))
2731       (unless (newsticker--lists-intersect-p
2732                (get-text-property (point) 'invisible)
2733                     buffer-invisibility-spec)
2734         (setq go-ahead nil))))
2735   (run-hooks 'newsticker-select-item-hook)
2736   (force-mode-line-update)
2737   (point))
2738
2739 (defun newsticker-next-item-same-feed ()
2740   "Go to next news item in the same feed.
2741 Return new buffer position.  If no item is found below point or if
2742 auto-narrow-to-item is enabled, nil is returned."
2743   (interactive)
2744   (if newsticker--auto-narrow-to-item
2745       nil
2746     (let ((go-ahead t)
2747           (current-pos (point))
2748           (end-of-feed (save-excursion (newsticker--buffer-end-of-feed))))
2749       (while go-ahead
2750         (unless (newsticker--buffer-goto '(item))
2751           (setq go-ahead nil))
2752         (unless (newsticker--lists-intersect-p
2753                  (get-text-property (point) 'invisible)
2754                  buffer-invisibility-spec)
2755           (setq go-ahead nil)))
2756       (if (and (> (point) current-pos)
2757                (< (point) end-of-feed))
2758           (point)
2759         (goto-char current-pos)
2760         nil))))
2761
2762 (defun newsticker-previous-item (&optional do-not-wrap-at-bob)
2763   "Go to previous news item.
2764 Return new buffer position.
2765 If no item is found before point, search is continued at
2766 beginning of buffer unless optional argument DO-NOT-WRAP-AT-BOB
2767 is non-nil."
2768   (interactive)
2769   (widen)
2770   (let ((go-ahead t)
2771         (search-list '(item)))
2772     (if newsticker--auto-narrow-to-item
2773         (setq search-list '(item feed)))
2774     (when (bobp)
2775       (unless do-not-wrap-at-bob
2776         (goto-char (point-max))))
2777     (while go-ahead
2778       (if (newsticker--buffer-goto search-list nil t)
2779           (unless (newsticker--lists-intersect-p
2780                    (get-text-property (point) 'invisible)
2781                    buffer-invisibility-spec)
2782             (setq go-ahead nil))
2783         (goto-char (point-min))
2784         (setq go-ahead nil))))
2785   (run-hooks 'newsticker-select-item-hook)
2786   (force-mode-line-update)
2787   (point))
2788
2789 (defun newsticker-next-feed ()
2790   "Go to next news feed.
2791 Return new buffer position."
2792   (interactive)
2793   (widen)
2794   (newsticker--buffer-goto '(feed))
2795   (run-hooks 'newsticker-select-feed-hook)
2796   (force-mode-line-update)
2797   (point))
2798
2799 (defun newsticker-previous-feed ()
2800   "Go to previous news feed.
2801 Return new buffer position."
2802   (interactive)
2803   (widen)
2804   (newsticker--buffer-goto '(feed) nil t)
2805   (run-hooks 'newsticker-select-feed-hook)
2806   (force-mode-line-update)
2807   (point))
2808
2809 (defun newsticker-mark-all-items-at-point-as-read-and-redraw ()
2810   "Mark all items as read and clear ticker contents."
2811   (interactive)
2812   (when (or newsticker--buffer-uptodate-p
2813             (y-or-n-p
2814              "Buffer is not up to date -- really mark items as read? "))
2815     (newsticker-mark-all-items-of-feed-as-read
2816      (get-text-property (point) 'feed))))
2817
2818 (defun newsticker-mark-all-items-of-feed-as-read (feed)
2819   "Mark all items as read, clear ticker, and redraw *newsticker* buffer."
2820   (when feed
2821     (let ((pos (point)))
2822       (message "Marking all items as read for %s" (symbol-name feed))
2823       (newsticker--cache-replace-age newsticker--cache feed 'new 'old)
2824       (newsticker--cache-replace-age newsticker--cache feed 'obsolete
2825                                      'old)
2826       (newsticker--cache-update)
2827       (newsticker--buffer-set-uptodate nil)
2828       (newsticker--ticker-text-setup)
2829       (newsticker-buffer-update)
2830       ;; go back to where we came frome
2831       (goto-char pos)
2832       (end-of-line)
2833       (newsticker--buffer-goto '(feed) nil t))))
2834
2835 (defun newsticker-mark-all-items-at-point-as-read ()
2836   "Mark all items as read and clear ticker contents."
2837   (interactive)
2838   (when (or newsticker--buffer-uptodate-p
2839             (y-or-n-p
2840              "Buffer is not up to date -- really mark items as read? "))
2841     (newsticker--do-mark-item-at-point-as-read t)
2842     (while (newsticker-next-item-same-feed)
2843       (newsticker--do-mark-item-at-point-as-read t))
2844     (newsticker-next-item t)))
2845
2846 (defun newsticker-mark-item-at-point-as-read (&optional respect-immortality)
2847   "Mark item at point as read and move to next item.
2848 If optional argument RESPECT-IMMORTALITY is not nil immortal items do
2849 not get changed."
2850   (interactive)
2851   (when (or newsticker--buffer-uptodate-p
2852             (y-or-n-p
2853              "Buffer is not up to date -- really mark this item as read? "))
2854     (newsticker--do-mark-item-at-point-as-read respect-immortality)
2855     ;; move forward
2856     (newsticker-next-item t)))
2857
2858 (defun newsticker--do-mark-item-at-point-as-read (&optional respect-immortality)
2859   "Mark item at point as read.
2860 If optional argument RESPECT-IMMORTALITY is not nil immortal items do
2861 not get changed."
2862   (let ((feed (get-text-property (point) 'feed)))
2863     (when feed
2864       (save-excursion
2865         (newsticker--buffer-beginning-of-item)
2866         (let ((inhibit-read-only t)
2867               (age (get-text-property (point) 'nt-age))
2868               (title (get-text-property (point) 'nt-title))
2869               (guid (get-text-property (point) 'nt-guid))
2870               (nt-desc (get-text-property (point) 'nt-desc))
2871               (pos (save-excursion (newsticker--buffer-end-of-item)))
2872               item)
2873           (when (or (eq age 'new)
2874                     (eq age 'obsolete)
2875                     (and (eq age 'immortal)
2876                          (not respect-immortality)))
2877             ;; find item
2878             (setq item (newsticker--cache-contains newsticker--cache
2879                                                    feed title nt-desc
2880                                                    nil nil guid))
2881             ;; mark as old
2882             (when item
2883               (setcar (nthcdr 4 item) 'old)
2884               (newsticker--do-forget-preformatted item))
2885             ;; clean up ticker
2886             (if (or (and (eq age 'new)
2887                          newsticker-hide-immortal-items-in-echo-area)
2888                     (and (memq age '(old immortal))
2889                          (not
2890                           (eq newsticker-hide-old-items-in-newsticker-buffer
2891                               newsticker-hide-immortal-items-in-echo-area))))
2892                 (newsticker--ticker-text-remove feed title))
2893             ;; set faces etc.
2894             (save-excursion
2895               (save-restriction
2896                 (widen)
2897                 (put-text-property (point) pos 'nt-age 'old)
2898                 (newsticker--buffer-set-faces (point) pos)))
2899             (set-buffer-modified-p nil)))))))
2900
2901 (defun newsticker-mark-item-at-point-as-immortal ()
2902   "Mark item at point as read."
2903   (interactive)
2904   (when (or newsticker--buffer-uptodate-p
2905             (y-or-n-p
2906              "Buffer is not up to date -- really mark this item as read? "))
2907     (let ((feed (get-text-property (point) 'feed))
2908           (item nil))
2909       (when feed
2910         (save-excursion
2911           (newsticker--buffer-beginning-of-item)
2912           (let ((inhibit-read-only t)
2913                 (oldage (get-text-property (point) 'nt-age))
2914                 (title (get-text-property (point) 'nt-title))
2915                 (guid (get-text-property (point) 'nt-guid))
2916                 (pos  (save-excursion (newsticker--buffer-end-of-item))))
2917             (let ((newage 'immortal))
2918               (if (eq oldage 'immortal)
2919                   (setq newage 'old))
2920               (setq item (newsticker--cache-contains newsticker--cache
2921                                                      feed title nil nil nil
2922                                                      guid))
2923               ;; change age
2924               (when item
2925                 (setcar (nthcdr 4 item) newage)
2926                 (newsticker--do-forget-preformatted item))
2927               (if (or (and (eq newage 'immortal)
2928                            newsticker-hide-immortal-items-in-echo-area)
2929                       (and (eq newage 'obsolete)
2930                            newsticker-hide-obsolete-items-in-echo-area)
2931                       (and (eq oldage 'immortal)
2932                            (not
2933                             (eq newsticker-hide-old-items-in-newsticker-buffer
2934                                 newsticker-hide-immortal-items-in-echo-area))))
2935                   (newsticker--ticker-text-remove feed title)
2936                 (newsticker--ticker-text-setup))
2937               (save-excursion
2938                 (save-restriction
2939                   (widen)
2940                   (put-text-property (point) pos 'nt-age newage)
2941                   (if (eq newage 'immortal)
2942                       (put-text-property (point) pos 'nt-age 'immortal)
2943                     (put-text-property (point) pos 'nt-age 'old))
2944                   (newsticker--buffer-set-faces (point) pos))))))
2945           (if item
2946             (newsticker-next-item t))))))
2947
2948 (defun newsticker-mark-all-items-as-read ()
2949   "Mark all items as read and clear ticker contents."
2950   (interactive)
2951   (when (or newsticker--buffer-uptodate-p
2952             (y-or-n-p
2953              "Buffer is not up to date -- really mark items as read? "))
2954     (newsticker--cache-replace-age newsticker--cache 'any 'new 'old)
2955     (newsticker--buffer-set-uptodate nil)
2956     (newsticker--ticker-text-setup)
2957     (newsticker--cache-update)
2958     (newsticker-buffer-update)))
2959
2960 (defun newsticker-hide-extra ()
2961   "Hide the extra elements of items."
2962   (interactive)
2963   (newsticker--buffer-hideshow 'extra nil)
2964   (newsticker--buffer-redraw))
2965
2966 (defun newsticker-show-extra ()
2967   "Show the extra elements of items."
2968   (interactive)
2969   (newsticker--buffer-hideshow 'extra t)
2970   (newsticker--buffer-redraw))
2971
2972 (defun newsticker-hide-old-item-desc ()
2973   "Hide the description of old items."
2974   (interactive)
2975   (newsticker--buffer-hideshow 'desc-old nil)
2976   (newsticker--buffer-redraw))
2977
2978 (defun newsticker-show-old-item-desc ()
2979   "Show the description of old items."
2980   (interactive)
2981   (newsticker--buffer-hideshow 'item-old t)
2982   (newsticker--buffer-hideshow 'desc-old t)
2983   (newsticker--buffer-redraw))
2984
2985 (defun newsticker-hide-new-item-desc ()
2986   "Hide the description of new items."
2987   (interactive)
2988   (newsticker--buffer-hideshow 'desc-new nil)
2989   (newsticker--buffer-hideshow 'desc-immortal nil)
2990   (newsticker--buffer-hideshow 'desc-obsolete nil)
2991   (newsticker--buffer-redraw))
2992
2993 (defun newsticker-show-new-item-desc ()
2994   "Show the description of new items."
2995   (interactive)
2996   (newsticker--buffer-hideshow 'desc-new t)
2997   (newsticker--buffer-hideshow 'desc-immortal t)
2998   (newsticker--buffer-hideshow 'desc-obsolete t)
2999   (newsticker--buffer-redraw))
3000
3001 (defun newsticker-hide-feed-desc ()
3002   "Hide the description of feeds."
3003   (interactive)
3004   (newsticker--buffer-hideshow 'desc-feed nil)
3005   (newsticker--buffer-redraw))
3006
3007 (defun newsticker-show-feed-desc ()
3008   "Show the description of old items."
3009   (interactive)
3010   (newsticker--buffer-hideshow 'desc-feed t)
3011   (newsticker--buffer-redraw))
3012
3013 (defun newsticker-hide-all-desc ()
3014   "Hide the descriptions of feeds and all items."
3015   (interactive)
3016   (newsticker--buffer-hideshow 'desc-feed nil)
3017   (newsticker--buffer-hideshow 'desc-immortal nil)
3018   (newsticker--buffer-hideshow 'desc-obsolete nil)
3019   (newsticker--buffer-hideshow 'desc-new  nil)
3020   (newsticker--buffer-hideshow 'desc-old  nil)
3021   (newsticker--buffer-redraw))
3022
3023 (defun newsticker-show-all-desc ()
3024   "Show the descriptions of feeds and all items."
3025   (interactive)
3026   (newsticker--buffer-hideshow 'desc-feed t)
3027   (newsticker--buffer-hideshow 'desc-immortal  t)
3028   (newsticker--buffer-hideshow 'desc-obsolete  t)
3029   (newsticker--buffer-hideshow 'desc-new  t)
3030   (newsticker--buffer-hideshow 'desc-old  t)
3031   (newsticker--buffer-redraw))
3032
3033 (defun newsticker-hide-old-items ()
3034   "Hide old items."
3035   (interactive)
3036   (newsticker--buffer-hideshow 'desc-old nil)
3037   (newsticker--buffer-hideshow 'item-old nil)
3038   (newsticker--buffer-redraw))
3039
3040 (defun newsticker-show-old-items ()
3041   "Show old items."
3042   (interactive)
3043   (newsticker--buffer-hideshow 'item-old t)
3044   (newsticker--buffer-redraw))
3045
3046 (defun newsticker-hide-entry ()
3047   "Hide description of entry at point."
3048   (interactive)
3049   (save-excursion
3050     (let* (pos1 pos2
3051                 (inhibit-read-only t)
3052                 inv-prop org-inv-prop
3053                 is-invisible)
3054       (newsticker--buffer-beginning-of-item)
3055       (newsticker--buffer-goto '(desc))
3056       (setq pos1 (max (point-min) (1- (point))))
3057       (newsticker--buffer-goto '(extra feed item nil))
3058       (setq pos2 (max (point-min) (1- (point))))
3059       (setq inv-prop (get-text-property pos1 'invisible))
3060       (setq org-inv-prop (get-text-property pos1 'org-invisible))
3061       (cond ((eq inv-prop t)
3062              ;; do nothing
3063              )
3064             ((eq org-inv-prop nil)
3065              (add-text-properties pos1 pos2
3066                                   (list 'invisible (list t)
3067                                         'org-invisible inv-prop)))
3068             (t
3069              ;; toggle
3070              (add-text-properties pos1 pos2
3071                                   (list 'invisible org-inv-prop))
3072              (remove-text-properties pos1 pos2 '(org-invisible))))))
3073   (newsticker--buffer-redraw))
3074
3075 (defun newsticker-show-entry ()
3076   "Show description of entry at point."
3077   (interactive)
3078   (save-excursion
3079     (let* (pos1 pos2
3080                 (inhibit-read-only t)
3081                 inv-prop org-inv-prop
3082                 is-invisible)
3083       (newsticker--buffer-beginning-of-item)
3084       (newsticker--buffer-goto '(desc))
3085       (setq pos1 (max (point-min) (1- (point))))
3086       (newsticker--buffer-goto '(extra feed item))
3087       (setq pos2 (max (point-min) (1- (point))))
3088       (setq inv-prop (get-text-property pos1 'invisible))
3089       (setq org-inv-prop (get-text-property pos1 'org-invisible))
3090       (cond ((eq org-inv-prop nil)
3091              (add-text-properties pos1 pos2
3092                                   (list 'invisible nil
3093                                         'org-invisible inv-prop)))
3094             (t
3095              ;; toggle
3096              (add-text-properties pos1 pos2
3097                                   (list 'invisible org-inv-prop))
3098              (remove-text-properties pos1 pos2 '(org-invisible))))))
3099   (newsticker--buffer-redraw))
3100
3101 (defun newsticker-toggle-auto-narrow-to-feed ()
3102   "Toggle narrowing to current news feed.
3103 If auto-narrowing is active, only news item of the current feed
3104 are visible."
3105   (interactive)
3106   (newsticker-set-auto-narrow-to-feed
3107    (not newsticker--auto-narrow-to-feed)))
3108
3109 (defun newsticker-set-auto-narrow-to-feed (value)
3110   "Turn narrowing to current news feed on or off.
3111 If VALUE is nil, auto-narrowing is turned off, otherwise it is turned on."
3112   (interactive)
3113   (setq newsticker--auto-narrow-to-item nil)
3114   (setq newsticker--auto-narrow-to-feed value)
3115   (widen)
3116   (newsticker--buffer-make-item-completely-visible)
3117   (run-hooks 'newsticker-narrow-hook))
3118
3119 (defun newsticker-toggle-auto-narrow-to-item ()
3120   "Toggle narrowing to current news item.
3121 If auto-narrowing is active, only one item of the current feed
3122 is visible."
3123   (interactive)
3124   (newsticker-set-auto-narrow-to-item
3125    (not newsticker--auto-narrow-to-item)))
3126
3127 (defun newsticker-set-auto-narrow-to-item (value)
3128   "Turn narrowing to current news item on or off.
3129 If VALUE is nil, auto-narrowing is turned off, otherwise it is turned on."
3130   (interactive)
3131   (setq newsticker--auto-narrow-to-feed nil)
3132   (setq newsticker--auto-narrow-to-item value)
3133   (widen)
3134   (newsticker--buffer-make-item-completely-visible)
3135   (run-hooks 'newsticker-narrow-hook))
3136
3137 (defun newsticker-customize ()
3138   "Open the newsticker customization group."
3139   (interactive)
3140   (customize-group "newsticker"))
3141
3142 (defun newsticker-next-feed-available-p ()
3143   "Return t if position is before last feed, nil otherwise."
3144   (save-excursion
3145     (let ((p (point)))
3146       (newsticker--buffer-goto '(feed))
3147       (not (= p (point))))))
3148
3149 (defun newsticker-previous-feed-available-p ()
3150   "Return t if position is behind first feed, nil otherwise."
3151   (save-excursion
3152     (let ((p (point)))
3153       (newsticker--buffer-goto '(feed) nil t)
3154       (not (= p (point))))))
3155
3156 (defun newsticker-next-item-available-p ()
3157   "Return t if position is before last feed, nil otherwise."
3158   (save-excursion
3159     (catch 'result
3160       (while (< (point) (point-max))
3161         (unless (newsticker--buffer-goto '(item))
3162           (throw 'result nil))
3163         (unless (newsticker--lists-intersect-p
3164                  (get-text-property (point) 'invisible)
3165                  buffer-invisibility-spec)
3166           (throw 'result t))))))
3167
3168 (defun newsticker-previous-item-available-p ()
3169   "Return t if position is behind first item, nil otherwise."
3170   (save-excursion
3171     (catch 'result
3172       (while (> (point) (point-min))
3173         (unless (newsticker--buffer-goto '(item) nil t)
3174           (throw 'result nil))
3175         (unless (newsticker--lists-intersect-p
3176                  (get-text-property (point) 'invisible)
3177                  buffer-invisibility-spec)
3178           (throw 'result t))))))
3179
3180 (defun newsticker-item-not-old-p ()
3181   "Return t if there is an item at point which is not old, nil otherwise."
3182     (when (get-text-property (point) 'feed)
3183       (save-excursion
3184         (newsticker--buffer-beginning-of-item)
3185         (let ((age (get-text-property (point) 'nt-age)))
3186           (and (memq  age '(new immortal obsolete)) t)))))
3187
3188 (defun newsticker-item-not-immortal-p ()
3189   "Return t if there is an item at point which is not immortal, nil otherwise."
3190     (when (get-text-property (point) 'feed)
3191       (save-excursion
3192         (newsticker--buffer-beginning-of-item)
3193         (let ((age (get-text-property (point) 'nt-age)))
3194           (and (memq  age '(new old obsolete)) t)))))
3195
3196 ;; ======================================================================
3197 ;;; local stuff
3198 ;; ======================================================================
3199 (defun newsticker-get-news (feed-name)
3200   "Get news from the site FEED-NAME and load feed logo.
3201 FEED-NAME must be a string which occurs as the label (i.e. the first element)
3202 in an element of `newsticker-url-list' or `newsticker-url-list-defaults'."
3203   (newsticker--debug-msg "%s: Getting news for %s"
3204                          (format-time-string "%A, %H:%M" (current-time))
3205                          feed-name)
3206   (let* ((buffername (concat " *newsticker-wget-" feed-name "*"))
3207          (item (or (assoc feed-name newsticker-url-list)
3208                    (assoc feed-name newsticker-url-list-defaults)
3209                    (error
3210                     "Cannot get news for %s: Check newsticker-url-list"
3211                     feed-name)))
3212          (url (cadr item))
3213          (wget-arguments (or (car (cdr (cdr (cdr (cdr item)))))
3214                              newsticker-wget-arguments)))
3215     (save-excursion
3216       (set-buffer (get-buffer-create buffername))
3217       (erase-buffer)
3218       ;; throw an error if there is an old wget-process around
3219       (if (get-process feed-name)
3220           (error "Another wget-process is running for %s" feed-name))
3221       ;; start wget
3222       (let* ((args (append wget-arguments (list url)))
3223              (proc (apply 'start-process feed-name buffername
3224                           newsticker-wget-name args)))
3225         (set-process-coding-system proc 'no-conversion 'no-conversion)
3226         (set-process-sentinel proc 'newsticker--sentinel)
3227         (setq newsticker--process-ids (cons (process-id proc)
3228                                             newsticker--process-ids))
3229         (force-mode-line-update)))))
3230
3231 (defun newsticker-mouse-browse-url (event)
3232   "Call `browse-url' for the link of the item at which the EVENT occurred."
3233   (interactive "e")
3234   (save-excursion
3235     (switch-to-buffer (window-buffer (posn-window (event-end event))))
3236     (let ((url (get-text-property (posn-point (event-end event))
3237                                   'nt-link)))
3238       (when url
3239         (browse-url url)
3240         (save-excursion
3241           (goto-char (posn-point (event-end event)))
3242           (if newsticker-automatically-mark-visited-items-as-old
3243               (newsticker-mark-item-at-point-as-read t)))))))
3244
3245 (defun newsticker-browse-url ()
3246   "Call `browse-url' for the link of the item at point."
3247   (interactive)
3248   (let ((url (get-text-property (point) 'nt-link)))
3249     (when url
3250       (browse-url url)
3251       (if newsticker-automatically-mark-visited-items-as-old
3252           (newsticker-mark-item-at-point-as-read t)))))
3253
3254 (defvar newsticker-open-url-history
3255   '("wget" "xmms" "realplay")
3256   "...")
3257
3258 (defun newsticker-handle-url ()
3259   "Ask for a program to open the link of the item at point."
3260   (interactive)
3261   (let ((url (get-text-property (point) 'nt-link)))
3262     (when url
3263       (let ((prog (read-string "Open url with: " nil
3264                                'newsticker-open-url-history)))
3265         (when prog
3266           (message "%s %s" prog url)
3267           (start-process prog prog prog url)
3268       (if newsticker-automatically-mark-visited-items-as-old
3269           (newsticker-mark-item-at-point-as-read t)))))))
3270
3271 (defun newsticker--sentinel (process event)
3272   "Sentinel for extracting news titles from an RDF buffer.
3273 Argument PROCESS is the process which has just changed its state.
3274 Argument EVENT tells what has happened to the process."
3275   (let* ((p-status (process-status process))
3276          (exit-status (process-exit-status process))
3277          (time (current-time))
3278          (name (process-name process))
3279          (name-symbol (intern name))
3280          (something-was-added nil))
3281     ;; catch known errors (zombie processes, rubbish-xml etc.
3282     ;; if an error occurs the news feed is not updated!
3283     (catch 'oops
3284       (unless (and (eq p-status 'exit)
3285                    (= exit-status 0))
3286         (setq newsticker--cache
3287               (newsticker--cache-add
3288                newsticker--cache
3289                name-symbol
3290                newsticker--error-headline
3291                (format
3292                 (concat "%s: Newsticker could not retrieve news from %s.\n"
3293                         "Return status: `%s'\n"
3294                         "Command was `%s'")
3295                 (format-time-string "%A, %H:%M" (current-time))
3296                 name event (process-command process))
3297                ""
3298                (current-time)
3299                'new
3300                0 nil))
3301         (message "%s: Error while retrieving news from %s"
3302                  (format-time-string "%A, %H:%M" (current-time))
3303                  (process-name process))
3304         (throw 'oops nil))
3305       (let* ((coding-system 'utf-8)
3306              (node-list
3307               (save-current-buffer
3308                 (set-buffer (process-buffer process))
3309                 ;; a very very dirty workaround to overcome the
3310                 ;; problems with the newest (20030621) xml.el:
3311                 ;; remove all unnecessary whitespace
3312                 (goto-char (point-min))
3313                 (while (re-search-forward ">[ \t\r\n]+<" nil t)
3314                   (replace-match "><" nil t))
3315                 ;; and another brutal workaround (20031105)!  For some
3316                 ;; reason the xml parser does not like the colon in the
3317                 ;; doctype name "rdf:RDF"
3318                 (goto-char (point-min))
3319                 (if (re-search-forward "<!DOCTYPE[ \t\n]+rdf:RDF" nil t)
3320                   (replace-match "<!DOCTYPE rdfColonRDF" nil t))
3321                 ;; finally.... ~##^°!!!!!
3322                 (goto-char (point-min))
3323                 (while (search-forward "\r\n" nil t)
3324                   (replace-match "\n" nil t))
3325                 ;; still more brutal workarounds (20040309)!  The xml
3326                 ;; parser does not like doctype rss
3327                 (goto-char (point-min))
3328                 (if (re-search-forward "<!DOCTYPE[ \t\n]+rss[ \t\n]*>" nil t)
3329                   (replace-match "" nil t))
3330                 ;; And another one (20050618)! (Fixed in GNU Emacs 22.0.50.18)
3331                 ;; Remove comments to avoid this xml-parsing bug:
3332                 ;; "XML files can have only one toplevel tag"
3333                 (goto-char (point-min))
3334                 (while (search-forward "<!--" nil t)
3335                   (let ((start (match-beginning 0)))
3336                     (unless (search-forward "-->" nil t)
3337                       (error "Can't find end of comment"))
3338                     (delete-region start (point))))
3339                 ;; And another one (20050702)! If description is HTML
3340                 ;; encoded and starts with a `<', wrap the whole
3341                 ;; description in a CDATA expression.  This happened for
3342                 ;; http://www.thefreedictionary.com/_/WoD/rss.aspx?type=quote
3343                 (goto-char (point-min))
3344                 (while (re-search-forward
3345                         "<description>\\(<img.*?\\)</description>" nil t)
3346                   (replace-match
3347                    "<description><![CDATA[ \\1 ]]></description>"))
3348                 ;; And another one (20051123)! XML parser does not like this:
3349                 ;; <yweather:location city="Frankfurt/Main" region="" country="GM" />
3350                 ;; try to "fix" empty attributes
3351                 ;; This happened for
3352                 ;; http://xml.weather.yahoo.com/forecastrss?p=GMXX0040&u=f
3353                 (goto-char (point-min))
3354                 (while (re-search-forward "\\(<[^>]*\\)=\"\"" nil t)
3355                   (replace-match "\\1=\" \""))
3356                 ;;
3357                 (set-buffer-modified-p nil)
3358                 ;; check coding system
3359                 (goto-char (point-min))
3360                 (if (re-search-forward "encoding=\"\\([^\"]+\\)\""
3361                                        nil t)
3362                     (setq coding-system (intern (downcase (match-string 1))))
3363                   (setq coding-system
3364                         (condition-case nil
3365                               (check-coding-system coding-system)
3366                           (coding-system-error
3367                            (message
3368                             "newsticker.el: ignoring coding system %s for %s"
3369                             coding-system name)
3370                            nil))))
3371                 ;; Decode if possible
3372                 (when coding-system
3373                   (decode-coding-region (point-min) (point-max)
3374                                         coding-system))
3375                 (condition-case errordata
3376                     ;; The xml parser might fail
3377                     ;; or the xml might be bugged
3378                     (xml-parse-region (point-min) (point-max))
3379                   (error (message "Could not parse %s: %s"
3380                                   (buffer-name) (cadr errordata))
3381                          (throw 'oops nil)))))
3382              (topnode (car node-list))
3383              (channelnode (car (xml-get-children topnode 'channel)))
3384              (imageurl nil))
3385         ;; mark all items as obsolete
3386         (newsticker--cache-replace-age newsticker--cache
3387                                        name-symbol
3388                                        'new 'obsolete-new)
3389         (newsticker--cache-replace-age newsticker--cache
3390                                        name-symbol
3391                                        'old 'obsolete-old)
3392         (newsticker--cache-replace-age newsticker--cache
3393                                        name-symbol
3394                                        'feed 'obsolete-old)
3395
3396         ;; check Atom/RSS version and call corresponding parser
3397         (condition-case error-data
3398             (if (cond
3399                  ;; RSS 0.91
3400                  ((and (eq 'rss (xml-node-name topnode))
3401                        (string= "0.91" (xml-get-attribute topnode 'version)))
3402                   (setq imageurl (newsticker--get-logo-url-rss-0.91 topnode))
3403                   (newsticker--parse-rss-0.91 name time topnode))
3404                  ;; RSS 0.92
3405                  ((and (eq 'rss (xml-node-name topnode))
3406                        (string= "0.92" (xml-get-attribute topnode 'version)))
3407                   (setq imageurl (newsticker--get-logo-url-rss-0.92 topnode))
3408                   (newsticker--parse-rss-0.92 name time topnode))
3409                  ;; RSS 1.0
3410                  ((eq 'rdf:RDF (xml-node-name topnode))
3411                   (setq imageurl (newsticker--get-logo-url-rss-1.0 topnode))
3412                   (newsticker--parse-rss-1.0 name time topnode))
3413                  ;; RSS 2.0
3414                  ((and (eq 'rss (xml-node-name topnode))
3415                        (string= "2.0" (xml-get-attribute topnode 'version)))
3416                   (setq imageurl (newsticker--get-logo-url-rss-2.0 topnode))
3417                   (newsticker--parse-rss-2.0 name time topnode))
3418                  ;; Atom 0.3
3419                  ((and (eq 'feed (xml-node-name topnode))
3420                        (string= "http://purl.org/atom/ns#"
3421                                 (xml-get-attribute topnode 'xmlns)))
3422                   (setq imageurl (newsticker--get-logo-url-atom-0.3 topnode))
3423                   (newsticker--parse-atom-0.3 name time topnode))
3424                  ;; Atom 1.0
3425                  ((and (eq 'feed (xml-node-name topnode))
3426                        (string= "http://www.w3.org/2005/Atom"
3427                                 (xml-get-attribute topnode 'xmlns)))
3428                   (setq imageurl (newsticker--get-logo-url-atom-1.0 topnode))
3429                   (newsticker--parse-atom-1.0 name time topnode))
3430                  ;; unknown feed type
3431                  (t
3432                   (newsticker--debug-msg "Feed type unknown: %s: %s"
3433                                          (xml-node-name topnode) name)
3434                   nil))
3435                 (setq something-was-added t))
3436           (xerror (message "sentinelerror in %s: %s" name error-data)))
3437
3438         ;; Remove those old items from cache which have been removed from
3439         ;; the feed
3440         (newsticker--cache-replace-age newsticker--cache
3441                                        name-symbol 'obsolete-old 'deleteme)
3442         (newsticker--cache-remove newsticker--cache name-symbol
3443                                   'deleteme)
3444         ;; Remove those new items from cache which have been removed from
3445         ;; the feed.  Or keep them as `obsolete'
3446         (if (not newsticker-keep-obsolete-items)
3447             (newsticker--cache-remove newsticker--cache
3448                                       name-symbol 'obsolete-new)
3449           (setq newsticker--cache
3450                 (newsticker--cache-mark-expired
3451                  newsticker--cache name-symbol 'obsolete 'obsolete-expired
3452                  newsticker-obsolete-item-max-age))
3453           (newsticker--cache-remove newsticker--cache
3454                                     name-symbol 'obsolete-expired)
3455           (newsticker--cache-replace-age newsticker--cache
3456                                          name-symbol 'obsolete-new
3457                                          'obsolete))
3458         (newsticker--update-process-ids)
3459         ;; setup scrollable text
3460         (when (= 0 (length newsticker--process-ids))
3461           (newsticker--ticker-text-setup))
3462         (setq newsticker--latest-update-time (current-time))
3463         (when something-was-added
3464           ;; FIXME: should we care about removed items as well?
3465           (newsticker--cache-update)
3466           (newsticker--buffer-set-uptodate nil))
3467         ;; kill the process buffer if wanted
3468         (unless newsticker-debug
3469           (kill-buffer (process-buffer process)))
3470         ;; launch retrieval of image
3471         (when (and imageurl
3472                    (string-match "%l" newsticker-heading-format))
3473           (newsticker--image-get name imageurl))))))
3474
3475 (defun newsticker--get-logo-url-atom-1.0 (node)
3476   "Return logo URL from atom 1.0 data in NODE."
3477   (car (xml-node-children
3478         (car (xml-get-children node 'logo)))))
3479
3480 (defun newsticker--get-logo-url-atom-0.3 (node)
3481   "Return logo URL from atom 0.3 data in NODE."
3482   (car (xml-node-children
3483         (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
3484
3485 (defun newsticker--get-logo-url-rss-2.0 (node)
3486   "Return logo URL from RSS 2.0 data in NODE."
3487   (car (xml-node-children
3488         (car (xml-get-children
3489               (car (xml-get-children
3490                     (car (xml-get-children node 'channel)) 'image)) 'url)))))
3491
3492 (defun newsticker--get-logo-url-rss-1.0 (node)
3493   "Return logo URL from RSS 1.0 data in NODE."
3494   (car (xml-node-children
3495         (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
3496
3497 (defun newsticker--get-logo-url-rss-0.92 (node)
3498   "Return logo URL from RSS 0.92 data in NODE."
3499   (car (xml-node-children
3500         (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
3501
3502 (defun newsticker--get-logo-url-rss-0.91 (node)
3503   "Return logo URL from RSS 0.91 data in NODE."
3504   (car (xml-node-children
3505         (car (xml-get-children (car (xml-get-children node 'image)) 'url)))))
3506
3507 (defun newsticker--parse-atom-0.3 (name time topnode)
3508   "Parse Atom 0.3 data.
3509 Return value as well as arguments NAME, TIME, and TOPNODE are the
3510 same as in `newsticker--parse-atom-1.0'."
3511   (newsticker--debug-msg "Parsing Atom 0.3 feed %s" name)
3512   (let (new-feed new-item)
3513     (setq new-feed (newsticker--parse-generic-feed
3514                     name time
3515                     ;; title
3516                     (car (xml-node-children
3517                           (car (xml-get-children topnode 'title))))
3518                     ;; desc
3519                     (car (xml-node-children
3520                           (car (xml-get-children topnode 'content))))
3521                     ;; link
3522                     (xml-get-attribute
3523                      (car (xml-get-children topnode 'link)) 'href)
3524                     ;; extra-elements
3525                     (xml-node-children topnode)))
3526     (setq new-item (newsticker--parse-generic-items
3527                     name time (xml-get-children topnode 'entry)
3528                     ;; title-fn
3529                     (lambda (node)
3530                       (car (xml-node-children
3531                             (car (xml-get-children node 'title)))))
3532                     ;; desc-fn
3533                     (lambda (node)
3534                       (or (car (xml-node-children
3535                                 (car (xml-get-children node 'content))))
3536                           (car (xml-node-children
3537                                 (car (xml-get-children node 'summary))))))
3538                     ;; link-fn
3539                     (lambda (node)
3540                       (xml-get-attribute
3541                        (car (xml-get-children node 'link)) 'href))
3542                     ;; time-fn
3543                     (lambda (node)
3544                       (newsticker--decode-rfc822-date
3545                             (car (xml-node-children
3546                                   (car (xml-get-children node 'modified))))))
3547                     ;; guid-fn
3548                     (lambda (node)
3549                       (let ((tguid (assoc 'guid (xml-node-children node))))
3550                         (if (stringp tguid)
3551                             tguid
3552                           (car (xml-node-children tguid)))))
3553                     ;; extra-fn
3554                     (lambda (node)
3555                       (xml-node-children node))))
3556     (or new-item new-feed)))
3557
3558 (defun newsticker--parse-atom-1.0 (name time topnode)
3559   "Parse Atom 1.0 data.
3560 Argument NAME gives the name of a news feed.  TIME gives the
3561 system time at which the data have been retrieved.  TOPNODE
3562 contains the feed data as returned by the xml parser.
3563
3564 For the Atom 1.0 specification see
3565 http://www.atompub.org/2005/08/17/draft-ietf-atompub-format-11.html"
3566   (newsticker--debug-msg "Parsing Atom 1.0 feed %s" name)
3567   (let (new-feed new-item)
3568     (setq new-feed (newsticker--parse-generic-feed
3569                     name time
3570                     ;; title
3571                     (car (xml-node-children
3572                           (car (xml-get-children topnode 'title))))
3573                     ;; desc
3574                     (car (xml-node-children
3575                           (car (xml-get-children topnode 'subtitle))))
3576                     ;; link
3577                     (car (xml-node-children
3578                           (car (xml-get-children topnode 'link))))
3579                     ;; extra-elements
3580                     (xml-node-children topnode)))
3581     (setq new-item (newsticker--parse-generic-items
3582                     name time (xml-get-children topnode 'entry)
3583                     ;; title-fn
3584                     (lambda (node)
3585                       (car (xml-node-children
3586                             (car (xml-get-children node 'title)))))
3587                     ;; desc-fn
3588                     (lambda (node)
3589                       (or (car (xml-node-children
3590                                 (car (xml-get-children node 'content))))
3591                           (car (xml-node-children
3592                                 (car (xml-get-children node 'summary))))))
3593                     ;; link-fn
3594                     (lambda (node)
3595                       (car (xml-node-children
3596                             (car (xml-get-children node 'link)))))
3597                     ;; time-fn
3598                     (lambda (node)
3599                       (newsticker--decode-iso8601-date
3600                        (or (car (xml-node-children
3601                                  (car (xml-get-children node 'updated))))
3602                            (car (xml-node-children
3603                                  (car (xml-get-children node 'published)))))))
3604                     ;; guid-fn
3605                     (lambda (node)
3606                       (car (xml-node-children
3607                             (car (xml-get-children node 'id)))))
3608                     ;; extra-fn
3609                     (lambda (node)
3610                       (xml-node-children node))))
3611     (or new-item new-feed)))
3612
3613 (defun newsticker--parse-rss-0.91 (name time topnode)
3614   "Parse RSS 0.91 data.
3615 Return value as well as arguments NAME, TIME, and TOPNODE are the
3616 same as in `newsticker--parse-atom-1.0'.
3617
3618 For the RSS 0.91 specification see http://backend.userland.com/rss091 or
3619 http://my.netscape.com/publish/formats/rss-spec-0.91.html."
3620   (newsticker--debug-msg "Parsing RSS 0.91 feed %s" name)
3621   (let* ((channelnode (car (xml-get-children topnode 'channel)))
3622          (pub-date (newsticker--decode-rfc822-date
3623                     (car (xml-node-children
3624                           (car (xml-get-children channelnode 'pubDate))))))
3625          is-new-feed has-new-items)
3626     (setq is-new-feed (newsticker--parse-generic-feed
3627                        name time
3628                        ;; title
3629                        (car (xml-node-children
3630                              (car (xml-get-children channelnode 'title))))
3631                        ;; desc
3632                        (car (xml-node-children
3633                              (car (xml-get-children channelnode
3634                                                     'description))))
3635                        ;; link
3636                        (car (xml-node-children
3637                              (car (xml-get-children channelnode 'link))))
3638                        ;; extra-elements
3639                        (xml-node-children channelnode)))
3640     (setq has-new-items (newsticker--parse-generic-items
3641                          name time (xml-get-children channelnode 'item)
3642                          ;; title-fn
3643                          (lambda (node)
3644                            (car (xml-node-children
3645                                  (car (xml-get-children node 'title)))))
3646                          ;; desc-fn
3647                          (lambda (node)
3648                            (car (xml-node-children
3649                                  (car (xml-get-children node 'description)))))
3650                          ;; link-fn
3651                          (lambda (node)
3652                            (car (xml-node-children
3653                                  (car (xml-get-children node 'link)))))
3654                          ;; time-fn
3655                          (lambda (node)
3656                            pub-date)
3657                          ;; guid-fn
3658                          (lambda (node)
3659                            nil)
3660                          ;; extra-fn
3661                          (lambda (node)
3662                            (xml-node-children node))))
3663     (or has-new-items is-new-feed)))
3664
3665 (defun newsticker--parse-rss-0.92 (name time topnode)
3666   "Parse RSS 0.92 data.
3667 Return value as well as arguments NAME, TIME, and TOPNODE are the
3668 same as in `newsticker--parse-atom-1.0'.
3669
3670 For the RSS 0.92 specification see http://backend.userland.com/rss092."
3671   (newsticker--debug-msg "Parsing RSS 0.92 feed %s" name)
3672   (let* ((channelnode (car (xml-get-children topnode 'channel)))
3673          (pub-date (newsticker--decode-rfc822-date
3674                     (car (xml-node-children
3675                           (car (xml-get-children channelnode 'pubDate))))))
3676          is-new-feed has-new-items)
3677     (setq is-new-feed (newsticker--parse-generic-feed
3678                        name time
3679                        ;; title
3680                        (car (xml-node-children
3681                              (car (xml-get-children channelnode 'title))))
3682                        ;; desc
3683                        (car (xml-node-children
3684                              (car (xml-get-children channelnode
3685                                                     'description))))
3686                        ;; link
3687                        (car (xml-node-children
3688                              (car (xml-get-children channelnode 'link))))
3689                        ;; extra-elements
3690                        (xml-node-children channelnode)))
3691     (setq has-new-items (newsticker--parse-generic-items
3692                          name time (xml-get-children channelnode 'item)
3693                          ;; title-fn
3694                          (lambda (node)
3695                            (car (xml-node-children
3696                                  (car (xml-get-children node 'title)))))
3697                          ;; desc-fn
3698                          (lambda (node)
3699                            (car (xml-node-children
3700                                  (car (xml-get-children node 'description)))))
3701                          ;; link-fn
3702                          (lambda (node)
3703                            (car (xml-node-children
3704                                  (car (xml-get-children node 'link)))))
3705                          ;; time-fn
3706                          (lambda (node)
3707                            pub-date)
3708                          ;; guid-fn
3709                          (lambda (node)
3710                            nil)
3711                          ;; extra-fn
3712                          (lambda (node)
3713                            (xml-node-children node))))
3714     (or has-new-items is-new-feed)))
3715
3716 (defun newsticker--parse-rss-1.0 (name time topnode)
3717   "Parse RSS 1.0 data.
3718 Return value as well as arguments NAME, TIME, and TOPNODE are the
3719 same as in `newsticker--parse-atom-1.0'.
3720
3721 For the RSS 1.0 specification see http://web.resource.org/rss/1.0/spec."
3722   (newsticker--debug-msg "Parsing RSS 1.0 feed %s" name)
3723   (let* ((channelnode (car (xml-get-children topnode 'channel)))
3724          is-new-feed has-new-items)
3725     (setq is-new-feed (newsticker--parse-generic-feed
3726                        name time
3727                        ;; title
3728                        (car (xml-node-children
3729                              (car (xml-get-children channelnode 'title))))
3730                        ;; desc
3731                        (car (xml-node-children
3732                              (car (xml-get-children channelnode
3733                                                     'description))))
3734                        ;; link
3735                        (car (xml-node-children
3736                              (car (xml-get-children channelnode 'link))))
3737                        ;; extra-elements
3738                        (xml-node-children channelnode)))
3739     (setq has-new-items (newsticker--parse-generic-items
3740                          name time (xml-get-children topnode 'item)
3741                          ;; title-fn
3742                          (lambda (node)
3743                            (car (xml-node-children
3744                                  (car (xml-get-children node 'title)))))
3745                          ;; desc-fn
3746                          (lambda (node)
3747                            (car (xml-node-children
3748                                  (car (xml-get-children node
3749                                                         'description)))))
3750                          ;; link-fn
3751                          (lambda (node)
3752                            (car (xml-node-children
3753                                  (car (xml-get-children node 'link)))))
3754                          ;; time-fn
3755                          (lambda (node)
3756                            (newsticker--decode-iso8601-date
3757                             (car (xml-node-children
3758                                   (car (xml-get-children node 'dc:date))))))
3759                          ;; guid-fn
3760                          (lambda (node)
3761                            nil)
3762                          ;; extra-fn
3763                          (lambda (node)
3764                            (xml-node-children node))))
3765     (or has-new-items is-new-feed)))
3766
3767 (defun newsticker--parse-rss-2.0 (name time topnode)
3768   "Parse RSS 2.0 data.
3769 Return value as well as arguments NAME, TIME, and TOPNODE are the
3770 same as in `newsticker--parse-atom-1.0'.
3771
3772 For the RSS 2.0 specification see http://blogs.law.harvard.edu/tech/rss."
3773   (newsticker--debug-msg "Parsing RSS 2.0 feed %s" name)
3774   (let* ((channelnode (car (xml-get-children topnode 'channel)))
3775          is-new-feed has-new-items)
3776     (setq is-new-feed (newsticker--parse-generic-feed
3777                        name time
3778                        ;; title
3779                        (car (xml-node-children
3780                              (car (xml-get-children channelnode 'title))))
3781                        ;; desc
3782                        (car (xml-node-children
3783                              (car (xml-get-children channelnode
3784                                                     'description))))
3785                        ;; link
3786                        (car (xml-node-children
3787                              (car (xml-get-children channelnode 'link))))
3788                        ;; extra-elements
3789                        (xml-node-children channelnode)))
3790     (setq has-new-items (newsticker--parse-generic-items
3791                          name time (xml-get-children channelnode 'item)
3792                          ;; title-fn
3793                          (lambda (node)
3794                            (car (xml-node-children
3795                                  (car (xml-get-children node 'title)))))
3796                          ;; desc-fn
3797                          (lambda (node)
3798                            (or (car (xml-node-children
3799                                      (car (xml-get-children node
3800                                                             'content:encoded))))
3801                                (car (xml-node-children
3802                                      (car (xml-get-children node
3803                                                             'description))))))
3804                          ;; link-fn
3805                          (lambda (node)
3806                            (car (xml-node-children
3807                                  (car (xml-get-children node 'link)))))
3808                          ;; time-fn
3809                          (lambda (node)
3810                            (newsticker--decode-rfc822-date
3811                             (car (xml-node-children
3812                                   (car (xml-get-children node 'pubDate))))))
3813                          ;; guid-fn
3814                          (lambda (node)
3815                            (let* ((tguid (assoc 'guid
3816                                                 (xml-node-children node))))
3817                              (if (stringp tguid)
3818                                  tguid
3819                                (car (xml-node-children tguid)))))
3820                          ;; extra-fn
3821                          (lambda (node)
3822                            (xml-node-children node))))
3823     (or has-new-items is-new-feed)))
3824
3825 (defun newsticker--parse-generic-feed (name time title desc link
3826                                             extra-elements)
3827   "Parse generic news feed data.
3828 Argument NAME gives the name of a news feed.  TIME gives the
3829 system time at which the data have been retrieved.
3830
3831 The arguments TITLE, DESC, LINK, and EXTRA-ELEMENTS give the feed's title,
3832 description, link, and extra elements resp."
3833   (let ((title (or title "[untitled]"))
3834         (link (or link ""))
3835         (old-item nil)
3836         (position 0)
3837         (something-was-added nil))
3838     ;; decode numeric entities
3839     (setq title (newsticker--decode-numeric-entities title))
3840     (setq desc  (newsticker--decode-numeric-entities desc))
3841     (setq link  (newsticker--decode-numeric-entities link))
3842     ;; remove whitespace from title, desc, and link
3843     (setq title (newsticker--remove-whitespace title))
3844     (setq desc (newsticker--remove-whitespace desc))
3845     (setq link (newsticker--remove-whitespace link))
3846
3847     ;; handle the feed itself
3848     (unless (newsticker--cache-contains newsticker--cache
3849                                         (intern name) title
3850                                         desc link 'feed)
3851       (setq something-was-added t))
3852     (setq newsticker--cache
3853           (newsticker--cache-add newsticker--cache (intern name)
3854                                  title desc link time 'feed position
3855                                  extra-elements 'feed time))
3856     something-was-added))
3857
3858 (defun newsticker--parse-generic-items (name time itemlist
3859                                              title-fn desc-fn
3860                                              link-fn time-fn
3861                                              guid-fn extra-fn)
3862   "Parse generic news feed data.
3863 Argument NAME gives the name of a news feed.  TIME gives the
3864 system time at which the data have been retrieved.  ITEMLIST
3865 contains the news items returned by the xml parser.
3866
3867 The arguments TITLE-FN, DESC-FN, LINK-FN, TIME-FN, GUID-FN, and
3868 EXTRA-FN give functions for extracting title, description, link,
3869 time, guid, and extra-elements resp.  They are called with one
3870 argument, which is one of the items in ITEMLIST."
3871   (let (title desc link
3872         (old-item nil)
3873         (position 0)
3874         (something-was-added nil))
3875     ;; gather all items for this feed
3876     (mapc (lambda (node)
3877             (setq position (1+ position))
3878             (setq title (or (funcall title-fn node) "[untitled]"))
3879             (setq desc (funcall desc-fn node))
3880             (setq link (or (funcall link-fn node) ""))
3881             (setq time (or (funcall time-fn node) time))
3882             ;; It happened that the title or description
3883             ;; contained evil HTML code that confused the
3884             ;; xml parser.  Therefore:
3885             (unless (stringp title)
3886               (setq title (prin1-to-string title)))
3887             (unless (or (stringp desc) (not desc))
3888               (setq desc (prin1-to-string desc)))
3889             ;; ignore items with empty title AND empty desc
3890             (when (or (> (length title) 0)
3891                       (> (length desc) 0))
3892               ;; decode numeric entities
3893               (setq title (newsticker--decode-numeric-entities title))
3894               (when desc
3895                 (setq desc  (newsticker--decode-numeric-entities desc)))
3896               (setq link (newsticker--decode-numeric-entities link))
3897               ;; remove whitespace from title, desc, and link
3898               (setq title (newsticker--remove-whitespace title))
3899               (setq desc (newsticker--remove-whitespace desc))
3900               (setq link (newsticker--remove-whitespace link))
3901               ;; add data to cache
3902               ;; do we have this item already?
3903               (let* ((guid (funcall guid-fn node)))
3904                 ;;(message "guid=%s" guid)
3905                 (setq old-item
3906                       (newsticker--cache-contains newsticker--cache
3907                                                   (intern name) title
3908                                                   desc link nil guid)))
3909               ;; add this item, or mark it as old, or do nothing
3910               (let ((age1 'new)
3911                     (age2 'old)
3912                     (item-new-p nil))
3913                 (if old-item
3914                     (let ((prev-age (newsticker--age old-item)))
3915                       (unless
3916                           newsticker-automatically-mark-items-as-old
3917                         (if (eq prev-age 'obsolete-old)
3918                             (setq age2 'old)
3919                           (setq age2 'new)))
3920                       (if (eq prev-age 'immortal)
3921                           (setq age2 'immortal)))
3922                   ;; item was not there
3923                   (setq item-new-p t)
3924                   (setq something-was-added t))
3925                 (setq newsticker--cache
3926                       (newsticker--cache-add
3927                        newsticker--cache (intern name) title desc link
3928                        time age1 position (funcall extra-fn node)
3929                        age2))
3930                 (when item-new-p
3931                   (let ((item (newsticker--cache-contains
3932                                newsticker--cache (intern name) title
3933                                desc link nil)))
3934                     (if newsticker-auto-mark-filter-list
3935                         (newsticker--run-auto-mark-filter name item))
3936                     (run-hook-with-args
3937                      'newsticker-new-item-functions name item))))))
3938           itemlist)
3939     something-was-added))
3940
3941 (defun newsticker--display-tick ()
3942   "Called from the display timer.
3943 This function calls a display function, according to the variable
3944 `newsticker-scroll-smoothly'."
3945   (if newsticker-scroll-smoothly
3946       (newsticker--display-scroll)
3947     (newsticker--display-jump)))
3948
3949 (defsubst newsticker--echo-area-clean-p ()
3950   "Check whether somebody is using the echo area / minibuffer.
3951 Return t if echo area and minibuffer are unused."
3952   (not (or (active-minibuffer-window)
3953            (and (current-message)
3954                 (not (string= (current-message)
3955                               newsticker--prev-message))))))
3956
3957 (defun newsticker--display-jump ()
3958   "Called from the display timer.
3959 This function displays the next ticker item in the echo area, unless
3960 there is another message displayed or the minibuffer is active."
3961   (let ((message-log-max nil));; prevents message text from being logged
3962     (when (newsticker--echo-area-clean-p)
3963       (setq newsticker--item-position (1+ newsticker--item-position))
3964       (when (>= newsticker--item-position (length newsticker--item-list))
3965         (setq newsticker--item-position 0))
3966       (setq newsticker--prev-message
3967             (nth newsticker--item-position newsticker--item-list))
3968       (message "%s" newsticker--prev-message))))
3969
3970 (defun newsticker--display-scroll ()
3971   "Called from the display timer.
3972 This function scrolls the ticker items in the echo area, unless
3973 there is another message displayed or the minibuffer is active."
3974   (when (newsticker--echo-area-clean-p)
3975     (let* ((width (- (frame-width) 1))
3976            (message-log-max nil);; prevents message text from being logged
3977            (i newsticker--item-position)
3978            subtext
3979            (s-text newsticker--scrollable-text)
3980            (l (length s-text)))
3981       ;; don't show anything if there is nothing to show
3982       (unless (< (length s-text) 1)
3983         ;; repeat the ticker string if it is shorter than frame width
3984         (while (< (length s-text) width)
3985           (setq s-text (concat s-text s-text)))
3986         ;; get the width of the printed string
3987         (setq l (length s-text))
3988         (cond ((< i (- l width))
3989                (setq subtext (substring s-text i (+ i width))))
3990               (t
3991                (setq subtext (concat
3992                               (substring s-text i l)
3993                               (substring s-text 0 (- width (- l i)))))))
3994         ;; Take care of multibyte strings, for which (string-width) is
3995         ;; larger than (length).
3996         ;; Actually, such strings may be smaller than (frame-width)
3997         ;; because return values of (string-width) are too large:
3998         ;; (string-width "<japanese character>") => 2
3999         (let ((t-width (1- (length subtext))))
4000           (while (> (string-width subtext) width)
4001             (setq subtext (substring subtext 0 t-width))
4002             (setq t-width (1- t-width))))
4003         ;; show the ticker text and save current position
4004         (message "%s" subtext)
4005         (setq newsticker--prev-message subtext)
4006         (setq newsticker--item-position (1+ i))
4007         (when (>= newsticker--item-position l)
4008           (setq newsticker--item-position 0))))))
4009
4010 ;; ======================================================================
4011 ;;; misc
4012 ;; ======================================================================
4013 (defun newsticker--decode-numeric-entities (string)
4014   "Decode SGML numeric entities by their respective utf characters.
4015 This function replaces numeric entities in the input STRING and
4016 returns the modified string.  For example \"&#42;\" gets replaced
4017 by \"*\"."
4018   (if (and string (stringp string))
4019       (let ((start 0))
4020         (while (string-match "&#\\([0-9]+\\);" string start)
4021           (condition-case nil
4022               (setq string (replace-match
4023                             (string (read (substring string
4024                                                      (match-beginning 1)
4025                                                      (match-end 1))))
4026                             nil nil string))
4027             (error nil))
4028           (setq start (1+ (match-beginning 0))))
4029         string)
4030     nil))
4031
4032 (defun newsticker--remove-whitespace (string)
4033   "Remove leading and trailing whitespace from STRING."
4034   ;; we must have ...+ but not ...* in the regexps otherwise xemacs loops
4035   ;; endlessly...
4036   (when (and string (stringp string))
4037     (replace-regexp-in-string
4038      "[ \t\r\n]+$" ""
4039      (replace-regexp-in-string "^[ \t\r\n]+" "" string))))
4040
4041 (defun newsticker--do-forget-preformatted (item)
4042   "Forget pre-formatted data for ITEM.
4043 Remove the pre-formatted from `newsticker--cache'."
4044   (if (nthcdr 7 item)
4045       (setcar (nthcdr 7 item) nil))
4046   (if (nthcdr 6 item)
4047       (setcar (nthcdr 6 item) nil)))
4048
4049 (defun newsticker--forget-preformatted ()
4050   "Forget all cached pre-formatted data.
4051 Remove the pre-formatted from `newsticker--cache'."
4052   (mapc (lambda (feed)
4053           (mapc 'newsticker--do-forget-preformatted
4054                 (cdr feed)))
4055         newsticker--cache)
4056   (newsticker--buffer-set-uptodate nil))
4057
4058 (defun newsticker--debug-msg (string &rest args)
4059   "Print newsticker debug messages.
4060 This function calls `message' with arguments STRING and ARGS, if
4061 `newsticker-debug' is non-nil."
4062   (and newsticker-debug
4063        ;;(not (active-minibuffer-window))
4064        ;;(not (current-message))
4065        (apply 'message string args)))
4066
4067 (defun newsticker--decode-iso8601-date (iso8601-string)
4068   "Return ISO8601-STRING in format like `decode-time'.
4069 Converts from ISO-8601 to Emacs representation.
4070 Examples:
4071 2004-09-17T05:09:49+00:00
4072 2004-09-17T05:09+00:00
4073 2004-09-17T05:09:49
4074 2004-09-17T05:09
4075 2004-09-17
4076 2004-09
4077 2004"
4078   (if iso8601-string
4079       (when (string-match
4080              (concat
4081               "^ *\\([0-9]\\{4\\}\\)"
4082               "\\(-\\([0-9]\\{2\\}\\)"
4083               "\\(-\\([0-9]\\{2\\}\\)"
4084               "\\(T"
4085               "\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)"
4086               "\\(:\\([0-9]\\{2\\}\\)\\)?"
4087               "\\(\\([-+Z]\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)?"
4088               "\\)?\\)?\\)? *$")
4089              iso8601-string)
4090         (let ((year (read (match-string 1 iso8601-string)))
4091               (month (read (or (match-string 3 iso8601-string)
4092                                "1")))
4093               (day (read (or (match-string 5 iso8601-string)
4094                              "1")))
4095               (hour (read (or (match-string 7 iso8601-string)
4096                               "0")))
4097               (minute (read (or (match-string 8 iso8601-string)
4098                                 "0")))
4099               ;;(second (read (or (match-string 10 iso8601-string)
4100               ;; "0")))
4101               (sign (match-string 12 iso8601-string))
4102               (offset-hour (read (or (match-string 14 iso8601-string)
4103                                      "0")))
4104               (offset-minute (read (or (match-string 15 iso8601-string)
4105                                        "0")))
4106               (second 0))
4107           (cond ((string= sign "+")
4108                  (setq hour (- hour offset-hour))
4109                  (setq minute (- minute offset-minute)))
4110                 ((string= sign "-")
4111                  (setq hour (+ hour offset-hour))
4112                  (setq minute (+ minute offset-minute))))
4113           ;; if UTC subtract current-time-zone offset
4114           ;;(setq second (+ (car (current-time-zone)) second)))
4115
4116           (condition-case nil
4117               (encode-time second minute hour day month year t)
4118             (error
4119              (message "Cannot decode \"%s\"" iso8601-string)
4120              nil))))
4121     nil))
4122
4123 (defun newsticker--decode-rfc822-date (rfc822-string)
4124   "Return RFC822-STRING in format like `decode-time'.
4125 Converts from RFC822 to Emacs representation.
4126 Examples:
4127 Sat, 07 Sep 2002 00:00:01 GMT
4128 07 Sep 2002 00:00:01 GMT
4129 07 Sep 2002"
4130   (if (and rfc822-string (stringp rfc822-string))
4131       (when (string-match
4132              (concat
4133               "\\s-*"
4134               ;; week day
4135               "\\(\\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\)\\s-*,?\\)?\\s-*"
4136               ;; day
4137               "\\([0-9]\\{1,2\\}\\)\\s-+"
4138               ;; month
4139               "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|"
4140               "Sep\\|Oct\\|Nov\\|Dec\\)\\s-+"
4141               ;; year
4142               "\\([0-9]\\{2,4\\}\\)"
4143               ;; time may be missing
4144               "\\(\\s-+"
4145               ;; hour
4146               "\\([0-9]\\{2\\}\\)"
4147               ;; minute
4148               ":\\([0-9]\\{2\\}\\)"
4149               ;; second
4150               "\\(:\\([0-9]\\{2\\}\\)\\)?"
4151               ;; zone -- fixme
4152               "\\(\\s-+.*\\)?"
4153               "\\)?")
4154              rfc822-string)
4155         (let ((day (read (match-string 3 rfc822-string)))
4156               (month-name (match-string 4 rfc822-string))
4157               (month 0)
4158               (year (read (match-string 5 rfc822-string)))
4159               (hour (read (or (match-string 7 rfc822-string) "0")))
4160               (minute (read (or (match-string 8 rfc822-string) "0")))
4161               (second (read (or (match-string 10 rfc822-string) "0")))
4162               ;;(zone (match-string 11 rfc822-string))
4163               )
4164           (condition-case error-data
4165               (let ((i 1))
4166                 (mapc (lambda (m)
4167                         (if (string= month-name m)
4168                             (setq month i))
4169                         (setq i (1+ i)))
4170                       '("Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug"
4171                         "Sep" "Oct" "Nov" "Dec"))
4172                 (encode-time second minute hour day month year t))
4173             (error
4174              (message "Cannot decode \"%s\": %s %s" rfc822-string
4175                       (car error-data) (cdr error-data))
4176              nil))))
4177       nil))
4178
4179 (defun newsticker--lists-intersect-p (list1 list2)
4180   "Return t if LIST1 and LIST2 share elements."
4181   (let ((result nil))
4182     (mapc (lambda (elt)
4183             (if (memq elt list2)
4184                 (setq result t)))
4185           list1)
4186     result))
4187
4188 (defun newsticker--update-process-ids ()
4189   "Update list of ids of active newsticker processes.
4190 Checks list of active processes against list of newsticker processes."
4191   (let ((active-procs (process-list))
4192         (new-list nil))
4193     (mapc (lambda (proc)
4194             (let ((id (process-id proc)))
4195               (if (memq id newsticker--process-ids)
4196                   (setq new-list (cons id new-list)))))
4197           active-procs)
4198     (setq newsticker--process-ids new-list))
4199   (force-mode-line-update))
4200
4201 ;; ======================================================================
4202 ;;; images
4203 ;; ======================================================================
4204 (defun newsticker--image-get (feed-name url)
4205   "Get image of the news site FEED-NAME from URL.
4206 If the image has been downloaded in the last 24h do nothing."
4207   (let ((image-name (concat newsticker-imagecache-dirname "/"
4208                             feed-name)))
4209     (if (and (file-exists-p image-name)
4210              (time-less-p (current-time)
4211                           (time-add (nth 5 (file-attributes image-name))
4212                                     (seconds-to-time 86400))))
4213         (newsticker--debug-msg "%s: Getting image for %s skipped"
4214                                (format-time-string "%A, %H:%M" (current-time))
4215                                feed-name)
4216       ;; download
4217       (newsticker--debug-msg "%s: Getting image for %s"
4218                              (format-time-string "%A, %H:%M" (current-time))
4219                              feed-name)
4220       (let* ((buffername (concat " *newsticker-wget-image-" feed-name "*"))
4221              (item (or (assoc feed-name newsticker-url-list)
4222                        (assoc feed-name newsticker-url-list-defaults)
4223                        (error
4224                         "Cannot get news for %s: Check newsticker-url-list"
4225                         feed-name)))
4226              (wget-arguments (or (car (cdr (cdr (cdr (cdr item)))))
4227                                  newsticker-wget-arguments)))
4228         (save-excursion
4229           (set-buffer (get-buffer-create buffername))
4230           (erase-buffer)
4231           ;; throw an error if there is an old wget-process around
4232           (if (get-process feed-name)
4233               (error "Another wget-process is running for image %s"
4234                      feed-name))
4235           ;; start wget
4236           (let* ((args (append wget-arguments (list url)))
4237                  (proc (apply 'start-process feed-name buffername
4238                               newsticker-wget-name args)))
4239             (set-process-coding-system proc 'no-conversion 'no-conversion)
4240             (set-process-sentinel proc 'newsticker--image-sentinel)))))))
4241
4242 (defun newsticker--image-sentinel (process event)
4243   "Sentinel for image-retrieving PROCESS caused by EVENT."
4244   (let* ((p-status (process-status process))
4245          (exit-status (process-exit-status process))
4246          (feed-name (process-name process)))
4247     ;; catch known errors (zombie processes, rubbish-xml, etc.)
4248     ;; if an error occurs the news feed is not updated!
4249     (catch 'oops
4250       (unless (and (eq p-status 'exit)
4251                    (= exit-status 0))
4252         (message "%s: Error while retrieving image from %s"
4253                  (format-time-string "%A, %H:%M" (current-time))
4254                  feed-name)
4255         (throw 'oops nil))
4256       (let (image-name)
4257         (save-excursion
4258           (set-buffer (process-buffer process))
4259           (setq image-name (concat newsticker-imagecache-dirname "/"
4260                                    feed-name))
4261           (set-buffer-file-coding-system 'no-conversion)
4262           ;; make sure the cache dir exists
4263           (unless (file-directory-p newsticker-imagecache-dirname)
4264             (make-directory newsticker-imagecache-dirname))
4265           ;; write and close buffer
4266           (let ((require-final-newline nil)
4267                 (backup-inhibited t)
4268                 (coding-system-for-write 'no-conversion))
4269             (write-region nil nil image-name nil 'quiet))
4270           (set-buffer-modified-p nil)
4271           (kill-buffer (current-buffer)))))))
4272
4273 (defun newsticker--image-read (feed-name-symbol disabled)
4274   "Read the cached image for FEED-NAME-SYMBOL from disk.
4275 If DISABLED is non-nil the image will be converted to a disabled look
4276 \(unless `newsticker-enable-logo-manipulations' is not t\).
4277 Return the image."
4278   (let ((image-name (concat newsticker-imagecache-dirname "/"
4279                             (symbol-name feed-name-symbol)))
4280         (img nil))
4281     (when (file-exists-p image-name)
4282       (condition-case error-data
4283           (setq img (create-image
4284                      image-name nil nil
4285                      :conversion (and newsticker-enable-logo-manipulations
4286                                       disabled
4287                                       'disabled)
4288                      :mask (and newsticker-enable-logo-manipulations
4289                                 'heuristic)
4290                      :ascent 70))
4291         (error
4292          (message "Error: cannot create image for %s: %s"
4293                   feed-name-symbol error-data))))
4294     img))
4295
4296 ;; ======================================================================
4297 ;;; imenu stuff
4298 ;; ======================================================================
4299 (defun newsticker--imenu-create-index ()
4300   "Scan newsticker buffer and return an index for imenu."
4301   (save-excursion
4302     (goto-char (point-min))
4303     (let ((index-alist nil)
4304           (feed-list nil)
4305           (go-ahead t))
4306       (while go-ahead
4307         (let ((type  (get-text-property (point) 'nt-type))
4308               (title (get-text-property (point) 'nt-title)))
4309           (cond ((eq type 'feed)
4310                  ;; we're on a feed heading
4311                  (when feed-list
4312                    (if index-alist
4313                        (nconc index-alist (list feed-list))
4314                      (setq index-alist (list feed-list))))
4315                  (setq feed-list (list title)))
4316                 (t
4317                  (nconc feed-list
4318                         (list (cons title (point)))))))
4319         (setq go-ahead (newsticker--buffer-goto '(item feed))))
4320       (if index-alist
4321           (nconc index-alist (list feed-list))
4322         (setq index-alist (list feed-list)))
4323       index-alist)))
4324
4325 (defun newsticker--imenu-goto (name pos &rest args)
4326   "Go to item NAME at position POS and show item.
4327 ARGS are ignored."
4328   (goto-char pos)
4329   ;; show headline
4330   (newsticker--buffer-goto '(desc extra feed item))
4331   (let* ((inhibit-read-only t)
4332          (pos1 (max (point-min) (1- pos)))
4333          (pos2 (max pos1 (1- (point))))
4334          (inv-prop (get-text-property pos 'invisible))
4335          (org-inv-prop (get-text-property pos 'org-invisible)))
4336     (when (eq org-inv-prop nil)
4337       (add-text-properties pos1 pos2 (list 'invisible nil
4338                                           'org-invisible inv-prop))))
4339   ;; show desc
4340   (newsticker-show-entry))
4341
4342 ;; ======================================================================
4343 ;;; buffer stuff
4344 ;; ======================================================================
4345 (defun newsticker--buffer-set-uptodate (value)
4346   "Set the uptodate-status of the newsticker buffer to VALUE.
4347 The mode-line is changed accordingly."
4348   (setq newsticker--buffer-uptodate-p value)
4349   (let ((b (get-buffer "*newsticker*")))
4350     (when b
4351       (save-excursion
4352        (set-buffer b)
4353        (if value
4354            (setq mode-name "Newsticker -- up to date -- ")
4355          (setq mode-name "Newsticker -- NEED UPDATE -- ")))
4356       (force-mode-line-update 0))))
4357
4358 (defun newsticker--buffer-redraw ()
4359   "Redraw the newsticker window."
4360   (if (fboundp 'force-window-update)
4361       (force-window-update (current-buffer))
4362     (redraw-frame (selected-frame)))
4363   (run-hooks 'newsticker-buffer-change-hook)
4364   (sit-for 0))
4365
4366 (defun newsticker--buffer-insert-all-items ()
4367   "Insert all cached newsticker items into the current buffer.
4368 Keeps order of feeds as given in `newsticker-url-list' and
4369 `newsticker-url-list-defaults'."
4370   (goto-char (point-min))
4371   (mapc (lambda (url-item)
4372           (let* ((feed-name (car url-item))
4373                  (feed-name-symbol (intern feed-name))
4374                  (feed (assoc feed-name-symbol newsticker--cache))
4375                  (items (cdr feed))
4376                  (pos (point)))
4377             (when feed
4378               ;; insert the feed description
4379               (mapc (lambda (item)
4380                       (when (eq (newsticker--age item) 'feed)
4381                         (newsticker--buffer-insert-item item
4382                                                         feed-name-symbol)))
4383                     items)
4384               ;;insert the items
4385               (mapc (lambda (item)
4386                       (if (memq (newsticker--age item) '(new immortal old
4387                                                              obsolete))
4388                           (newsticker--buffer-insert-item item
4389                                                           feed-name-symbol)))
4390                     items)
4391               (put-text-property pos (point) 'feed (car feed))
4392
4393               ;; insert empty line between feeds
4394               (let ((p (point)))
4395                 (insert "\n")
4396                 (put-text-property p (point) 'hard t)))))
4397         (append newsticker-url-list newsticker-url-list-defaults))
4398
4399   (newsticker--buffer-set-faces (point-min) (point-max))
4400   (newsticker--buffer-set-invisibility (point-min) (point-max))
4401   (goto-char (point-min)))
4402
4403 (defun newsticker--buffer-insert-item (item &optional feed-name-symbol)
4404   "Insert a news item in the current buffer.
4405 Insert a formatted representation of the ITEM.  The optional parameter
4406 FEED-NAME-SYMBOL determines how the item is formatted and whether the
4407 item-retrieval time is added as well."
4408   ;; insert headline
4409   (if (eq (newsticker--age item) 'feed)
4410       (newsticker--buffer-do-insert-text item 'feed feed-name-symbol)
4411     (newsticker--buffer-do-insert-text item 'item feed-name-symbol))
4412   ;; insert the description
4413   (newsticker--buffer-do-insert-text item 'desc feed-name-symbol))
4414
4415 (defun newsticker--buffer-do-insert-text (item type feed-name-symbol)
4416   "Actually insert contents of news item, format it, render it and all that.
4417 ITEM is a news item, TYPE tells which part of the item shall be inserted,
4418 FEED-NAME-SYMBOL tells to which feed this item belongs."
4419   (let* ((pos (point))
4420          (format newsticker-desc-format)
4421          (pos-date-start nil)
4422          (pos-date-end nil)
4423          (pos-stat-start nil)
4424          (pos-stat-end nil)
4425          (pos-text-start nil)
4426          (pos-text-end nil)
4427          (pos-extra-start nil)
4428          (pos-extra-end nil)
4429          (pos-enclosure-start nil)
4430          (pos-enclosure-end nil)
4431          (age (newsticker--age item))
4432          (preformatted-contents (newsticker--preformatted-contents item))
4433          (preformatted-title (newsticker--preformatted-title item)))
4434     (cond ((and preformatted-contents
4435                 (not (eq (aref preformatted-contents 0) ?\n));; we must
4436                                                        ;; NOT have a line
4437                                                        ;; break!
4438                 (eq type 'desc))
4439            (insert preformatted-contents))
4440           ((and preformatted-title
4441                 (not (eq (aref preformatted-title 0) ?\n));; we must NOT have a
4442                                                     ;; line break!
4443                 (eq type 'item))
4444            (insert preformatted-title))
4445           (t
4446            ;; item was not formatted before.
4447            ;; Let's go.
4448            (if (eq type 'item)
4449                (setq format newsticker-item-format)
4450              (if (eq type 'feed)
4451                  (setq format newsticker-heading-format)))
4452
4453            (while (> (length format) 0)
4454              (let ((prefix (if (> (length format) 1)
4455                                (substring format 0 2)
4456                              "")))
4457                (cond ((string= "%c" prefix)
4458                       ;; contents
4459                       (when (newsticker--desc item)
4460                         (setq pos-text-start (point-marker))
4461                         (insert (newsticker--desc item))
4462                         (setq pos-text-end (point-marker)))
4463                       (setq format (substring format 2)))
4464                      ((string= "%d" prefix)
4465                       ;; date
4466                       (setq pos-date-start (point-marker))
4467                       (if (newsticker--time item)
4468                           (insert (format-time-string newsticker-date-format
4469                                                       (newsticker--time item))))
4470                       (setq pos-date-end (point-marker))
4471                       (setq format (substring format 2)))
4472                      ((string= "%l" prefix)
4473                       ;; logo
4474                       (let ((disabled (cond ((eq (newsticker--age item) 'feed)
4475                                              (= (newsticker--stat-num-items
4476                                                  feed-name-symbol 'new) 0))
4477                                             (t
4478                                              (not (eq (newsticker--age item)
4479                                                       'new))))))
4480                         (let ((img (newsticker--image-read feed-name-symbol
4481                                                            disabled)))
4482                           (when img
4483                             (newsticker--insert-image img (car item)))))
4484                       (setq format (substring format 2)))
4485                      ((string= "%L" prefix)
4486                       ;; logo or title
4487                       (let ((disabled (cond ((eq (newsticker--age item) 'feed)
4488                                              (= (newsticker--stat-num-items
4489                                                  feed-name-symbol 'new) 0))
4490                                             (t
4491                                              (not (eq (newsticker--age item)
4492                                                       'new))))))
4493                         (let ((img (newsticker--image-read feed-name-symbol
4494                                                            disabled)))
4495                           (if img
4496                               (newsticker--insert-image img (car item))
4497                             (when (car item)
4498                               (setq pos-text-start (point-marker))
4499                               (if (eq (newsticker--age item) 'feed)
4500                                   (insert (newsticker--title item))
4501                                 ;; FIXME: This is not the "real" title!
4502                                 (insert (format "%s"
4503                                                 (car (newsticker--cache-get-feed
4504                                                       feed-name-symbol)))))
4505                               (setq pos-text-end (point-marker))))))
4506                       (setq format (substring format 2)))
4507                      ((string= "%s" prefix)
4508                       ;; statistics
4509                       (setq pos-stat-start (point-marker))
4510                       (if (eq (newsticker--age item) 'feed)
4511                           (insert (newsticker--buffer-statistics
4512                                    feed-name-symbol)))
4513                       (setq pos-stat-end (point-marker))
4514                       (setq format (substring format 2)))
4515                      ((string= "%t" prefix)
4516                       ;; title
4517                       (when (car item)
4518                         (setq pos-text-start (point-marker))
4519                         (insert (car item))
4520                         (setq pos-text-end (point-marker)))
4521                       (setq format (substring format 2)))
4522                      ((string-match "%." prefix)
4523                       ;; unknown specifier!
4524                       (insert prefix)
4525                       (setq format (substring format 2)))
4526                      ((string-match "^\\([^%]*\\)\\(.*\\)" format) ;; FIXME!
4527                       ;; everything else
4528                       (let ((p (point)))
4529                         (insert (substring format
4530                                            (match-beginning 1) (match-end 1)))
4531                         ;; in case that the format string contained newlines
4532                         (put-text-property p (point) 'hard t))
4533                       (setq format (substring format (match-beginning 2)))))))
4534
4535            ;; decode HTML if possible...
4536            (let ((is-rendered-HTML nil))
4537              (when (and newsticker-html-renderer pos-text-start pos-text-end)
4538                (condition-case error-data
4539                    (save-excursion
4540                      ;; check whether it is necessary to call html renderer
4541                      ;; (regexp inspired by htmlr.el)
4542                      (goto-char pos-text-start)
4543                      (when (re-search-forward
4544                             "</?[A-Za-z1-6]*\\|&#?[A-Za-z0-9]+;" pos-text-end t)
4545                        ;; (message "%s" (newsticker--title item))
4546                        (let ((w3m-fill-column (if newsticker-use-full-width
4547                                                   -1 fill-column))
4548                              (w3-maximum-line-length
4549                               (if newsticker-use-full-width nil fill-column)))
4550                          (save-excursion
4551                            (funcall newsticker-html-renderer pos-text-start
4552                                     pos-text-end)))
4553                        (cond ((eq newsticker-html-renderer 'w3m-region)
4554                               (add-text-properties pos (point-max)
4555                                                    (list 'keymap
4556                                                          w3m-minor-mode-map)))
4557                              ((eq newsticker-html-renderer 'w3-region)
4558                               (add-text-properties pos (point-max)
4559                                                    (list 'keymap w3-mode-map))))
4560                        (setq is-rendered-HTML t)))
4561                  (error
4562                   (message "Error: HTML rendering failed: %s, %s"
4563                            (car error-data) (cdr error-data)))))
4564              ;; After html rendering there might be chunks of blank
4565              ;; characters between rendered text and date, statistics or
4566              ;; whatever.  Remove it
4567              (when (and (eq type 'item) is-rendered-HTML)
4568                (goto-char pos)
4569                (while (re-search-forward "[ \t]*\n[ \t]*" nil t)
4570                  (replace-match " " nil nil))
4571                (goto-char (point-max)))
4572              (when (and newsticker-justification
4573                         (memq type '(item desc))
4574                         (not is-rendered-HTML))
4575                (condition-case nil
4576                    (let ((use-hard-newlines t))
4577                      (fill-region pos (point-max) newsticker-justification))
4578                  (error nil))))
4579
4580            ;; remove leading and trailing newlines
4581            (goto-char pos)
4582            (unless (= 0 (skip-chars-forward " \t\r\n"))
4583              (delete-region pos (point)))
4584            (goto-char (point-max))
4585            (let ((end (point)))
4586              (unless (= 0 (skip-chars-backward " \t\r\n" (1+ pos)))
4587                (delete-region (point) end)))
4588            (goto-char (point-max))
4589            ;; closing newline
4590            (unless nil ;;(eq pos (point))
4591              (insert "\n")
4592              (put-text-property (1- (point)) (point) 'hard t))
4593
4594            ;; insert enclosure element
4595            (when (eq type 'desc)
4596              (setq pos-enclosure-start (point))
4597              (newsticker--buffer-insert-enclosure item)
4598              (setq pos-enclosure-end (point)))
4599
4600            ;; show extra elements
4601            (when (eq type 'desc)
4602              (goto-char (point-max))
4603              (setq pos-extra-start (point))
4604              (newsticker--buffer-print-extra-elements item)
4605              (setq pos-extra-end (point)))
4606
4607            ;; text properties
4608            (when (memq type '(feed item))
4609              (add-text-properties pos (1- (point))
4610                                   (list 'mouse-face 'highlight
4611                                         'nt-link (newsticker--link item)
4612                                         'help-echo
4613                                         (format "mouse-2: visit item (%s)"
4614                                                 (newsticker--link item))
4615                                         'keymap newsticker--url-keymap))
4616              (add-text-properties pos (point)
4617                                   (list 'nt-title (newsticker--title item)
4618                                         'nt-desc (newsticker--desc item))))
4619
4620            (add-text-properties pos (point)
4621                                 (list 'nt-type type
4622                                       'nt-face type
4623                                       'nt-age  age
4624                                       'nt-guid (newsticker--guid item)))
4625            (when (and pos-date-start pos-date-end)
4626              (put-text-property pos-date-start pos-date-end 'nt-face 'date))
4627            (when (and pos-stat-start pos-stat-end)
4628              (put-text-property pos-stat-start pos-stat-end 'nt-face 'stat))
4629            (when (and pos-extra-start pos-extra-end)
4630              (put-text-property pos-extra-start pos-extra-end
4631                                 'nt-face 'extra)
4632              (put-text-property pos-extra-start pos-extra-end
4633                                 'nt-type 'extra))
4634            (when (and pos-enclosure-start pos-enclosure-end
4635                       (> pos-enclosure-end pos-enclosure-start))
4636              (put-text-property pos-enclosure-start (1- pos-enclosure-end)
4637                                 'nt-face 'enclosure))
4638
4639            ;; left margin
4640            ;;(unless (memq type '(feed item))
4641            ;;(set-left-margin pos (1- (point)) 1))
4642
4643            ;; save rendered stuff
4644            (cond ((eq type 'desc)
4645                   ;; preformatted contents
4646                   (newsticker--cache-set-preformatted-contents
4647                    item (buffer-substring pos (point))))
4648                   ((eq type 'item)
4649                    ;; preformatted title
4650                    (newsticker--cache-set-preformatted-title
4651                     item (buffer-substring pos (point)))))))))
4652
4653 (defun newsticker--buffer-print-extra-elements (item)
4654   "Insert extra-elements of ITEM in a pretty form into the current buffer."
4655   (let ((ignored-elements '(items link title description
4656                                   content:encoded
4657                                   dc:subject dc:date item guid
4658                                   pubDate enclosure))
4659         (left-column-width 1))
4660     (mapc (lambda (extra-element)
4661             (unless (memq (car extra-element) ignored-elements)
4662               (setq left-column-width (max left-column-width
4663                                            (length (symbol-name
4664                                                     (car extra-element)))))))
4665           (newsticker--extra item))
4666     (mapc (lambda (extra-element)
4667             (unless (memq (car extra-element) ignored-elements)
4668               (newsticker--buffer-do-print-extra-element extra-element
4669                                                          left-column-width)))
4670           (newsticker--extra item))))
4671
4672 (defun newsticker--buffer-do-print-extra-element (extra-element width)
4673   "Actually print an EXTRA-ELEMENT using the given WIDTH."
4674   (let ((name (symbol-name (car extra-element))))
4675     (insert (format "%s: " name))
4676     (insert (make-string (- width (length name)) ? )))
4677   (let (;;(attributes (cadr extra-element)) ;FIXME!!!!
4678         (contents (cddr extra-element)))
4679     (cond ((listp contents)
4680            (mapc (lambda (i)
4681                    (if (and (stringp i)
4682                             (string-match "^http://.*" i))
4683                        (let ((pos (point)))
4684                          (insert i " ") ; avoid self-reference from the
4685                                         ; nt-link thing
4686                          (add-text-properties
4687                           pos (point)
4688                           (list 'mouse-face 'highlight
4689                                 'nt-link i
4690                                 'help-echo
4691                                 (format "mouse-2: visit (%s)" i)
4692                                 'keymap newsticker--url-keymap)))
4693                          (insert (format "%s" i))))
4694                  contents))
4695           (t
4696            (insert (format "%s" contents))))
4697     (insert "\n")))
4698
4699 (defun newsticker--buffer-insert-enclosure (item)
4700   "Insert enclosure element of a news ITEM into the current buffer."
4701   (let ((enclosure (newsticker--enclosure item))
4702         (beg (point)))
4703     (when enclosure
4704       (let ((url (cdr (assoc 'url enclosure)))
4705             (length (string-to-number (or (cdr (assoc 'length enclosure))
4706                                           "0")))
4707             (type (cdr (assoc 'type enclosure))))
4708         (cond ((> length 1048576)
4709                (insert (format "Enclosed file (%s, %1.2f MBytes)" type
4710                                (/ length 1048576))))
4711               ((> length 1024)
4712                (insert (format "Enclosed file (%s, %1.2f KBytes)" type
4713                                (/ length 1024)))))
4714         (add-text-properties beg (point)
4715                              (list 'mouse-face 'highlight
4716                                    'nt-link url
4717                                    'help-echo (format
4718                                                "mouse-2: visit (%s)" url)
4719                                    'keymap newsticker--url-keymap
4720                                    'nt-face 'enclosure
4721                                    'nt-type 'desc))
4722         (insert "\n")))))
4723
4724 (defun newsticker--buffer-statistics (feed-name-symbol)
4725   "Return a statistic string for the feed given by FEED-NAME-SYMBOL.
4726 See `newsticker-statistics-format'."
4727   (let ((case-fold-search nil))
4728     (replace-regexp-in-string
4729      "%a"
4730      (format "%d" (newsticker--stat-num-items feed-name-symbol))
4731      (replace-regexp-in-string
4732       "%i"
4733       (format "%d" (newsticker--stat-num-items feed-name-symbol 'immortal))
4734       (replace-regexp-in-string
4735        "%n"
4736        (format "%d" (newsticker--stat-num-items feed-name-symbol 'new))
4737        (replace-regexp-in-string
4738         "%o"
4739         (format "%d" (newsticker--stat-num-items feed-name-symbol 'old))
4740         (replace-regexp-in-string
4741          "%O"
4742          (format "%d" (newsticker--stat-num-items feed-name-symbol 'obsolete))
4743          newsticker-statistics-format)))))))
4744
4745 (defun newsticker--buffer-set-faces (start end)
4746   "Add face properties according to mark property.
4747 Scans the buffer between START and END."
4748   (save-excursion
4749     ;;(put-text-property start end 'face 'newsticker-default-face)
4750     (goto-char start)
4751     (let ((pos1 start)
4752           (pos2 1)
4753           (nt-face (get-text-property start 'nt-face))
4754           (nt-age (get-text-property start 'nt-age)))
4755       (when nt-face
4756         (setq pos2 (next-single-property-change (point) 'nt-face))
4757         (newsticker--set-face-properties pos1 pos2 nt-face nt-age)
4758         (setq nt-face (get-text-property pos2 'nt-face))
4759         (setq pos1 pos2))
4760       (while (and (setq pos2 (next-single-property-change pos1 'nt-face))
4761                   (<= pos2 end)
4762                   (> pos2 pos1))
4763         (newsticker--set-face-properties pos1 pos2 nt-face nt-age)
4764         (setq nt-face (get-text-property pos2 'nt-face))
4765         (setq nt-age (get-text-property pos2 'nt-age))
4766         (setq pos1 pos2)))))
4767
4768 (defun newsticker--buffer-set-invisibility (start end)
4769   "Add invisibility properties according to nt-type property.
4770 Scans the buffer between START and END.  Sets the 'invisible
4771 property to '(<nt-type>-<nt-age> <nt-type> <nt-age>)."
4772   (save-excursion
4773     ;; reset invisibility settings
4774     (put-text-property start end 'invisible nil)
4775     ;; let's go
4776     (goto-char start)
4777     (let ((pos1 start)
4778           (pos2 1)
4779           (nt-type (get-text-property start 'nt-type))
4780           (nt-age (get-text-property start 'nt-age)))
4781       (when nt-type
4782         (setq pos2 (next-single-property-change (point) 'nt-type))
4783         (put-text-property (max (point-min) pos1) (1- pos2)
4784                            'invisible
4785                            (list (intern
4786                                   (concat
4787                                    (symbol-name
4788                                     (if (eq nt-type 'extra) 'desc nt-type))
4789                                    "-"
4790                                    (symbol-name nt-age)))
4791                                  nt-type
4792                                  nt-age))
4793         (setq nt-type (get-text-property pos2 'nt-type))
4794         (setq pos1 pos2))
4795       (while (and (setq pos2 (next-single-property-change pos1 'nt-type))
4796                   (<= pos2 end)
4797                   (> pos2 pos1))
4798         ;; must shift one char to the left in order to handle inivisible
4799         ;; newlines, motion in invisible text areas and all that correctly
4800         (put-text-property (1- pos1) (1- pos2)
4801                            'invisible
4802                            (list (intern
4803                                   (concat
4804                                    (symbol-name
4805                                     (if (eq nt-type 'extra) 'desc nt-type))
4806                                    "-"
4807                                    (symbol-name nt-age)))
4808                                  nt-type
4809                                  nt-age))
4810         (setq nt-type (get-text-property pos2 'nt-type))
4811         (setq nt-age (get-text-property pos2 'nt-age))
4812         (setq pos1 pos2)))))
4813
4814 (defun newsticker--set-face-properties (pos1 pos2 nt-face age)
4815   "Set the face for the text between the positions POS1 and POS2.
4816 The face is chosen according the values of NT-FACE and AGE."
4817   (let ((face (cond ((eq nt-face 'feed)
4818                      'newsticker-feed-face)
4819                     ((eq nt-face 'item)
4820                      (cond ((eq age 'new)
4821                             'newsticker-new-item-face)
4822                            ((eq age 'old)
4823                             'newsticker-old-item-face)
4824                            ((eq age 'immortal)
4825                             'newsticker-immortal-item-face)
4826                            ((eq age 'obsolete)
4827                             'newsticker-obsolete-item-face)))
4828                     ((eq nt-face 'date)
4829                      'newsticker-date-face)
4830                     ((eq nt-face 'stat)
4831                      'newsticker-statistics-face)
4832                     ((eq nt-face 'extra)
4833                      'newsticker-extra-face)
4834                     ((eq nt-face 'enclosure)
4835                      'newsticker-enclosure-face))))
4836     (when face
4837       (put-text-property pos1 (max pos1 pos2) 'face face))))
4838
4839 (defun newsticker--insert-image (img string)
4840   "Insert IMG with STRING at point."
4841   (insert-image img string))
4842
4843 ;; ======================================================================
4844 ;;; HTML rendering
4845 ;; ======================================================================
4846 (defun newsticker-htmlr-render (pos1 pos2) ;
4847   "Replacement for `htmlr-render'.
4848 Renders the HTML code in the region POS1 to POS2 using htmlr."
4849   (let ((str (buffer-substring-no-properties pos1 pos2)))
4850     (delete-region pos1 pos2)
4851     (insert
4852      (with-temp-buffer
4853        (insert str)
4854        (goto-char (point-min))
4855        ;; begin original htmlr-render
4856        (htmlr-reset)
4857        ;; something omitted here...
4858        (while (< (point) (point-max))
4859          (htmlr-step))
4860        ;; end original htmlr-render
4861        (newsticker--remove-whitespace (buffer-string))))))
4862
4863 ;; ======================================================================
4864 ;;; Functions working on the *newsticker* buffer
4865 ;; ======================================================================
4866 (defun newsticker--buffer-make-item-completely-visible ()
4867   "Scroll buffer until current item is completely visible."
4868   (when newsticker--auto-narrow-to-feed
4869     (let* ((min (or (save-excursion (newsticker--buffer-beginning-of-feed))
4870                     (point-min)))
4871            (max (or (save-excursion (newsticker--buffer-end-of-feed))
4872                     (point-max))))
4873       (narrow-to-region min max)))
4874   (when newsticker--auto-narrow-to-item
4875     (let* ((min (or (save-excursion (newsticker--buffer-beginning-of-item))
4876                     (point-min)))
4877            (max (or (save-excursion (newsticker--buffer-end-of-item))
4878                     (point-max))))
4879       (narrow-to-region min max)))
4880   (sit-for 0)
4881   ;; do not count lines and stuff because that does not work when images
4882   ;; are displayed. Do it the simple way:
4883   (save-excursion
4884     (newsticker--buffer-end-of-item)
4885     (unless (pos-visible-in-window-p)
4886       (recenter -1)))
4887   (unless (pos-visible-in-window-p)
4888     (recenter 0)))
4889
4890 (defun newsticker--buffer-get-feed-title-at-point ()
4891   "Return feed symbol of headline at point."
4892   (format "%s" (or (get-text-property (point) 'feed) " ")))
4893
4894 (defun newsticker--buffer-get-item-title-at-point ()
4895   "Return feed symbol of headline at point."
4896   (format "%s" (or (get-text-property (point) 'nt-title) " ")))
4897
4898 (defun newsticker--buffer-goto (types &optional age backwards)
4899   "Search next occurrence of TYPES in current buffer.
4900 TYPES is a list of symbols.  If TYPES is found point is moved, if
4901 not point is left unchanged.  If optional parameter AGE is not
4902 nil, the type AND the age must match.  If BACKWARDS is t, search
4903 backwards."
4904   (let ((pos (save-excursion
4905                (save-restriction
4906                  (widen)
4907                  (catch 'found
4908                    (let ((tpos (point)))
4909                      (while (setq tpos
4910                                   (if backwards
4911                                       (if (eq tpos (point-min))
4912                                           nil
4913                                         (or (previous-single-property-change
4914                                              tpos 'nt-type)
4915                                             (point-min)))
4916                                     (next-single-property-change
4917                                      tpos 'nt-type)))
4918                        (and (memq (get-text-property tpos 'nt-type) types)
4919                             (or (not age)
4920                                 (eq (get-text-property tpos 'nt-age) age))
4921                             (throw 'found tpos)))))))))
4922     (when pos
4923       (goto-char pos))
4924     pos))
4925
4926 (defun newsticker--buffer-hideshow (mark-age onoff)
4927   "Hide or show items of type MARK-AGE.
4928 If ONOFF is nil the item is hidden, otherwise it is shown."
4929   (if onoff
4930       (remove-from-invisibility-spec mark-age)
4931     (add-to-invisibility-spec mark-age)))
4932
4933 (defun newsticker--buffer-beginning-of-item ()
4934   "Move point to the beginning of the item at point.
4935 Return new position."
4936   (if (bobp)
4937       (point)
4938     (let ((type (get-text-property (point) 'nt-type))
4939           (typebefore (get-text-property (1- (point)) 'nt-type)))
4940       (if (and (memq type '(item feed))
4941                    (not (eq type typebefore)))
4942           (point)
4943         (newsticker--buffer-goto '(item feed) nil t)
4944         (point)))))
4945
4946 (defun newsticker--buffer-beginning-of-feed ()
4947   "Move point to the beginning of the feed at point.
4948 Return new position."
4949   (if (bobp)
4950       (point)
4951     (let ((type (get-text-property (point) 'nt-type))
4952           (typebefore (get-text-property (1- (point)) 'nt-type)))
4953       (if (and (memq type '(feed))
4954                    (not (eq type typebefore)))
4955           (point)
4956         (newsticker--buffer-goto '(feed) nil t)
4957         (point)))))
4958
4959 (defun newsticker--buffer-end-of-item ()
4960   "Move point to the end of the item at point.
4961 Take care: end of item is at the end of its last line!"
4962   (when (newsticker--buffer-goto '(item feed nil))
4963     (point)))
4964
4965 (defun newsticker--buffer-end-of-feed ()
4966   "Move point to the end of the last item of the feed at point.
4967 Take care: end of item is at the end of its last line!"
4968   (when (newsticker--buffer-goto '(feed nil))
4969     (backward-char 1)
4970     (point)))
4971
4972 ;; ======================================================================
4973 ;;; manipulation of ticker text
4974 ;; ======================================================================
4975 (defun newsticker--ticker-text-setup ()
4976   "Build the ticker text which is scrolled or flashed in the echo area."
4977   ;; reset scrollable text
4978   (setq newsticker--scrollable-text "")
4979   (setq newsticker--item-list nil)
4980   (setq newsticker--item-position 0)
4981   ;; build scrollable text from cache data
4982   (let ((have-something nil))
4983     (mapc
4984      (lambda (feed)
4985        (let ((feed-name (symbol-name (car feed))))
4986          (let ((num-new (newsticker--stat-num-items (car feed) 'new))
4987                (num-old (newsticker--stat-num-items (car feed) 'old))
4988                (num-imm (newsticker--stat-num-items (car feed) 'immortal))
4989                (num-obs (newsticker--stat-num-items (car feed) 'obsolete)))
4990            (when (or (> num-new 0)
4991                      (and (> num-old 0)
4992                           (not newsticker-hide-old-items-in-echo-area))
4993                      (and (> num-imm 0)
4994                           (not newsticker-hide-immortal-items-in-echo-area))
4995                      (and (> num-obs 0)
4996                           (not newsticker-hide-obsolete-items-in-echo-area)))
4997              (setq have-something t)
4998              (mapc
4999               (lambda (item)
5000                 (let ((title (replace-regexp-in-string
5001                               "[\r\n]+" " "
5002                               (newsticker--title item)))
5003                       (age (newsticker--age item)))
5004                   (unless (string= title newsticker--error-headline)
5005                     (when
5006                         (or (eq age 'new)
5007                             (and (eq age 'old)
5008                                  (not newsticker-hide-old-items-in-echo-area))
5009                             (and (eq age 'obsolete)
5010                                  (not
5011                                   newsticker-hide-obsolete-items-in-echo-area))
5012                             (and (eq age 'immortal)
5013                                  (not
5014                                   newsticker-hide-immortal-items-in-echo-area)))
5015                       (setq title (newsticker--remove-whitespace title))
5016                       ;; add to flash list
5017                       (add-to-list 'newsticker--item-list
5018                                    (concat feed-name ": " title) t)
5019                       ;; and to the scrollable text
5020                       (setq newsticker--scrollable-text
5021                             (concat newsticker--scrollable-text
5022                                     " " feed-name ": " title " +++"))))))
5023                 (cdr feed))))))
5024      newsticker--cache)
5025     (when have-something
5026       (setq newsticker--scrollable-text
5027             (concat "+++ "
5028                     (format-time-string "%A, %H:%M"
5029                                         newsticker--latest-update-time)
5030                     " ++++++" newsticker--scrollable-text)))))
5031
5032 (defun newsticker--ticker-text-remove (feed title)
5033   "Remove the item of FEED with TITLE from the ticker text."
5034   ;; reset scrollable text
5035   (setq newsticker--item-position 0)
5036   (let ((feed-name (symbol-name feed))
5037         (t-title (replace-regexp-in-string "[\r\n]+" " " title)))
5038     ;; remove from flash list
5039     (setq newsticker--item-list (remove (concat feed-name ": " t-title)
5040                                         newsticker--item-list))
5041     ;; and from the scrollable text
5042     (setq newsticker--scrollable-text
5043           (replace-regexp-in-string
5044            (regexp-quote (concat " " feed-name ": " t-title " +++"))
5045            ""
5046            newsticker--scrollable-text))
5047     (if (string-match (concat "^\\+\\+\\+ [A-Z][a-z]+, "
5048                               "[012]?[0-9]:[0-9][0-9] \\+\\+\\+\\+\\+\\+$")
5049                               newsticker--scrollable-text)
5050         (setq newsticker--scrollable-text ""))))
5051
5052 ;; ======================================================================
5053 ;;; manipulation of cached data
5054 ;; ======================================================================
5055 (defun newsticker--cache-set-preformatted-contents (item contents)
5056   "Set preformatted contents of ITEM to CONTENTS."
5057   (if (nthcdr 6 item)
5058       (setcar (nthcdr 6 item) contents)
5059     (setcdr (nthcdr 5 item) (list contents))))
5060
5061 (defun newsticker--cache-set-preformatted-title (item title)
5062   "Set preformatted title of ITEM to TITLE."
5063   (if (nthcdr 7 item)
5064       (setcar (nthcdr 7 item) title)
5065     (setcdr (nthcdr 6 item) title)))
5066
5067 (defun newsticker--cache-replace-age (data feed old-age new-age)
5068   "Mark all items in DATA in FEED which carry age OLD-AGE with NEW-AGE.
5069 If FEED is 'any it applies to all feeds.  If OLD-AGE is 'any,
5070 all marks are replaced by NEW-AGE.  Removes all pre-formatted contents."
5071   (mapc (lambda (a-feed)
5072           (when (or (eq feed 'any)
5073                     (eq (car a-feed) feed))
5074             (let ((items (cdr a-feed)))
5075               (mapc (lambda (item)
5076                       (when (or (eq old-age 'any)
5077                                 (eq (newsticker--age item) old-age))
5078                         (setcar (nthcdr 4 item) new-age)
5079                         (newsticker--do-forget-preformatted item)))
5080                     items))))
5081         data)
5082   data)
5083
5084 (defun newsticker--cache-mark-expired (data feed old-age new-age time)
5085   "Mark all expired entries.
5086 This function sets the age entries in DATA in the feed FEED.  If
5087 an item's age is OLD-AGE it is set to NEW-AGE if the item is
5088 older than TIME."
5089   (mapc
5090    (lambda (a-feed)
5091      (when (or (eq feed 'any)
5092                (eq (car a-feed) feed))
5093        (let ((items (cdr a-feed)))
5094          (mapc
5095           (lambda (item)
5096             (when (eq (newsticker--age item) old-age)
5097               (let ((exp-time (time-add (newsticker--time item)
5098                                         (seconds-to-time time))))
5099                 (when (time-less-p exp-time (current-time))
5100                   (newsticker--debug-msg
5101                    "Item `%s' from %s has expired on %s"
5102                    (newsticker--title item)
5103                    (format-time-string "%Y-%02m-%d, %H:%M"
5104                                        (newsticker--time item))
5105                    (format-time-string "%Y-%02m-%d, %H:%M" exp-time))
5106                   (setcar (nthcdr 4 item) new-age)))))
5107           items))))
5108    data)
5109   data)
5110
5111 (defun newsticker--cache-contains (data feed title desc link age
5112                                         &optional guid)
5113   "Check DATA whether FEED contains an item with the given properties.
5114 This function returns the contained item or nil if it is not
5115 contained.
5116 The properties which are checked are TITLE, DESC, LINK, AGE, and
5117 GUID.  In general all properties must match in order to return a
5118 certain item, except for the following cases.
5119
5120 If AGE equals 'feed the TITLE, DESCription and LINK do not
5121 matter.  If DESC is nil it is ignored as well.  If
5122 `newsticker-desc-comp-max' is non-nil, only the first
5123 `newsticker-desc-comp-max' characters of DESC are taken into
5124 account.
5125
5126 If GUID is non-nil it is sufficient to match this value, and the
5127 other properties are ignored."
5128   (condition-case nil
5129       (catch 'found
5130         (when (and desc newsticker-desc-comp-max
5131                    (> (length desc) newsticker-desc-comp-max))
5132           (setq desc (substring desc 0 newsticker-desc-comp-max)))
5133         (mapc
5134          (lambda (this-feed)
5135            (when (eq (car this-feed) feed)
5136              (mapc (lambda (anitem)
5137                      (when (or
5138                             ;; global unique id can match
5139                             (and guid
5140                                  (string= guid (newsticker--guid anitem)))
5141                             ;; or title, desc, etc.
5142                             (and
5143                              ;;(or (not (eq age 'feed))
5144                              ;;  (eq (newsticker--age anitem) 'feed))
5145                              (string= (newsticker--title anitem)
5146                                       title)
5147                              (or (not link)
5148                                  (string= (newsticker--link anitem)
5149                                           link))
5150                              (or (not desc)
5151                                  (if (and desc newsticker-desc-comp-max
5152                                           (> (length (newsticker--desc anitem))
5153                                              newsticker-desc-comp-max))
5154                                      (string= (substring
5155                                                (newsticker--desc anitem)
5156                                                0 newsticker-desc-comp-max)
5157                                               desc)
5158                                    (string= (newsticker--desc anitem)
5159                                             desc)))))
5160                        (throw 'found anitem)))
5161                    (cdr this-feed))))
5162          data)
5163         nil)
5164     (error nil)))
5165
5166 (defun newsticker--cache-add (data feed-name-symbol title desc link time age
5167                                    position extra-elements
5168                                    &optional updated-age updated-time
5169                                    preformatted-contents
5170                                    preformatted-title)
5171   "Add another item to cache data.
5172 Add to DATA in the FEED-NAME-SYMBOL an item with TITLE, DESC,
5173 LINK, TIME, AGE, POSITION, and EXTRA-ELEMENTS.  If this item is
5174 contained already, its mark is set to UPDATED-AGE, its time is
5175 set to UPDATED-TIME, and its pre-formatted contents is set to
5176 PREFORMATTED-CONTENTS and PREFORMATTED-TITLE.  Returns the age
5177 which the item got."
5178   (let ((item (newsticker--cache-contains data feed-name-symbol title
5179                                           desc link age)))
5180     (if item
5181       ;; does exist already -- change age, update time and position
5182         (progn
5183           (if (nthcdr 5 item)
5184               (setcar (nthcdr 5 item) position)
5185             (setcdr (nthcdr 4 item) (list position)))
5186           (setcar (nthcdr 4 item) updated-age)
5187           (if updated-time
5188               (setcar (nthcdr 3 item) updated-time))
5189           ;; replace cached pre-formatted contents
5190           (newsticker--cache-set-preformatted-contents
5191            item preformatted-contents)
5192           (newsticker--cache-set-preformatted-title
5193            item preformatted-title))
5194       ;; did not exist or age equals 'feed-name-symbol
5195       (catch 'found
5196         (mapc (lambda (this-feed)
5197                 (when (eq (car this-feed) feed-name-symbol)
5198                   (setcdr this-feed (nconc (cdr this-feed)
5199                                            (list (list title desc link
5200                                                        time age position
5201                                                        preformatted-contents
5202                                                        preformatted-title
5203                                                        extra-elements))))
5204                   (throw 'found this-feed)))
5205               data)
5206         ;; the feed is not contained
5207         (add-to-list 'data (list feed-name-symbol
5208                                  (list title desc link time age position
5209                                        preformatted-contents
5210                                        preformatted-title
5211                                        extra-elements))
5212                      t))))
5213   data)
5214
5215 (defun newsticker--cache-remove (data feed-symbol age)
5216   "Remove all entries from DATA in the feed FEED-SYMBOL with AGE.
5217 FEED-SYMBOL may be 'any.  Entries from old feeds, which are no longer in
5218 `newsticker-url-list' or `newsticker-url-list-defaults', are removed as
5219 well."
5220   (let* ((pos data)
5221          (feed (car pos))
5222          (last-pos nil))
5223     (while feed
5224       (if (or (assoc (symbol-name (car feed)) newsticker-url-list)
5225               (assoc (symbol-name (car feed)) newsticker-url-list-defaults))
5226           ;; feed is still valid=active
5227           ;; (message "Keeping feed %s" (car feed))
5228           (if  (or (eq feed-symbol 'any)
5229                    (eq feed-symbol (car feed)))
5230               (let* ((item-pos (cdr feed))
5231                      (item (car item-pos))
5232                      (prev-pos nil))
5233                 (while item
5234                   ;;(message "%s" (car item))
5235                   (if (eq age (newsticker--age item))
5236                       ;; remove this item
5237                       (progn
5238                         ;;(message "Removing item %s" (car item))
5239                         (if prev-pos
5240                             (setcdr prev-pos (cdr item-pos))
5241                           (setcdr feed (cdr item-pos))))
5242                     ;;(message "Keeping item %s" (car item))
5243                     (setq prev-pos item-pos))
5244                   (setq item-pos (cdr item-pos))
5245                   (setq item (car item-pos)))))
5246         ;; feed is not active anymore
5247         ;; (message "Removing feed %s" (car feed))
5248         (if last-pos
5249             (setcdr last-pos (cdr pos))
5250           (setq data (cdr pos))))
5251       (setq last-pos pos)
5252       (setq pos (cdr pos))
5253       (setq feed (car pos)))))
5254
5255 ;; ======================================================================
5256 ;;; Sorting
5257 ;; ======================================================================
5258 (defun newsticker--cache-item-compare-by-time (item1 item2)
5259   "Compare two news items ITEM1 and ITEM2 by comparing their time values."
5260   (catch 'result
5261     (let ((age1 (newsticker--age item1))
5262           (age2 (newsticker--age item2)))
5263       (if (not (eq age1 age2))
5264           (cond ((eq age1 'obsolete)
5265                  (throw 'result nil))
5266                 ((eq age2 'obsolete)
5267                  (throw 'result t)))))
5268     (let* ((time1 (newsticker--time item1))
5269            (time2 (newsticker--time item2)))
5270       (cond ((< (nth 0 time1) (nth 0 time2))
5271              nil)
5272             ((> (nth 0 time1) (nth 0 time2))
5273              t)
5274             ((< (nth 1 time1) (nth 1 time2))
5275              nil)
5276             ((> (nth 1 time1) (nth 1 time2))
5277              t)
5278             ((< (or (nth 2 time1) 0) (or (nth 2 time2) 0))
5279              nil)
5280             ((> (or (nth 2 time1) 0) (or (nth 2 time2) 0))
5281              t)
5282             (t
5283              nil)))))
5284
5285 (defun newsticker--cache-item-compare-by-title (item1 item2)
5286   "Compare ITEM1 and ITEM2 by comparing their titles."
5287   (catch 'result
5288     (let ((age1 (newsticker--age item1))
5289           (age2 (newsticker--age item2)))
5290       (if (not (eq age1 age2))
5291           (cond ((eq age1 'obsolete)
5292                  (throw 'result nil))
5293                 ((eq age2 'obsolete)
5294                  (throw 'result t)))))
5295     (string< (newsticker--title item1) (newsticker--title item2))))
5296
5297 (defun newsticker--cache-item-compare-by-position (item1 item2)
5298   "Compare ITEM1 and ITEM2 by comparing their original positions."
5299   (catch 'result
5300     (let ((age1 (newsticker--age item1))
5301           (age2 (newsticker--age item2)))
5302       (if (not (eq age1 age2))
5303           (cond ((eq age1 'obsolete)
5304                  (throw 'result nil))
5305                 ((eq age2 'obsolete)
5306                  (throw 'result t)))))
5307     (< (or (newsticker--pos item1) 0) (or (newsticker--pos item2) 0))))
5308
5309 (defun newsticker--cache-sort ()
5310   "Sort the newsticker cache data."
5311   (let ((sort-fun (cond ((eq newsticker-sort-method 'sort-by-time)
5312                          'newsticker--cache-item-compare-by-time)
5313                         ((eq newsticker-sort-method 'sort-by-title)
5314                          'newsticker--cache-item-compare-by-title)
5315                         ((eq newsticker-sort-method 'sort-by-original-order)
5316                          'newsticker--cache-item-compare-by-position))))
5317     (mapc (lambda (feed-list)
5318             (setcdr feed-list (sort (cdr feed-list)
5319                                     sort-fun)))
5320           newsticker--cache)))
5321
5322 (defun newsticker--cache-update (&optional save)
5323   "Update newsticker cache file.
5324 If optional argument SAVE is not nil the cache file is saved to disk."
5325   (save-excursion
5326     (let ((coding-system-for-write 'utf-8)
5327           (buf (find-file-noselect newsticker-cache-filename)))
5328       (when buf
5329         (set-buffer buf)
5330         (setq buffer-undo-list t)
5331         (erase-buffer)
5332         (insert ";; -*- coding: utf-8 -*-\n")
5333         (insert (prin1-to-string newsticker--cache))
5334         (when save
5335           (save-buffer))))))
5336
5337 (defun newsticker--cache-get-feed (feed)
5338   "Return the cached data for the feed FEED.
5339 FEED is a symbol!"
5340   (assoc feed newsticker--cache))
5341
5342 ;; ======================================================================
5343 ;;; Statistics
5344 ;; ======================================================================
5345 (defun newsticker--stat-num-items (feed &optional age)
5346   "Return number of items in the given FEED which have the given AGE.
5347 If AGE is nil, the total number of items is returned."
5348   (let ((items (cdr (newsticker--cache-get-feed feed)))
5349         (num 0))
5350     (while items
5351       (if age
5352           (if (eq (newsticker--age (car items)) age)
5353               (setq num (1+ num)))
5354         (if (memq (newsticker--age (car items)) '(new old immortal obsolete))
5355               (setq num (1+ num))))
5356       (setq items (cdr items)))
5357     num))
5358
5359 ;; ======================================================================
5360 ;;; OPML
5361 ;; ======================================================================
5362 (defun newsticker-opml-export ()
5363   "OPML subscription export.
5364 Export subscriptions to a buffer in OPML Format."
5365   (interactive)
5366   (with-current-buffer (get-buffer-create "*OPML Export*")
5367     (set-buffer-file-coding-system 'utf-8)
5368     (insert (concat
5369              "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
5370              "<!-- OPML generated by Emacs newsticker.el -->\n"
5371              "<opml version=\"1.0\">\n"
5372              "  <head>\n"
5373              "    <title>mySubscriptions</title>\n"
5374              "    <dateCreated>" (format-time-string "%a, %d %b %Y %T %z")
5375              "</dateCreated>\n"
5376              "    <ownerEmail>" user-mail-address "</ownerEmail>\n"
5377              "    <ownerName>" (user-full-name) "</ownerName>\n"
5378              "  </head>\n"
5379              "  <body>\n"))
5380     (mapc (lambda (sub)
5381             (insert "    <outline text=\"")
5382             (insert (newsticker--title sub))
5383             (insert "\" xmlUrl=\"")
5384             (insert (cadr sub))
5385             (insert "\"/>\n"))
5386           (append newsticker-url-list newsticker-url-list-defaults))
5387     (insert "  </body>\n</opml>\n"))
5388   (pop-to-buffer "*OPML Export*")
5389   (when (fboundp 'sgml-mode)
5390     (sgml-mode)))
5391
5392 (defun newsticker-opml-import (filename)
5393   "Import OPML data from FILENAME."
5394   (interactive "fOPML file: ")
5395   (set-buffer (find-file-noselect filename))
5396   (goto-char (point-min))
5397   (let* ((node-list (xml-parse-region (point-min) (point-max)))
5398          (body (car (xml-get-children (car node-list) 'body)))
5399          (outlines (xml-get-children body 'outline)))
5400     (mapc (lambda (outline)
5401             (let ((name (xml-get-attribute outline 'text))
5402                   (url (xml-get-attribute outline 'xmlUrl)))
5403               (add-to-list 'newsticker-url-list
5404                            (list name url nil nil nil) t)))
5405           outlines))
5406   (customize-variable 'newsticker-url-list))
5407
5408 ;; ======================================================================
5409 ;;; Auto marking
5410 ;; ======================================================================
5411 (defun newsticker--run-auto-mark-filter (feed item)
5412   "Automatically mark an item as old or immortal.
5413 This function checks the variable `newsticker-auto-mark-filter-list'
5414 for an entry that matches FEED and ITEM."
5415   (let ((case-fold-search t))
5416     (mapc (lambda (filter)
5417             (let ((filter-feed (car filter))
5418                   (pattern-list (cadr filter)))
5419             (when (string-match filter-feed feed)
5420               (newsticker--do-run-auto-mark-filter item pattern-list))))
5421           newsticker-auto-mark-filter-list)))
5422
5423 (defun newsticker--do-run-auto-mark-filter (item list)
5424   "Actually compare ITEM against the pattern-LIST
5425 \(from `newsticker-auto-mark-filter-list')."
5426   (mapc (lambda (pattern)
5427           (let ((age    (nth 0 pattern))
5428                 (place  (nth 1 pattern))
5429                 (regexp (nth 2 pattern))
5430                 (title (newsticker--title item))
5431                 (desc  (newsticker--desc item)))
5432             (when (or (eq place 'title) (eq place 'all))
5433               (when (and title (string-match regexp title))
5434                 (newsticker--debug-msg "Auto-marking as %s: `%s'"
5435                                        age (newsticker--title item))
5436                 (setcar (nthcdr 4 item) age)))
5437             (when (or (eq place 'description) (eq place 'all))
5438               (when (and desc (string-match regexp desc))
5439                 (newsticker--debug-msg "Auto-marking as %s: `%s'"
5440                                        age (newsticker--title item))
5441                 (setcar (nthcdr 4 item) age)))))
5442         list))
5443
5444
5445 ;; ======================================================================
5446 ;;; hook samples
5447 ;; ======================================================================
5448 (defun newsticker-new-item-functions-sample (feed item)
5449   "Demonstrate the use of the `newsticker-new-item-functions' hook.
5450 This function just prints out the values of the FEED and title of the ITEM."
5451   (message (concat "newsticker-new-item-functions-sample: feed=`%s', "
5452                    "title=`%s'")
5453            feed (newsticker--title item)))
5454
5455 (defun newsticker-download-images (feed item)
5456   "Download the first image.
5457 If FEED equals \"imagefeed\" download the first image URL found
5458 in the description=contents of ITEM to the directory
5459 \"~/tmp/newsticker/FEED/TITLE\" where TITLE is the title of the item."
5460   (when (string= feed "imagefeed")
5461     (let ((title (newsticker--title item))
5462           (desc (newsticker--desc item)))
5463       (when (string-match "<img src=\"\\(http://[^ \"]+\\)\"" desc)
5464         (let ((url (substring desc (match-beginning 1) (match-end 1)))
5465               (temp-dir (concat "~/tmp/newsticker/" feed "/" title))
5466               (org-dir default-directory))
5467           (unless (file-directory-p temp-dir)
5468             (make-directory temp-dir t))
5469           (cd temp-dir)
5470           (message "Getting image %s" url)
5471           (apply 'start-process "wget-image"
5472                  " *newsticker-wget-download-images*"
5473                  newsticker-wget-name
5474                  (list url))
5475           (cd org-dir))))))
5476
5477 (defun newsticker-download-enclosures (feed item)
5478   "In all FEEDs download the enclosed object of the news ITEM.
5479 The object is saved to the directory \"~/tmp/newsticker/FEED/TITLE\", which
5480 is created if it does not exist.  TITLE is the title of the news
5481 item.  Argument FEED is ignored.
5482 This function is suited for adding it to `newsticker-new-item-functions'."
5483   (let ((title (newsticker--title item))
5484         (enclosure (newsticker--enclosure item)))
5485     (when enclosure
5486       (let ((url (cdr (assoc 'url enclosure)))
5487             (temp-dir (concat "~/tmp/newsticker/" feed "/" title))
5488             (org-dir default-directory))
5489         (unless (file-directory-p temp-dir)
5490           (make-directory temp-dir t))
5491         (cd temp-dir)
5492         (message "Getting enclosure %s" url)
5493         (apply 'start-process "wget-enclosure"
5494                " *newsticker-wget-download-enclosures*"
5495                newsticker-wget-name
5496                (list url))
5497         (cd org-dir)))))
5498
5499
5500 (provide 'newsticker)
5501
5502 ;; arch-tag: ab761dfa-67bc-4207-bc64-4307271dc381
5503 ;;; newsticker.el ends here