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('GNUSOCIAL')) { exit(1); }
40 * Returns the notice specified by id as a Twitter-style status and inline user
44 * @author Craig Andrews <candrews@integralblue.com>
45 * @author Evan Prodromou <evan@status.net>
46 * @author Jeffery To <jeffery.to@gmail.com>
47 * @author Tom Blankenship <mac65@mac65.com>
48 * @author Mike Cochrane <mikec@mikenz.geek.nz>
49 * @author Robin Millette <robin@millette.info>
50 * @author Zach Copley <zach@status.net>
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52 * @link http://status.net/
54 class ApiStatusesShowAction extends ApiPrivateAuthAction
56 var $notice_id = null;
60 * Take arguments for running
62 * @param array $args $_REQUEST args
64 * @return boolean success flag
66 protected function prepare(array $args=array())
68 parent::prepare($args);
70 // 'id' is an undocumented parameter in Twitter's API. Several
71 // clients make use of it, so we support it too.
73 // show.json?id=12345 takes precedence over /show/12345.json
75 $this->notice_id = (int)$this->trimmed('id');
77 $this->notice = Notice::getKV($this->notice_id);
78 if (!$this->notice->inScope($this->scoped)) {
79 // TRANS: Client exception thrown when trying a view a notice the user has no access to.
80 throw new ClientException(_('Access restricted.'), 403);
89 * Check the format and show the notice
93 protected function handle()
97 if (!in_array($this->format, array('xml', 'json', 'atom'))) {
98 // TRANS: Client error displayed when coming across a non-supported API method.
99 $this->clientError(_('API method not found.'), 404);
102 switch ($_SERVER['REQUEST_METHOD']) {
107 $this->deleteNotice();
110 // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
111 $this->clientError(_('HTTP method not supported.'), 405);
120 function showNotice()
122 if (!empty($this->notice)) {
123 switch ($this->format) {
125 $this->showSingleXmlStatus($this->notice);
128 $this->show_single_json_status($this->notice);
131 $this->showSingleAtomStatus($this->notice);
134 // TRANS: Exception thrown requesting an unsupported notice output format.
135 // TRANS: %s is the requested output format.
136 throw new Exception(sprintf(_("Unsupported format: %s."), $this->format));
139 // XXX: Twitter just sets a 404 header and doens't bother
140 // to return an err msg
142 $deleted = Deleted_notice::getKV($this->notice_id);
144 if (!empty($deleted)) {
146 // TRANS: Client error displayed requesting a deleted status.
147 _('Status deleted.'),
153 // TRANS: Client error displayed requesting a status with an invalid ID.
154 _('No status with that ID found.'),
163 * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
165 * @param array $args other arguments
167 * @return boolean true
170 function isReadOnly($args)
172 return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
176 * When was this notice last modified?
178 * @return string datestamp of the latest notice in the stream
180 function lastModified()
182 if (!empty($this->notice)) {
183 return strtotime($this->notice->created);
190 * An entity tag for this notice
192 * Returns an Etag based on the action name, language, and
193 * timestamps of the notice
195 * @return string etag
199 if (!empty($this->notice)) {
201 return '"' . implode(
203 array($this->arg('action'),
204 common_user_cache_hash($this->auth_user),
207 strtotime($this->notice->created))
215 function deleteNotice()
217 if ($this->format != 'atom') {
218 // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
219 $this->clientError(_('Can only delete using the Atom format.'));
222 if (empty($this->auth_user) ||
223 ($this->notice->profile_id != $this->auth_user->id &&
224 !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
225 // TRANS: Client error displayed when a user has no rights to delete notices of other users.
226 $this->clientError(_('Cannot delete this notice.'), 403);
229 if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
230 $this->notice->delete();
231 Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
234 // @fixme is there better output we could do here?
236 header('HTTP/1.1 200 OK');
237 header('Content-Type: text/plain');
238 // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
239 print(sprintf(_('Deleted notice %d'), $this->notice->id));