3 * StatusNet, the distributed open-source microblogging tool
5 * Show notices mentioning a user (@nickname)
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 (default 20) mentions (status containing @nickname)
47 * @author Craig Andrews <candrews@integralblue.com>
48 * @author Evan Prodromou <evan@status.net>
49 * @author Jeffery To <jeffery.to@gmail.com>
50 * @author mac65 <mac65@mac65.com>
51 * @author Mike Cochrane <mikec@mikenz.geek.nz>
52 * @author Robin Millette <robin@millette.info>
53 * @author Zach Copley <zach@status.net>
54 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
55 * @link http://status.net/
58 class ApiTimelineMentionsAction 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);
76 $this->user = $this->getTargetUser($this->arg('id'));
78 if (empty($this->user)) {
79 $this->clientError(_('No such user.'), 404, $this->format);
83 $this->notices = $this->getNotices();
91 * Just show the notices
93 * @param array $args $_REQUEST data (unused)
98 function handle($args)
100 parent::handle($args);
101 $this->showTimeline();
105 * Show the timeline of notices
110 function showTimeline()
112 $profile = $this->user->getProfile();
113 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
115 $sitename = common_config('site', 'name');
117 _('%1$s / Updates mentioning %2$s'),
118 $sitename, $this->user->nickname
120 $taguribase = TagURI::base();
121 $id = "tag:$taguribase:Mentions:" . $this->user->id;
122 $link = common_local_url(
124 array('nickname' => $this->user->nickname)
127 _('%1$s updates that reply to updates from %2$s / %3$s.'),
128 $sitename, $this->user->nickname, $profile->getBestName()
130 $logo = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
132 switch($this->format) {
134 $this->showXmlTimeline($this->notices);
137 $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $logo);
141 $atom = new AtomNoticeFeed();
144 $atom->setTitle($title);
145 $atom->setSubtitle($subtitle);
146 $atom->setLogo($logo);
147 $atom->setUpdated('now');
152 array('nickname' => $this->user->nickname)
156 $id = $this->arg('id');
157 $aargs = array('format' => 'atom');
163 $this->getSelfUri('ApiTimelineMentions', $aargs),
164 array('rel' => 'self', 'type' => 'application/atom+xml')
167 $atom->addEntryFromNotices($this->notices);
168 $this->raw($atom->getString());
172 $this->showJsonTimeline($this->notices);
175 $this->clientError(_('API method not found.'), $code = 404);
183 * @return array notices
186 function getNotices()
190 $notice = $this->user->getReplies(
191 ($this->page - 1) * $this->count, $this->count,
192 $this->since_id, $this->max_id, $this->since
195 while ($notice->fetch()) {
196 $notices[] = clone($notice);
203 * Is this action read only?
205 * @param array $args other arguments
207 * @return boolean true
210 function isReadOnly($args)
216 * When was this feed last modified?
218 * @return string datestamp of the latest notice in the stream
221 function lastModified()
223 if (!empty($this->notices) && (count($this->notices) > 0)) {
224 return strtotime($this->notices[0]->created);
231 * An entity tag for this stream
233 * Returns an Etag based on the action name, language, user ID, and
234 * timestamps of the first and last notice in the timeline
236 * @return string etag
241 if (!empty($this->notices) && (count($this->notices) > 0)) {
243 $last = count($this->notices) - 1;
245 return '"' . implode(
247 array($this->arg('action'),
250 strtotime($this->notices[0]->created),
251 strtotime($this->notices[$last]->created))