3 * StatusNet, the distributed open-source microblogging tool
5 * Show a notice (as a Twitter-style status)
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 Tom Blankenship <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 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
33 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
34 * @link http://status.net/
37 if (!defined('STATUSNET')) {
42 * Returns the notice specified by id as a Twitter-style status and inline user
46 * @author Craig Andrews <candrews@integralblue.com>
47 * @author Evan Prodromou <evan@status.net>
48 * @author Jeffery To <jeffery.to@gmail.com>
49 * @author Tom Blankenship <mac65@mac65.com>
50 * @author Mike Cochrane <mikec@mikenz.geek.nz>
51 * @author Robin Millette <robin@millette.info>
52 * @author Zach Copley <zach@status.net>
53 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
54 * @link http://status.net/
56 class ApiStatusesShowAction extends ApiPrivateAuthAction
58 var $notice_id = null;
62 * Take arguments for running
64 * @param array $args $_REQUEST args
66 * @return boolean success flag
68 function prepare($args)
70 parent::prepare($args);
72 // 'id' is an undocumented parameter in Twitter's API. Several
73 // clients make use of it, so we support it too.
75 // show.json?id=12345 takes precedence over /show/12345.json
77 $this->notice_id = (int)$this->trimmed('id');
79 if (empty($notice_id)) {
80 $this->notice_id = (int)$this->arg('id');
83 $this->notice = Notice::getKV((int)$this->notice_id);
91 * Check the format and show the notice
93 * @param array $args $_REQUEST data (unused)
97 function handle($args)
99 parent::handle($args);
101 if (!in_array($this->format, array('xml', 'json', 'atom'))) {
102 // TRANS: Client error displayed when coming across a non-supported API method.
103 $this->clientError(_('API method not found.'), 404);
107 switch ($_SERVER['REQUEST_METHOD']) {
112 $this->deleteNotice();
115 // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
116 $this->clientError(_('HTTP method not supported.'), 405);
126 function showNotice()
128 if (!empty($this->notice)) {
129 switch ($this->format) {
131 $this->showSingleXmlStatus($this->notice);
134 $this->show_single_json_status($this->notice);
137 $this->showSingleAtomStatus($this->notice);
140 // TRANS: Exception thrown requesting an unsupported notice output format.
141 // TRANS: %s is the requested output format.
142 throw new Exception(sprintf(_("Unsupported format: %s."), $this->format));
145 // XXX: Twitter just sets a 404 header and doens't bother
146 // to return an err msg
148 $deleted = Deleted_notice::getKV($this->notice_id);
150 if (!empty($deleted)) {
152 // TRANS: Client error displayed requesting a deleted status.
153 _('Status deleted.'),
159 // TRANS: Client error displayed requesting a status with an invalid ID.
160 _('No status with that ID found.'),
169 * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
171 * @param array $args other arguments
173 * @return boolean true
176 function isReadOnly($args)
178 return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
182 * When was this notice last modified?
184 * @return string datestamp of the latest notice in the stream
186 function lastModified()
188 if (!empty($this->notice)) {
189 return strtotime($this->notice->created);
196 * An entity tag for this notice
198 * Returns an Etag based on the action name, language, and
199 * timestamps of the notice
201 * @return string etag
205 if (!empty($this->notice)) {
207 return '"' . implode(
209 array($this->arg('action'),
210 common_user_cache_hash($this->auth_user),
213 strtotime($this->notice->created))
221 function deleteNotice()
223 if ($this->format != 'atom') {
224 // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
225 $this->clientError(_('Can only delete using the Atom format.'));
229 if (empty($this->auth_user) ||
230 ($this->notice->profile_id != $this->auth_user->id &&
231 !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
232 // TRANS: Client error displayed when a user has no rights to delete notices of other users.
233 $this->clientError(_('Cannot delete this notice.'), 403);
237 if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
238 $this->notice->delete();
239 Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
242 // @fixme is there better output we could do here?
244 header('HTTP/1.1 200 OK');
245 header('Content-Type: text/plain');
246 // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
247 print(sprintf(_('Deleted notice %d'), $this->notice->id));