cgit.sxemacs.org Git - gnus/blob - lisp/nnrss.el

   1 ;;; nnrss.el --- interfacing with RSS
   2 ;; Copyright (C) 2001, 2002, 2003, 2004  Free Software Foundation, Inc.
   3
   4 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
   5 ;; Keywords: RSS
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published
  11 ;; by the Free Software Foundation; either version 2, or (at your
  12 ;; option) any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful, but
  15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 ;; General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile (require 'cl))
  29
  30 (require 'gnus)
  31 (require 'nnoo)
  32 (require 'nnmail)
  33 (require 'message)
  34 (require 'mm-util)
  35 (require 'gnus-util)
  36 (require 'time-date)
  37 (require 'rfc2231)
  38 (require 'mm-url)
  39 (eval-when-compile
  40   (ignore-errors
  41     (require 'xml)))
  42 (eval '(require 'xml))
  43
  44 (nnoo-declare nnrss)
  45
  46 (defvoo nnrss-directory (nnheader-concat gnus-directory "rss/")
  47   "Where nnrss will save its files.")
  48
  49 ;; (group max rss-url)
  50 (defvoo nnrss-server-data nil)
  51
  52 ;; (num timestamp url subject author date extra)
  53 (defvoo nnrss-group-data nil)
  54 (defvoo nnrss-group-max 0)
  55 (defvoo nnrss-group-min 1)
  56 (defvoo nnrss-group nil)
  57 (defvoo nnrss-group-hashtb (make-hash-table :test 'equal))
  58 (defvoo nnrss-status-string "")
  59
  60 (defconst nnrss-version "nnrss 1.0")
  61
  62 (defvar nnrss-group-alist '()
  63   "List of RSS addresses.")
  64
  65 (defvar nnrss-use-local nil)
  66
  67 (defvar nnrss-description-field 'X-Gnus-Description
  68   "Field name used for DESCRIPTION.
  69 To use the description in headers, put this name into `nnmail-extra-headers'.")
  70
  71 (defvar nnrss-url-field 'X-Gnus-Url
  72   "Field name used for URL.
  73 To use the description in headers, put this name into `nnmail-extra-headers'.")
  74
  75 (defvar nnrss-content-function nil
  76   "A function which is called in `nnrss-request-article'.
  77 The arguments are (ENTRY GROUP ARTICLE).
  78 ENTRY is the record of the current headline.  GROUP is the group name.
  79 ARTICLE is the article number of the current headline.")
  80
  81 (nnoo-define-basics nnrss)
  82
  83 ;;; Interface functions
  84
  85 (deffoo nnrss-retrieve-headers (articles &optional group server fetch-old)
  86   (nnrss-possibly-change-group group server)
  87   (let (e)
  88     (save-excursion
  89       (set-buffer nntp-server-buffer)
  90       (erase-buffer)
  91       (dolist (article articles)
  92         (if (setq e (assq article nnrss-group-data))
  93             (insert (number-to-string (car e)) "\t" ;; number
  94                     (if (nth 3 e)
  95                         (nnrss-format-string (nth 3 e)) "")
  96                     "\t" ;; subject
  97                     (if (nth 4 e)
  98                         (nnrss-format-string (nth 4 e))
  99                       "(nobody)")
 100                     "\t" ;;from
 101                     (or (nth 5 e) "")
 102                     "\t" ;; date
 103                     (format "<%d@%s.nnrss>" (car e) group)
 104                     "\t" ;; id
 105                     "\t" ;; refs
 106                     "-1" "\t" ;; chars
 107                     "-1" "\t" ;; lines
 108                     "" "\t" ;; Xref
 109                     (if (and (nth 6 e)
 110                              (memq nnrss-description-field
 111                                    nnmail-extra-headers))
 112                         (concat (symbol-name nnrss-description-field)
 113                                 ": "
 114                                 (nnrss-format-string (nth 6 e))
 115                                 "\t")
 116                       "")
 117                     (if (and (nth 2 e)
 118                              (memq nnrss-url-field
 119                                    nnmail-extra-headers))
 120                         (concat (symbol-name nnrss-url-field)
 121                                 ": "
 122                                 (nnrss-format-string (nth 2 e))
 123                                 "\t")
 124                       "")
 125                     "\n")))))
 126   'nov)
 127
 128 (deffoo nnrss-request-group (group &optional server dont-check)
 129   (nnrss-possibly-change-group group server)
 130   (if dont-check
 131       t
 132     (nnrss-check-group group server)
 133     (nnheader-report 'nnrss "Opened group %s" group)
 134     (nnheader-insert
 135      "211 %d %d %d %s\n" nnrss-group-max nnrss-group-min nnrss-group-max
 136      (prin1-to-string group)
 137      t)))
 138
 139 (deffoo nnrss-close-group (group &optional server)
 140   t)
 141
 142 (deffoo nnrss-request-article (article &optional group server buffer)
 143   (nnrss-possibly-change-group group server)
 144   (let ((e (assq article nnrss-group-data))
 145         (boundary "=-=-=-=-=-=-=-=-=-")
 146         (nntp-server-buffer (or buffer nntp-server-buffer))
 147         post err)
 148     (when e
 149       (catch 'error
 150         (with-current-buffer nntp-server-buffer
 151           (erase-buffer)
 152           (goto-char (point-min))
 153           (insert "Mime-Version: 1.0\nContent-Type: multipart/alternative; boundary=\"" boundary "\"\n")
 154           (if group
 155               (insert "Newsgroups: " group "\n"))
 156           (if (nth 3 e)
 157               (insert "Subject: " (nnrss-format-string (nth 3 e)) "\n"))
 158           (if (nth 4 e)
 159               (insert "From: " (nnrss-format-string (nth 4 e)) "\n"))
 160           (if (nth 5 e)
 161               (insert "Date: " (nnrss-format-string (nth 5 e)) "\n"))
 162           (insert "Message-ID: " (format "<%d@%s.nnrss>" (car e) group) "\n")
 163           (insert "\n")
 164           (let ((text (if (nth 6 e)
 165                           (nnrss-string-as-multibyte (nth 6 e))))
 166                 (link (if (nth 2 e)
 167                           (nth 2 e))))
 168             (insert "\n\n--" boundary "\nContent-Type: text/plain\n\n")
 169             (let ((point (point)))
 170               (when text
 171                 (insert text)
 172                 (goto-char point)
 173                 (while (re-search-forward "\n" nil t)
 174                   (replace-match " "))
 175                 (goto-char (point-max))
 176                 (insert "\n\n"))
 177               (when link
 178                 (insert link)))
 179             (insert "\n\n--" boundary "\nContent-Type: text/html\n\n")
 180             (let ((point (point)))
 181               (when text
 182                 (insert "<html><head></head><body>\n" text "\n</body></html>")
 183                 (goto-char point)
 184                 (while (re-search-forward "\n" nil t)
 185                   (replace-match " "))
 186                 (goto-char (point-max))
 187                 (insert "\n\n"))
 188               (when link
 189                 (insert "<p><a href=\"" link "\">link</a></p>\n"))))
 190           (when nnrss-content-function
 191             (funcall nnrss-content-function e group article)))))
 192     (cond
 193      (err
 194       (nnheader-report 'nnrss err))
 195      ((not e)
 196       (nnheader-report 'nnrss "no such id: %d" article))
 197      (t
 198       (nnheader-report 'nnrss "article %s retrieved" (car e))
 199       ;; we return the article number.
 200       (cons nnrss-group (car e))))))
 201
 202 (deffoo nnrss-request-list (&optional server)
 203   (nnrss-possibly-change-group nil server)
 204   (nnrss-generate-active)
 205   t)
 206
 207 (deffoo nnrss-open-server (server &optional defs connectionless)
 208   (nnrss-read-server-data server)
 209   (nnoo-change-server 'nnrss server defs)
 210   t)
 211
 212 (deffoo nnrss-request-expire-articles
 213     (articles group &optional server force)
 214   (nnrss-possibly-change-group group server)
 215   (let (e days not-expirable changed)
 216     (dolist (art articles)
 217       (if (and (setq e (assq art nnrss-group-data))
 218                (nnmail-expired-article-p
 219                 group
 220                 (if (listp (setq days (nth 1 e))) days
 221                   (days-to-time (- days (time-to-days '(0 0)))))
 222                 force))
 223           (setq nnrss-group-data (delq e nnrss-group-data)
 224                 changed t)
 225         (push art not-expirable)))
 226     (if changed
 227         (nnrss-save-group-data group server))
 228     not-expirable))
 229
 230 (deffoo nnrss-request-delete-group (group &optional force server)
 231   (nnrss-possibly-change-group group server)
 232   (setq nnrss-server-data
 233         (delq (assoc group nnrss-server-data) nnrss-server-data))
 234   (nnrss-save-server-data server)
 235   (ignore-errors
 236     (delete-file (nnrss-make-filename group server)))
 237   t)
 238
 239 (deffoo nnrss-request-list-newsgroups (&optional server)
 240   (nnrss-possibly-change-group nil server)
 241   (save-excursion
 242     (set-buffer nntp-server-buffer)
 243     (erase-buffer)
 244     (dolist (elem nnrss-group-alist)
 245       (if (third elem)
 246           (insert (car elem) "\t" (third elem) "\n"))))
 247   t)
 248
 249 (nnoo-define-skeleton nnrss)
 250
 251 ;;; Internal functions
 252 (eval-when-compile (defun xml-rpc-method-call (&rest args)))
 253 (defun nnrss-fetch (url &optional local)
 254   "Fetch URL and put it in a the expected Lisp structure."
 255   (with-temp-buffer
 256   ;some CVS versions of url.el need this to close the connection quickly
 257     (let* (xmlform htmlform)
 258       ;; bit o' work necessary for w3 pre-cvs and post-cvs
 259       (if local
 260           (let ((coding-system-for-read 'binary))
 261             (insert-file-contents url))
 262         (mm-url-insert url))
 263
 264 ;; Because xml-parse-region can't deal with anything that isn't
 265 ;; xml and w3-parse-buffer can't deal with some xml, we have to
 266 ;; parse with xml-parse-region first and, if that fails, parse
 267 ;; with w3-parse-buffer.  Yuck.  Eventually, someone should find out
 268 ;; why w3-parse-buffer fails to parse some well-formed xml and
 269 ;; fix it.
 270
 271     (condition-case err
 272         (setq xmlform (xml-parse-region (point-min) (point-max)))
 273       (error (if (fboundp 'w3-parse-buffer)
 274                  (setq htmlform (caddar (w3-parse-buffer
 275                                          (current-buffer))))
 276                (message "nnrss: Not valid XML and w3 parse not available (%s)"
 277                         url))))
 278     (if htmlform
 279         htmlform
 280       xmlform))))
 281
 282 (defun nnrss-possibly-change-group (&optional group server)
 283   (when (and server
 284              (not (nnrss-server-opened server)))
 285     (nnrss-open-server server))
 286   (when (and group (not (equal group nnrss-group)))
 287     (nnrss-read-group-data group server)
 288     (setq nnrss-group group)))
 289
 290 (defvar nnrss-extra-categories '(nnrss-snarf-moreover-categories))
 291
 292 (defun nnrss-generate-active ()
 293   (if (y-or-n-p "Fetch extra categories? ")
 294       (dolist (func nnrss-extra-categories)
 295         (funcall func)))
 296   (save-excursion
 297     (set-buffer nntp-server-buffer)
 298     (erase-buffer)
 299     (dolist (elem nnrss-group-alist)
 300       (insert (prin1-to-string (car elem)) " 0 1 y\n"))
 301     (dolist (elem nnrss-server-data)
 302       (unless (assoc (car elem) nnrss-group-alist)
 303         (insert (prin1-to-string (car elem)) " 0 1 y\n")))))
 304
 305 ;;; data functions
 306
 307 (defun nnrss-read-server-data (server)
 308   (setq nnrss-server-data nil)
 309   (let ((file (nnrss-make-filename "nnrss" server)))
 310     (when (file-exists-p file)
 311       (let ((coding-system-for-read 'binary))
 312         (load file nil nil t)))))
 313
 314 (defun nnrss-save-server-data (server)
 315   (gnus-make-directory nnrss-directory)
 316   (let ((coding-system-for-write 'binary))
 317     (with-temp-file (nnrss-make-filename "nnrss" server)
 318       (gnus-prin1 `(setq nnrss-group-alist ',nnrss-group-alist))
 319       (gnus-prin1 `(setq nnrss-server-data ',nnrss-server-data)))))
 320
 321 (defun nnrss-read-group-data (group server)
 322   (setq nnrss-group-data nil)
 323   (if (hash-table-p nnrss-group-hashtb)
 324       (clrhash nnrss-group-hashtb)
 325     (setq nnrss-group-hashtb (make-hash-table :test 'equal)))
 326   (let ((pair (assoc group nnrss-server-data)))
 327     (setq nnrss-group-max (or (cadr pair) 0))
 328     (setq nnrss-group-min (+ nnrss-group-max 1)))
 329   (let ((file (nnrss-make-filename group server)))
 330     (when (file-exists-p file)
 331       (let ((coding-system-for-read 'binary))
 332         (load file nil t t))
 333       (dolist (e nnrss-group-data)
 334         (puthash (nth 2 e) e nnrss-group-hashtb)
 335         (when (and (car e) (> nnrss-group-min (car e)))
 336           (setq nnrss-group-min (car e)))
 337         (when (and (car e) (< nnrss-group-max (car e)))
 338           (setq nnrss-group-max (car e)))))))
 339
 340 (defun nnrss-save-group-data (group server)
 341   (gnus-make-directory nnrss-directory)
 342   (let ((coding-system-for-write 'binary))
 343     (with-temp-file (nnrss-make-filename group server)
 344       (gnus-prin1 `(setq nnrss-group-data ',nnrss-group-data )))))
 345
 346 (defun nnrss-make-filename (name server)
 347   (expand-file-name
 348    (nnrss-translate-file-chars
 349     (concat name
 350             (and server
 351                  (not (equal server ""))
 352                  "-")
 353             server
 354             ".el"))
 355    nnrss-directory))
 356
 357 (gnus-add-shutdown 'nnrss-close 'gnus)
 358
 359 (defun nnrss-close ()
 360   "Clear internal nnrss variables."
 361   (setq nnrss-group-data nil
 362         nnrss-server-data nil
 363         nnrss-group-hashtb nil
 364         nnrss-group-alist nil))
 365
 366 ;;; URL interface
 367
 368 (defun nnrss-no-cache (url)
 369   "")
 370
 371 (defun nnrss-insert-w3 (url)
 372   (mm-with-unibyte-current-buffer
 373     (mm-url-insert url)))
 374
 375 (defun nnrss-decode-entities-unibyte-string (string)
 376   (if string
 377       (mm-with-unibyte-buffer
 378         (insert string)
 379         (mm-url-decode-entities-nbsp)
 380         (buffer-string))))
 381
 382 (defalias 'nnrss-insert 'nnrss-insert-w3)
 383
 384 (if (featurep 'xemacs)
 385     (defalias 'nnrss-string-as-multibyte 'identity)
 386   (defalias 'nnrss-string-as-multibyte 'string-as-multibyte))
 387
 388 ;;; Snarf functions
 389
 390 (defun nnrss-check-group (group server)
 391   (let (file xml subject url extra changed author
 392              date rss-ns rdf-ns content-ns dc-ns)
 393     (if (and nnrss-use-local
 394              (file-exists-p (setq file (expand-file-name
 395                                         (nnrss-translate-file-chars
 396                                          (concat group ".xml"))
 397                                         nnrss-directory))))
 398         (setq xml (nnrss-fetch file t))
 399       (setq url (or (nth 2 (assoc group nnrss-server-data))
 400                     (second (assoc group nnrss-group-alist))))
 401       (unless url
 402         (setq url
 403              (cdr
 404               (assoc 'href
 405                      (nnrss-discover-feed
 406                       (read-string
 407                        (format "URL to search for %s: " group) "http://")))))
 408         (let ((pair (assoc group nnrss-server-data)))
 409           (if pair
 410               (setcdr (cdr pair) (list url))
 411             (push (list group nnrss-group-max url) nnrss-server-data)))
 412         (setq changed t))
 413       (setq xml (nnrss-fetch url)))
 414     ;; See
 415     ;; http://feeds.archive.org/validator/docs/howto/declare_namespaces.html
 416     ;; for more RSS namespaces.
 417     (setq dc-ns (nnrss-get-namespace-prefix xml "http://purl.org/dc/elements/1.1/")
 418           rdf-ns (nnrss-get-namespace-prefix xml "http://www.w3.org/1999/02/22-rdf-syntax-ns#")
 419           rss-ns (nnrss-get-namespace-prefix xml "http://purl.org/rss/1.0/")
 420           content-ns (nnrss-get-namespace-prefix xml "http://purl.org/rss/1.0/modules/content/"))
 421     (dolist (item (nreverse (nnrss-find-el (intern (concat rss-ns "item")) xml)))
 422       (when (and (listp item)
 423                  (eq (intern (concat rss-ns "item")) (car item))
 424                  (setq url (nnrss-decode-entities-unibyte-string
 425                             (nnrss-node-text rss-ns 'link (cddr item))))
 426                  (not (gethash url nnrss-group-hashtb)))
 427         (setq subject (nnrss-node-text rss-ns 'title item))
 428         (setq extra (or (nnrss-node-text content-ns 'encoded item)
 429                         (nnrss-node-text rss-ns 'description item)))
 430         (setq author (or (nnrss-node-text rss-ns 'author item)
 431                          (nnrss-node-text dc-ns 'creator item)
 432                          (nnrss-node-text dc-ns 'contributor item)))
 433         (setq date (or (nnrss-node-text dc-ns 'date item)
 434                        (nnrss-node-text rss-ns 'pubDate item)
 435                        (message-make-date)))
 436         (push
 437          (list
 438           (incf nnrss-group-max)
 439           (current-time)
 440           url
 441           (and subject (nnrss-decode-entities-unibyte-string subject))
 442           (and author (nnrss-decode-entities-unibyte-string author))
 443           date
 444           (and extra (nnrss-decode-entities-unibyte-string extra)))
 445          nnrss-group-data)
 446         (puthash url (car nnrss-group-data) nnrss-group-hashtb)
 447         (setq changed t)))
 448     (when changed
 449       (nnrss-save-group-data group server)
 450       (let ((pair (assoc group nnrss-server-data)))
 451         (if pair
 452             (setcar (cdr pair) nnrss-group-max)
 453           (push (list group nnrss-group-max) nnrss-server-data)))
 454       (nnrss-save-server-data server))))
 455
 456 (defun nnrss-opml-import (opml-file)
 457   "OPML subscriptions import.
 458 Read the file and attempt to subscribe to each Feed in the file."
 459   (interactive "fImport file: ")
 460   (mapcar
 461    (lambda (node) (gnus-group-make-rss-group
 462                    (cdr (assq 'xmlUrl (cadr node)))))
 463    (nnrss-find-el 'outline
 464                   (progn
 465                     (find-file opml-file)
 466                     (xml-parse-region (point-min)
 467                                       (point-max))))))
 468
 469 (defun nnrss-opml-export ()
 470   "OPML subscription export.
 471 Export subscriptions to a buffer in OPML Format."
 472   (interactive)
 473   (with-current-buffer (get-buffer-create "*OPML Export*")
 474     (mm-set-buffer-file-coding-system 'utf-8)
 475     (insert (concat
 476              "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
 477              "<!-- OPML generated by Emacs Gnus' nnrss.el -->\n"
 478              "<opml version=\"1.1\">\n"
 479              "  <head>\n"
 480              "    <title>mySubscriptions</title>\n"
 481              "    <dateCreated>" (format-time-string "%a, %d %b %Y %T %z")
 482              "</dateCreated>\n"
 483              "    <ownerEmail>" user-mail-address "</ownerEmail>\n"
 484              "    <ownerName>" (user-full-name) "</ownerName>\n"
 485              "  </head>\n"
 486              "  <body>\n"))
 487     (mapcar (lambda (sub)
 488               (insert (concat
 489                        "    <outline text=\"" (car sub) "\" xmlUrl=\""
 490                        (cadr sub) "\"/>\n")))
 491             nnrss-group-alist)
 492     (insert (concat
 493              "  </body>\n"
 494            "</opml>\n")))
 495   (pop-to-buffer "*OPML Export*")
 496   (when (fboundp 'sgml-mode)
 497     (sgml-mode)))
 498
 499 (defun nnrss-generate-download-script ()
 500   "Generate a download script in the current buffer.
 501 It is useful when `(setq nnrss-use-local t)'."
 502   (interactive)
 503   (insert "#!/bin/sh\n")
 504   (insert "WGET=wget\n")
 505   (insert "RSSDIR='" (expand-file-name nnrss-directory) "'\n")
 506   (dolist (elem nnrss-server-data)
 507     (let ((url (or (nth 2 elem)
 508                    (second (assoc (car elem) nnrss-group-alist)))))
 509       (insert "$WGET -q -O \"$RSSDIR\"/'"
 510               (nnrss-translate-file-chars (concat (car elem) ".xml"))
 511               "' '" url "'\n"))))
 512
 513 (defun nnrss-translate-file-chars (name)
 514   (let ((nnheader-file-name-translation-alist
 515          (append nnheader-file-name-translation-alist '((?' . ?_)))))
 516     (nnheader-translate-file-chars name)))
 517
 518 (defvar nnrss-moreover-url
 519   "http://w.moreover.com/categories/category_list_rss.html"
 520   "The url of moreover.com categories.")
 521
 522 (defun nnrss-snarf-moreover-categories ()
 523   "Snarf RSS links from moreover.com."
 524   (interactive)
 525   (let (category name url changed)
 526     (with-temp-buffer
 527       (nnrss-insert nnrss-moreover-url)
 528       (goto-char (point-min))
 529       (while (re-search-forward
 530               "<a name=\"\\([^\"]+\\)\">\\|<a href=\"\\(http://[^\"]*moreover\\.com[^\"]+page\\?c=\\([^\"&]+\\)&o=rss\\)" nil t)
 531         (if (match-string 1)
 532             (setq category (match-string 1))
 533           (setq url (match-string 2)
 534                 name (mm-url-decode-entities-string
 535                       (rfc2231-decode-encoded-string
 536                        (match-string 3))))
 537           (if category
 538               (setq name (concat category "." name)))
 539           (unless (assoc name nnrss-server-data)
 540             (setq changed t)
 541             (push (list name 0 url) nnrss-server-data)))))
 542     (if changed
 543         (nnrss-save-server-data ""))))
 544
 545 (defun nnrss-format-string (string)
 546   (gnus-replace-in-string (nnrss-string-as-multibyte string) " *\n *" " "))
 547
 548 (defun nnrss-node-text (namespace local-name element)
 549   (let* ((node (assq (intern (concat namespace (symbol-name local-name)))
 550                      element))
 551          (text (if (and node (listp node))
 552                    (nnrss-node-just-text node)
 553                  node))
 554          (cleaned-text (if text (gnus-replace-in-string
 555                                  text "^[\000-\037\177]+\\|^ +\\| +$" ""))))
 556     (if (string-equal "" cleaned-text)
 557         nil
 558       cleaned-text)))
 559
 560 (defun nnrss-node-just-text (node)
 561   (if (and node (listp node))
 562       (mapconcat 'nnrss-node-just-text (cddr node) " ")
 563     node))
 564
 565 (defun nnrss-find-el (tag data &optional found-list)
 566   "Find the all matching elements in the data.
 567 Careful with this on large documents!"
 568   (if (listp data)
 569       (mapcar (lambda (bit)
 570                 (when (car-safe bit)
 571                   (when (equal tag (car bit))
 572                     (setq found-list
 573                           (append found-list
 574                                   (list bit))))
 575                   (if (and (listp (car-safe (caddr bit)))
 576                            (not (stringp (caddr bit))))
 577                       (setq found-list
 578                             (append found-list
 579                                     (nnrss-find-el
 580                                      tag (caddr bit))))
 581                     (setq found-list
 582                           (append found-list
 583                                   (nnrss-find-el
 584                                    tag (cddr bit)))))))
 585               data))
 586   found-list)
 587
 588 (defun nnrss-rsslink-p (el)
 589   "Test if the element we are handed is an RSS autodiscovery link."
 590   (and (eq (car-safe el) 'link)
 591        (string-equal (cdr (assoc 'rel (cadr el))) "alternate")
 592        (or (string-equal (cdr (assoc 'type (cadr el)))
 593                          "application/rss+xml")
 594            (string-equal (cdr (assoc 'type (cadr el))) "text/xml"))))
 595
 596 (defun nnrss-get-rsslinks (data)
 597   "Extract the <link> elements that are links to RSS from the parsed data."
 598   (delq nil (mapcar
 599              (lambda (el)
 600                (if (nnrss-rsslink-p el) el))
 601              (nnrss-find-el 'link data))))
 602
 603 (defun nnrss-extract-hrefs (data)
 604   "Recursively extract hrefs from a page's source.
 605 DATA should be the output of `xml-parse-region' or
 606 `w3-parse-buffer'."
 607   (mapcar (lambda (ahref)
 608             (cdr (assoc 'href (cadr ahref))))
 609           (nnrss-find-el 'a data)))
 610
 611 (defmacro nnrss-match-macro (base-uri item
 612                                            onsite-list offsite-list)
 613   `(cond ((or (string-match (concat "^" ,base-uri) ,item)
 614                (not (string-match "://" ,item)))
 615            (setq ,onsite-list (append ,onsite-list (list ,item))))
 616           (t (setq ,offsite-list (append ,offsite-list (list ,item))))))
 617
 618 (defun nnrss-order-hrefs (base-uri hrefs)
 619   "Given a list of hrefs, sort them using the following priorities:
 620   1. links ending in .rss
 621   2. links ending in .rdf
 622   3. links ending in .xml
 623   4. links containing the above
 624   5. offsite links
 625
 626 BASE-URI is used to determine the location of the links and
 627 whether they are `offsite' or `onsite'."
 628   (let (rss-onsite-end  rdf-onsite-end  xml-onsite-end
 629         rss-onsite-in   rdf-onsite-in   xml-onsite-in
 630         rss-offsite-end rdf-offsite-end xml-offsite-end
 631         rss-offsite-in rdf-offsite-in xml-offsite-in)
 632     (mapcar (lambda (href)
 633               (if (not (null href))
 634               (cond ((string-match "\\.rss$" href)
 635                      (nnrss-match-macro
 636                       base-uri href rss-onsite-end rss-offsite-end))
 637                     ((string-match "\\.rdf$" href)
 638                      (nnrss-match-macro
 639                       base-uri href rdf-onsite-end rdf-offsite-end))
 640                     ((string-match "\\.xml$" href)
 641                      (nnrss-match-macro
 642                       base-uri href xml-onsite-end xml-offsite-end))
 643                     ((string-match "rss" href)
 644                      (nnrss-match-macro
 645                       base-uri href rss-onsite-in rss-offsite-in))
 646                     ((string-match "rdf" href)
 647                      (nnrss-match-macro
 648                       base-uri href rdf-onsite-in rdf-offsite-in))
 649                     ((string-match "xml" href)
 650                      (nnrss-match-macro
 651                       base-uri href xml-onsite-in xml-offsite-in)))))
 652             hrefs)
 653     (append
 654      rss-onsite-end  rdf-onsite-end  xml-onsite-end
 655      rss-onsite-in   rdf-onsite-in   xml-onsite-in
 656      rss-offsite-end rdf-offsite-end xml-offsite-end
 657      rss-offsite-in rdf-offsite-in xml-offsite-in)))
 658
 659 (defun nnrss-discover-feed (url)
 660   "Given a page, find an RSS feed using Mark Pilgrim's
 661 `ultra-liberal rss locator' (http://diveintomark.org/2002/08/15.html)."
 662
 663   (let ((parsed-page (nnrss-fetch url)))
 664
 665 ;;    1. if this url is the rss, use it.
 666     (if (nnrss-rss-p parsed-page)
 667         (let ((rss-ns (nnrss-get-namespace-prefix parsed-page "http://purl.org/rss/1.0/")))
 668           (nnrss-rss-title-description rss-ns parsed-page url))
 669
 670 ;;    2. look for the <link rel="alternate"
 671 ;;    type="application/rss+xml" and use that if it is there.
 672       (let ((links (nnrss-get-rsslinks parsed-page)))
 673         (if links
 674             (let* ((xml (nnrss-fetch
 675                          (cdr (assoc 'href (cadar links)))))
 676                    (rss-ns (nnrss-get-namespace-prefix xml "http://purl.org/rss/1.0/")))
 677               (nnrss-rss-title-description rss-ns xml (cdr (assoc 'href (cadar links)))))
 678
 679 ;;    3. look for links on the site in the following order:
 680 ;;       - onsite links ending in .rss, .rdf, or .xml
 681 ;;       - onsite links containing any of the above
 682 ;;       - offsite links ending in .rss, .rdf, or .xml
 683 ;;       - offsite links containing any of the above
 684           (let* ((base-uri (progn (string-match ".*://[^/]+/?" url)
 685                                   (match-string 0 url)))
 686                  (hrefs (nnrss-order-hrefs
 687                          base-uri (nnrss-extract-hrefs parsed-page)))
 688                  (rss-link nil))
 689           (while (and (eq rss-link nil) (not (eq hrefs nil)))
 690             (let ((href-data (nnrss-fetch (car hrefs))))
 691               (if (nnrss-rss-p href-data)
 692                   (let* ((rss-ns (nnrss-get-namespace-prefix href-data "http://purl.org/rss/1.0/")))
 693                     (setq rss-link (nnrss-rss-title-description
 694                                     rss-ns href-data (car hrefs))))
 695                 (setq hrefs (cdr hrefs)))))
 696           (if rss-link rss-link
 697
 698 ;;    4. check syndic8
 699             (nnrss-find-rss-via-syndic8 url))))))))
 700
 701 (defun nnrss-find-rss-via-syndic8 (url)
 702   "Query syndic8 for the rss feeds it has for URL."
 703   (if (not (locate-library "xml-rpc"))
 704       (progn
 705         (message "XML-RPC is not available... not checking Syndic8.")
 706         nil)
 707     (require 'xml-rpc)
 708     (let ((feedid (xml-rpc-method-call
 709                    "http://www.syndic8.com/xmlrpc.php"
 710                    'syndic8.FindSites
 711                    url)))
 712       (when feedid
 713         (let* ((feedinfo (xml-rpc-method-call
 714                           "http://www.syndic8.com/xmlrpc.php"
 715                           'syndic8.GetFeedInfo
 716                           feedid))
 717                (urllist
 718                 (delq nil
 719                       (mapcar
 720                        (lambda (listinfo)
 721                          (if (string-equal
 722                               (cdr (assoc "status" listinfo))
 723                               "Syndicated")
 724                              (cons
 725                               (cdr (assoc "sitename" listinfo))
 726                               (list
 727                                (cons 'title
 728                                      (cdr (assoc
 729                                            "sitename" listinfo)))
 730                                (cons 'href
 731                                      (cdr (assoc
 732                                            "dataurl" listinfo)))))))
 733                        feedinfo))))
 734           (if (not (> (length urllist) 1))
 735               (cdar urllist)
 736             (let ((completion-ignore-case t)
 737                   (selection
 738                    (mapcar (lambda (listinfo)
 739                              (cons (cdr (assoc "sitename" listinfo))
 740                                    (string-to-int
 741                                     (cdr (assoc "feedid" listinfo)))))
 742                            feedinfo)))
 743               (cdr (assoc
 744                     (completing-read
 745                      "Multiple feeds found.  Select one: "
 746                      selection nil t) urllist)))))))))
 747
 748 (defun nnrss-rss-p (data)
 749   "Test if DATA is an RSS feed.
 750 Simply ensures that the first element is rss or rdf."
 751   (or (eq (caar data) 'rss)
 752       (eq (caar data) 'rdf:RDF)))
 753
 754 (defun nnrss-rss-title-description (rss-namespace data url)
 755   "Return the title of an RSS feed."
 756   (if (nnrss-rss-p data)
 757       (let ((description (intern (concat rss-namespace "description")))
 758             (title (intern (concat rss-namespace "title")))
 759             (channel (nnrss-find-el (intern (concat rss-namespace "channel"))
 760                                     data)))
 761         (list
 762          (cons 'description (caddr (nth 0 (nnrss-find-el description channel))))
 763          (cons 'title (caddr (nth 0 (nnrss-find-el title channel))))
 764          (cons 'href url)))))
 765
 766 (defun nnrss-get-namespace-prefix (el uri)
 767   "Given EL (containing a parsed element) and URI (containing a string
 768 that gives the URI for which you want to retrieve the namespace
 769 prefix), return the prefix."
 770   (let* ((prefix (car (rassoc uri (cadar el))))
 771          (nslist (if prefix
 772                      (split-string (symbol-name prefix) ":")))
 773          (ns (cond ((eq (length nslist) 1) ; no prefix given
 774                     "")
 775                    ((eq (length nslist) 2) ; extract prefix
 776                     (cadr nslist)))))
 777     (if (and ns (not (eq ns "")))
 778         (concat ns ":")
 779       ns)))
 780
 781 (provide 'nnrss)
 782
 783
 784 ;;; nnrss.el ends here
 785