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 Zach Copley <zach@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR.'/lib/apibareauth.php';
37 * Returns the most recent notices (default 20) posted by the authenticating
38 * user. Another user's timeline can be requested via the id parameter. This
39 * is the API equivalent of the user profile web page.
43 * @author Zach Copley <zach@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
48 class ApiTimelineUserAction extends ApiBareAuthAction
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
63 function prepare($args)
65 parent::prepare($args);
67 $this->user = $this->getTargetUser($this->arg('id'));
69 if (empty($this->user)) {
70 $this->clientError(_('No such user!'), 404, $this->format);
74 $this->notices = $this->getNotices();
82 * Just show the notices
84 * @param array $args $_REQUEST data (unused)
89 function handle($args)
91 parent::handle($args);
92 $this->showTimeline();
96 * Show the timeline of notices
101 function showTimeline()
103 $profile = $this->user->getProfile();
105 $sitename = common_config('site', 'name');
106 $title = sprintf(_("%s timeline"), $this->user->nickname);
107 $taguribase = common_config('integration', 'taguri');
108 $id = "tag:$taguribase:UserTimeline:" . $this->user->id;
109 $link = common_local_url(
111 array('nickname' => $this->user->nickname)
114 _('Updates from %1$s on %2$s!'),
115 $this->user->nickname, $sitename
118 // FriendFeed's SUP protocol
119 // Also added RSS and Atom feeds
121 $suplink = common_local_url('sup', null, null, $this->user->id);
122 header('X-SUP-ID: ' . $suplink);
124 switch($this->format) {
126 $this->show_xml_timeline($this->notices);
129 $this->show_rss_timeline(
130 $this->notices, $title, $link,
135 if (isset($apidata['api_arg'])) {
136 $selfuri = common_root_url() .
137 'api/statuses/user_timeline/' .
138 $apidata['api_arg'] . '.atom';
140 $selfuri = common_root_url() .
141 'api/statuses/user_timeline.atom';
143 $this->show_atom_timeline(
144 $this->notices, $title, $id, $link,
145 $subtitle, $suplink, $selfuri
149 $this->show_json_timeline($this->notices);
152 $this->clientError(_('API method not found!'), $code = 404);
161 * @return array notices
164 function getNotices()
168 $notice = $this->user->getNotices(
169 ($this->page-1) * $this->count, $this->count,
170 $this->since_id, $this->max_id, $this->since
173 while ($notice->fetch()) {
174 $notices[] = clone($notice);
181 * Is this action read only?
183 * @param array $args other arguments
185 * @return boolean true
188 function isReadOnly($args)
194 * When was this feed last modified?
196 * @return string datestamp of the latest notice in the stream
199 function lastModified()
201 if (!empty($this->notices) && (count($this->notices) > 0)) {
202 return strtotime($this->notices[0]->created);
209 * An entity tag for this stream
211 * Returns an Etag based on the action name, language, user ID, and
212 * timestamps of the first and last notice in the timeline
214 * @return string etag
219 if (!empty($this->notices) && (count($this->notices) > 0)) {
221 $last = count($this->notices) - 1;
223 return '"' . implode(
225 array($this->arg('action'),
228 strtotime($this->notices[0]->created),
229 strtotime($this->notices[$last]->created))