]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apimediaupload.php
Merge branch 'nightly' of gitorious.org:social/mainline into nightly
[quix0rs-gnu-social.git] / actions / apimediaupload.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Upload an image via the API
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  * @author    Zach Copley <zach@status.net>
24  * @copyright 2010 StatusNet, Inc.
25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
26  * @link      http://status.net/
27  */
28
29 if (!defined('GNUSOCIAL')) { exit(1); }
30
31 /**
32  * Upload an image via the API.  Returns a shortened URL for the image
33  * to the user.
34  *
35  * @category API
36  * @package  StatusNet
37  * @author   Zach Copley <zach@status.net>
38  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
39  * @link     http://status.net/
40  */
41 class ApiMediaUploadAction extends ApiAuthAction
42 {
43     protected $needPost = true;
44
45     /**
46      * Handle the request
47      *
48      * Grab the file from the 'media' param, then store, and shorten
49      *
50      * @todo Upload throttle!
51      * @return void
52      */
53     protected function handle()
54     {
55         parent::handle($args);
56
57         // Workaround for PHP returning empty $_POST and $_FILES when POST
58         // length > post_max_size in php.ini
59
60         if (empty($_FILES)
61             && empty($_POST)
62             && ($_SERVER['CONTENT_LENGTH'] > 0)
63         ) {
64             // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
65             // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
66             $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
67                       'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
68                       intval($_SERVER['CONTENT_LENGTH']));
69             $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
70         }
71
72         // we could catch "NoUploadedMediaException" as "no media uploaded", but here we _always_ want an upload
73         $upload = MediaFile::fromUpload('media', $this->scoped);
74         
75         // Thumbnails will be generated/cached on demand when accessed (such as with /attachment/:id/thumbnail)
76
77         $this->showResponse($upload);
78     }
79
80     /**
81      * Show a Twitpic-like response with the ID of the media file
82      * and a (hopefully) shortened URL for it.
83      *
84      * @param MediaFile $upload  the uploaded file
85      *
86      * @return void
87      */
88     function showResponse(MediaFile $upload)
89     {
90         $this->initDocument();
91         $this->elementStart('rsp', array('stat' => 'ok'));
92         $this->element('mediaid', null, $upload->fileRecord->id);
93         $this->element('mediaurl', null, $upload->shortUrl());
94         $this->elementEnd('rsp');
95         $this->endDocument();
96     }
97
98     /**
99      * Overrided clientError to show a more Twitpic-like error
100      *
101      * @param String $msg an error message
102      */
103     function clientError($msg)
104     {
105         $this->initDocument();
106         $this->elementStart('rsp', array('stat' => 'fail'));
107
108         // @todo add in error code
109         $errAttr = array('msg' => $msg);
110
111         $this->element('err', $errAttr, null);
112         $this->elementEnd('rsp');
113         $this->endDocument();
114     }
115 }