emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Arun Isaac <theroarofthedragon@gmail.com>
To: emacs-org <emacs-orgmode@gnu.org>
Subject: Re: Bug: XML entities in the ox-rss exporter
Date: Wed, 25 May 2016 15:42:00 +0530	[thread overview]
Message-ID: <87fut6qwen.fsf@gmail.com> (raw)
In-Reply-To: <8737p79o8m.fsf@saiph.selenimh>


[-- Attachment #1.1: Type: text/plain, Size: 798 bytes --]


>> I can provide a patch for this. 

Please find attached the patch.

> Since "ox-rss.el" loads "ox-html", could you re-use code in the latter?

I think even ox-html could benefit from using an XML/HTML generation
library that can convert s-expressions to XML/HTML. xml.el has
`xml-parse-region' to convert XML strings to an s-expression tree, but
unfortunately has no function to do the inverse, that is, convert an
s-expression tree to an XML string. If it had such a function, we
needn't have to depend on an external library such as xmlgen, and things
would have been more convenient.

Anyways, for now, I have implemented a patch which uses
`org-rss-plain-text' (which, in turn uses `org-html-encode-plain-text')
to encode the disallowed characters to their XML entities.


[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 472 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: ox-rss-Encode-characters-to-their-XML-entities.patch --]
[-- Type: text/x-diff, Size: 1999 bytes --]

From 2b310b32234e6193154c9850d51aaa8ed312f2df Mon Sep 17 00:00:00 2001
From: Arun Isaac <theroarofthedragon@gmail.com>
Date: Wed, 25 May 2016 15:11:34 +0530
Subject: [PATCH] ox-rss: Encode characters to their XML entities

* contrib/lisp/ox-rss.el (org-rss-build-channel-info, org-rss-headline):
  Encode disallowed characters in `title' to their XML entities

The `title' field is user specified and may contain characters such as
"&", "<" or ">" that are disallowed in XML. These characters should be
encoded into their corresponding XML entities.
---
 contrib/lisp/ox-rss.el | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/contrib/lisp/ox-rss.el b/contrib/lisp/ox-rss.el
index 0c4a2f2..95d20ec 100644
--- a/contrib/lisp/ox-rss.el
+++ b/contrib/lisp/ox-rss.el
@@ -248,12 +248,13 @@ communication channel."
 			    (format-time-string
 			     "%a, %d %b %Y %H:%M:%S %z"
 			     (org-time-string-to-time pubdate0)))))
-	     (title (or (org-element-property :RSS_TITLE headline)
-			(replace-regexp-in-string
-			 org-bracket-link-regexp
-			 (lambda (m) (or (match-string 3 m)
-					 (match-string 1 m)))
-			 (org-element-property :raw-value headline))))
+	     (title (org-rss-plain-text
+		     (or (org-element-property :RSS_TITLE headline)
+			 (replace-regexp-in-string
+			  org-bracket-link-regexp
+			  (lambda (m) (or (match-string 3 m)
+					  (match-string 1 m)))
+			  (org-element-property :raw-value headline))) info))
 	     (publink
 	      (or (and hl-perm (concat (or hl-home hl-pdir) hl-perm))
 		  (concat
@@ -318,7 +319,7 @@ as a communication channel."
 (defun org-rss-build-channel-info (info)
   "Build the RSS channel information."
   (let* ((system-time-locale "C")
-	 (title (plist-get info :title))
+	 (title (org-rss-plain-text (or (plist-get info :title) "") info))
 	 (email (org-export-data (plist-get info :email) info))
 	 (author (and (plist-get info :with-author)
 		      (let ((auth (plist-get info :author)))
-- 
2.8.2


  reply	other threads:[~2016-05-25 10:12 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-05-17 19:20 Bug: XML entities in the ox-rss exporter Arun Isaac
2016-05-24 20:48 ` Nicolas Goaziou
2016-05-25 10:12   ` Arun Isaac [this message]
2016-05-26 10:17     ` Arun Isaac
2016-05-26 12:05       ` Arun Isaac
2016-05-26 13:22         ` Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87fut6qwen.fsf@gmail.com \
    --to=theroarofthedragon@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).