gnu-social/lib/profileaction.php

364 lines
13 KiB
PHP
Raw Normal View History

<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Common parent of Personal and Profile actions
*
* 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-2011 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
2009-08-25 23:16:46 +01:00
* @link http://status.net/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Profile action common superclass
*
* Abstracts out common code from profile and personal tabs
*
* @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
2009-08-25 23:16:46 +01:00
* @link http://status.net/
*/
abstract class ProfileAction extends ManagedAction
{
var $page = null;
var $tag = null;
protected $target = null; // Profile that we're showing
protected function doPreparation()
{
try {
$nickname_arg = $this->arg('nickname');
$nickname = common_canonical_nickname($nickname_arg);
// Permanent redirect on non-canonical nickname
if ($nickname_arg != $nickname) {
$args = array('nickname' => $nickname);
if ($this->arg('page') && $this->arg('page') != 1) {
$args['page'] = $this->arg['page'];
}
common_redirect(common_local_url($this->getActionName(), $args), 301);
}
$this->user = User::getKV('nickname', $nickname);
if (!$this->user) {
// TRANS: Client error displayed when calling a profile action without specifying a user.
$this->clientError(_('No such user.'), 404);
}
$this->target = $this->user->getProfile();
} catch (NicknameException $e) {
$id = (int)$this->arg('id');
$this->target = Profile::getKV('id', $id);
if (!$this->target instanceof Profile) {
// TRANS: Error message displayed when referring to a user without a profile.
$this->serverError(_m('Profile ID does not exist.'));
}
if ($this->target->isLocal()) {
// For local users when accessed by id number, redirect to
// the same action but using the nickname as argument.
common_redirect(common_local_url($this->getActionName(),
array('nickname'=>$user->getNickname())));
}
}
if ($this->target->hasRole(Profile_role::SILENCED) &&
(empty($this->scoped) || !$this->scoped->hasRight(Right::SILENCEUSER))) {
2012-03-08 12:45:56 +00:00
throw new ClientException(_('This profile has been silenced by site moderators'), 403);
}
// backwards compatibility until all actions are fixed to use $this->target
$this->profile = $this->target;
$this->tag = $this->trimmed('tag');
$this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
common_set_returnto($this->selfUrl());
return $this->profileActionPreparation();
}
protected function profileActionPreparation()
{
// No-op by default.
}
function isReadOnly($args)
{
return true;
}
function showSections()
{
$this->showSubscriptions();
$this->showSubscribers();
$this->showGroups();
2011-04-14 21:57:50 +01:00
$this->showLists();
$this->showStatistics();
}
/**
* Convenience function for common pattern of links to subscription/groups sections.
*
* @param string $actionClass
* @param string $title
* @param string $cssClass
*/
private function statsSectionLink($actionClass, $title, $cssClass='')
{
$this->element('a', array('href' => common_local_url($actionClass,
array('nickname' => $this->target->getNickname())),
'class' => $cssClass),
$title);
}
function showSubscriptions()
{
$this->elementStart('div', array('id' => 'entity_subscriptions',
'class' => 'section'));
if (Event::handle('StartShowSubscriptionsMiniList', array($this))) {
$this->elementStart('h2');
// TRANS: H2 text for user subscription statistics.
$this->statsSectionLink('subscriptions', _('Following'));
$this->text(' ');
$this->text($this->target->subscriptionCount());
$this->elementEnd('h2');
try {
$profile = $this->target->getSubscribed(0, PROFILES_PER_MINILIST + 1);
$pml = new ProfileMiniList($profile, $this);
$pml->show();
} catch (NoResultException $e) {
// TRANS: Text for user subscription statistics if the user has no subscription
$this->element('p', null, _('(None)'));
}
Event::handle('EndShowSubscriptionsMiniList', array($this));
}
$this->elementEnd('div');
}
function showSubscribers()
{
$this->elementStart('div', array('id' => 'entity_subscribers',
'class' => 'section'));
2010-04-05 15:12:40 +01:00
if (Event::handle('StartShowSubscribersMiniList', array($this))) {
$this->elementStart('h2');
// TRANS: H2 text for user subscriber statistics.
$this->statsSectionLink('subscribers', _('Followers'));
$this->text(' ');
$this->text($this->target->subscriberCount());
$this->elementEnd('h2');
try {
$profile = $this->target->getSubscribers(0, PROFILES_PER_MINILIST + 1);
2010-04-05 15:22:54 +01:00
$sml = new SubscribersMiniList($profile, $this);
$sml->show();
} catch (NoResultException $e) {
// TRANS: Text for user subscriber statistics if user has no subscribers.
$this->element('p', null, _('(None)'));
}
2010-04-05 15:12:40 +01:00
Event::handle('EndShowSubscribersMiniList', array($this));
}
$this->elementEnd('div');
}
function showStatistics()
{
$notice_count = $this->target->noticeCount();
$age_days = (time() - strtotime($this->target->created)) / 86400;
if ($age_days < 1) {
// Rather than extrapolating out to a bajillion...
$age_days = 1;
}
$daily_count = round($notice_count / $age_days);
$this->elementStart('div', array('id' => 'entity_statistics',
'class' => 'section'));
// TRANS: H2 text for user statistics.
$this->element('h2', null, _('Statistics'));
$profile = $this->target;
$actionParams = array('nickname' => $profile->nickname);
$stats = array(
array(
'id' => 'user-id',
// TRANS: Label for user statistics.
'label' => _('User ID'),
'value' => $profile->id,
),
array(
'id' => 'member-since',
// TRANS: Label for user statistics.
'label' => _('Member since'),
'value' => date('j M Y', strtotime($profile->created))
),
array(
'id' => 'notices',
// TRANS: Label for user statistics.
'label' => _('Notices'),
'value' => $notice_count,
),
array(
'id' => 'daily_notices',
// TRANS: Label for user statistics.
// TRANS: Average count of posts made per day since account registration.
'label' => _('Daily average'),
'value' => $daily_count
)
);
// Give plugins a chance to add stats entries
Event::handle('ProfileStats', array($profile, &$stats));
foreach ($stats as $row) {
$this->showStatsRow($row);
}
$this->elementEnd('div');
}
private function showStatsRow($row)
{
$this->elementStart('dl', 'entity_' . $row['id']);
$this->elementStart('dt');
if (!empty($row['link'])) {
$this->element('a', array('href' => $row['link']), $row['label']);
} else {
$this->text($row['label']);
}
$this->elementEnd('dt');
$this->element('dd', null, $row['value']);
$this->elementEnd('dl');
}
function showGroups()
{
$groups = $this->target->getGroups(0, GROUPS_PER_MINILIST + 1);
$this->elementStart('div', array('id' => 'entity_groups',
'class' => 'section'));
if (Event::handle('StartShowGroupsMiniList', array($this))) {
$this->elementStart('h2');
// TRANS: H2 text for user group membership statistics.
$this->statsSectionLink('usergroups', _('Groups'));
$this->text(' ');
$this->text($this->target->getGroupCount());
$this->elementEnd('h2');
if ($groups instanceof User_group) {
$gml = new GroupMiniList($groups, $this->target, $this);
$cnt = $gml->show();
} else {
// TRANS: Text for user user group membership statistics if user is not a member of any group.
$this->element('p', null, _('(None)'));
}
Event::handle('EndShowGroupsMiniList', array($this));
}
$this->elementEnd('div');
}
2011-04-14 21:57:50 +01:00
function showLists()
{
$lists = $this->target->getLists($this->scoped);
2011-04-14 21:57:50 +01:00
if ($lists->N > 0) {
$this->elementStart('div', array('id' => 'entity_lists',
'class' => 'section'));
if (Event::handle('StartShowListsMiniList', array($this))) {
$url = common_local_url('peopletagsbyuser',
array('nickname' => $this->target->getNickname()));
2011-04-14 21:57:50 +01:00
$this->elementStart('h2');
$this->element('a',
array('href' => $url),
// TRANS: H2 text for user list membership statistics.
_('Lists'));
2011-04-14 21:57:50 +01:00
$this->text(' ');
$this->text($lists->N);
$this->elementEnd('h2');
$this->elementStart('ul');
$first = true;
2011-04-14 21:57:50 +01:00
while ($lists->fetch()) {
if (!empty($lists->mainpage)) {
$url = $lists->mainpage;
} else {
$url = common_local_url('showprofiletag',
array('tagger' => $this->target->getNickname(),
'tag' => $lists->tag));
2011-04-14 21:57:50 +01:00
}
if (!$first) {
$this->text(', ');
} else {
$first = false;
}
$this->element('a', array('href' => $url),
$lists->tag);
2011-04-14 21:57:50 +01:00
}
$this->elementEnd('ul');
Event::handle('EndShowListsMiniList', array($this));
}
$this->elementEnd('div');
}
}
}
2010-04-05 15:22:54 +01:00
class SubscribersMiniList extends ProfileMiniList
{
function newListItem($profile)
{
return new SubscribersMiniListItem($profile, $this->action);
}
}
class SubscribersMiniListItem extends ProfileMiniListItem
{
function linkAttributes()
2010-04-05 15:22:54 +01:00
{
$aAttrs = parent::linkAttributes();
if (common_config('nofollow', 'subscribers')) {
$aAttrs['rel'] .= ' nofollow';
2010-04-05 15:22:54 +01:00
}
return $aAttrs;
2010-04-05 15:22:54 +01:00
}
}