fixed author/email handling in RSS/Atom feeds

1) Now reports full user name for logged in users
2) Reports actual email when not mail guarding; otherwise it's "user@ip"
3) RSS 1.0 (default) format is now <dc:creator>name (email)</dc:creator>
4) RSS 0.91/RSS 2.0 format is now <author>email (name)</author>
5) Atom format is now <author><name>name</name><email>email</email></author>
6) When anonymous, all RSS formats just reports "user@ip" in element
7) When anonymous, Atom just reports <author><email>user@ip</email></author>

darcs-hash:20050916203852-36b45-ed5310a65360811bdd153ba12b0e925675bdd7a4.gz

2 files changed, 63 insertions, 12 deletions

diff --git a/feed.php b/feed.php
index 0e057eed3..9454a9b95 100644
--- a/feed.php
+++ b/feed.php
@@ -91,6 +91,7 @@
 function rssRecentChanges(&$rss,$num,$ltype,$ns){
   global $conf;
   if(!$num) $num = $conf['recent'];
+  $guardmail = ($conf['mailguard'] != '' && $conf['mailguard'] != 'none');
 
   $recents = getRecents(0,$num,false,$ns);
 
@@ -137,12 +138,23 @@ function rssRecentChanges(&$rss,$num,$ltype,$ns){
     if(strpos($id,':')!==false){
       $item->category    = substr($id,0,strrpos($id,':'));
     }
-    if($recents[$id]['user']){
-      $item->author = $recents[$id]['user'].'@';
+    
+    $user = null;
+    $user = @$recents[$id]['user']; // the @ spares time repeating lookup
+    $item->author = '';
+    
+    if($user){
+      $userInfo = auth_getUserData($user);
+      $item->author = $userInfo['name'];
+      if($guardmail) {
+        //cannot obfuscate because some RSS readers may check validity
+        $item->authorEmail = $user.'@'.$recents[$id]['ip'];
+      }else{
+        $item->authorEmail = $userInfo['mail'];
+      }
     }else{
-      $item->author = 'anonymous@';
+      $item->authorEmail = 'anonymous@'.$recents[$id]['ip'];
     }
-    $item->author  .= $recents[$id]['ip'];
     $rss->addItem($item);
   }
 }
diff --git a/inc/feedcreator.class.php b/inc/feedcreator.class.php
index 59f80cf36..09cecb613 100644
--- a/inc/feedcreator.class.php
+++ b/inc/feedcreator.class.php
@@ -685,7 +685,6 @@ class FeedCreator extends HtmlDescribable {
 			echo "<br /><b>Error creating feed file, please check write permissions.</b><br />";
 		}
 	}
-	
 }
 
 
@@ -846,8 +845,9 @@ class RSSCreator10 extends FeedCreator {
 			if ($this->items[$i]->source!="") {
 				$feed.= "        <dc:source>".htmlspecialchars($this->items[$i]->source)."</dc:source>\n";
 			}
-			if ($this->items[$i]->author!="") {
-				$feed.= "        <dc:creator>".htmlspecialchars($this->items[$i]->author)."</dc:creator>\n";
+            $creator = $this->getAuthor($this->items[$i]->author, $this->items[$i]->authorEmail);
+			if ($creator) {
+				$feed.= "        <dc:creator>".htmlspecialchars($creator)."</dc:creator>\n";
 			}
 			$feed.= "        <title>".htmlspecialchars(strip_tags(strtr($this->items[$i]->title,"\n\r","  ")))."</title>\n";
 			$feed.= "        <link>".htmlspecialchars($this->items[$i]->link)."</link>\n";
@@ -858,6 +858,22 @@ class RSSCreator10 extends FeedCreator {
 		$feed.= "</rdf:RDF>\n";
 		return $feed;
 	}
+
+    /**
+     * Compose the RSS-1.0 author field.
+     *
+     * @author Joe Lapp <joe.lapp@pobox.com>
+     */
+     
+    function getAuthor($author, $email) {
+      if($author) {
+        if($email) {
+          return $author.' ('.$email.')';
+        }
+        return $author;
+      }
+      return $email;
+    }        
 }
 
 
@@ -967,8 +983,9 @@ class RSSCreator091 extends FeedCreator {
 			$feed.= "            <link>".htmlspecialchars($this->items[$i]->link)."</link>\n";
 			$feed.= "            <description>".$this->items[$i]->getDescription()."</description>\n";
 			
-			if ($this->items[$i]->author!="") {
-				$feed.= "            <author>".htmlspecialchars($this->items[$i]->author)."</author>\n";
+            $author = $this->getAuthor($this->items[$i]->author, $this->items[$i]->authorEmail);
+			if ($author) {
+				$feed.= "            <author>".htmlspecialchars($author)."</author>\n";
 			}
 			/*
 			// on hold
@@ -996,6 +1013,19 @@ class RSSCreator091 extends FeedCreator {
 		$feed.= "</rss>\n";
 		return $feed;
 	}
+
+    /**
+     * Compose the RSS-0.91 and RSS-2.0 author field.
+     *
+     * @author Joe Lapp <joe.lapp@pobox.com>
+     */
+     
+    function getAuthor($author, $email) {
+      if($author && $email) {
+        return $email.' ('.$author.')';
+      }
+      return $email;
+    }        
 }
 
 
@@ -1127,11 +1157,20 @@ class AtomCreator03 extends FeedCreator {
 			$feed.= "        <modified>".htmlspecialchars($itemDate->iso8601())."</modified>\n";
 			$feed.= "        <id>".htmlspecialchars($this->items[$i]->link)."</id>\n";
 			$feed.= $this->_createAdditionalElements($this->items[$i]->additionalElements, "        ");
-			if ($this->items[$i]->author!="") {
+
+            $author = $this->items[$i]->author;
+            $authorEmail = $this->items[$i]->authorEmail;
+			if ($author || $authorEmail) {
 				$feed.= "        <author>\n";
-				$feed.= "            <name>".htmlspecialchars($this->items[$i]->author)."</name>\n";
-				$feed.= "        </author>\n";
+                if($author) {
+  				    $feed.= "            <name>".htmlspecialchars($author)."</name>\n";
+				}
+                if($authorEmail) {
+  				    $feed.= "            <email>".htmlspecialchars($authorEmail)."</email>\n";
+                }
+                $feed.= "        </author>\n";
 			}
+            
 			if ($this->items[$i]->description!="") {
 				$feed.= "        <summary>".htmlspecialchars($this->items[$i]->description)."</summary>\n";
 			}