3 * StatusNet, the distributed open-source microblogging tool
5 * Show a user's 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 authenticating
44 * user. Another user's timeline can be requested via the id parameter. This
45 * is the API equivalent of the user profile web page.
49 * @author Craig Andrews <candrews@integralblue.com>
50 * @author Evan Prodromou <evan@status.net>
51 * @author Jeffery To <jeffery.to@gmail.com>
52 * @author mac65 <mac65@mac65.com>
53 * @author Mike Cochrane <mikec@mikenz.geek.nz>
54 * @author Robin Millette <robin@millette.info>
55 * @author Zach Copley <zach@status.net>
56 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
57 * @link http://status.net/
60 class ApiTimelineUserAction extends ApiBareAuthAction
66 * Take arguments for running
68 * @param array $args $_REQUEST args
70 * @return boolean success flag
74 function prepare($args)
76 parent::prepare($args);
78 $this->user = $this->getTargetUser($this->arg('id'));
80 if (empty($this->user)) {
81 $this->clientError(_('No such user.'), 404, $this->format);
85 $this->notices = $this->getNotices();
93 * Just show the notices
95 * @param array $args $_REQUEST data (unused)
100 function handle($args)
102 parent::handle($args);
103 $this->showTimeline();
107 * Show the timeline of notices
112 function showTimeline()
114 $profile = $this->user->getProfile();
116 // We'll use the shared params from the Atom stub
117 // for other feed types.
118 $atom = new AtomUserNoticeFeed($this->user);
120 $link = common_local_url(
122 array('nickname' => $this->user->nickname)
125 $self = $this->getSelfUri();
127 // FriendFeed's SUP protocol
128 // Also added RSS and Atom feeds
130 $suplink = common_local_url('sup', null, null, $this->user->id);
131 header('X-SUP-ID: ' . $suplink);
133 switch($this->format) {
135 $this->showXmlTimeline($this->notices);
138 $this->showRssTimeline(
150 header('Content-Type: application/atom+xml; charset=utf-8');
153 $atom->setSelfLink($self);
154 $atom->addEntryFromNotices($this->notices);
155 $this->raw($atom->getString());
159 $this->showJsonTimeline($this->notices);
162 $this->clientError(_('API method not found.'), $code = 404);
171 * @return array notices
174 function getNotices()
178 $notice = $this->user->getNotices(
179 ($this->page-1) * $this->count, $this->count,
180 $this->since_id, $this->max_id
183 while ($notice->fetch()) {
184 $notices[] = clone($notice);
191 * Is this action read only?
193 * @param array $args other arguments
195 * @return boolean true
198 function isReadOnly($args)
204 * When was this feed last modified?
206 * @return string datestamp of the latest notice in the stream
209 function lastModified()
211 if (!empty($this->notices) && (count($this->notices) > 0)) {
212 return strtotime($this->notices[0]->created);
219 * An entity tag for this stream
221 * Returns an Etag based on the action name, language, user ID, and
222 * timestamps of the first and last notice in the timeline
224 * @return string etag
229 if (!empty($this->notices) && (count($this->notices) > 0)) {
231 $last = count($this->notices) - 1;
233 return '"' . implode(
235 array($this->arg('action'),
238 strtotime($this->notices[0]->created),
239 strtotime($this->notices[$last]->created))