gnu-social/plugins/Favorite/actions/showfavorites.php

258 lines
9.2 KiB
PHP
Raw Normal View History

<?php
2009-01-19 15:28:27 +00:00
/**
* StatusNet, the distributed open-source microblogging tool
*
2009-01-19 15:28:27 +00:00
* List of replies
*
* 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/>.
2009-01-19 15:28:27 +00:00
*
* @category Personal
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2008-2011 StatusNet, Inc.
2009-01-19 15:28:27 +00:00
* @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('STATUSNET') && !defined('LACONICA')) {
2009-01-19 15:28:27 +00:00
exit(1);
}
2009-01-19 15:28:27 +00:00
require_once INSTALLDIR.'/lib/personalgroupnav.php';
require_once INSTALLDIR.'/lib/noticelist.php';
require_once INSTALLDIR.'/lib/feedlist.php';
2009-01-19 15:28:27 +00:00
/**
* List of replies
*
* @category Personal
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
2009-01-19 15:28:27 +00:00
* @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/
2009-01-19 15:28:27 +00:00
*/
class ShowfavoritesAction extends Action
2009-01-19 15:28:27 +00:00
{
/** User we're getting the faves of */
var $user = null;
/** Page of the faves we're on */
var $page = null;
2009-01-19 18:10:20 +00:00
/**
* Is this a read-only page?
*
* @return boolean true
*/
function isReadOnly($args)
2009-01-19 18:10:20 +00:00
{
return true;
}
2009-01-19 15:28:27 +00:00
/**
* Title of the page
*
* Includes name of user and page number.
*
* @return string title of page
*/
function title()
{
2009-01-19 15:28:27 +00:00
if ($this->page == 1) {
// TRANS: Title for first page of favourite notices of a user.
// TRANS: %s is the user for whom the favourite notices are displayed.
return sprintf(_('%s\'s favorite notices'), $this->user->nickname);
2009-01-19 15:28:27 +00:00
} else {
// TRANS: Title for all but the first page of favourite notices of a user.
// TRANS: %1$s is the user for whom the favourite notices are displayed, %2$d is the page number.
return sprintf(_('%1$s\'s favorite notices, page %2$d'),
2009-01-19 15:28:27 +00:00
$this->user->nickname,
$this->page);
}
}
2009-01-19 15:28:27 +00:00
/**
* Prepare the object
*
* Check the input values and initialize the object.
* Shows an error page on bad input.
*
* @param array $args $_REQUEST data
*
* @return boolean success flag
*/
function prepare($args)
{
parent::prepare($args);
$nickname = common_canonical_nickname($this->arg('nickname'));
$this->user = User::getKV('nickname', $nickname);
2009-01-19 15:28:27 +00:00
if (!$this->user) {
// TRANS: Client error displayed when trying to display favourite notices for a non-existing user.
$this->clientError(_('No such user.'));
}
2009-01-19 15:28:27 +00:00
$this->page = $this->trimmed('page');
2009-01-19 15:28:27 +00:00
if (!$this->page) {
$this->page = 1;
}
common_set_returnto($this->selfUrl());
$cur = common_current_user();
// Show imported/gateway notices as well as local if
// the user is looking at their own favorites, otherwise not.
$this->notice = Fave::stream($this->user->id,
($this->page-1)*NOTICES_PER_PAGE, // offset
NOTICES_PER_PAGE + 1, // limit
(!empty($cur) && $cur->id == $this->user->id) // own feed?
);
if (empty($this->notice)) {
// TRANS: Server error displayed when favourite notices could not be retrieved from the database.
$this->serverError(_('Could not retrieve favorite notices.'));
}
if($this->page > 1 && $this->notice->N == 0){
// TRANS: Client error when page not found (404)
$this->clientError(_('No such page.'), 404);
}
2009-01-19 15:28:27 +00:00
return true;
}
2009-01-19 15:28:27 +00:00
/**
* Handle a request
*
* Just show the page. All args already handled.
*
* @param array $args $_REQUEST data
*
* @return void
*/
function handle($args)
{
parent::handle($args);
$this->showPage();
}
2009-01-19 15:28:27 +00:00
/**
* Feeds for the <head> section
*
* @return array Feed objects to show
2009-01-19 15:28:27 +00:00
*/
function getFeeds()
{
return array(new Feed(Feed::JSON,
common_local_url('ApiTimelineFavorites',
array(
'id' => $this->user->nickname,
'format' => 'as')),
// TRANS: Feed link text. %s is a username.
sprintf(_('Feed for favorites of %s (Activity Streams JSON)'),
$this->user->nickname)),
new Feed(Feed::RSS1,
common_local_url('favoritesrss',
array('nickname' => $this->user->nickname)),
// TRANS: Feed link text. %s is a username.
sprintf(_('Feed for favorites of %s (RSS 1.0)'),
$this->user->nickname)),
new Feed(Feed::RSS2,
common_local_url('ApiTimelineFavorites',
array(
'id' => $this->user->nickname,
'format' => 'rss')),
// TRANS: Feed link text. %s is a username.
sprintf(_('Feed for favorites of %s (RSS 2.0)'),
$this->user->nickname)),
new Feed(Feed::ATOM,
common_local_url('ApiTimelineFavorites',
array(
'id' => $this->user->nickname,
'format' => 'atom')),
// TRANS: Feed link text. %s is a username.
sprintf(_('Feed for favorites of %s (Atom)'),
$this->user->nickname)));
}
function showEmptyListMessage()
{
if (common_logged_in()) {
$current_user = common_current_user();
if ($this->user->id === $current_user->id) {
// TRANS: Text displayed instead of favourite notices for the current logged in user that has no favourites.
$message = _('You haven\'t chosen any favorite notices yet. Click the fave button on notices you like to bookmark them for later or shed a spotlight on them.');
} else {
// TRANS: Text displayed instead of favourite notices for a user that has no favourites while logged in.
// TRANS: %s is a username.
2010-07-20 03:09:09 +01:00
$message = sprintf(_('%s hasn\'t added any favorite notices yet. Post something interesting they would add to their favorites :)'), $this->user->nickname);
}
}
else {
// TRANS: Text displayed instead of favourite notices for a user that has no favourites while not logged in.
// TRANS: %s is a username, %%%%action.register%%%% is a link to the user registration page.
// TRANS: (link text)[link] is a Mark Down link.
2010-07-20 03:09:09 +01:00
$message = sprintf(_('%s hasn\'t added any favorite notices yet. Why not [register an account](%%%%action.register%%%%) and then post something interesting they would add to their favorites :)'), $this->user->nickname);
}
$this->elementStart('div', 'guide');
$this->raw(common_markup_to_html($message));
$this->elementEnd('div');
}
2009-01-19 15:28:27 +00:00
/**
* Show the content
*
* A list of notices that this user has marked as a favorite
*
* @return void
*/
function showContent()
{
$nl = new FavoritesNoticeList($this->notice, $this);
2009-01-19 15:28:27 +00:00
$cnt = $nl->show();
if (0 == $cnt) {
$this->showEmptyListMessage();
}
2009-01-19 15:28:27 +00:00
$this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
$this->page, 'showfavorites',
array('nickname' => $this->user->nickname));
}
function showPageNotice() {
// TRANS: Page notice for show favourites page.
$this->element('p', 'instructions', _('This is a way to share what you like.'));
}
}
class FavoritesNoticeList extends NoticeList
{
function newListItem($notice)
{
return new FavoritesNoticeListItem($notice, $this->out);
}
}
// All handled by superclass
class FavoritesNoticeListItem extends DoFollowListItem
{
}