3 * StatusNet, the distributed open-source microblogging tool
5 * Show the home timeline
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Jeffery To <jeffery.to@gmail.com>
27 * @author mac65 <mac65@mac65.com>
28 * @author Mike Cochrane <mikec@mikenz.geek.nz>
29 * @author Robin Millette <robin@millette.info>
30 * @author Zach Copley <zach@status.net>
31 * @copyright 2009 StatusNet, Inc.
32 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
33 * @link http://status.net/
36 if (!defined('STATUSNET')) {
40 require_once INSTALLDIR . '/lib/apibareauth.php';
43 * Returns the most recent notices (default 20) posted by the target user.
44 * This is the equivalent of 'You and friends' page accessed via Web.
48 * @author Craig Andrews <candrews@integralblue.com>
49 * @author Evan Prodromou <evan@status.net>
50 * @author Jeffery To <jeffery.to@gmail.com>
51 * @author mac65 <mac65@mac65.com>
52 * @author Mike Cochrane <mikec@mikenz.geek.nz>
53 * @author Robin Millette <robin@millette.info>
54 * @author Zach Copley <zach@status.net>
55 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
56 * @link http://status.net/
59 class ApiTimelineHomeAction extends ApiBareAuthAction
64 * Take arguments for running
66 * @param array $args $_REQUEST args
68 * @return boolean success flag
72 function prepare($args)
74 parent::prepare($args);
75 common_debug("api home_timeline");
76 $this->user = $this->getTargetUser($this->arg('id'));
78 if (empty($this->user)) {
79 $this->clientError(_('No such user.'), 404, $this->format);
83 $this->notices = $this->getNotices();
91 * Just show the notices
93 * @param array $args $_REQUEST data (unused)
98 function handle($args)
100 parent::handle($args);
101 $this->showTimeline();
105 * Show the timeline of notices
110 function showTimeline()
112 $profile = $this->user->getProfile();
113 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
114 $sitename = common_config('site', 'name');
115 $title = sprintf(_("%s and friends"), $this->user->nickname);
116 $taguribase = common_config('integration', 'taguri');
117 $id = "tag:$taguribase:HomeTimeline:" . $this->user->id;
120 _('Updates from %1$s and friends on %2$s!'),
121 $this->user->nickname, $sitename
124 $logo = (!empty($avatar))
125 ? $avatar->displayUrl()
126 : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
128 switch($this->format) {
130 $this->showXmlTimeline($this->notices);
133 $link = common_local_url(
135 array('nickname' => $this->user->nickname)
137 $this->showRssTimeline(
148 header('Content-Type: application/atom+xml; charset=utf-8');
150 $atom = new AtomNoticeFeed();
153 $atom->setTitle($title);
154 $atom->setSubtitle($subtitle);
155 $atom->setLogo($logo);
156 $atom->setUpdated('now');
161 array('nickname' => $this->user->nickname)
165 $id = $this->arg('id');
166 $aargs = array('format' => 'atom');
172 $this->getSelfUri('ApiTimelineHome', $aargs),
173 array('rel' => 'self', 'type' => 'application/atom+xml')
176 $atom->addEntryFromNotices($this->notices);
177 $this->raw($atom->getString());
181 $this->showJsonTimeline($this->notices);
184 $this->clientError(_('API method not found.'), $code = 404);
192 * @return array notices
195 function getNotices()
199 if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
200 $notice = $this->user->noticeInbox(
201 ($this->page-1) * $this->count,
202 $this->count, $this->since_id,
203 $this->max_id, $this->since
206 $notice = $this->user->noticesWithFriends(
207 ($this->page-1) * $this->count,
208 $this->count, $this->since_id,
209 $this->max_id, $this->since
213 while ($notice->fetch()) {
214 $notices[] = clone($notice);
221 * Is this action read only?
223 * @param array $args other arguments
225 * @return boolean true
228 function isReadOnly($args)
234 * When was this feed last modified?
236 * @return string datestamp of the latest notice in the stream
239 function lastModified()
241 if (!empty($this->notices) && (count($this->notices) > 0)) {
242 return strtotime($this->notices[0]->created);
249 * An entity tag for this stream
251 * Returns an Etag based on the action name, language, user ID, and
252 * timestamps of the first and last notice in the timeline
254 * @return string etag
259 if (!empty($this->notices) && (count($this->notices) > 0)) {
261 $last = count($this->notices) - 1;
263 return '"' . implode(
265 array($this->arg('action'),
268 strtotime($this->notices[0]->created),
269 strtotime($this->notices[$last]->created))