* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
* @copyright 2009-2010 StatusNet, Inc.
+ * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
exit(1);
}
-require_once INSTALLDIR.'/lib/apibareauth.php';
-
/**
* Returns the 20 most recent favorite notices for the authenticating user or user
* specified by the ID parameter in the requested format.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
-
class ApiTimelineFavoritesAction extends ApiBareAuthAction
{
var $notices = null;
* @param array $args $_REQUEST args
*
* @return boolean success flag
- *
*/
-
- function prepare($args)
+ protected function prepare(array $args=array())
{
parent::prepare($args);
- $this->user = $this->getTargetUser($this->arg('id'));
+ $this->target = $this->getTargetProfile($this->arg('id'));
- if (empty($this->user)) {
- $this->clientError(_('No such user.'), 404, $this->format);
- return;
+ if (!($this->target instanceof Profile)) {
+ // TRANS: Client error displayed when requesting most recent favourite notices by a user for a non-existing user.
+ $this->clientError(_('No such user.'), 404);
}
$this->notices = $this->getNotices();
*
* Just show the notices
*
- * @param array $args $_REQUEST data (unused)
- *
* @return void
*/
-
- function handle($args)
+ protected function handle()
{
- parent::handle($args);
+ parent::handle();
$this->showTimeline();
}
*
* @return void
*/
-
function showTimeline()
{
- $profile = $this->user->getProfile();
- $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
-
$sitename = common_config('site', 'name');
$title = sprintf(
+ // TRANS: Title for timeline of most recent favourite notices by a user.
+ // TRANS: %1$s is the StatusNet sitename, %2$s is a user nickname.
_('%1$s / Favorites from %2$s'),
$sitename,
- $this->user->nickname
+ $this->target->nickname
);
$taguribase = TagURI::base();
- $id = "tag:$taguribase:Favorites:" . $this->user->id;
+ $id = "tag:$taguribase:Favorites:" . $this->target->id;
$subtitle = sprintf(
- _('%1$s updates favorited by %2$s / %2$s.'),
+ // TRANS: Subtitle for timeline of most recent favourite notices by a user.
+ // TRANS: %1$s is the StatusNet sitename, %2$s is a user's full name,
+ // TRANS: %3$s is a user nickname.
+ _('%1$s updates favorited by %2$s / %3$s.'),
$sitename,
- $profile->getBestName(),
- $this->user->nickname
- );
- $logo = !empty($avatar)
- ? $avatar->displayUrl()
- : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
-
- $link = common_local_url(
- 'showfavorites',
- array('nickname' => $this->user->nickname)
+ $this->target->getBestName(),
+ $this->target->nickname
);
+ $logo = $this->target->avatarUrl(AVATAR_PROFILE_SIZE);
+ $link = common_local_url('showfavorites',
+ array('nickname' => $this->target->nickname));
$self = $this->getSelfUri();
switch($this->format) {
);
break;
case 'atom':
-
header('Content-Type: application/atom+xml; charset=utf-8');
- $atom = new AtomNoticeFeed();
+ $atom = new AtomNoticeFeed($this->auth_user);
$atom->setId($id);
$atom->setTitle($title);
$atom->addEntryFromNotices($this->notices);
$this->raw($atom->getString());
-
break;
case 'json':
$this->showJsonTimeline($this->notices);
break;
- default:
- $this->clientError(_('API method not found.'), $code = 404);
+ case 'as':
+ header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
+ $doc = new ActivityStreamJSONDocument($this->auth_user);
+ $doc->setTitle($title);
+ $doc->addLink($link,'alternate', 'text/html');
+ $doc->addItemsFromNotices($this->notices);
+ $this->raw($doc->asString());
break;
+ default:
+ // TRANS: Client error displayed when coming across a non-supported API method.
+ $this->clientError(_('API method not found.'), 404);
}
}
*
* @return array notices
*/
-
function getNotices()
{
$notices = array();
- if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
- $notice = $this->user->favoriteNotices(
+ common_debug("since id = " . $this->since_id . " max id = " . $this->max_id);
+
+ if (!empty($this->auth_user) && $this->auth_user->id == $this->target->id) {
+ $notice = $this->target->favoriteNotices(
+ true,
($this->page-1) * $this->count,
$this->count,
- true
+ $this->since_id,
+ $this->max_id
);
} else {
- $notice = $this->user->favoriteNotices(
+ $notice = $this->target->favoriteNotices(
+ false,
($this->page-1) * $this->count,
$this->count,
- false
+ $this->since_id,
+ $this->max_id
);
}
*
* @return boolean true
*/
-
function isReadOnly($args)
{
return true;
*
* @return string datestamp of the latest notice in the stream
*/
-
function lastModified()
{
if (!empty($this->notices) && (count($this->notices) > 0)) {
*
* @return string etag
*/
-
function etag()
{
if (!empty($this->notices) && (count($this->notices) > 0)) {
return '"' . implode(
':',
array($this->arg('action'),
+ common_user_cache_hash($this->auth_user),
common_language(),
- $this->user->id,
+ $this->target->id,
strtotime($this->notices[0]->created),
strtotime($this->notices[$last]->created))
)
return null;
}
-
}