Upgraded showstream, didn't make it phpcs-compatible

1 files changed, 200 insertions, 191 deletions

diff --git a/actions/showstream.php b/actions/showstream.php
index ed38c67f9..aaa55b330 100644
--- a/actions/showstream.php
+++ b/actions/showstream.php
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * User profile page
+ *
+ * PHP version 5
+ *
+ * LICENCE: 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.
@@ -15,27 +18,64 @@
  *
  * 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/>.
+ *
+ * @category  Personal
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008-2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/stream.php');
+require_once INSTALLDIR.'/lib/personalgroupnav.php';
+require_once INSTALLDIR.'/lib/noticelist.php';
+require_once INSTALLDIR.'/lib/feedlist.php';
 
-define('SUBSCRIPTIONS_PER_ROW', 4);
-define('SUBSCRIPTIONS', 80);
+/**
+ * User profile page
+ *
+ * When I created this page, "show stream" seemed like the best name for it.
+ * Now, it seems like a really bad name.
+ *
+ * It shows a stream of the user's posts, plus lots of profile info, links
+ * to subscriptions and stuff, etc.
+ *
+ * @category Personal
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
 
-class ShowstreamAction extends StreamAction
+class ShowstreamAction extends Action
 {
+    var $user = null;
+    var $page = null;
+    var $profile = null;
 
-    function handle($args)
+    function title()
     {
+        if ($this->page == 1) {
+            return $this->user->nickname;
+        } else {
+            return sprintf(_("%s, page %d"),
+                           $this->user->nickname,
+                           $this->page);
+        }
+    }
 
-        parent::handle($args);
+    function prepare($args)
+    {
+        parent::prepare($args);
 
         $nickname_arg = $this->arg('nickname');
         $nickname = common_canonical_nickname($nickname_arg);
 
-        # Permanent redirect on non-canonical nickname
+        // Permanent redirect on non-canonical nickname
 
         if ($nickname_arg != $nickname) {
             $args = array('nickname' => $nickname);
@@ -43,181 +83,182 @@ class ShowstreamAction extends StreamAction
                 $args['page'] = $this->arg['page'];
             }
             common_redirect(common_local_url('showstream', $args), 301);
-            return;
+            return false;
         }
 
-        $user = User::staticGet('nickname', $nickname);
+        $this->user = User::staticGet('nickname', $nickname);
 
-        if (!$user) {
-            $this->no_such_user();
-            return;
+        if (!$this->user) {
+            $this->clientError(_('No such user.'), 404);
+            return false;
         }
 
-        $profile = $user->getProfile();
+        $this->profile = $this->user->getProfile();
 
-        if (!$profile) {
+        if (!$this->profile) {
             $this->serverError(_('User has no profile.'));
-            return;
+            return false;
         }
 
-        # Looks like we're good; start output
+        $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
 
-        # For YADIS discovery, we also have a <meta> tag
+        return true;
+    }
 
-        header('X-XRDS-Location: '. common_local_url('xrds', array('nickname' =>
-                                                                   $user->nickname)));
+    function handle($args)
+    {
 
-        common_show_header($profile->nickname,
-                           array($this, 'show_header'), $user,
-                           array($this, 'show_top'));
+        // Looks like we're good; start output
 
-        $this->show_profile($profile);
+        // For YADIS discovery, we also have a <meta> tag
 
-        $this->show_notices($user);
+        header('X-XRDS-Location: '. common_local_url('xrds', array('nickname' =>
+                                                                   $this->user->nickname)));
 
-        common_show_footer();
+        $this->showPage();
     }
 
-    function show_top($user)
+    function showContent()
     {
-        $cur = common_current_user();
+        $this->showProfile();
+        $this->showNotices();
+    }
 
-        if ($cur && $cur->id == $user->id) {
-            common_notice_form('showstream');
-        }
+    function showLocalNav()
+    {
+        $nav = new PersonalGroupNav($this);
+        $nav->show();
+    }
 
-        $this->views_menu();
-
-        $this->show_feeds_list(array(0=>array('href'=>common_local_url('userrss', array('nickname' => $user->nickname)),
-                                              'type' => 'rss',
-                                              'version' => 'RSS 1.0',
-                                              'item' => 'notices'),
-                                     1=>array('href'=>common_local_url('usertimeline', array('nickname' => $user->nickname)),
-                                              'type' => 'atom',
-                                              'version' => 'Atom 1.0',
-                                              'item' => 'usertimeline'),
-
-                                     2=>array('href'=>common_local_url('foaf',array('nickname' => $user->nickname)),
-                                              'type' => 'rdf',
-                                              'version' => 'FOAF',
-                                              'item' => 'foaf')));
+    function showPageTitle()
+    {
+        // Don't show the H1; we have one in the profile block
+    }
+
+    function showExportData()
+    {
+        $fl = new FeedList($this);
+        $fl->show(array(0=>array('href'=>common_local_url('userrss',
+                                                          array('nickname' => $this->user->nickname)),
+                                 'type' => 'rss',
+                                 'version' => 'RSS 1.0',
+                                 'item' => 'notices'),
+                        1=>array('href'=>common_local_url('usertimeline',
+                                                          array('nickname' => $this->user->nickname)),
+                                 'type' => 'atom',
+                                 'version' => 'Atom 1.0',
+                                 'item' => 'usertimeline'),
+                        2=>array('href'=>common_local_url('foaf',
+                                                          array('nickname' => $this->user->nickname)),
+                                 'type' => 'rdf',
+                                 'version' => 'FOAF',
+                                 'item' => 'foaf')));
     }
 
-    function show_header($user)
+    function showFeeds()
     {
-        # Feeds
+        // Feeds
         $this->element('link', array('rel' => 'alternate',
                                      'href' => common_local_url('api',
                                                                 array('apiaction' => 'statuses',
                                                                       'method' => 'user_timeline.rss',
-                                                                      'argument' => $user->nickname)),
+                                                                      'argument' => $this->user->nickname)),
                                      'type' => 'application/rss+xml',
-                                     'title' => sprintf(_('Notice feed for %s'), $user->nickname)));
+                                     'title' => sprintf(_('Notice feed for %s'), $this->user->nickname)));
         $this->element('link', array('rel' => 'alternate feed',
                                      'href' => common_local_url('api',
                                                                 array('apiaction' => 'statuses',
                                                                       'method' => 'user_timeline.atom',
-                                                                      'argument' => $user->nickname)),
+                                                                      'argument' => $this->user->nickname)),
                                      'type' => 'application/atom+xml',
-                                     'title' => sprintf(_('Notice feed for %s'), $user->nickname)));
+                                     'title' => sprintf(_('Notice feed for %s'), $this->user->nickname)));
         $this->element('link', array('rel' => 'alternate',
                                      'href' => common_local_url('userrss', array('nickname' =>
-                                                                               $user->nickname)),
+                                                                               $this->user->nickname)),
                                      'type' => 'application/rdf+xml',
-                                     'title' => sprintf(_('Notice feed for %s'), $user->nickname)));
-        # FOAF
+                                     'title' => sprintf(_('Notice feed for %s'), $this->user->nickname)));
+    }
+
+    function extraHead()
+    {
+        // FOAF
         $this->element('link', array('rel' => 'meta',
                                      'href' => common_local_url('foaf', array('nickname' =>
-                                                                              $user->nickname)),
+                                                                              $this->user->nickname)),
                                      'type' => 'application/rdf+xml',
                                      'title' => 'FOAF'));
-        # for remote subscriptions etc.
+        // for remote subscriptions etc.
         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
                                      'content' => common_local_url('xrds', array('nickname' =>
-                                                                               $user->nickname))));
-        $profile = $user->getProfile();
-        if ($profile->bio) {
+                                                                               $this->user->nickname))));
+
+        if ($this->profile->bio) {
             $this->element('meta', array('name' => 'description',
-                                         'content' => $profile->bio));
+                                         'content' => $this->profile->bio));
         }
 
-        if ($user->emailmicroid && $user->email && $profile->profileurl) {
+        if ($this->user->emailmicroid && $this->user->email && $this->profile->profileurl) {
+            $id = new Microid('mailto:'.$this->user->email,
+                              $this->selfUrl());
             $this->element('meta', array('name' => 'microid',
-                                         'content' => "mailto+http:sha1:" . sha1(sha1('mailto:' . $user->email) . sha1($profile->profileurl))));
+                                         'content' => $id->toString()));
         }
-        if ($user->jabbermicroid && $user->jabber && $profile->profileurl) {
+        if ($this->user->jabbermicroid && $this->user->jabber && $this->profile->profileurl) {
+            $id = new Microid('xmpp:'.$this->user->jabber,
+                              $this->selfUrl());
             $this->element('meta', array('name' => 'microid',
-                                         'content' => "xmpp+http:sha1:" . sha1(sha1('xmpp:' . $user->jabber) . sha1($profile->profileurl))));
+                                         'content' => $id->toString()));
         }
 
-        # See https://wiki.mozilla.org/Microsummaries
+        // See https://wiki.mozilla.org/Microsummaries
 
         $this->element('link', array('rel' => 'microsummary',
                                      'href' => common_local_url('microsummary',
-                                                                array('nickname' => $profile->nickname))));
+                                                                array('nickname' => $this->profile->nickname))));
     }
 
-    function no_such_user()
+    function showProfile()
     {
-        $this->clientError(_('No such user.'), 404);
-    }
-
-    function show_profile($profile)
-    {
-
         $this->elementStart('div', array('id' => 'profile', 'class' => 'vcard'));
 
-        $this->show_personal($profile);
-
-        $this->show_last_notice($profile);
-
-        $cur = common_current_user();
-
-        $this->show_subscriptions($profile);
-
-        $this->elementEnd('div');
-    }
-
-    function show_personal($profile)
-    {
-
-        $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
+        $avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
         $this->elementStart('div', array('id' => 'profile_avatar'));
         $this->element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_PROFILE_SIZE),
                                     'class' => 'avatar profile photo',
                                     'width' => AVATAR_PROFILE_SIZE,
                                     'height' => AVATAR_PROFILE_SIZE,
-                                    'alt' => $profile->nickname));
+                                    'alt' => $this->profile->nickname));
 
         $this->elementStart('ul', array('id' => 'profile_actions'));
 
         $this->elementStart('li', array('id' => 'profile_subscribe'));
         $cur = common_current_user();
         if ($cur) {
-            if ($cur->id != $profile->id) {
-                if ($cur->isSubscribed($profile)) {
-                    common_unsubscribe_form($profile);
+            if ($cur->id != $this->profile->id) {
+                if ($cur->isSubscribed($this->profile)) {
+                    $sf = new SubscribeForm($this, $this->profile);
+                    $sf->show();
                 } else {
-                    common_subscribe_form($profile);
+                    $usf = new UnsubscribeForm($this, $this->profile);
+                    $usf->show();
                 }
             }
         } else {
-            $this->show_remote_subscribe_link($profile);
+            $this->showRemoteSubscribeLink();
         }
         $this->elementEnd('li');
 
-        $user = User::staticGet('id', $profile->id);
-        common_profile_new_message_nudge($cur, $user, $profile);
+        common_profile_new_message_nudge($cur, $this->user, $this->profile);
 
-        if ($cur && $cur->id != $profile->id) {
-            $blocked = $cur->hasBlocked($profile);
+        if ($cur && $cur->id != $this->profile->id) {
+            $blocked = $cur->hasBlocked($this->profile);
             $this->elementStart('li', array('id' => 'profile_block'));
             if ($blocked) {
-                common_unblock_form($profile, array('action' => 'showstream',
-                                                    'nickname' => $profile->nickname));
+                $bf = new BlockForm($this, $this->profile);
+                $bf->show();
             } else {
-                common_block_form($profile, array('action' => 'showstream',
-                                                  'nickname' => $profile->nickname));
+                $ubf = new UnblockForm($this, $this->profile);
+                $ubf->show();
             }
             $this->elementEnd('li');
         }
@@ -228,72 +269,73 @@ class ShowstreamAction extends StreamAction
 
         $this->elementStart('div', array('id' => 'profile_information'));
 
-        if ($profile->fullname) {
-            $this->element('h1', array('class' => 'fn'), $profile->fullname . ' (' . $profile->nickname . ')');
+        if ($this->profile->fullname) {
+            $this->element('h1', array('class' => 'fn'), $this->profile->fullname . ' (' . $this->profile->nickname . ')');
         } else {
-            $this->element('h1', array('class' => 'fn nickname'), $profile->nickname);
+            $this->element('h1', array('class' => 'fn nickname'), $this->profile->nickname);
         }
 
-        if ($profile->location) {
-            $this->element('p', 'location', $profile->location);
+        if ($this->profile->location) {
+            $this->element('p', 'location', $this->profile->location);
         }
-        if ($profile->bio) {
-            $this->element('p', 'description note', $profile->bio);
+        if ($this->profile->bio) {
+            $this->element('p', 'description note', $this->profile->bio);
         }
-        if ($profile->homepage) {
+        if ($this->profile->homepage) {
             $this->elementStart('p', 'website');
-            $this->element('a', array('href' => $profile->homepage,
+            $this->element('a', array('href' => $this->profile->homepage,
                                       'rel' => 'me', 'class' => 'url'),
-                           $profile->homepage);
+                           $this->profile->homepage);
             $this->elementEnd('p');
         }
 
-        $this->show_statistics($profile);
+        $this->elementEnd('div');
 
         $this->elementEnd('div');
     }
 
-    function show_remote_subscribe_link($profile)
+    function showRemoteSubscribeLink()
     {
         $url = common_local_url('remotesubscribe',
-                                array('nickname' => $profile->nickname));
+                                array('nickname' => $this->profile->nickname));
         $this->element('a', array('href' => $url,
                                   'id' => 'remotesubscribe'),
                        _('Subscribe'));
     }
 
-    function show_unsubscribe_form($profile)
+    function showNotices()
     {
-        $this->elementStart('form', array('id' => 'unsubscribe', 'method' => 'post',
-                                           'action' => common_local_url('unsubscribe')));
-        $this->hidden('token', common_session_token());
-        $this->element('input', array('id' => 'unsubscribeto',
-                                      'name' => 'unsubscribeto',
-                                      'type' => 'hidden',
-                                      'value' => $profile->nickname));
-        $this->element('input', array('type' => 'submit',
-                                      'class' => 'submit',
-                                      'value' => _('Unsubscribe')));
-        $this->elementEnd('form');
+        $notice = $this->user->getNotices(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
+
+        $pnl = new ProfileNoticeList($notice, $this);
+        $cnt = $pnl->show();
+
+        $this->pagination($this->page>1, $cnt>NOTICES_PER_PAGE, $this->page,
+                          'showstream', array('nickname' => $this->user->nickname));
     }
 
-    function show_subscriptions($profile)
+    function showSections()
     {
-        global $config;
+        $this->showStatistics();
+        $this->showSubscriptions();
+    }
 
-        $subs = DB_DataObject::factory('subscription');
-        $subs->subscriber = $profile->id;
-        $subs->whereAdd('subscribed != ' . $profile->id);
+    function showSubscriptions()
+    {
+        $subs = new Subscription();
+        $subs->subscriber = $this->profile->id;
+        $subs->whereAdd('subscribed != ' . $this->profile->id);
 
         $subs->orderBy('created DESC');
 
-        # We ask for an extra one to know if we need to do another page
+        // We ask for an extra one to know if we need to do another page
 
         $subs->limit(0, SUBSCRIPTIONS + 1);
 
         $subs_count = $subs->find();
 
-        $this->elementStart('div', array('id' => 'subscriptions'));
+        $this->elementStart('div', array('id' => 'subscriptions',
+                                         'class' => 'section'));
 
         $this->element('h2', null, _('Subscriptions'));
 
@@ -341,7 +383,7 @@ class ShowstreamAction extends StreamAction
             $this->elementStart('p', array('id' => 'subscriptions_viewall'));
 
             $this->element('a', array('href' => common_local_url('subscriptions',
-                                                                 array('nickname' => $profile->nickname)),
+                                                                 array('nickname' => $this->profile->nickname)),
                                       'class' => 'moresubscriptions'),
                            _('All subscriptions'));
             $this->elementEnd('p');
@@ -350,49 +392,51 @@ class ShowstreamAction extends StreamAction
         $this->elementEnd('div');
     }
 
-    function show_statistics($profile)
+    function showStatistics()
     {
 
         // XXX: WORM cache this
-        $subs = DB_DataObject::factory('subscription');
-        $subs->subscriber = $profile->id;
+        $subs = new Subscription();
+        $subs->subscriber = $this->profile->id;
         $subs_count = (int) $subs->count() - 1;
 
-        $subbed = DB_DataObject::factory('subscription');
-        $subbed->subscribed = $profile->id;
+        $subbed = new Subscription();
+        $subbed->subscribed = $this->profile->id;
         $subbed_count = (int) $subbed->count() - 1;
 
-        $notices = DB_DataObject::factory('notice');
-        $notices->profile_id = $profile->id;
+        $notices = new Notice();
+        $notices->profile_id = $this->profile->id;
         $notice_count = (int) $notices->count();
 
-        $this->elementStart('div', 'statistics');
+        $this->elementStart('div', array('id' => 'statistics',
+                                         'class' => 'section'));
+
         $this->element('h2', 'statistics', _('Statistics'));
 
-        # Other stats...?
+        // Other stats...?
         $this->elementStart('dl', 'statistics');
         $this->element('dt', 'membersince', _('Member since'));
         $this->element('dd', 'membersince', date('j M Y',
-                                                 strtotime($profile->created)));
+                                                 strtotime($this->profile->created)));
 
         $this->elementStart('dt', 'subscriptions');
         $this->element('a', array('href' => common_local_url('subscriptions',
-                                                             array('nickname' => $profile->nickname))),
+                                                             array('nickname' => $this->profile->nickname))),
                        _('Subscriptions'));
         $this->elementEnd('dt');
         $this->element('dd', 'subscriptions', (is_int($subs_count)) ? $subs_count : '0');
         $this->elementStart('dt', 'subscribers');
         $this->element('a', array('href' => common_local_url('subscribers',
-                                                             array('nickname' => $profile->nickname))),
+                                                             array('nickname' => $this->profile->nickname))),
                        _('Subscribers'));
         $this->elementEnd('dt');
         $this->element('dd', 'subscribers', (is_int($subbed_count)) ? $subbed_count : '0');
         $this->element('dt', 'notices', _('Notices'));
         $this->element('dd', 'notices', (is_int($notice_count)) ? $notice_count : '0');
-        # XXX: link these to something
+        // XXX: link these to something
         $this->element('dt', 'tags', _('Tags'));
         $this->elementStart('dd', 'tags');
-        $tags = Profile_tag::getTags($profile->id, $profile->id);
+        $tags = Profile_tag::getTags($this->profile->id, $this->profile->id);
 
         $this->elementStart('ul', 'tags xoxo');
         foreach ($tags as $tag) {
@@ -411,50 +455,15 @@ class ShowstreamAction extends StreamAction
         $this->elementEnd('div');
     }
 
-    function show_notices($user)
-    {
-
-        $page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
-
-        $notice = $user->getNotices(($page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
-
-        $pnl = new ProfileNoticeList($notice);
-        $cnt = $pnl->show();
-
-        common_pagination($page>1, $cnt>NOTICES_PER_PAGE, $page,
-                          'showstream', array('nickname' => $user->nickname));
-    }
-
-    function show_last_notice($profile)
-    {
-
-        $this->element('h2', null, _('Currently'));
-
-        $notice = $profile->getCurrentNotice();
-
-        if ($notice) {
-            # FIXME: URL, image, video, audio
-            $this->elementStart('p', array('class' => 'notice_current'));
-            if ($notice->rendered) {
-                $this->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)
-                $this->raw(common_render_content($notice->content, $notice));
-            }
-            $this->elementEnd('p');
-        }
-    }
 }
 
-# We don't show the author for a profile, since we already know who it is!
+// We don't show the author for a profile, since we already know who it is!
 
 class ProfileNoticeList extends NoticeList
 {
     function newListItem($notice)
     {
-        return new ProfileNoticeListItem($notice);
+        return new ProfileNoticeListItem($notice, $this->out);
     }
 }