gnu-social/actions/showstream.php

<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * 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.
 *
 * 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/>.
 *
 * @category  Personal
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
 * @copyright 2008-2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET') && !defined('LACONICA')) {
    exit(1);
}

require_once INSTALLDIR.'/lib/personalgroupnav.php';
require_once INSTALLDIR.'/lib/noticelist.php';
require_once INSTALLDIR.'/lib/profileminilist.php';
require_once INSTALLDIR.'/lib/groupminilist.php';
require_once INSTALLDIR.'/lib/feedlist.php';

/**
 * 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  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class ShowstreamAction extends ProfileAction
{
    function isReadOnly($args)
    {
        return true;
    }

    function title()
    {
        if (!empty($this->profile->fullname)) {
            $base = $this->profile->fullname . ' (' . $this->user->nickname . ') ';
        } else {
            $base = $this->user->nickname;
        }
        if (!empty($this->tag)) {
            $base .= sprintf(_(' tagged %s'), $this->tag);
        }

        if ($this->page == 1) {
            return $base;
        } else {
            return sprintf(_("%s, page %d"),
                           $base,
                           $this->page);
        }
    }

    function handle($args)
    {

        // Looks like we're good; start output

        // For YADIS discovery, we also have a <meta> tag

        header('X-XRDS-Location: '. common_local_url('xrds', array('nickname' =>
                                                                   $this->user->nickname)));

        $this->showPage();
    }

    function showContent()
    {
        $this->showProfile();
        $this->showNotices();
    }

    function showLocalNav()
    {
        $nav = new PersonalGroupNav($this);
        $nav->show();
    }

    function showPageNoticeBlock()
    {
        return;
    }

    function getFeeds()
    {
        if (!empty($this->tag)) {
            return array(new Feed(Feed::RSS1,
                                  common_local_url('userrss',
                                                   array('nickname' => $this->user->nickname,
                                                         'tag' => $this->tag)),
                                  sprintf(_('Notice feed for %s tagged %s (RSS 1.0)'),
                                          $this->user->nickname, $this->tag)));
        }

        return array(new Feed(Feed::RSS1,
                              common_local_url('userrss',
                                               array('nickname' => $this->user->nickname)),
                              sprintf(_('Notice feed for %s (RSS 1.0)'),
                                      $this->user->nickname)),
                     new Feed(Feed::RSS2,
                              common_local_url('api',
                                               array('apiaction' => 'statuses',
                                                     'method' => 'user_timeline',
                                                     'argument' => $this->user->nickname.'.rss')),
                              sprintf(_('Notice feed for %s (RSS 2.0)'),
                                      $this->user->nickname)),
                     new Feed(Feed::ATOM,
                              common_local_url('api',
                                               array('apiaction' => 'statuses',
                                                     'method' => 'user_timeline',
                                                     'argument' => $this->user->nickname.'.atom')),
                              sprintf(_('Notice feed for %s (Atom)'),
                                      $this->user->nickname)),
                     new Feed(Feed::FOAF,
                              common_local_url('foaf', array('nickname' =>
                                                             $this->user->nickname)),
                              sprintf(_('FOAF for %s'), $this->user->nickname)));
    }

    function extraHead()
    {
        // for remote subscriptions etc.
        $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
                                     'content' => common_local_url('xrds', array('nickname' =>
                                                                                 $this->user->nickname))));

        if ($this->profile->bio) {
            $this->element('meta', array('name' => 'description',
                                         'content' => $this->profile->bio));
        }

        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' => $id->toString()));
        }
        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' => $id->toString()));
        }

        // See https://wiki.mozilla.org/Microsummaries

        $this->element('link', array('rel' => 'microsummary',
                                     'href' => common_local_url('microsummary',
                                                                array('nickname' => $this->profile->nickname))));
    }

    function showProfile()
    {
        $this->showProfileData();
        $this->showEntityActions();
    }

    function showProfileData()
    {
        if (Event::handle('StartProfilePageProfileSection', array(&$this, $this->profile))) {

            $this->elementStart('div', 'entity_profile vcard author');
            $this->element('h2', null, _('User profile'));

            if (Event::handle('StartProfilePageProfileElements', array(&$this, $this->profile))) {

                $this->showAvatar();
                $this->showNickname();
                $this->showFullName();
                $this->showLocation();
                $this->showHomepage();
                $this->showBio();
                $this->showProfileTags();

                Event::handle('EndProfilePageProfileElements', array(&$this, $this->profile));
            }

            $this->elementEnd('div');
            Event::handle('EndProfilePageProfileSection', array(&$this, $this->profile));
        }
    }

    function showAvatar()
    {
        if (Event::handle('StartProfilePageAvatar', array($this, $this->profile))) {

            $avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);

            $this->elementStart('dl', 'entity_depiction');
            $this->element('dt', null, _('Photo'));
            $this->elementStart('dd');
            $this->element('img', array('src' => ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE),
                                        'class' => 'photo avatar',
                                        'width' => AVATAR_PROFILE_SIZE,
                                        'height' => AVATAR_PROFILE_SIZE,
                                        'alt' => $this->profile->nickname));
            $this->elementEnd('dd');

            $user = User::staticGet('id', $this->profile->id);

            $cur = common_current_user();
            if ($cur && $cur->id == $user->id) {
                $this->elementStart('dd');
                $this->element('a', array('href' => common_local_url('avatarsettings')), _('Edit Avatar'));
                $this->elementEnd('dd');
            }

            $this->elementEnd('dl');

            Event::handle('EndProfilePageAvatar', array($this, $this->profile));
        }
    }

    function showNickname()
    {
        if (Event::handle('StartProfilePageNickname', array($this, $this->profile))) {

            $this->elementStart('dl', 'entity_nickname');
            $this->element('dt', null, _('Nickname'));
            $this->elementStart('dd');
            $hasFN = ($this->profile->fullname) ? 'nickname url uid' : 'fn nickname url uid';
            $this->element('a', array('href' => $this->profile->profileurl,
                                      'rel' => 'me', 'class' => $hasFN),
                           $this->profile->nickname);
            $this->elementEnd('dd');
            $this->elementEnd('dl');

            Event::handle('EndProfilePageNickname', array($this, $this->profile));
        }
    }

    function showFullName()
    {
        if (Event::handle('StartProfilePageFullName', array($this, $this->profile))) {
            if ($this->profile->fullname) {
                $this->elementStart('dl', 'entity_fn');
                $this->element('dt', null, _('Full name'));
                $this->elementStart('dd');
                $this->element('span', 'fn', $this->profile->fullname);
                $this->elementEnd('dd');
                $this->elementEnd('dl');
            }
            Event::handle('EndProfilePageFullName', array($this, $this->profile));
        }
    }

    function showLocation()
    {
        if (Event::handle('StartProfilePageLocation', array($this, $this->profile))) {
            if ($this->profile->location) {
                $this->elementStart('dl', 'entity_location');
                $this->element('dt', null, _('Location'));
                $this->element('dd', 'label', $this->profile->location);
                $this->elementEnd('dl');
            }
            Event::handle('EndProfilePageLocation', array($this, $this->profile));
        }
    }

    function showHomepage()
    {
        if (Event::handle('StartProfilePageHomepage', array($this, $this->profile))) {
            if ($this->profile->homepage) {
                $this->elementStart('dl', 'entity_url');
                $this->element('dt', null, _('URL'));
                $this->elementStart('dd');
                $this->element('a', array('href' => $this->profile->homepage,
                                          'rel' => 'me', 'class' => 'url'),
                               $this->profile->homepage);
                $this->elementEnd('dd');
                $this->elementEnd('dl');
            }
            Event::handle('EndProfilePageHomepage', array($this, $this->profile));
        }
    }

    function showBio()
    {
        if (Event::handle('StartProfilePageBio', array($this, $this->profile))) {
            if ($this->profile->bio) {
                $this->elementStart('dl', 'entity_note');
                $this->element('dt', null, _('Note'));
                $this->element('dd', 'note', $this->profile->bio);
                $this->elementEnd('dl');
            }
            Event::handle('EndProfilePageBio', array($this, $this->profile));
        }
    }

    function showProfileTags()
    {
        if (Event::handle('StartProfilePageProfileTags', array($this, $this->profile))) {
            $tags = Profile_tag::getTags($this->profile->id, $this->profile->id);

            if (count($tags) > 0) {
                $this->elementStart('dl', 'entity_tags');
                $this->element('dt', null, _('Tags'));
                $this->elementStart('dd');
                $this->elementStart('ul', 'tags xoxo');
                foreach ($tags as $tag) {
                    $this->elementStart('li');
                    // Avoid space by using raw output.
                    $pt = '<span class="mark_hash">#</span><a rel="tag" href="' .
                      common_local_url('peopletag', array('tag' => $tag)) .
                      '">' . $tag . '</a>';
                    $this->raw($pt);
                    $this->elementEnd('li');
                }
                $this->elementEnd('ul');
                $this->elementEnd('dd');
                $this->elementEnd('dl');
            }
            Event::handle('EndProfilePageProfileTags', array($this, $this->profile));
        }
    }

    function showEntityActions()
    {
        if (Event::handle('StartProfilePageActionsSection', array(&$this, $this->profile))) {

            $cur = common_current_user();

            $this->elementStart('div', 'entity_actions');
            $this->element('h2', null, _('User actions'));
            $this->elementStart('ul');

            if (Event::handle('StartProfilePageActionsElements', array(&$this, $this->profile))) {
                if (empty($cur)) { // not logged in
                    $this->elementStart('li', 'entity_subscribe');
                    $this->showRemoteSubscribeLink();
                    $this->elementEnd('li');
                } else {
                    if ($cur->id == $this->profile->id) { // your own page
                        $this->elementStart('li', 'entity_edit');
                        $this->element('a', array('href' => common_local_url('profilesettings'),
                                                  'title' => _('Edit profile settings')),
                                       _('Edit'));
                        $this->elementEnd('li');
                    } else { // someone else's page

                        // subscribe/unsubscribe button

                        $this->elementStart('li', 'entity_subscribe');

                        if ($cur->isSubscribed($this->profile)) {
                            $usf = new UnsubscribeForm($this, $this->profile);
                            $usf->show();
                        } else {
                            $sf = new SubscribeForm($this, $this->profile);
                            $sf->show();
                        }
                        $this->elementEnd('li');

                        if ($cur->mutuallySubscribed($this->user)) {

                            // message

                            $this->elementStart('li', 'entity_send-a-message');
                            $this->element('a', array('href' => common_local_url('newmessage', array('to' => $this->user->id)),
                                                      'title' => _('Send a direct message to this user')),
                                           _('Message'));
                            $this->elementEnd('li');

                            // nudge

                            if ($this->user->email && $this->user->emailnotifynudge) {
                                $this->elementStart('li', 'entity_nudge');
                                $nf = new NudgeForm($this, $this->user);
                                $nf->show();
                                $this->elementEnd('li');
                            }
                        }

                        // block/unblock

                        $blocked = $cur->hasBlocked($this->profile);
                        $this->elementStart('li', 'entity_block');
                        if ($blocked) {
                            $ubf = new UnblockForm($this, $this->profile,
                                                   array('action' => 'showstream',
                                                         'nickname' => $this->profile->nickname));
                            $ubf->show();
                        } else {
                            $bf = new BlockForm($this, $this->profile,
                                                array('action' => 'showstream',
                                                      'nickname' => $this->profile->nickname));
                            $bf->show();
                        }
                        $this->elementEnd('li');
                    }
                }

                Event::handle('EndProfilePageActionsElements', array(&$this, $this->profile));
            }

            $this->elementEnd('ul');
            $this->elementEnd('div');

            Event::handle('EndProfilePageActionsSection', array(&$this, $this->profile));
        }
    }

    function showRemoteSubscribeLink()
    {
        $url = common_local_url('remotesubscribe',
                                array('nickname' => $this->profile->nickname));
        $this->element('a', array('href' => $url,
                                  'class' => 'entity_remote_subscribe'),
                       _('Subscribe'));
    }

    function showEmptyListMessage()
    {
        $message = sprintf(_('This is the timeline for %s but %s hasn\'t posted anything yet.'), $this->user->nickname, $this->user->nickname) . ' ';

        if (common_logged_in()) {
            $current_user = common_current_user();
            if ($this->user->id === $current_user->id) {
                $message .= _('Seen anything interesting recently? You haven\'t posted any notices yet, now would be a good time to start :)');
            } else {
                $message .= sprintf(_('You can try to nudge %s or [post something to his or her attention](%%%%action.newnotice%%%%?status_textarea=%s).'), $this->user->nickname, '@' . $this->user->nickname);
            }
        }
        else {
            $message .= sprintf(_('Why not [register an account](%%%%action.register%%%%) and then nudge %s or post a notice to his or her attention.'), $this->user->nickname);
        }

        $this->elementStart('div', 'guide');
        $this->raw(common_markup_to_html($message));
        $this->elementEnd('div');
    }

    function showNotices()
    {
        $notice = empty($this->tag)
          ? $this->user->getNotices(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1)
            : $this->user->getTaggedNotices($this->tag, ($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1, 0, 0, null);

        $pnl = new ProfileNoticeList($notice, $this);
        $cnt = $pnl->show();
        if (0 == $cnt) {
            $this->showEmptyListMessage();
        }

        $args = array('nickname' => $this->user->nickname);
        if (!empty($this->tag))
        {
            $args['tag'] = $this->tag;
        }
        $this->pagination($this->page>1, $cnt>NOTICES_PER_PAGE, $this->page,
                          'showstream', $args);
    }

    function showAnonymousMessage()
    {
        if (!(common_config('site','closed') || common_config('site','inviteonly'))) {
            $m = sprintf(_('**%s** has an account on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
                           'based on the Free Software [StatusNet](http://status.net/) tool. ' .
                           '[Join now](%%%%action.register%%%%) to follow **%s**\'s notices and many more! ([Read more](%%%%doc.help%%%%))'),
                         $this->user->nickname, $this->user->nickname);
        } else {
            $m = sprintf(_('**%s** has an account on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
                           'based on the Free Software [StatusNet](http://status.net/) tool. '),
                         $this->user->nickname, $this->user->nickname);
        }
        $this->elementStart('div', array('id' => 'anon_notice'));
        $this->raw(common_markup_to_html($m));
        $this->elementEnd('div');
    }

    function showSections()
    {
        parent::showSections();
        $cloud = new PersonalTagCloudSection($this, $this->user);
        $cloud->show();
    }
}

// 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, $this->out);
    }
}

class ProfileNoticeListItem extends NoticeListItem
{
    function showAuthor()
    {
        return;
    }
}