3 * StatusNet, the distributed open-source microblogging tool
5 * Show a user's favorite notices
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 20 most recent favorite notices for the authenticating user or user
38 * specified by the ID parameter in the requested format.
42 * @author Zach Copley <zach@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44 * @link http://status.net/
47 class ApiTimelineFavoritesAction extends ApiBareAuthAction
59 * Take arguments for running
61 * @param array $args $_REQUEST args
63 * @return boolean success flag
67 function prepare($args)
69 parent::prepare($args);
71 $this->page = (int)$this->arg('page', 1);
72 $this->count = (int)$this->arg('count', 20);
73 $this->max_id = (int)$this->arg('max_id', 0);
74 $this->since_id = (int)$this->arg('since_id', 0);
75 $this->since = $this->arg('since');
77 $this->user = $this->getTargetUser($this->arg('id'));
79 if (empty($this->user)) {
80 $this->clientError(_('No such user!'), 404, $this->format);
84 $this->notices = $this->getNotices();
92 * Just show the notices
94 * @param array $args $_REQUEST data (unused)
99 function handle($args)
101 parent::handle($args);
102 $this->showTimeline();
106 * Show the timeline of notices
111 function showTimeline()
113 $profile = $this->user->getProfile();
115 $sitename = common_config('site', 'name');
117 _('%s / Favorites from %s'),
119 $this->user->nickname
122 $taguribase = common_config('integration', 'taguri');
123 $id = "tag:$taguribase:Favorites:" . $this->user->id;
124 $link = common_local_url(
126 array('nickname' => $this->user->nickname)
129 _('%s updates favorited by %s / %s.'),
131 $profile->getBestName(),
132 $this->user->nickname
135 switch($this->format) {
137 $this->show_xml_timeline($this->notices);
140 $this->show_rss_timeline($this->notices, $title, $link, $subtitle);
143 $selfuri = common_root_url() .
144 ltrim($_SERVER['QUERY_STRING'], 'p=');
145 $this->show_atom_timeline(
146 $this->notices, $title, $id, $link, $subtitle,
151 $this->show_json_timeline($this->notices);
154 $this->clientError(_('API method not found!'), $code = 404);
162 * @return array notices
165 function getNotices()
169 if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
170 $notice = $this->user->favoriteNotices(
171 ($this->page-1) * $this->count,
176 $notice = $this->user->favoriteNotices(
177 ($this->page-1) * $this->count,
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))