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/
59 class ApiStatusesShowAction extends ApiPrivateAuthAction
62 var $notice_id = null;
66 * Take arguments for running
68 * @param array $args $_REQUEST args
70 * @return boolean success flag
74 function prepare($args)
76 parent::prepare($args);
78 // 'id' is an undocumented parameter in Twitter's API. Several
79 // clients make use of it, so we support it too.
81 // show.json?id=12345 takes precedence over /show/12345.json
83 $this->notice_id = (int)$this->trimmed('id');
85 if (empty($notice_id)) {
86 $this->notice_id = (int)$this->arg('id');
89 $this->notice = Notice::staticGet((int)$this->notice_id);
97 * Check the format and show the notice
99 * @param array $args $_REQUEST data (unused)
104 function handle($args)
106 parent::handle($args);
108 if (!in_array($this->format, array('xml', 'json'))) {
109 $this->clientError(_('API method not found.'), $code = 404);
122 function showNotice()
124 if (!empty($this->notice)) {
125 if ($this->format == 'xml') {
126 $this->showSingleXmlStatus($this->notice);
127 } elseif ($this->format == 'json') {
128 $this->show_single_json_status($this->notice);
132 // XXX: Twitter just sets a 404 header and doens't bother
133 // to return an err msg
135 $deleted = Deleted_notice::staticGet($this->notice_id);
137 if (!empty($deleted)) {
139 _('Status deleted.'),
145 _('No status with that ID found.'),
154 * Is this action read only?
156 * @param array $args other arguments
158 * @return boolean true
161 function isReadOnly($args)
167 * When was this notice last modified?
169 * @return string datestamp of the latest notice in the stream
172 function lastModified()
174 if (!empty($this->notice)) {
175 return strtotime($this->notice->created);
182 * An entity tag for this notice
184 * Returns an Etag based on the action name, language, and
185 * timestamps of the notice
187 * @return string etag
192 if (!empty($this->notice)) {
194 return '"' . implode(
196 array($this->arg('action'),
199 strtotime($this->notice->created))