]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apistatusesshow.php
Qvitter API changes (thanks hannes2peer)
[quix0rs-gnu-social.git] / actions / apistatusesshow.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show a notice (as a Twitter-style status)
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  API
23  * @package   StatusNet
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/
35  */
36
37 if (!defined('STATUSNET')) {
38     exit(1);
39 }
40
41 /**
42  * Returns the notice specified by id as a Twitter-style status and inline user
43  *
44  * @category API
45  * @package  StatusNet
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/
55  */
56 class ApiStatusesShowAction extends ApiPrivateAuthAction
57 {
58     var $notice_id = null;
59     var $notice    = null;
60
61     /**
62      * Take arguments for running
63      *
64      * @param array $args $_REQUEST args
65      *
66      * @return boolean success flag
67      */
68     function prepare($args)
69     {
70         parent::prepare($args);
71
72         // 'id' is an undocumented parameter in Twitter's API. Several
73         // clients make use of it, so we support it too.
74
75         // show.json?id=12345 takes precedence over /show/12345.json
76
77         $this->notice_id = (int)$this->trimmed('id');
78
79         if (empty($notice_id)) {
80             $this->notice_id = (int)$this->arg('id');
81         }
82
83         $this->notice = Notice::getKV((int)$this->notice_id);
84
85         return true;
86     }
87
88     /**
89      * Handle the request
90      *
91      * Check the format and show the notice
92      *
93      * @param array $args $_REQUEST data (unused)
94      *
95      * @return void
96      */
97     function handle($args)
98     {
99         parent::handle($args);
100
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);
104             return;
105         }
106
107         switch ($_SERVER['REQUEST_METHOD']) {
108         case 'GET':
109             $this->showNotice();
110             break;
111         case 'DELETE':
112             $this->deleteNotice();
113             break;
114         default:
115             // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
116             $this->clientError(_('HTTP method not supported.'), 405);
117             return;
118         }
119     }
120
121     /**
122      * Show the notice
123      *
124      * @return void
125      */
126     function showNotice()
127     {
128         if (!empty($this->notice)) {
129             switch ($this->format) {
130             case 'xml':
131                 $this->showSingleXmlStatus($this->notice);
132                 break;
133             case 'json':
134                 $this->show_single_json_status($this->notice);
135                 break;
136             case 'atom':
137                 $this->showSingleAtomStatus($this->notice);
138                 break;
139             default:
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));
143             }
144         } else {
145             // XXX: Twitter just sets a 404 header and doens't bother
146             // to return an err msg
147
148             $deleted = Deleted_notice::getKV($this->notice_id);
149
150             if (!empty($deleted)) {
151                 $this->clientError(
152                     // TRANS: Client error displayed requesting a deleted status.
153                     _('Status deleted.'),
154                     410,
155                     $this->format
156                 );
157             } else {
158                 $this->clientError(
159                     // TRANS: Client error displayed requesting a status with an invalid ID.
160                     _('No status with that ID found.'),
161                     404,
162                     $this->format
163                 );
164             }
165         }
166     }
167
168     /**
169      * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
170      *
171      * @param array $args other arguments
172      *
173      * @return boolean true
174      */
175
176     function isReadOnly($args)
177     {
178         return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
179     }
180
181     /**
182      * When was this notice last modified?
183      *
184      * @return string datestamp of the latest notice in the stream
185      */
186     function lastModified()
187     {
188         if (!empty($this->notice)) {
189             return strtotime($this->notice->created);
190         }
191
192         return null;
193     }
194
195     /**
196      * An entity tag for this notice
197      *
198      * Returns an Etag based on the action name, language, and
199      * timestamps of the notice
200      *
201      * @return string etag
202      */
203     function etag()
204     {
205         if (!empty($this->notice)) {
206
207             return '"' . implode(
208                 ':',
209                 array($this->arg('action'),
210                       common_user_cache_hash($this->auth_user),
211                       common_language(),
212                       $this->notice->id,
213                       strtotime($this->notice->created))
214             )
215             . '"';
216         }
217
218         return null;
219     }
220
221     function deleteNotice()
222     {
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.'));
226             return;
227         }
228
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);
234             return;
235         }
236
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));
240         }
241
242         // @fixme is there better output we could do here?
243
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));
248         print("\n");
249     }
250 }