X-Git-Url: https://gitweb.fperrin.net/?a=blobdiff_plain;f=atom.el;h=51c9d7d0ba20b1d61a87d11b75ae9967756cf77c;hb=04fc260c5af5c992db43e4689d9775667554be5d;hp=ce01f85a09e4c18b16c267392ee03fdc64051166;hpb=36d9eaeb906863b92a3756eb6483f7cd05767e04;p=atom.git
diff --git a/atom.el b/atom.el
index ce01f85..51c9d7d 100644
--- a/atom.el
+++ b/atom.el
@@ -27,8 +27,7 @@
;; permanent link and the content of the entry. Text-only, HTML and
;; XHTML entries are supported.
-;; A feed is really a Lisp structure as used by the `xml.el' package,
-;; without the parent `feed' element.
+;; It is possible to produce both Atom and RSS feeds.
;; A typical usage would look like this:
@@ -40,31 +39,23 @@
;; "http://example.org/hello"
;; "Hello the world!")
;;
-;; ; A text-only entry, with all the optional pieces of data
-;; (atom-add-text-entry
-;; my-atom-feed
-;; "Bonjour"
-;; "http://example.org/bonjour"
-;; "Bonjour à tout le monde !"
-;; ;; optional: the last modification time
-;; (date-to-time "2011-01-30 23:40:12")
-;; ;; optional: an identifier for this entry; a common way to generate it is
-;; ;; to use the domain name and the creation date of the entry.
-;; (atom-generate-id "http://example.org"
-;; (date-to-time "2011-01-30 10:01:05"))
-;; ;; optional: a summary for this entry
-;; "Bonjour, monde.")
-;;
;; (atom-add-xhtml-entry
;; my-atom-feed
;; "An XHTML example"
;; "http://example.org/html-example"
;; "
One can also use XHTML in the entries.
")
-;; (atom-print my-atom-feed))
+;;
+;; (atom-print my-atom-feed)
+;; ;; If you prefer RSS feeds:
+;; (atom-to-rss-print my-atom-feed))
+
+;; Full documentation is available at .
;;; Code:
(require 'xml)
+(require 'url-parse)
+(require 'cl) ; for setf in url-canonalize
(defun atom-create (title link &optional subtitle self id author updated)
"Create a new atom structure.
@@ -84,7 +75,8 @@ ID is a unique identifier for this feed. If not given, it
defaults to SELF.
AUTHOR is the author of the feed. See `atom-massage-author' for
-the possible ways to specify it.
+the possible ways to specify it. In particular, `nil' uses
+`user-full-name' and `user-mail-address'.
UPDATED is the date the feed was last updated. If not given,
`(current-time)' is used."
@@ -155,13 +147,19 @@ for additional details."
updated id (and summary (atom-massage-html summary))))
(defun atom-add-xhtml-entry (atom title link content
- &optional updated id summary)
+ &optional updated id summary noconvert)
"Add an entry to ATOM, with some XHTML content. CONTENT may be
given either as a string, or as an XML tree, of a valid XHTML
-fragment. See `atom-add-entry' for additional details."
- (atom-add-entry atom
- title link (atom-massage-xhtml content)
- updated id (and summary (atom-massage-xhtml summary))))
+fragment. See `atom-add-entry' for additional details.
+
+If CONVERT, translate all links in CONTENT so that they are no
+longer relative to LINK."
+ (let ((xhtml-content (atom-massage-xhtml content)))
+ (unless noconvert
+ (atom-xhtml-convert-links (cadr xhtml-content) link))
+ (atom-add-entry atom
+ title link xhtml-content
+ updated id (and summary (atom-massage-xhtml summary)))))
(defun atom-print (atom)
"Print the Atom feed ATOM in the current buffer."
@@ -205,7 +203,7 @@ Some information may be lost or approximated."
(setcar (cdr guid) (list (cons 'isPermaLink "false"))))
(if (and descr
(equal (xml-get-attribute descr 'type) "xhtml"))
- (setcar (cddr descr) (xml-node-text descr))))
+ (setcar (cddr descr) (xml-node-as-text descr))))
`(item nil ,@item)))
(defun atom-to-rss-translator (source target translations)
@@ -216,15 +214,9 @@ Some information may be lost or approximated."
(when data
(atom-modify-entry target to data)))))
-(defun xml-node-text (node)
- (with-temp-buffer
- (xml-print (xml-node-children node))
- (buffer-string)))
-
(defun atom-to-rss-modify-link (entry)
(let* ((link (assoc 'link entry))
(link-addr (xml-get-attribute-or-nil link 'href)))
- (message "%S" link)
(when link
(setcar (cdr link) nil)
(setcdr (cdr link) (cons link-addr nil)))))
@@ -284,21 +276,25 @@ Atom feed. CONTENT must be a string."
(insert "")
(insert string)
(insert "
")
- (xml-parse-region (point-min) (point-max))))
+ ;; `xml-parse-region' doesn't require that the XML parsed be enclosed in a
+ ;; root node, and accordingly, returns a list of elements. We are only
+ ;; interested in the first one, the DIV we just inserted.
+ (car (xml-parse-region (point-min) (point-max)))))
(defun atom-massage-xhtml (content)
"Massage CONTENT so it can be used as an XHTML fragment in an
Atom feed."
- `(((type . "xhtml"))
- ,@(or (and (stringp content)
- (atom-string-to-xml content))
- content)))
+ (list '((type . "xhtml"))
+ (or (and (stringp content)
+ (atom-string-to-xml content))
+ `(div ((xmlns . "http://www.w3.org/1999/xhtml\">")) ,@content))))
(defun atom-massage-author (author)
"Return an XML node representing the author. AUTHOR can be:
- nil, in which case `user-full-name' and `user-mail-address' are
used;
-- a single string, the full name of the author;
+- a single string, the full name of the author; no email address
+ will be included;
- a list with two elements, the full name and the email address
of the author;
- something else, assumed to be a complete `atomPersonConstruct'."
@@ -310,7 +306,14 @@ Atom feed."
(email nil ,(cadr author))))
(t `(author nil ,author)))))
-(require 'url-parse)
+(defun atom-xhtml-convert-links (node base)
+ "Make all links in NODE (a fragment of an XHTML document)
+absolute, in the context of BASE, an URL."
+ (dolist (attr-name (list 'href 'src))
+ (let ((attr (assoc attr-name (xml-node-attributes node))))
+ (when attr (setcdr attr (url-canonalize (cdr attr) base)))))
+ (dolist (child (xml-node-children node))
+ (when (listp child) (atom-xhtml-convert-links child base))))
(defun atom-generate-id (link creation-date)
"Generate a string suitable for use as an atom:id element. This
@@ -321,5 +324,30 @@ CREATION-DATE of the entry, and the domain part of LINK."
(format-time-string "%Y-%m-%d" creation-date)
(format-time-string "%Y%m%d%H%M%S" creation-date)))
+
+;;; Functions that should probably not be there
+
+(defun url-canonalize (address base)
+ "Make ADRESS an absolute URL, taking it in the BASE context."
+ ;; I feel such a function should exist in `url-parse'. Did I miss it?
+ (let ((url-base (url-generic-parse-url base))
+ (url-address (url-generic-parse-url address)))
+ (if (url-host url-address)
+ address
+ (setf (url-filename url-base)
+ (expand-file-name address
+ (file-name-directory (url-filename url-base))))
+ (url-recreate-url url-base))))
+
+(defun xml-node-as-text (node)
+ "Return a string representing NODE, an XML structure."
+ (with-temp-buffer
+ (xml-print (xml-node-children node))
+ (buffer-string)))
+
+(defun xml-node-create (name attrlist childlist)
+ "Create a new XML node."
+ (list name attrlist . childlist))
+
(provide 'atom)
;;; atom.el ends here