Changeset 726

Timestamp:

08/19/2007 08:41:38 PM (3 years ago)

Author:

JavaWoman

Message:

• fixes a number of notices that prevented a feed from being displayed directly in the browser, (or as an aggregated feed via the {{rss}} action)
• some other small bugs fixed as well
• added @todo and @@@ markers in the source for further issues to be resolved (see #552 a.o); see also remarks about usage of the $item->source attribute (currently used only in an RSS 1.0 feed as a dc:source element)
• corrects @since tag in recentchanges.xml.php

refs #496,
refs #552

Location:

trunk/handlers

Files:

• comments.xml/comments.xml.php (modified) (8 diffs)
• recentchanges.xml/recentchanges.xml.php (modified) (7 diffs)

trunk/handlers/comments.xml/comments.xml.php

@@ -14 +14 @@
  * @access      public
  * @since       1.1.7
+ *
  * @uses        FeedCreator
  * @uses        Config::$base_url
@@ -22 +23 @@
  * @uses        Wakka::LoadRecentComments()
  * @uses        Wakka::StaticHref()
- * 
+ *
+ * @input       string  $f      optional GET parameter: output format, can be any of the
+ *                                      following: RSS0.91, RSS1.0, RSS2.0, ATOM1.0
+ *                                      default: RSS2.0
+ *                                      the default can be overridden by providing a URL parameter 'f'.
+ * @output      feed for recent comments in the specified format.
  * @todo        move some defaults to wiki configuration files
  * @todo        add flexible filtering support
@@ -30 +36 @@
  * @todo        use stylesheet compatible with multiple feed formats
  * @todo        allow feed for one page only, e.g. Feed for comments on my userpage only. Perhaps by adding params in $_GET.
- *
- * @input       string  $f      optional: output format, can be any of the following: 
- *                              RSS0.91, RSS1.0, RSS2.0, ATOM1.0
- *                              default: RSS2.0
- *                              the default format can be overridden by providing a URL parameter 'f'.
- * @output      feed for recently changed pages in the specified format.
+ * @todo        replace htmlspecialchars() in FeedCreator with our secure version (!)
+ * @todo        either do not escape a <link> in FeedCreator, or feed it a URL that
+ *                      does not already have '&' in a URL escaped (as Href() is doing!)
+ *                      because it gets "double-escaped" now; in fact, I think it should not
+ *                      be escaped at all in a feed, only in HTML
+ * @todo        review whether page, or actual comment, should be used for the item
+ *                      'source' attribute in RSS 1.0
+ * @todo        replace current feed image 'images/wikka_logo.jpg' by a more
+ *                      appropriate smaller feed image
  */
 
@@ -78 +87 @@
 //get URL parameters
 $formats = explode(",",FEED_VALID_FORMATS);
-$f = (in_array($_GET['f'], $formats))? $_GET['f'] : FEED_DEFAULT_OUTPUT_FORMAT;
+#$f = (in_array($_GET['f'], $formats))? $_GET['f'] : FEED_DEFAULT_OUTPUT_FORMAT;
+$f = (isset($_GET['f']) && in_array($_GET['f'], $formats)) ? $_GET['f'] : FEED_DEFAULT_OUTPUT_FORMAT;
 
 //create object
@@ -97 +107 @@
 $rss->descriptionTruncSize = FEED_DESCRIPTION_TRUNCATE_SIZE;
 $rss->descriptionHtmlSyndicated = FEED_DESCRIPTION_HTML;
-$rss->link = $this->Href('', $this->GetConfigValue('root_page'));       // just $this->Href() should do it!
-$rss->syndicationURL = $this->Href($this->method,'','f='.$f);
+$rss->link = $this->Href('', $this->GetConfigValue('root_page'));
+$rss->syndicationURL = $this->Href($this->handler,'','f='.$f);
 
 //create feed image
@@ -105 +115 @@
 $image->title = FEED_IMAGE_TITLE;
 $image->url = FEED_IMAGE_URL;
-$image->link = $this->Href('', $this->GetConfigValue('root_page'));     // just $this->Href() should do it!
+$image->link = $this->Href('', $this->GetConfigValue('root_page'));
 $image->description = FEED_IMAGE_DESCRIPTION;
 $image->descriptionTruncSize = FEED_DESCRIPTION_TRUNCATE_SIZE;
@@ -114 +124 @@
 $n = (int) $n;
 // get feed items
-// To optimize memory usage, we should load the minimum items. But, we must load 
+// To optimize memory usage, we should load the minimum items. But, we must load
 // more than what we need, because we may have no rights on some items.
 // Twice the number we need is just an arbitrary value!!! (2*$n)
@@ -131 +141 @@
                 $item->title = $comment['page_tag']; 
                 $item->link = $this->Href('', $comment['page_tag'], 'show_comments=1').'#comment_'.$comment['id'];
+                // @@@ ^ uses &amp;amp; in all formats - this is FC escaping the &amp; that Href() outputs
+                // WARNING: the double escape comes from the use of htmlspecialchars()
+                // see also recentchanges.xml.php
                 $item->date = date('r', strtotime($comment['time'])); 
                 $item->description = 'By '.$comment['user'].': '.$comment['comment']."\n";
                 #$item->source = $this->GetConfigValue('base_url');
-                $item->source = $this->base_url;        // @@@ JW: should link to actual comment, I think
-                if ($f == 'ATOM1.0' || $f == 'RSS1.0') 
+                #$item->source = $this->base_url;       // home page
+                // @@@ ^ JW: should link to actual comment, or (maybe) the page that has the comment
+/*
+http://dublincore.org/documents/1999/07/02/dces/
+Element: Source
+
+  Name:        Source
+  Identifier:  Source
+  Definition:  A Reference to a resource from which the present resource
+               is derived.
+  Comment:     The present resource may be derived from the Source resource
+               in whole or in part.  Recommended best practice is to reference 
+               the resource by means of a string or number conforming to a 
+               formal identification system.
+*/
+                if ('RSS1.0' == $f)             // dc:source used only here
+                {
+                        $item->source = $this->Href('', $comment['page_tag']);  // use page, rather than comment, for now
+                }
+                #if ($f == 'ATOM1.0' || $f == 'RSS1.0')
+                if (('ATOM1.0' == $f || 'RSS1.0' == $f) && $this->existsUser($comment['user'])) // check for existence of user
                 {
                         $item->author = $comment['user']; # RSS0.91 and RSS2.0 require authorEmail
                 }
-                $rss->addItem($item); 
+                $rss->addItem($item);
+
                 if ($c == $n)                                   // enough!
                 {

trunk/handlers/recentchanges.xml/recentchanges.xml.php

@@ -7 +7 @@
  *
  * @package             Handlers
- * @author              {@link http://wikkawiki.org/DarTar Dario Taraborelli}
+ * @author              {@link http://wikkawiki.org/DarTar Dario Taraborelli} (rewrite using FeedCreator)
  * @version             $Id$
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
+ * @license             http://www.gnu.org/copyleft/gpl.html GNU General Public License
  * @filesource
  *
  * @access      public
- * @since       1.1.7
+ * @since       1.0.0
+ *
  * @uses        FeedCreator
  * @uses        Config::$base_url
@@ -33 +34 @@
  * @todo        use stylesheet compatible with multiple feed formats
  *
- * @input       string  $f      optional: output format, can be any of the following: 
- *                              RSS0.91, RSS1.0, RSS2.0, ATOM1.0
- *                              default: RSS2.0
- *                              the default format can be overridden by providing a URL parameter 'f'.
+ * @input       string  $f      optional GET parameter: output format, can be any of the
+ *                                      following: RSS0.91, RSS1.0, RSS2.0, ATOM1.0
+ *                                      default: RSS2.0
+ *                                      the default can be overridden by providing a URL parameter 'f'.
  * @output      feed for recently changed pages in the specified format.
+ * @todo        replace htmlspecialchars() in FeedCreator with our secure version (!)
+ * @todo        either do not escape a <link> in FeedCreator, or feed it a URL that
+ *                      does not already have '&' in a URL escaped (as Href() is doing!)
+ *                      because it gets "double-escaped" now; in fact, I think it should not
+ *                      be escaped at all in a feed, only in HTML
+ * @todo        replace current feed image 'images/wikka_logo.jpg' by a more
+ *                      appropriate smaller feed image
  */
 
@@ -61 +69 @@
  * Logo image to be used.
  */
-if (!defined('FEED_IMAGE_PATH')) define('FEED_IMAGE_PATH', $this->StaticHref('images/wikka_logo.jpg'));
+if (!defined('FEED_IMAGE_URL')) define('FEED_IMAGE_URL', $this->StaticHref('images/wikka_logo.jpg'));
 
 /**#@+
@@ -85 +93 @@
 //get URL parameters
 $formats = explode(',',FEED_VALID_FORMATS);
-$f = (in_array($_GET['f'], $formats))? $_GET['f'] : FEED_DEFAULT_OUTPUT_FORMAT;
+#$f = (in_array($_GET['f'], $formats))? $_GET['f'] : FEED_DEFAULT_OUTPUT_FORMAT;
+$f = (isset($_GET['f']) && in_array($_GET['f'], $formats)) ? $_GET['f'] : FEED_DEFAULT_OUTPUT_FORMAT;
 
 //create object
@@ -104 +113 @@
 $rss->descriptionTruncSize = FEED_DESCRIPTION_TRUNCATE_SIZE;
 $rss->descriptionHtmlSyndicated = FEED_DESCRIPTION_HTML;
-$rss->link = $this->Href('', $this->GetConfigValue('root_page'));       // just $this->Href() should do it!
-$rss->syndicationURL = $this->Href($this->method,'','f='.$f); 
+$rss->link = $this->Href('', $this->GetConfigValue('root_page'));
+$rss->syndicationURL = $this->Href($this->handler,'','f='.$f); 
 
 //create feed image
@@ -111 +120 @@
 $image = instantiate('FeedImage');
 $image->title = FEED_IMAGE_TITLE;
-$image->url = $PHP_SELF.FEED_IMAGE_PATH;
-$image->link = $this->Href('', $this->GetConfigValue('root_page'));     // just $this->Href() should do it!
+$image->url = FEED_IMAGE_URL;
+$image->link = $this->Href('', $this->GetConfigValue('root_page'));
 $image->description = FEED_IMAGE_DESCRIPTION;
 $image->descriptionTruncSize = FEED_DESCRIPTION_TRUNCATE_SIZE;
@@ -130 +139 @@
                         #$item = new FeedItem();
                         $item = instantiate('FeedItem');
-                        $item->title = $page['tag']; 
-                        $item->link = $this->Href('show', $page['tag'], 'time='.urlencode($page['time'])); 
-                        $item->date = date('r',strtotime($page['time'])); 
+                        $item->title = $page['tag'];
+                        #$item->link = $this->Href('show', $page['tag'], 'time='.urlencode($page['time'])); 
+                        $item->link = $this->Href('', $page['tag'], 'time='.urlencode($page['time']));
+                        // @@@ ^ uses &amp;amp; in all formats - this is FC escaping the &amp; that Href() outputs
+                        // WARNING: the double escape comes from the use of htmlspecialchars()
+                        // 1. we need to replace this with our own secure version
+                        // 2. we should NOT use it on already-escaped links -OR- feed it
+                        //    links that that have & not escaped (yet)
+                        $item->date = date('r',strtotime($page['time']));       // RFC2822
                         $item->description = sprintf(FEED_ITEM_DESCRIPTION, $page['user']).($page['note'] ? ' ('.$page['note'].')' : '')."\n";
                         #$item->source = $this->GetConfigValue('base_url');
-                        $item->source = $this->base_url;        // home page    // @@@ JW: should link to actual page, I think
-                        #if (($f == 'ATOM1.0' || $f == 'RSS1.0') && $this->LoadUser($page['user']))// @@@ only check for existence of user here
-                        if (($f == 'ATOM1.0' || $f == 'RSS1.0') && $this->existsUser($page['user']))// @@@ only check for existence of user here
+                        #$item->source = $this->base_url;       // home page
+                        // @@@ JW: ^ should link to *actual* page not root
+/*
+http://dublincore.org/documents/1999/07/02/dces/
+Element: Source
+
+  Name:        Source
+  Identifier:  Source
+  Definition:  A Reference to a resource from which the present resource
+               is derived.
+  Comment:     The present resource may be derived from the Source resource
+               in whole or in part.  Recommended best practice is to reference 
+               the resource by means of a string or number conforming to a 
+               formal identification system.
+*/
+                        if ('RSS1.0' == $f)             // dc:source used only here
+                        {
+                                $item->source = $this->Href('', $page['tag']);  // correct, I think, but actually redundant -- JW
+                        }
+                        #if (($f == 'ATOM1.0' || $f == 'RSS1.0') && $this->LoadUser($page['user']))     //only check for existence of user here
+                        if (('ATOM1.0' == $f || 'RSS1.0' == $f) && $this->existsUser($page['user']))    // check for existence of user
                         {
                                 $item->author = $page['user']; # RSS0.91 and RSS2.0 require authorEmail
                         }
-                        $rss->addItem($item); 
+                        $rss->addItem($item);
                 }
         }
-} 
+}
 
 //output feed