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')) {
41 require_once INSTALLDIR . '/lib/apiprivateauth.php';
44 * Returns the notice specified by id as a Twitter-style status and inline user
48 * @author Craig Andrews <candrews@integralblue.com>
49 * @author Evan Prodromou <evan@status.net>
50 * @author Jeffery To <jeffery.to@gmail.com>
51 * @author Tom Blankenship <mac65@mac65.com>
52 * @author Mike Cochrane <mikec@mikenz.geek.nz>
53 * @author Robin Millette <robin@millette.info>
54 * @author Zach Copley <zach@status.net>
55 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
56 * @link http://status.net/
58 class ApiStatusesShowAction extends ApiPrivateAuthAction
60 var $notice_id = null;
64 * Take arguments for running
66 * @param array $args $_REQUEST args
68 * @return boolean success flag
70 function prepare($args)
72 parent::prepare($args);
74 // 'id' is an undocumented parameter in Twitter's API. Several
75 // clients make use of it, so we support it too.
77 // show.json?id=12345 takes precedence over /show/12345.json
79 $this->notice_id = (int)$this->trimmed('id');
81 if (empty($notice_id)) {
82 $this->notice_id = (int)$this->arg('id');
85 $this->notice = Notice::staticGet((int)$this->notice_id);
93 * Check the format and show the notice
95 * @param array $args $_REQUEST data (unused)
99 function handle($args)
101 parent::handle($args);
103 if (!in_array($this->format, array('xml', 'json', 'atom'))) {
104 // TRANS: Client error displayed when trying to handle an unknown API method.
105 $this->clientError(_('API method not found.'), 404);
109 switch ($_SERVER['REQUEST_METHOD']) {
114 $this->deleteNotice();
117 $this->clientError(_('HTTP method not supported.'), 405);
127 function showNotice()
129 if (!empty($this->notice)) {
130 switch ($this->format) {
132 $this->showSingleXmlStatus($this->notice);
135 $this->show_single_json_status($this->notice);
138 $this->showSingleAtomStatus($this->notice);
141 throw new Exception(sprintf(_("Unsupported format: %s"), $this->format));
144 // XXX: Twitter just sets a 404 header and doens't bother
145 // to return an err msg
147 $deleted = Deleted_notice::staticGet($this->notice_id);
149 if (!empty($deleted)) {
151 // TRANS: Client error displayed requesting a deleted status.
152 _('Status deleted.'),
158 // TRANS: Client error displayed requesting a status with an invalid ID.
159 _('No status with that ID found.'),
168 * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
170 * @param array $args other arguments
172 * @return boolean true
175 function isReadOnly($args)
177 return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
181 * When was this notice last modified?
183 * @return string datestamp of the latest notice in the stream
185 function lastModified()
187 if (!empty($this->notice)) {
188 return strtotime($this->notice->created);
195 * An entity tag for this notice
197 * Returns an Etag based on the action name, language, and
198 * timestamps of the notice
200 * @return string etag
204 if (!empty($this->notice)) {
206 return '"' . implode(
208 array($this->arg('action'),
209 common_user_cache_hash($this->auth_user),
212 strtotime($this->notice->created))
220 function deleteNotice()
222 if ($this->format != 'atom') {
223 $this->clientError(_("Can only delete using the Atom format."));
227 if (empty($this->auth_user) ||
228 ($this->notice->profile_id != $this->auth_user->id &&
229 !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
230 $this->clientError(_('Can\'t delete this notice.'), 403);
234 if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
235 $this->notice->delete();
236 Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
239 // @fixme is there better output we could do here?
241 header('HTTP/1.1 200 OK');
242 header('Content-Type: text/plain');
243 print(sprintf(_('Deleted notice %d'), $this->notice->id));