lib/profileaction.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Common parent of Personal and Profile actions
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Personal
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008-2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/profileminilist.php';
  36 require_once INSTALLDIR.'/lib/groupminilist.php';
  37
  38 /**
  39  * Profile action common superclass
  40  *
  41  * Abstracts out common code from profile and personal tabs
  42  *
  43  * @category Personal
  44  * @package  StatusNet
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  */
  49 class ProfileAction extends Action
  50 {
  51     var $page    = null;
  52     var $profile = null;
  53     var $tag     = null;
  54
  55     function prepare($args)
  56     {
  57         parent::prepare($args);
  58
  59         $nickname_arg = $this->arg('nickname');
  60         $nickname     = common_canonical_nickname($nickname_arg);
  61
  62         // Permanent redirect on non-canonical nickname
  63
  64         if ($nickname_arg != $nickname) {
  65             $args = array('nickname' => $nickname);
  66             if ($this->arg('page') && $this->arg('page') != 1) {
  67                 $args['page'] = $this->arg['page'];
  68             }
  69             common_redirect(common_local_url($this->trimmed('action'), $args), 301);
  70             return false;
  71         }
  72
  73         $this->user = User::getKV('nickname', $nickname);
  74
  75         if (!$this->user) {
  76             // TRANS: Client error displayed when calling a profile action without specifying a user.
  77             $this->clientError(_('No such user.'), 404);
  78             return false;
  79         }
  80
  81         $this->profile = $this->user->getProfile();
  82
  83         if (!$this->profile) {
  84             // TRANS: Error message displayed when referring to a user without a profile.
  85             $this->serverError(_('User has no profile.'));
  86             return false;
  87         }
  88
  89         $user = common_current_user();
  90
  91         if ($this->profile->hasRole(Profile_role::SILENCED) &&
  92             (empty($user) || !$user->hasRight(Right::SILENCEUSER))) {
  93             throw new ClientException(_('This profile has been silenced by site moderators'), 403);
  94         }
  95
  96         $this->tag = $this->trimmed('tag');
  97         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  98         common_set_returnto($this->selfUrl());
  99         return true;
 100     }
 101
 102     function showSections()
 103     {
 104         $this->showSubscriptions();
 105         $this->showSubscribers();
 106         $this->showGroups();
 107         $this->showLists();
 108         $this->showStatistics();
 109     }
 110
 111     /**
 112      * Convenience function for common pattern of links to subscription/groups sections.
 113      *
 114      * @param string $actionClass
 115      * @param string $title
 116      * @param string $cssClass
 117      */
 118     private function statsSectionLink($actionClass, $title, $cssClass='')
 119     {
 120         $this->element('a', array('href' => common_local_url($actionClass,
 121                                                              array('nickname' => $this->profile->nickname)),
 122                                   'class' => $cssClass),
 123                        $title);
 124     }
 125
 126     function showSubscriptions()
 127     {
 128         $this->elementStart('div', array('id' => 'entity_subscriptions',
 129                                          'class' => 'section'));
 130         if (Event::handle('StartShowSubscriptionsMiniList', array($this))) {
 131             $this->elementStart('h2');
 132             // TRANS: H2 text for user subscription statistics.
 133             $this->statsSectionLink('subscriptions', _('Following'));
 134             $this->text(' ');
 135             $this->text($this->profile->subscriptionCount());
 136             $this->elementEnd('h2');
 137
 138             try {
 139                 $profile = $this->profile->getSubscribed(0, PROFILES_PER_MINILIST + 1);
 140                 $pml = new ProfileMiniList($profile, $this);
 141                 $pml->show();
 142             } catch (NoResultException $e) {
 143                 // TRANS: Text for user subscription statistics if the user has no subscription
 144                 $this->element('p', null, _('(None)'));
 145             }
 146
 147             Event::handle('EndShowSubscriptionsMiniList', array($this));
 148         }
 149         $this->elementEnd('div');
 150     }
 151
 152     function showSubscribers()
 153     {
 154         $this->elementStart('div', array('id' => 'entity_subscribers',
 155                                          'class' => 'section'));
 156
 157         if (Event::handle('StartShowSubscribersMiniList', array($this))) {
 158
 159             $this->elementStart('h2');
 160             // TRANS: H2 text for user subscriber statistics.
 161             $this->statsSectionLink('subscribers', _('Followers'));
 162             $this->text(' ');
 163             $this->text($this->profile->subscriberCount());
 164             $this->elementEnd('h2');
 165
 166             try {
 167                 $profile = $this->profile->getSubscribers(0, PROFILES_PER_MINILIST + 1);
 168                 $sml = new SubscribersMiniList($profile, $this);
 169                 $sml->show();
 170             } catch (NoResultException $e) {
 171                 // TRANS: Text for user subscriber statistics if user has no subscribers.
 172                 $this->element('p', null, _('(None)'));
 173             }
 174
 175             Event::handle('EndShowSubscribersMiniList', array($this));
 176         }
 177
 178         $this->elementEnd('div');
 179     }
 180
 181     function showStatistics()
 182     {
 183         $notice_count = $this->profile->noticeCount();
 184         $age_days     = (time() - strtotime($this->profile->created)) / 86400;
 185         if ($age_days < 1) {
 186             // Rather than extrapolating out to a bajillion...
 187             $age_days = 1;
 188         }
 189         $daily_count = round($notice_count / $age_days);
 190
 191         $this->elementStart('div', array('id' => 'entity_statistics',
 192                                          'class' => 'section'));
 193
 194         // TRANS: H2 text for user statistics.
 195         $this->element('h2', null, _('Statistics'));
 196
 197         $profile = $this->profile;
 198         $actionParams = array('nickname' => $profile->nickname);
 199         $stats = array(
 200             array(
 201                 'id' => 'user-id',
 202                 // TRANS: Label for user statistics.
 203                 'label' => _('User ID'),
 204                 'value' => $profile->id,
 205             ),
 206             array(
 207                 'id' => 'member-since',
 208                 // TRANS: Label for user statistics.
 209                 'label' => _('Member since'),
 210                 'value' => date('j M Y', strtotime($profile->created))
 211             ),
 212             array(
 213                 'id' => 'notices',
 214                 // TRANS: Label for user statistics.
 215                 'label' => _('Notices'),
 216                 'value' => $notice_count,
 217             ),
 218             array(
 219                 'id' => 'daily_notices',
 220                 // TRANS: Label for user statistics.
 221                 // TRANS: Average count of posts made per day since account registration.
 222                 'label' => _('Daily average'),
 223                 'value' => $daily_count
 224             )
 225         );
 226
 227         // Give plugins a chance to add stats entries
 228         Event::handle('ProfileStats', array($profile, &$stats));
 229
 230         foreach ($stats as $row) {
 231             $this->showStatsRow($row);
 232         }
 233         $this->elementEnd('div');
 234     }
 235
 236     private function showStatsRow($row)
 237     {
 238         $this->elementStart('dl', 'entity_' . $row['id']);
 239         $this->elementStart('dt');
 240         if (!empty($row['link'])) {
 241             $this->element('a', array('href' => $row['link']), $row['label']);
 242         } else {
 243             $this->text($row['label']);
 244         }
 245         $this->elementEnd('dt');
 246         $this->element('dd', null, $row['value']);
 247         $this->elementEnd('dl');
 248     }
 249
 250     function showGroups()
 251     {
 252         $groups = $this->profile->getGroups(0, GROUPS_PER_MINILIST + 1);
 253
 254         $this->elementStart('div', array('id' => 'entity_groups',
 255                                          'class' => 'section'));
 256         if (Event::handle('StartShowGroupsMiniList', array($this))) {
 257             $this->elementStart('h2');
 258             // TRANS: H2 text for user group membership statistics.
 259             $this->statsSectionLink('usergroups', _('Groups'));
 260             $this->text(' ');
 261             $this->text($this->profile->getGroups(0, null)->N);
 262             $this->elementEnd('h2');
 263
 264             if ($groups) {
 265                 $gml = new GroupMiniList($groups, $this->profile, $this);
 266                 $cnt = $gml->show();
 267                 if ($cnt == 0) {
 268                     // TRANS: Text for user user group membership statistics if user is not a member of any group.
 269                     $this->element('p', null, _('(None)'));
 270                 }
 271             }
 272
 273             Event::handle('EndShowGroupsMiniList', array($this));
 274         }
 275             $this->elementEnd('div');
 276     }
 277
 278     function showLists()
 279     {
 280         $cur = common_current_user();
 281
 282         $lists = $this->profile->getLists($cur);
 283
 284         if ($lists->N > 0) {
 285             $this->elementStart('div', array('id' => 'entity_lists',
 286                                              'class' => 'section'));
 287
 288             if (Event::handle('StartShowListsMiniList', array($this))) {
 289
 290                 $url = common_local_url('peopletagsbyuser',
 291                                         array('nickname' => $this->profile->nickname));
 292
 293                 $this->elementStart('h2');
 294                 $this->element('a',
 295                                array('href' => $url),
 296                                // TRANS: H2 text for user list membership statistics.
 297                                _('Lists'));
 298                 $this->text(' ');
 299                 $this->text($lists->N);
 300                 $this->elementEnd('h2');
 301
 302                 $this->elementStart('ul');
 303
 304
 305                 $first = true;
 306
 307                 while ($lists->fetch()) {
 308                     if (!empty($lists->mainpage)) {
 309                         $url = $lists->mainpage;
 310                     } else {
 311                         $url = common_local_url('showprofiletag',
 312                                                 array('tagger' => $this->profile->nickname,
 313                                                       'tag'    => $lists->tag));
 314                     }
 315                     if (!$first) {
 316                         $this->text(', ');
 317                     } else {
 318                         $first = false;
 319                     }
 320
 321                     $this->element('a', array('href' => $url),
 322                                    $lists->tag);
 323                 }
 324
 325                 $this->elementEnd('ul');
 326
 327                 Event::handle('EndShowListsMiniList', array($this));
 328             }
 329             $this->elementEnd('div');
 330         }
 331     }
 332 }
 333
 334 class SubscribersMiniList extends ProfileMiniList
 335 {
 336     function newListItem($profile)
 337     {
 338         return new SubscribersMiniListItem($profile, $this->action);
 339     }
 340 }
 341
 342 class SubscribersMiniListItem extends ProfileMiniListItem
 343 {
 344     function linkAttributes()
 345     {
 346         $aAttrs = parent::linkAttributes();
 347         if (common_config('nofollow', 'subscribers')) {
 348             $aAttrs['rel'] .= ' nofollow';
 349         }
 350         return $aAttrs;
 351     }
 352 }