2009-09-24 05:45:51 +09:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* StatusNet, the distributed open-source microblogging tool
|
|
|
|
*
|
2009-12-15 06:10:16 +09:00
|
|
|
* Show the home timeline
|
2009-09-24 05:45:51 +09:00
|
|
|
*
|
|
|
|
* 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-09-28 07:33:46 +09:00
|
|
|
* @category API
|
2009-09-24 05:45:51 +09:00
|
|
|
* @package StatusNet
|
2009-10-13 08:36:00 +09:00
|
|
|
* @author Craig Andrews <candrews@integralblue.com>
|
|
|
|
* @author Evan Prodromou <evan@status.net>
|
|
|
|
* @author Jeffery To <jeffery.to@gmail.com>
|
|
|
|
* @author mac65 <mac65@mac65.com>
|
|
|
|
* @author Mike Cochrane <mikec@mikenz.geek.nz>
|
|
|
|
* @author Robin Millette <robin@millette.info>
|
2009-09-24 05:45:51 +09:00
|
|
|
* @author Zach Copley <zach@status.net>
|
|
|
|
* @copyright 2009 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('STATUSNET')) {
|
|
|
|
exit(1);
|
|
|
|
}
|
|
|
|
|
2009-10-13 08:36:00 +09:00
|
|
|
require_once INSTALLDIR . '/lib/apibareauth.php';
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-09-28 07:33:46 +09:00
|
|
|
/**
|
|
|
|
* Returns the most recent notices (default 20) posted by the target user.
|
|
|
|
* This is the equivalent of 'You and friends' page accessed via Web.
|
|
|
|
*
|
|
|
|
* @category API
|
|
|
|
* @package StatusNet
|
2009-10-13 08:36:00 +09:00
|
|
|
* @author Craig Andrews <candrews@integralblue.com>
|
|
|
|
* @author Evan Prodromou <evan@status.net>
|
|
|
|
* @author Jeffery To <jeffery.to@gmail.com>
|
|
|
|
* @author mac65 <mac65@mac65.com>
|
|
|
|
* @author Mike Cochrane <mikec@mikenz.geek.nz>
|
|
|
|
* @author Robin Millette <robin@millette.info>
|
2009-09-28 07:33:46 +09:00
|
|
|
* @author Zach Copley <zach@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/
|
|
|
|
*/
|
|
|
|
|
2009-12-15 06:10:16 +09:00
|
|
|
class ApiTimelineHomeAction extends ApiBareAuthAction
|
2009-09-24 05:45:51 +09:00
|
|
|
{
|
2009-10-01 09:02:04 +09:00
|
|
|
var $notices = null;
|
2009-09-25 10:13:46 +09:00
|
|
|
|
2009-09-24 05:45:51 +09:00
|
|
|
/**
|
|
|
|
* Take arguments for running
|
|
|
|
*
|
|
|
|
* @param array $args $_REQUEST args
|
|
|
|
*
|
|
|
|
* @return boolean success flag
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
function prepare($args)
|
|
|
|
{
|
|
|
|
parent::prepare($args);
|
2010-03-12 12:15:51 +09:00
|
|
|
|
2009-09-26 08:58:35 +09:00
|
|
|
$this->user = $this->getTargetUser($this->arg('id'));
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-09-26 08:58:35 +09:00
|
|
|
if (empty($this->user)) {
|
2009-11-09 07:10:44 +09:00
|
|
|
$this->clientError(_('No such user.'), 404, $this->format);
|
2009-09-25 10:13:46 +09:00
|
|
|
return;
|
2009-09-24 05:45:51 +09:00
|
|
|
}
|
|
|
|
|
2009-09-26 08:58:35 +09:00
|
|
|
$this->notices = $this->getNotices();
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-09-25 10:13:46 +09:00
|
|
|
return true;
|
|
|
|
}
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-09-28 06:11:12 +09:00
|
|
|
/**
|
|
|
|
* Handle the request
|
|
|
|
*
|
|
|
|
* Just show the notices
|
|
|
|
*
|
|
|
|
* @param array $args $_REQUEST data (unused)
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
|
2009-09-28 07:33:46 +09:00
|
|
|
function handle($args)
|
|
|
|
{
|
2009-09-26 08:58:35 +09:00
|
|
|
parent::handle($args);
|
|
|
|
$this->showTimeline();
|
2009-09-25 10:13:46 +09:00
|
|
|
}
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-09-28 06:11:12 +09:00
|
|
|
/**
|
|
|
|
* Show the timeline of notices
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
|
2009-09-25 10:13:46 +09:00
|
|
|
function showTimeline()
|
|
|
|
{
|
|
|
|
$profile = $this->user->getProfile();
|
2009-12-08 20:28:11 +09:00
|
|
|
$avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
|
2009-09-24 05:45:51 +09:00
|
|
|
$sitename = common_config('site', 'name');
|
2009-09-28 09:27:42 +09:00
|
|
|
$title = sprintf(_("%s and friends"), $this->user->nickname);
|
2010-02-21 03:31:20 +09:00
|
|
|
$taguribase = TagURI::base();
|
2009-12-15 06:10:16 +09:00
|
|
|
$id = "tag:$taguribase:HomeTimeline:" . $this->user->id;
|
2010-02-12 06:54:40 +09:00
|
|
|
|
2009-09-28 07:33:46 +09:00
|
|
|
$subtitle = sprintf(
|
2010-04-10 08:48:16 +09:00
|
|
|
// TRANS: Message is used as a subtitle. %1$s is a user nickname, %2$s is a site name.
|
2009-09-28 07:33:46 +09:00
|
|
|
_('Updates from %1$s and friends on %2$s!'),
|
2009-09-28 09:27:42 +09:00
|
|
|
$this->user->nickname, $sitename
|
2009-09-28 07:33:46 +09:00
|
|
|
);
|
2010-02-12 06:54:40 +09:00
|
|
|
|
2010-03-12 12:15:51 +09:00
|
|
|
$link = common_local_url(
|
|
|
|
'all',
|
|
|
|
array('nickname' => $this->user->nickname)
|
|
|
|
);
|
|
|
|
|
|
|
|
$self = $this->getSelfUri();
|
|
|
|
|
|
|
|
$logo = (!empty($avatar))
|
|
|
|
? $avatar->displayUrl()
|
2010-02-12 06:54:40 +09:00
|
|
|
: Avatar::defaultImage(AVATAR_PROFILE_SIZE);
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-10-01 09:02:04 +09:00
|
|
|
switch($this->format) {
|
2009-09-28 07:33:46 +09:00
|
|
|
case 'xml':
|
2009-10-10 09:53:35 +09:00
|
|
|
$this->showXmlTimeline($this->notices);
|
2009-09-28 07:33:46 +09:00
|
|
|
break;
|
|
|
|
case 'rss':
|
2010-02-12 06:54:40 +09:00
|
|
|
$this->showRssTimeline(
|
|
|
|
$this->notices,
|
|
|
|
$title,
|
|
|
|
$link,
|
|
|
|
$subtitle,
|
|
|
|
null,
|
2010-03-12 12:15:51 +09:00
|
|
|
$logo,
|
|
|
|
$self
|
2010-02-12 06:54:40 +09:00
|
|
|
);
|
2009-09-28 07:33:46 +09:00
|
|
|
break;
|
|
|
|
case 'atom':
|
|
|
|
|
2010-02-12 06:54:40 +09:00
|
|
|
header('Content-Type: application/atom+xml; charset=utf-8');
|
|
|
|
|
2010-05-28 05:49:23 +09:00
|
|
|
$atom = new AtomNoticeFeed($this->auth_user);
|
2009-09-28 07:33:46 +09:00
|
|
|
|
2010-02-12 06:54:40 +09:00
|
|
|
$atom->setId($id);
|
|
|
|
$atom->setTitle($title);
|
|
|
|
$atom->setSubtitle($subtitle);
|
|
|
|
$atom->setLogo($logo);
|
|
|
|
$atom->setUpdated('now');
|
|
|
|
|
2010-03-12 12:15:51 +09:00
|
|
|
$atom->addLink($link);
|
|
|
|
$atom->setSelfLink($self);
|
2010-02-12 06:54:40 +09:00
|
|
|
|
|
|
|
$atom->addEntryFromNotices($this->notices);
|
|
|
|
$this->raw($atom->getString());
|
|
|
|
|
2009-09-28 07:33:46 +09:00
|
|
|
break;
|
|
|
|
case 'json':
|
2009-10-10 09:53:35 +09:00
|
|
|
$this->showJsonTimeline($this->notices);
|
2009-09-28 07:33:46 +09:00
|
|
|
break;
|
|
|
|
default:
|
2010-01-10 20:26:24 +09:00
|
|
|
$this->clientError(_('API method not found.'), $code = 404);
|
2009-09-28 07:33:46 +09:00
|
|
|
break;
|
2009-09-25 10:13:46 +09:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-09-28 06:11:12 +09:00
|
|
|
/**
|
|
|
|
* Get notices
|
|
|
|
*
|
|
|
|
* @return array notices
|
|
|
|
*/
|
|
|
|
|
2009-09-25 10:13:46 +09:00
|
|
|
function getNotices()
|
|
|
|
{
|
2009-09-26 08:58:35 +09:00
|
|
|
$notices = array();
|
2009-09-25 10:13:46 +09:00
|
|
|
|
|
|
|
if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
|
2009-09-28 07:33:46 +09:00
|
|
|
$notice = $this->user->noticeInbox(
|
|
|
|
($this->page-1) * $this->count,
|
|
|
|
$this->count, $this->since_id,
|
2010-03-03 04:54:02 +09:00
|
|
|
$this->max_id
|
2009-09-28 07:33:46 +09:00
|
|
|
);
|
2009-09-25 10:13:46 +09:00
|
|
|
} else {
|
2009-09-28 07:33:46 +09:00
|
|
|
$notice = $this->user->noticesWithFriends(
|
|
|
|
($this->page-1) * $this->count,
|
|
|
|
$this->count, $this->since_id,
|
2010-03-03 04:54:02 +09:00
|
|
|
$this->max_id
|
2009-09-28 07:33:46 +09:00
|
|
|
);
|
2009-09-25 10:13:46 +09:00
|
|
|
}
|
|
|
|
|
2009-09-26 08:58:35 +09:00
|
|
|
while ($notice->fetch()) {
|
2009-09-25 10:13:46 +09:00
|
|
|
$notices[] = clone($notice);
|
2009-09-24 05:45:51 +09:00
|
|
|
}
|
|
|
|
|
2009-09-26 08:58:35 +09:00
|
|
|
return $notices;
|
2009-09-24 05:45:51 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2009-09-28 07:33:46 +09:00
|
|
|
* Is this action read only?
|
|
|
|
*
|
|
|
|
* @param array $args other arguments
|
2009-09-24 05:45:51 +09:00
|
|
|
*
|
|
|
|
* @return boolean true
|
|
|
|
*/
|
|
|
|
|
|
|
|
function isReadOnly($args)
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2009-09-25 10:13:46 +09:00
|
|
|
* When was this feed last modified?
|
2009-09-24 05:45:51 +09:00
|
|
|
*
|
2009-09-28 07:33:46 +09:00
|
|
|
* @return string datestamp of the latest notice in the stream
|
2009-09-24 05:45:51 +09:00
|
|
|
*/
|
|
|
|
|
|
|
|
function lastModified()
|
|
|
|
{
|
2009-09-28 06:11:12 +09:00
|
|
|
if (!empty($this->notices) && (count($this->notices) > 0)) {
|
|
|
|
return strtotime($this->notices[0]->created);
|
2009-09-25 10:13:46 +09:00
|
|
|
}
|
|
|
|
|
2009-09-28 06:11:12 +09:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2009-09-28 07:33:46 +09:00
|
|
|
* An entity tag for this stream
|
2009-09-28 06:11:12 +09:00
|
|
|
*
|
|
|
|
* Returns an Etag based on the action name, language, user ID, and
|
|
|
|
* timestamps of the first and last notice in the timeline
|
|
|
|
*
|
|
|
|
* @return string etag
|
|
|
|
*/
|
|
|
|
|
|
|
|
function etag()
|
|
|
|
{
|
|
|
|
if (!empty($this->notices) && (count($this->notices) > 0)) {
|
|
|
|
|
|
|
|
$last = count($this->notices) - 1;
|
|
|
|
|
2009-10-01 02:27:54 +09:00
|
|
|
return '"' . implode(
|
2009-09-28 07:33:46 +09:00
|
|
|
':',
|
2009-09-28 06:11:12 +09:00
|
|
|
array($this->arg('action'),
|
|
|
|
common_language(),
|
|
|
|
$this->user->id,
|
|
|
|
strtotime($this->notices[0]->created),
|
2009-09-28 07:33:46 +09:00
|
|
|
strtotime($this->notices[$last]->created))
|
|
|
|
)
|
|
|
|
. '"';
|
2009-09-25 10:13:46 +09:00
|
|
|
}
|
2009-09-24 05:45:51 +09:00
|
|
|
|
2009-09-28 06:11:12 +09:00
|
|
|
return null;
|
2009-09-24 05:45:51 +09:00
|
|
|
}
|
|
|
|
|
2009-09-28 06:11:12 +09:00
|
|
|
}
|