gnu-social/actions/shownotice.php

260 lines
7.5 KiB
PHP
Raw Normal View History

<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Show a single notice
*
* 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>
* @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/
*/
2019-06-02 13:46:39 +01:00
if (!defined('GNUSOCIAL')) {
exit(1);
}
require_once INSTALLDIR.'/lib/noticelist.php';
/**
* Show a single notice
*
* @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/
*/
class ShownoticeAction extends ManagedAction
{
protected $redirectAfterLogin = true;
/**
* Notice object to show
*/
2019-06-02 13:46:39 +01:00
public $notice = null;
/**
* Profile of the notice object
*/
2019-06-02 13:46:39 +01:00
public $profile = null;
/**
* Avatar of the profile of the notice object
*/
2019-06-02 13:46:39 +01:00
public $avatar = null;
/**
* Load attributes based on database arguments
*
* Loads all the DB stuff
*
* @param array $args $_REQUEST array
*
* @return success flag
*/
2019-06-02 13:46:39 +01:00
protected function prepare(array $args=[])
{
parent::prepare($args);
if ($this->boolean('ajax')) {
GNUsocial::setApi(true);
}
$this->notice = $this->getNotice();
2016-02-17 22:32:56 +00:00
$this->target = $this->notice;
if (!$this->notice->inScope($this->scoped)) {
// TRANS: Client exception thrown when trying a view a notice the user has no access to.
throw new ClientException(_('Access restricted.'), 403);
}
$this->profile = $this->notice->getProfile();
if (!$this->profile instanceof Profile) {
// TRANS: Server error displayed trying to show a notice without a connected profile.
$this->serverError(_('Notice has no profile.'), 500);
}
try {
$this->user = $this->profile->getUser();
} catch (NoSuchUserException $e) {
// FIXME: deprecate $this->user stuff in extended classes
$this->user = null;
}
2009-07-02 13:21:54 +01:00
try {
$this->avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
} catch (Exception $e) {
$this->avatar = null;
}
return true;
}
/**
* Fetch the notice to show. This may be overridden by child classes to
* customize what we fetch without duplicating all of the prepare() method.
*
* @return Notice
*/
2014-01-01 19:30:30 +00:00
protected function getNotice()
{
$id = $this->arg('notice');
$notice = null;
try {
$notice = Notice::getByID($id);
// Alright, got it!
return $notice;
} catch (NoResultException $e) {
// Hm, not found.
$deleted = null;
2019-06-02 13:46:39 +01:00
Event::handle('IsNoticeDeleted', [$id, &$deleted]);
if ($deleted === true) {
// TRANS: Client error displayed trying to show a deleted notice.
throw new ClientException(_('Notice deleted.'), 410);
}
}
// TRANS: Client error displayed trying to show a non-existing notice.
throw new ClientException(_('No such notice.'), 404);
}
/**
* Is this action read-only?
*
* @return boolean true
*/
2019-06-02 13:46:39 +01:00
public function isReadOnly($args)
{
return true;
}
/**
* Last-modified date for page
*
* When was the content of this page last modified? Based on notice,
* profile, avatar.
*
* @return int last-modified date as unix timestamp
*/
2019-06-02 13:46:39 +01:00
public function lastModified()
{
return max(strtotime($this->notice->modified),
strtotime($this->profile->modified),
($this->avatar) ? strtotime($this->avatar->modified) : 0);
}
/**
* An entity tag for this page
*
* Shows the ETag for the page, based on the notice ID and timestamps
* for the notice, profile, and avatar. It's weak, since we change
* the date text "one hour ago", etc.
*
* @return string etag
*/
2019-06-02 13:46:39 +01:00
public function etag()
{
$avtime = ($this->avatar) ?
strtotime($this->avatar->modified) : 0;
2019-06-02 13:46:39 +01:00
return 'W/"' . implode(':', [$this->arg('action'),
common_user_cache_hash(),
common_language(),
$this->notice->id,
strtotime($this->notice->created),
strtotime($this->profile->modified),
$avtime]) . '"';
}
/**
* Title of the page
*
* @return string title of the page
*/
2019-06-02 13:46:39 +01:00
public function title()
{
return $this->notice->getTitle();
}
/**
* Fill the content area of the page
*
* Shows a single notice list item.
*
* @return void
*/
2019-06-02 13:46:39 +01:00
public function showContent()
{
2019-06-02 13:46:39 +01:00
$this->elementStart('ol', ['class' => 'notices xoxo']);
$nli = new NoticeListItem($this->notice, $this);
$nli->show();
$this->elementEnd('ol');
}
/**
* Don't show page notice
*
* @return void
*/
2019-06-02 13:46:39 +01:00
public function showPageNoticeBlock()
{
}
2019-06-02 13:46:39 +01:00
public function getFeeds()
2016-02-17 22:32:56 +00:00
{
2019-06-02 13:46:39 +01:00
return [
new Feed(Feed::JSON,
common_local_url('ApiStatusesShow',
['id' => $this->target->getID(),
'format' => 'json']),
// TRANS: Title for link to single notice representation.
// TRANS: %s is a user nickname.
sprintf(_('Single notice (JSON)'))
),
new Feed(Feed::ATOM,
common_local_url('ApiStatusesShow',
['id' => $this->target->getID(),
'format' => 'atom']),
// TRANS: Title for link to notice feed.
// TRANS: %s is a user nickname.
sprintf(_('Single notice (Atom)'))
)
];
}
/**
* Extra <head> content
*
* Facebook OpenGraph metadata.
*
* @return void
*/
2019-06-02 13:46:39 +01:00
public function extraHead()
{
// Extras to aid in sharing notices to Facebook
$avatarUrl = $this->profile->avatarUrl(AVATAR_PROFILE_SIZE);
2019-06-02 13:46:39 +01:00
$this->element('meta', ['property' => 'og:image',
'content' => $avatarUrl]);
$this->element('meta', ['property' => 'og:description',
'content' => $this->notice->content]);
}
}