gnu-social/lib/profileaction.php
Mikael Nordfeldth 9a92b58057 ShowstreamAction tidying up
Lots of these changes mean that we're requiring certain values to
either by typed properly or return the expected value. If it doesn't
there should be a fatal exception thrown which we can followup in the
logs and won't go silently suppressed.
2015-07-10 13:44:47 +02:00

334 lines
11 KiB
PHP

<?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
* @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
* @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 prepare(array $args=array())
{
// this will call ->doPreparation() which child classes use to set $this->target
parent::prepare($args);
if ($this->target->hasRole(Profile_role::SILENCED)
&& (!$this->scoped instanceof Profile || !$this->scoped->hasRight(Right::SILENCEUSER))) {
throw new ClientException(_('This profile has been silenced by site moderators'), 403);
}
$this->tag = $this->trimmed('tag');
$this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
common_set_returnto($this->selfUrl());
return true;
}
protected function profileActionPreparation()
{
// Nothing to do by default.
}
public function getTarget()
{
if (!$this->target instanceof Profile) {
throw new ServerException('No target profile in ProfileAction class');
}
return $this->target;
}
function isReadOnly($args)
{
return true;
}
function showSections()
{
$this->showSubscriptions();
$this->showSubscribers();
$this->showGroups();
$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'));
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);
$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)'));
}
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');
}
function showLists()
{
$lists = $this->target->getLists($this->scoped);
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()));
$this->elementStart('h2');
$this->element('a',
array('href' => $url),
// TRANS: H2 text for user list membership statistics.
_('Lists'));
$this->text(' ');
$this->text($lists->N);
$this->elementEnd('h2');
$this->elementStart('ul');
$first = true;
while ($lists->fetch()) {
if (!empty($lists->mainpage)) {
$url = $lists->mainpage;
} else {
$url = common_local_url('showprofiletag',
array('tagger' => $this->target->getNickname(),
'tag' => $lists->tag));
}
if (!$first) {
$this->text(', ');
} else {
$first = false;
}
$this->element('a', array('href' => $url),
$lists->tag);
}
$this->elementEnd('ul');
Event::handle('EndShowListsMiniList', array($this));
}
$this->elementEnd('div');
}
}
}
class SubscribersMiniList extends ProfileMiniList
{
function newListItem($profile)
{
return new SubscribersMiniListItem($profile, $this->action);
}
}
class SubscribersMiniListItem extends ProfileMiniListItem
{
function linkAttributes()
{
$aAttrs = parent::linkAttributes();
if (common_config('nofollow', 'subscribers')) {
$aAttrs['rel'] .= ' nofollow';
}
return $aAttrs;
}
}