3 * StatusNet, the distributed open-source microblogging tool
5 * Show the friends 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 ApiTimelineFriendsAction 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 $this->user = $this->getTargetUser($this->arg('id'));
77 if (empty($this->user)) {
78 $this->clientError(_('No such user.'), 404, $this->format);
82 $this->notices = $this->getNotices();
90 * Just show the notices
92 * @param array $args $_REQUEST data (unused)
97 function handle($args)
99 parent::handle($args);
100 $this->showTimeline();
104 * Show the timeline of notices
109 function showTimeline()
111 $profile = $this->user->getProfile();
112 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
113 $sitename = common_config('site', 'name');
114 $title = sprintf(_("%s and friends"), $this->user->nickname);
115 $taguribase = common_config('integration', 'taguri');
116 $id = "tag:$taguribase:FriendsTimeline:" . $this->user->id;
117 $link = common_local_url(
118 'all', array('nickname' => $this->user->nickname)
121 _('Updates from %1$s and friends on %2$s!'),
122 $this->user->nickname, $sitename
124 $logo = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
126 switch($this->format) {
128 $this->showXmlTimeline($this->notices);
131 $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $logo);
135 $target_id = $this->arg('id');
137 if (isset($target_id)) {
138 $selfuri = common_root_url() .
139 'api/statuses/friends_timeline/' .
140 $target_id . '.atom';
142 $selfuri = common_root_url() .
143 'api/statuses/friends_timeline.atom';
146 $this->showAtomTimeline(
147 $this->notices, $title, $id, $link,
148 $subtitle, null, $selfuri, $logo
152 $this->showJsonTimeline($this->notices);
155 $this->clientError(_('API method not found.'), $code = 404);
163 * @return array notices
166 function getNotices()
170 if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
171 $notice = $this->user->ownFriendsTimeline(($this->page-1) * $this->count,
172 $this->count, $this->since_id,
173 $this->max_id, $this->since);
175 $notice = $this->user->friendsTimeline(($this->page-1) * $this->count,
176 $this->count, $this->since_id,
177 $this->max_id, $this->since);
180 while ($notice->fetch()) {
181 $notices[] = clone($notice);
188 * Is this action read only?
190 * @param array $args other arguments
192 * @return boolean true
195 function isReadOnly($args)
201 * When was this feed last modified?
203 * @return string datestamp of the latest notice in the stream
206 function lastModified()
208 if (!empty($this->notices) && (count($this->notices) > 0)) {
209 return strtotime($this->notices[0]->created);
216 * An entity tag for this stream
218 * Returns an Etag based on the action name, language, user ID, and
219 * timestamps of the first and last notice in the timeline
221 * @return string etag
226 if (!empty($this->notices) && (count($this->notices) > 0)) {
228 $last = count($this->notices) - 1;
230 return '"' . implode(
232 array($this->arg('action'),
235 strtotime($this->notices[0]->created),
236 strtotime($this->notices[$last]->created))