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 Craig Andrews <candrews@integralblue.com>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Zach Copley <zach@status.net>
27 * @copyright 2009-2010 StatusNet, Inc.
28 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29 * @link http://status.net/
32 if (!defined('STATUSNET')) {
36 require_once INSTALLDIR.'/lib/apibareauth.php';
39 * Returns the 20 most recent favorite notices for the authenticating user or user
40 * specified by the ID parameter in the requested format.
44 * @author Craig Andrews <candrews@integralblue.com>
45 * @author Evan Prodromou <evan@status.net>
46 * @author Zach Copley <zach@status.net>
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
51 class ApiTimelineFavoritesAction extends ApiBareAuthAction
56 * Take arguments for running
58 * @param array $args $_REQUEST args
60 * @return boolean success flag
64 function prepare($args)
66 parent::prepare($args);
68 $this->user = $this->getTargetUser($this->arg('id'));
70 if (empty($this->user)) {
71 $this->clientError(_('No such user.'), 404, $this->format);
75 $this->notices = $this->getNotices();
83 * Just show the notices
85 * @param array $args $_REQUEST data (unused)
90 function handle($args)
92 parent::handle($args);
93 $this->showTimeline();
97 * Show the timeline of notices
102 function showTimeline()
104 $profile = $this->user->getProfile();
105 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
107 $sitename = common_config('site', 'name');
109 _('%1$s / Favorites from %2$s'),
111 $this->user->nickname
114 $taguribase = TagURI::base();
115 $id = "tag:$taguribase:Favorites:" . $this->user->id;
118 _('%1$s updates favorited by %2$s / %2$s.'),
120 $profile->getBestName(),
121 $this->user->nickname
123 $logo = !empty($avatar)
124 ? $avatar->displayUrl()
125 : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
127 $link = common_local_url(
129 array('nickname' => $this->user->nickname)
132 $self = $this->getSelfUri();
134 switch($this->format) {
136 $this->showXmlTimeline($this->notices);
139 $this->showRssTimeline(
151 header('Content-Type: application/atom+xml; charset=utf-8');
153 $atom = new AtomNoticeFeed();
156 $atom->setTitle($title);
157 $atom->setSubtitle($subtitle);
158 $atom->setLogo($logo);
159 $atom->setUpdated('now');
161 $atom->addLink($link);
162 $atom->setSelfLink($self);
164 $atom->addEntryFromNotices($this->notices);
166 $this->raw($atom->getString());
170 $this->showJsonTimeline($this->notices);
173 $this->clientError(_('API method not found.'), $code = 404);
181 * @return array notices
184 function getNotices()
188 if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
189 $notice = $this->user->favoriteNotices(
190 ($this->page-1) * $this->count,
195 $notice = $this->user->favoriteNotices(
196 ($this->page-1) * $this->count,
202 while ($notice->fetch()) {
203 $notices[] = clone($notice);
210 * Is this action read only?
212 * @param array $args other arguments
214 * @return boolean true
217 function isReadOnly($args)
223 * When was this feed last modified?
225 * @return string datestamp of the latest notice in the stream
228 function lastModified()
230 if (!empty($this->notices) && (count($this->notices) > 0)) {
231 return strtotime($this->notices[0]->created);
238 * An entity tag for this stream
240 * Returns an Etag based on the action name, language, user ID, and
241 * timestamps of the first and last notice in the timeline
243 * @return string etag
248 if (!empty($this->notices) && (count($this->notices) > 0)) {
250 $last = count($this->notices) - 1;
252 return '"' . implode(
254 array($this->arg('action'),
257 strtotime($this->notices[0]->created),
258 strtotime($this->notices[$last]->created))