]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apistatusesshow.php
Give NoticeListItem its own class
[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 require_once INSTALLDIR . '/lib/apiprivateauth.php';
42
43 /**
44  * Returns the notice specified by id as a Twitter-style status and inline user
45  *
46  * @category API
47  * @package  StatusNet
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/
57  */
58 class ApiStatusesShowAction extends ApiPrivateAuthAction
59 {
60     var $notice_id = null;
61     var $notice    = null;
62
63     /**
64      * Take arguments for running
65      *
66      * @param array $args $_REQUEST args
67      *
68      * @return boolean success flag
69      */
70     function prepare($args)
71     {
72         parent::prepare($args);
73
74         // 'id' is an undocumented parameter in Twitter's API. Several
75         // clients make use of it, so we support it too.
76
77         // show.json?id=12345 takes precedence over /show/12345.json
78
79         $this->notice_id = (int)$this->trimmed('id');
80
81         if (empty($notice_id)) {
82             $this->notice_id = (int)$this->arg('id');
83         }
84
85         $this->notice = Notice::staticGet((int)$this->notice_id);
86
87         return true;
88     }
89
90     /**
91      * Handle the request
92      *
93      * Check the format and show the notice
94      *
95      * @param array $args $_REQUEST data (unused)
96      *
97      * @return void
98      */
99     function handle($args)
100     {
101         parent::handle($args);
102
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);
106             return;
107         }
108
109         switch ($_SERVER['REQUEST_METHOD']) {
110         case 'GET':
111             $this->showNotice();
112             break;
113         case 'DELETE':
114             $this->deleteNotice();
115             break;
116         default:
117             // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
118             $this->clientError(_('HTTP method not supported.'), 405);
119             return;
120         }
121     }
122
123     /**
124      * Show the notice
125      *
126      * @return void
127      */
128     function showNotice()
129     {
130         if (!empty($this->notice)) {
131             switch ($this->format) {
132             case 'xml':
133                 $this->showSingleXmlStatus($this->notice);
134                 break;
135             case 'json':
136                 $this->show_single_json_status($this->notice);
137                 break;
138             case 'atom':
139                 $this->showSingleAtomStatus($this->notice);
140                 break;
141             default:
142                 // TRANS: Exception thrown requesting an unsupported notice output format.
143                 // TRANS: %s is the requested output format.
144                 throw new Exception(sprintf(_("Unsupported format: %s."), $this->format));
145             }
146         } else {
147             // XXX: Twitter just sets a 404 header and doens't bother
148             // to return an err msg
149
150             $deleted = Deleted_notice::staticGet($this->notice_id);
151
152             if (!empty($deleted)) {
153                 $this->clientError(
154                     // TRANS: Client error displayed requesting a deleted status.
155                     _('Status deleted.'),
156                     410,
157                     $this->format
158                 );
159             } else {
160                 $this->clientError(
161                     // TRANS: Client error displayed requesting a status with an invalid ID.
162                     _('No status with that ID found.'),
163                     404,
164                     $this->format
165                 );
166             }
167         }
168     }
169
170     /**
171      * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
172      *
173      * @param array $args other arguments
174      *
175      * @return boolean true
176      */
177
178     function isReadOnly($args)
179     {
180         return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
181     }
182
183     /**
184      * When was this notice last modified?
185      *
186      * @return string datestamp of the latest notice in the stream
187      */
188     function lastModified()
189     {
190         if (!empty($this->notice)) {
191             return strtotime($this->notice->created);
192         }
193
194         return null;
195     }
196
197     /**
198      * An entity tag for this notice
199      *
200      * Returns an Etag based on the action name, language, and
201      * timestamps of the notice
202      *
203      * @return string etag
204      */
205     function etag()
206     {
207         if (!empty($this->notice)) {
208
209             return '"' . implode(
210                 ':',
211                 array($this->arg('action'),
212                       common_user_cache_hash($this->auth_user),
213                       common_language(),
214                       $this->notice->id,
215                       strtotime($this->notice->created))
216             )
217             . '"';
218         }
219
220         return null;
221     }
222
223     function deleteNotice()
224     {
225         if ($this->format != 'atom') {
226             // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
227             $this->clientError(_('Can only delete using the Atom format.'));
228             return;
229         }
230
231         if (empty($this->auth_user) ||
232             ($this->notice->profile_id != $this->auth_user->id &&
233              !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
234             // TRANS: Client error displayed when a user has no rights to delete notices of other users.
235             $this->clientError(_('Cannot delete this notice.'), 403);
236             return;
237         }
238
239         if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
240             $this->notice->delete();
241             Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
242         }
243
244         // @fixme is there better output we could do here?
245
246         header('HTTP/1.1 200 OK');
247         header('Content-Type: text/plain');
248         // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
249         print(sprintf(_('Deleted notice %d'), $this->notice->id));
250         print("\n");
251     }
252 }