make a new NoticeList widget and call it from StreamAction

I made a new notice-list widget (like the profile list) and call it
from StreamAction. This cleans up some of the mess in the various
notice-stream-showing classes.

I also changed show-stream so it uses a subclass of NoticeList that
doesn't show author info (which is unnecessary).

darcs-hash:20081211231252-5ed1f-ee6e551ed5a029406748120f12e2ff57c4a86493.gz

11 files changed, 246 insertions, 255 deletions

diff --git a/actions/all.php b/actions/all.php
index 729b8dd16..2a26e48d4 100644
--- a/actions/all.php
+++ b/actions/all.php
@@ -82,23 +82,10 @@ class AllAction extends StreamAction {
 		if (!$page) {
 			$page = 1;
 		}
-		
+
 		$notice = $user->noticesWithFriends(($page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
-											
-		common_element_start('ul', array('id' => 'notices'));
-		
-		$cnt = 0;
-		
-		while ($notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
-			$cnt++;
-			
-			if ($cnt > NOTICES_PER_PAGE) {
-				break;
-			}
-			
-			$this->show_notice($notice);
-		}
-		common_element_end('ul');
+
+        $cnt = $this->show_notice_list($notice);
 
 		common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 						  $page, 'all', array('nickname' => $user->nickname));
diff --git a/actions/deleteprofile.php b/actions/deleteprofile.php
index 99e65ceb7..9823900c5 100644
--- a/actions/deleteprofile.php
+++ b/actions/deleteprofile.php
@@ -103,8 +103,7 @@ class DeleteprofileAction extends Action {
 		common_hidden('token', common_session_token());
         common_element('p', null, "Last chance to copy your notices and contacts by saving the two links below before deleting your account. Be careful, this operation cannot be undone.");
 
-
-		$this->show_feeds_list(array(0=>array('href'=>common_local_url('userrss', array('limit' => $notice_count, 'nickname' => $user->nickname)), 
+		$this->show_feeds_list(array(0=>array('href'=>common_local_url('userrss', array('limit' => $notice_count, 'nickname' => $user->nickname)),
 											  'type' => 'rss',
 											  'version' => 'RSS 1.0',
 											  'item' => 'notices'),
@@ -146,7 +145,7 @@ class DeleteprofileAction extends Action {
 
         $fave = new Fave;
         $fave->user_id = $user->id;
-        $n_faves_deleted = $fave->delete(); 
+        $n_faves_deleted = $fave->delete();
 
         $confirmation = new Confirm_address;
         $confirmation->user_id = $user->id;
@@ -177,7 +176,7 @@ class DeleteprofileAction extends Action {
         $profile_tagged = new Profile_tag;
         $profile_tagged->tagged = $user->id;
         $n_profiles_tagged_deleted = $profile_tagged->delete();
-               
+
         $remember_me = new Remember_me;
         $remember_me->user_id = $user->id;
         $n_remember_mes_deleted = $remember_me->delete();
@@ -257,7 +256,7 @@ class DeleteprofileAction extends Action {
 				'othersettings' =>
 				array(_('Other'),
 					  _('Other options')));
-		
+
         $action = $this->trimmed('action');
         common_element_start('ul', array('id' => 'nav_views'));
         foreach ($menu as $menuaction => $menudesc) {
diff --git a/actions/favorited.php b/actions/favorited.php
index 16bd8f226..13962b42e 100644
--- a/actions/favorited.php
+++ b/actions/favorited.php
@@ -88,19 +88,7 @@ class FavoritedAction extends StreamAction {
 		$notice->query(sprintf('SELECT * FROM notice WHERE id in (%s)',
 			implode(',', $notice_list)));
 
-		$cnt = 0;
-
-		if ($notice) {
-			common_element_start('ul', array('id' => 'notices'));
-			while ($notice->fetch()) {
-				$cnt++;
-				if ($cnt > NOTICES_PER_PAGE) {
-					break;
-				}
-				$this->show_notice($notice);
-			}
-			common_element_end('ul');
-		}
+        $cnt = $this->show_notice_list($notice);
 
 		common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 						  $page, 'favorited');
diff --git a/actions/public.php b/actions/public.php
index 8a41dcd56..218f80194 100644
--- a/actions/public.php
+++ b/actions/public.php
@@ -54,7 +54,6 @@ class PublicAction extends StreamAction {
 
 		$this->public_views_menu();
 
-
 		$this->show_feeds_list(array(0=>array('href'=>common_local_url('publicrss'),
 											  'type' => 'rss',
 											  'version' => 'RSS 1.0',
@@ -87,18 +86,13 @@ class PublicAction extends StreamAction {
 		$notice = Notice::publicStream(($page-1)*NOTICES_PER_PAGE,
 									   NOTICES_PER_PAGE + 1);
 
-		if ($notice) {
-			common_element_start('ul', array('id' => 'notices'));
-			while ($notice->fetch()) {
-				$cnt++;
-				if ($cnt > NOTICES_PER_PAGE) {
-					break;
-				}
-				$this->show_notice($notice);
-			}
-			common_element_end('ul');
+		if (!$notice) {
+            $this->server_error(_('Could not retrieve public stream.'));
+            return;
 		}
 
+        $cnt = $this->show_notice_list($notice);
+
 		common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 						  $page, 'public');
 	}
diff --git a/actions/replies.php b/actions/replies.php
index 529ce7e98..835871ffc 100644
--- a/actions/replies.php
+++ b/actions/replies.php
@@ -85,20 +85,8 @@ class RepliesAction extends StreamAction {
 		$page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
 
 		$notice = $user->getReplies(($page-1) * NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
-		
-		$cnt = 0;
-		
-		if ($notice) {
-			common_element_start('ul', array('id' => 'notices'));
-			while ($notice->fetch()) {
-				$cnt++;
-				if ($cnt > NOTICES_PER_PAGE) {
-					break;
-				}
-				$this->show_notice($notice);
-			}
-			common_element_end('ul');
-		}
+
+		$cnt = $this->show_notice_list($notice);
 
 		common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 						  $page, 'replies', array('nickname' => $user->nickname));
diff --git a/actions/showfavorites.php b/actions/showfavorites.php
index c18c73a7a..4de4b1271 100644
--- a/actions/showfavorites.php
+++ b/actions/showfavorites.php
@@ -89,20 +89,7 @@ class ShowfavoritesAction extends StreamAction {
 			return;
 		}
 
-		common_element_start('ul', array('id' => 'notices'));
-
-		$cnt = 0;
-
-		while ($notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
-			$cnt++;
-
-			if ($cnt > NOTICES_PER_PAGE) {
-				break;
-			}
-
-			$this->show_notice($notice);
-		}
-		common_element_end('ul');
+        $cnt = $this->show_notice_list($notice);
 
 		common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 						  $page, 'showfavorites', array('nickname' => $user->nickname));
diff --git a/actions/shownotice.php b/actions/shownotice.php
index b60b6f5a7..6dea6d7bb 100644
--- a/actions/shownotice.php
+++ b/actions/shownotice.php
@@ -77,7 +77,8 @@ class ShownoticeAction extends StreamAction {
 						   array($this, 'show_top'));
 
 		common_element_start('ul', array('id' => 'notices'));
-		$this->show_notice($this->notice);
+        $nli = new NoticeListItem($this->notice);
+        $nli->show();
 		common_element_end('ul');
 
 		common_show_footer();
diff --git a/actions/showstream.php b/actions/showstream.php
index 2919a154f..633b11abc 100644
--- a/actions/showstream.php
+++ b/actions/showstream.php
@@ -406,22 +406,8 @@ class ShowstreamAction extends StreamAction {
 
 		$notice = $user->getNotices(($page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
 
-		$cnt = 0;
-
-		if ($notice) {
-
-			common_element_start('ul', array('id' => 'notices'));
-
-			while ($notice->fetch()) {
-				$cnt++;
-				if ($cnt > NOTICES_PER_PAGE) {
-					break;
-				}
-				$this->show_notice($notice);
-			}
-
-			common_element_end('ul');
-		}
+        $pnl = new ProfileNoticeList($notice);
+        $cnt = $pnl->show();
 
 		common_pagination($page>1, $cnt>NOTICES_PER_PAGE, $page,
 						  'showstream', array('nickname' => $user->nickname));
@@ -447,72 +433,18 @@ class ShowstreamAction extends StreamAction {
 			common_element_end('p');
 		}
 	}
+}
 
-	function show_notice($notice) {
-		$profile = $notice->getProfile();
-		$user = common_current_user();
+# We don't show the author for a profile, since we already know who it is!
 
-		# XXX: RDFa
-		common_element_start('li', array('class' => 'notice_single hentry',
-										 'id' => 'notice-' . $notice->id));
-		if ($user) {
-			if ($user->hasFave($notice)) {
-				common_disfavor_form($notice);
-			} else {
-				common_favor_form($notice);
-			}
-		}
-		$noticeurl = common_local_url('shownotice', array('notice' => $notice->id));
-		# FIXME: URL, image, video, audio
-		common_element_start('p', 'entry-title');
-		if ($notice->rendered) {
-			common_raw($notice->rendered);
-		} else {
-			# XXX: may be some uncooked notices in the DB,
-			# we cook them right now. This can probably disappear in future
-			# versions (>> 0.4.x)
-			common_raw(common_render_content($notice->content, $notice));
-		}
-		common_element_end('p');
-		common_element_start('p', array('class' => 'time'));
-		common_element_start('a', array('class' => 'permalink',
-								  'rel' => 'bookmark',
-								  'href' => $noticeurl));
-		common_element('abbr', array('class' => 'published',
-									 'title' => common_date_iso8601($notice->created)),
-						common_date_string($notice->created));
-		common_element_end('a');
-
-		if ($notice->source) {
-			common_text(_(' from '));
-			$this->source_link($notice->source);
-		}
-		if ($notice->reply_to) {
-			$replyurl = common_local_url('shownotice', array('notice' => $notice->reply_to));
-			common_text(' (');
-			common_element('a', array('class' => 'inreplyto',
-									  'href' => $replyurl),
-						   _('in reply to...'));
-			common_text(')');
-		}
-		common_element_start('a',
-							 array('href' => common_local_url('newnotice',
-															  array('replyto' => $profile->nickname)),
-								   'onclick' => 'doreply("'.$profile->nickname.'"); return false',
-								   'title' => _('reply'),
-								   'class' => 'replybutton'));
-		common_raw('&rarr;');
-		common_element_end('a');
-		if ($user && $notice->profile_id == $user->id) {
-			$deleteurl = common_local_url('deletenotice', array('notice' => $notice->id));
-			common_element_start('a', array('class' => 'deletenotice',
-											'href' => $deleteurl,
-											'title' => _('delete')));
-			common_raw('&times;');
-			common_element_end('a');
-		}
+class ProfileNoticeList extends NoticeList {
+    function new_list_item($notice) {
+        return new ProfileNoticeListItem($notice);
+    }
+}
 
-		common_element_end('p');
-		common_element_end('li');
-	}
+class ProfileNoticeListItem extends NoticeListItem {
+    function show_author() {
+        return;
+    }
 }
diff --git a/actions/tag.php b/actions/tag.php
index 50b76dbcd..25cc853c4 100644
--- a/actions/tag.php
+++ b/actions/tag.php
@@ -106,7 +106,7 @@ class TagAction extends StreamAction {
 
 		if ($cnt > 0) {
 			common_element_start('p', 'tagcloud');
-			
+
 			$tw = array();
 			$sum = 0;
 			while ($tags->fetch()) {
@@ -115,7 +115,7 @@ class TagAction extends StreamAction {
 			}
 
 			ksort($tw);
-			
+
 			foreach ($tw as $tag => $weight) {
 				$this->show_tag($tag, $weight, $weight/$sum);
 			}
@@ -152,22 +152,12 @@ class TagAction extends StreamAction {
 	function show_notices($tag) {
 
 		$cnt = 0;
-		
+
 		$page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
 
 		$notice = Notice_tag::getStream($tag, (($page-1)*NOTICES_PER_PAGE), NOTICES_PER_PAGE + 1);
 
-		if ($notice) {
-			common_element_start('ul', array('id' => 'notices'));
-			while ($notice->fetch()) {
-				$cnt++;
-				if ($cnt > NOTICES_PER_PAGE) {
-					break;
-				}
-				$this->show_notice($notice);
-			}
-			common_element_end('ul');
-		}
+        $cnt = $this->show_notice_list($notice);
 
 		common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 						  $page, 'tag', array('tag' => $tag));
diff --git a/lib/noticelist.php b/lib/noticelist.php
new file mode 100644
index 000000000..1ffa802e9
--- /dev/null
+++ b/lib/noticelist.php
@@ -0,0 +1,206 @@
+<?php
+/*
+ * Laconica - a distributed open-source microblogging tool
+ * Copyright (C) 2008, Controlez-Vous, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.	 If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('LACONICA')) { exit(1); }
+
+class NoticeList {
+
+    var $notice = NULL;
+
+    function __construct($notice) {
+        $this->notice = $notice;
+    }
+
+    function show() {
+
+		common_element_start('ul', array('id' => 'notices'));
+
+		$cnt = 0;
+
+		while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
+			$cnt++;
+
+			if ($cnt > NOTICES_PER_PAGE) {
+				break;
+			}
+
+            $item = $this->new_list_item($this->notice);
+            $item->show();
+		}
+
+		common_element_end('ul');
+
+        return $cnt;
+	}
+
+    function new_list_item($notice) {
+        return new NoticeListItem($notice);
+    }
+}
+
+class NoticeListItem {
+
+    var $notice = NULL;
+    var $profile = NULL;
+
+    function __construct($notice) {
+        $this->notice = $notice;
+		$this->profile = $notice->getProfile();
+    }
+
+	function show($notice) {
+        $this->show_start();
+        $this->show_fave_form();
+        $this->show_author();
+        $this->show_content();
+        $this->show_start_time_section();
+        $this->show_notice_link();
+        $this->show_notice_source();
+        $this->show_reply_to();
+        $this->show_reply_link();
+        $this->show_delete_link();
+        $this->show_end_time_section();
+        $this->show_end();
+	}
+
+    function show_start() {
+		# XXX: RDFa
+		common_element_start('li', array('class' => 'notice_single hentry',
+										  'id' => 'notice-' . $this->notice->id));
+    }
+
+    function show_fave_form() {
+        $user = common_current_user();
+		if ($user) {
+			if ($user->hasFave($this->notice)) {
+				common_disfavor_form($this->notice);
+			} else {
+				common_favor_form($this->notice);
+			}
+		}
+    }
+
+    function show_author() {
+ 		common_element_start('span', 'vcard author');
+        $this->avatar();
+        $this->nickname();
+		common_element_end('span');
+    }
+
+    function show_avatar() {
+		$avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
+		common_element_start('a', array('href' => $profile->profileurl));
+		common_element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE),
+									'class' => 'avatar stream photo',
+									'width' => AVATAR_STREAM_SIZE,
+									'height' => AVATAR_STREAM_SIZE,
+									'alt' =>
+									($profile->fullname) ? $profile->fullname :
+									$profile->nickname));
+		common_element_end('a');
+    }
+
+    function show_nickname() {
+		common_element('a', array('href' => $profile->profileurl,
+								  'class' => 'nickname fn url'),
+					   $profile->nickname);
+    }
+
+    function show_content() {
+		# FIXME: URL, image, video, audio
+		common_element_start('p', array('class' => 'content entry-title'));
+		if ($this->notice->rendered) {
+			common_raw($this->notice->rendered);
+		} else {
+			# XXX: may be some uncooked notices in the DB,
+			# we cook them right now. This should probably disappear in future
+			# versions (>> 0.4.x)
+			common_raw(common_render_content($this->notice->content, $this->notice));
+		}
+		common_element_end('p');
+    }
+
+    function show_start_time_section() {
+		common_element_start('p', 'time');
+    }
+
+    function show_notice_link() {
+		$noticeurl = common_local_url('shownotice', array('notice' => $this->notice->id));
+		# XXX: we need to figure this out better. Is this right?
+		if (strcmp($this->notice->uri, $this->noticeurl) != 0 && preg_match('/^http/', $this->notice->uri)) {
+			$noticeurl = $this->notice->uri;
+		}
+		common_element_start('a', array('class' => 'permalink',
+								  'rel' => 'bookmark',
+								  'href' => $noticeurl));
+		common_element('abbr', array('class' => 'published',
+									 'title' => common_date_iso8601($this->notice->created)),
+						common_date_string($this->notice->created));
+		common_element_end('a');
+    }
+
+    function show_notice_source() {
+		if ($this->notice->source) {
+			common_text(_(' from '));
+			$this->source_link($this->notice->source);
+		}
+    }
+
+    function show_reply_to() {
+		if ($this->notice->reply_to) {
+			$replyurl = common_local_url('shownotice', array('notice' => $this->notice->reply_to));
+			common_text(' (');
+			common_element('a', array('class' => 'inreplyto',
+									  'href' => $replyurl),
+						   _('in reply to...'));
+			common_text(')');
+		}
+    }
+
+    function show_reply_link() {
+		common_element_start('a',
+							 array('href' => common_local_url('newnotice',
+															  array('replyto' => $profile->nickname)),
+								   'onclick' => 'return doreply("'.$profile->nickname.'", '.$this->notice->id.');',
+								   'title' => _('reply'),
+								   'class' => 'replybutton'));
+		common_raw('&rarr;');
+		common_element_end('a');
+    }
+
+    function show_delete_link() {
+        $user = common_current_user();
+		if ($user && $this->notice->profile_id == $user->id) {
+			$deleteurl = common_local_url('deletenotice', array('notice' => $this->notice->id));
+			common_element_start('a', array('class' => 'deletenotice',
+											'href' => $deleteurl,
+											'title' => _('delete')));
+			common_raw('&times;');
+			common_element_end('a');
+		}
+    }
+
+    function show_end_time_section() {
+		common_element_end('p');
+    }
+
+    function show_end() {
+		common_element_end('li');
+    }
+}
diff --git a/lib/stream.php b/lib/stream.php
index 1eec1496a..4569f3929 100644
--- a/lib/stream.php
+++ b/lib/stream.php
@@ -20,6 +20,7 @@
 if (!defined('LACONICA')) { exit(1); }
 
 require_once(INSTALLDIR.'/lib/personal.php');
+require_once(INSTALLDIR.'/lib/noticelist.php');
 
 class StreamAction extends PersonalAction {
 
@@ -47,90 +48,8 @@ class StreamAction extends PersonalAction {
 
 	}
 
-	function show_notice($notice) {
-		global $config;
-		$profile = $notice->getProfile();
-		$user = common_current_user();
-
-		# XXX: RDFa
-		common_element_start('li', array('class' => 'notice_single hentry',
-										  'id' => 'notice-' . $notice->id));
-		if ($user) {
-			if ($user->hasFave($notice)) {
-				common_disfavor_form($notice);
-			} else {
-				common_favor_form($notice);
-			}
-		}
- 		common_element_start('span', 'vcard author');
-		$avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
-		common_element_start('a', array('href' => $profile->profileurl));
-		common_element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE),
-									'class' => 'avatar stream photo',
-									'width' => AVATAR_STREAM_SIZE,
-									'height' => AVATAR_STREAM_SIZE,
-									'alt' =>
-									($profile->fullname) ? $profile->fullname :
-									$profile->nickname));
-		common_element_end('a');
-		common_element('a', array('href' => $profile->profileurl,
-								  'class' => 'nickname fn url'),
-					   $profile->nickname);
-		common_element_end('span');
-		# FIXME: URL, image, video, audio
-		common_element_start('p', array('class' => 'content entry-title'));
-		if ($notice->rendered) {
-			common_raw($notice->rendered);
-		} else {
-			# XXX: may be some uncooked notices in the DB,
-			# we cook them right now. This should probably disappear in future
-			# versions (>> 0.4.x)
-			common_raw(common_render_content($notice->content, $notice));
-		}
-		common_element_end('p');
-		$noticeurl = common_local_url('shownotice', array('notice' => $notice->id));
-		# XXX: we need to figure this out better. Is this right?
-		if (strcmp($notice->uri, $noticeurl) != 0 && preg_match('/^http/', $notice->uri)) {
-			$noticeurl = $notice->uri;
-		}
-		common_element_start('p', 'time');
-		common_element_start('a', array('class' => 'permalink',
-								  'rel' => 'bookmark',
-								  'href' => $noticeurl));
-		common_element('abbr', array('class' => 'published',
-									 'title' => common_date_iso8601($notice->created)),
-						common_date_string($notice->created));
-		common_element_end('a');
-
-		if ($notice->source) {
-			common_text(_(' from '));
-			$this->source_link($notice->source);
-		}
-		if ($notice->reply_to) {
-			$replyurl = common_local_url('shownotice', array('notice' => $notice->reply_to));
-			common_text(' (');
-			common_element('a', array('class' => 'inreplyto',
-									  'href' => $replyurl),
-						   _('in reply to...'));
-			common_text(')');
-		}
-		common_element_start('a',
-							 array('href' => common_local_url('newnotice',
-															  array('replyto' => $profile->nickname)),
-								   'onclick' => 'return doreply("'.$profile->nickname.'", '.$notice->id.');',
-								   'title' => _('reply'),
-								   'class' => 'replybutton'));
-		common_raw('&rarr;');
-		common_element_end('a');
-		if ($user && $notice->profile_id == $user->id) {
-			$deleteurl = common_local_url('deletenotice', array('notice' => $notice->id));
-			common_element_start('a', array('class' => 'deletenotice',
-											'href' => $deleteurl,
-											'title' => _('delete')));
-			common_raw('&times;');
-			common_element_end('a');
-		}
-		common_element_end('p');
-		common_element_end('li');
-	}
+    function show_notice_list($notice) {
+        $nl = new NoticeList($notice);
+        return $nl->show();
+    }
 }