Add a function to write an Atom feed to a file.

[atom.el.git] / atom.el

diff --git a/atom.el b/atom.el
index 42738e5c755dcc9cc5745f328519a4fee04e6d6a..c73c7d90704d10c8140183bff29e23e9d18a4603 100644 (file)
--- a/atom.el
+++ b/atom.el
@@ -62,12 +62,11 @@
 ;;    "<p>One can also use <acronym>XHTML</acronym> in the entries.</p>")
 ;;   (atom-print my-atom-feed))
 
 ;;    "<p>One can also use <acronym>XHTML</acronym> in the entries.</p>")
 ;;   (atom-print my-atom-feed))
 

-

 ;;; Code:
 
 (require 'xml)
 
 ;;; Code:
 
 (require 'xml)
 

-(defun atom-create (title link &optional author updated id)
+(defun atom-create (title link &optional author self updated id)

   "Create a new atom structure.
 
 TITLE is the title for the feed, a short, text-only, human
   "Create a new atom structure.
 
 TITLE is the title for the feed, a short, text-only, human


@@ -76,6 +75,8 @@ readable string.
 AUTHOR is the author of the feed. See `atom-massage-author' for
 the possible ways to specify it.
 
 AUTHOR is the author of the feed. See `atom-massage-author' for
 the possible ways to specify it.
 

+SELF is the canonical URL to this feed.
+

 LINK is the URL of a page responible for the content of this
 feed.
 
 LINK is the URL of a page responible for the content of this
 feed.
 


@@ -84,27 +85,27 @@ UPDATED is the date the feed was last updated. If not given,
 
 ID is a unique identifier for this feed. If not given, it
 defaults to LINK."
 
 ID is a unique identifier for this feed. If not given, it
 defaults to LINK."

-  `((title nil ,title)
-    (link ((href . ,link)))
-    ,(atom-massage-author author)
-    (updated nil ,(atom-format-time updated))
-    (id nil ,(or id link))))
+  (let ((atom-feed (list (list 'title nil title))))
+    (atom-modify-entry atom-feed 'link `(((href . ,link))))
+    (atom-modify-entry atom-feed 'author (atom-massage-author author))
+    (if self (atom-modify-entry atom-feed 'link
+                               `(((href . ,self) (rel . "self")
+                                  (type . "application/atom+xml")))))
+    (atom-modify-entry atom-feed 'updated (atom-format-time updated))
+    (atom-modify-entry atom-feed 'id (or id link))
+    atom-feed))

 
 (defun atom-push-entry (atom entry)
   "Add the entry ENTRY to the feed ATOM."
 
 (defun atom-push-entry (atom entry)
   "Add the entry ENTRY to the feed ATOM."

-  (nconc atom (list `(entry nil . ,entry))))
+  (nconc atom (list `(entry nil ,@entry))))

 
 (defun atom-modify-entry (entry name val)
 
 (defun atom-modify-entry (entry name val)

-  "Set the NAME element of ENTRY to VAL."
-  (let ((elem (assoc name entry)))
-    (if elem
-       (if (stringp val)
-           (setcar (cddr elem) val)
-         (setcdr elem val))
-      (setq elem (if (stringp val)
-                    (list name nil val)
-                  (cons name val)))
-      (nconc entry (list elem)))))
+  "Set the NAME element of ENTRY to VAL. A true MULTIPLE means
+to add a new element instead of updating it when it already exists."
+  (let ((elem (if (stringp val)
+                 (list name nil val)
+               (cons name val))))
+    (nconc entry (list elem))))

 
 (defun atom-add-entry (atom title link content
                            &optional updated id summary)
 
 (defun atom-add-entry (atom title link content
                            &optional updated id summary)


@@ -147,10 +148,8 @@ when the content of the entry ."
 be a string enconding a valid HTML fragment. See `atom-add-entry'
 for additional details."
   (atom-add-entry atom
 be a string enconding a valid HTML fragment. See `atom-add-entry'
 for additional details."
   (atom-add-entry atom

-   title link
-   (atom-massage-html content)
-   (and summary (atom-massage-html summary))
-   updated id))
+   title link (atom-massage-html content)
+   updated id (and summary (atom-massage-html summary))))

 
 (defun atom-add-xhtml-entry (atom title link content
                                  &optional updated id summary)
 
 (defun atom-add-xhtml-entry (atom title link content
                                  &optional updated id summary)


@@ -158,10 +157,8 @@ for additional details."
 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
 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)
-   (and summary        (atom-massage-xhtml summary))
-   updated id))
+   title link (atom-massage-xhtml content)
+   updated id (and summary (atom-massage-xhtml summary))))

 
 (defun atom-print (atom)
   "Print the Atom feed ATOM in the current buffer."
 
 (defun atom-print (atom)
   "Print the Atom feed ATOM in the current buffer."


@@ -170,6 +167,12 @@ fragment. See `atom-add-entry' for additional details."
   (xml-print atom)
   (insert "\n</feed>"))
 
   (xml-print atom)
   (insert "\n</feed>"))
 

+(defun atom-write-file (atom filename)
+  "Writes the feed ATOM to FILENAME."
+  (with-temp-buffer
+    (atom-print atom)
+    (write-region (point-min) (point-max) filename)))
+

 \f
 (defun atom-format-time (&optional time)
   "Format a time according to RFC3339."
 \f
 (defun atom-format-time (&optional time)
   "Format a time according to RFC3339."


@@ -188,17 +191,18 @@ Atom feed. CONTENT must be a string."
 (defun atom-string-to-xml (string)
   "Convert STRING into a Lisp structure as used by `xml.el'."
   (with-temp-buffer
 (defun atom-string-to-xml (string)
   "Convert STRING into a Lisp structure as used by `xml.el'."
   (with-temp-buffer

+    (insert "<div xmlns=\"http://www.w3.org/1999/xhtml\">")

     (insert string)
     (insert string)

+    (insert "</div>")

     (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."
     (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."

-  (list '((type . "xhtml"))
-       `(div ((xmlns . "http://www.w3.org/1999/xhtml"))
-             . ,(or (and (stringp content)
-                         (atom-string-to-xml content))
-                    content))))
+  `(((type . "xhtml"))
+    ,@(or (and (stringp content)
+              (atom-string-to-xml content))
+         content)))

 
 (defun atom-massage-author (author)
   "Return an XML node representing the author. AUTHOR can be:
 
 (defun atom-massage-author (author)
   "Return an XML node representing the author. AUTHOR can be:


@@ -208,22 +212,20 @@ Atom feed."
 - a list with two elements, the full name and the email address
   of the author;
 - something else, assumed to be a complete `atomPersonConstruct'."
 - a list with two elements, the full name and the email address
   of the author;
 - something else, assumed to be a complete `atomPersonConstruct'."

-  (cond
-   ((null author) `(author nil 
-                          (name nil ,user-full-name)
-                          (email nil ,user-mail-address)))
-   ((stringp author) `(author nil 
-                             (name nil ,user-full-name)))
-   ((= 2 (length author)) `(author nil (name nil ,(car author))
-                                  (email nil ,(cadr author))))
-   (t `(author nil ,author))))
+  `(nil ,@(cond
+          ((null author) `((name nil ,user-full-name)
+                           (email nil ,user-mail-address)))
+          ((stringp author) `((name nil ,author)))
+          ((= 2 (length author)) `((name nil ,(car author))
+                                   (email nil ,(cadr author))))
+          (t `(author nil ,author)))))

 
 (require 'url-parse)
 
 (defun atom-generate-id (link creation-date)
   "Generate a string suitable for use as an atom:id element. This
 implements Mark Pilgrom's tag: URI method, using the
 
 (require 'url-parse)
 
 (defun atom-generate-id (link creation-date)
   "Generate a string suitable for use as an atom:id element. This
 implements Mark Pilgrom's tag: URI method, using the

-CREATION-DATE of the entry, and the domain part of LINK"
+CREATION-DATE of the entry, and the domain part of LINK."

     (format "tag:%s,%s:/%s"
            (url-host (url-generic-parse-url link))
            (format-time-string "%Y-%m-%d" creation-date)
     (format "tag:%s,%s:/%s"
            (url-host (url-generic-parse-url link))
            (format-time-string "%Y-%m-%d" creation-date)