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> * @copyright 2009 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
35 require_once INSTALLDIR.'/lib/apibareauth.php';
38 * Returns the 20 most recent favorite notices for the authenticating user or user
39 * specified by the ID parameter in the requested format.
43 * @author Craig Andrews <candrews@integralblue.com>
44 * @author Evan Prodromou <evan@status.net>
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
50 class ApiTimelineFavoritesAction 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();
104 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
106 $sitename = common_config('site', 'name');
108 _('%1$s / Favorites from %2$s'),
110 $this->user->nickname
113 $taguribase = TagURI::base();
114 $id = "tag:$taguribase:Favorites:" . $this->user->id;
117 _('%1$s updates favorited by %2$s / %2$s.'),
119 $profile->getBestName(),
120 $this->user->nickname
122 $logo = !empty($avatar)
123 ? $avatar->displayUrl()
124 : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
126 switch($this->format) {
128 $this->showXmlTimeline($this->notices);
131 $link = common_local_url(
133 array('nickname' => $this->user->nickname)
135 $this->showRssTimeline(
146 header('Content-Type: application/atom+xml; charset=utf-8');
148 $atom = new AtomNoticeFeed();
151 $atom->setTitle($title);
152 $atom->setSubtitle($subtitle);
153 $atom->setLogo($logo);
154 $atom->setUpdated('now');
159 array('nickname' => $this->user->nickname)
163 $id = $this->arg('id');
164 $aargs = array('format' => 'atom');
170 $this->getSelfUri('ApiTimelineFavorites', $aargs),
171 array('rel' => 'self', 'type' => 'application/atom+xml')
174 $atom->addEntryFromNotices($this->notices);
176 $this->raw($atom->getString());
180 $this->showJsonTimeline($this->notices);
183 $this->clientError(_('API method not found.'), $code = 404);
191 * @return array notices
194 function getNotices()
198 if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
199 $notice = $this->user->favoriteNotices(
200 ($this->page-1) * $this->count,
205 $notice = $this->user->favoriteNotices(
206 ($this->page-1) * $this->count,
212 while ($notice->fetch()) {
213 $notices[] = clone($notice);
220 * Is this action read only?
222 * @param array $args other arguments
224 * @return boolean true
227 function isReadOnly($args)
233 * When was this feed last modified?
235 * @return string datestamp of the latest notice in the stream
238 function lastModified()
240 if (!empty($this->notices) && (count($this->notices) > 0)) {
241 return strtotime($this->notices[0]->created);
248 * An entity tag for this stream
250 * Returns an Etag based on the action name, language, user ID, and
251 * timestamps of the first and last notice in the timeline
253 * @return string etag
258 if (!empty($this->notices) && (count($this->notices) > 0)) {
260 $last = count($this->notices) - 1;
262 return '"' . implode(
264 array($this->arg('action'),
267 strtotime($this->notices[0]->created),
268 strtotime($this->notices[$last]->created))