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('STATUSNET')) {
  30     exit(1);
  31 }
  32
  33 /**
  34  * Upload an image via the API.  Returns a shortened URL for the image
  35  * to the user.
  36  *
  37  * @category API
  38  * @package  StatusNet
  39  * @author   Zach Copley <zach@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43 class ApiMediaUploadAction extends ApiAuthAction
  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      *
  52      * @param array $args $_REQUEST data (unused)
  53      *
  54      * @return void
  55      */
  56     function handle($args)
  57     {
  58         parent::handle($args);
  59
  60         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  61             $this->clientError(
  62                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  63                 _('This method requires a POST.'),
  64                 400, $this->format
  65             );
  66             return;
  67         }
  68
  69         // Workaround for PHP returning empty $_POST and $_FILES when POST
  70         // length > post_max_size in php.ini
  71
  72         if (empty($_FILES)
  73             && empty($_POST)
  74             && ($_SERVER['CONTENT_LENGTH'] > 0)
  75         ) {
  76             // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
  77             // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
  78             $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
  79                       'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
  80                       intval($_SERVER['CONTENT_LENGTH']));
  81             $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
  82             return;
  83         }
  84
  85         $upload = null;
  86
  87         try {
  88             $upload = MediaFile::fromUpload('media', $this->auth_user);
  89         } catch (Exception $e) {
  90             $this->clientError($e->getMessage(), $e->getCode());
  91             return;
  92         }
  93
  94         if (isset($upload)) {
  95             $this->showResponse($upload);
  96         } else {
  97             // TRANS: Client error displayed when uploading a media file has failed.
  98             $this->clientError(_('Upload failed.'));
  99             return;
 100         }
 101     }
 102
 103     /**
 104      * Show a Twitpic-like response with the ID of the media file
 105      * and a (hopefully) shortened URL for it.
 106      *
 107      * @param File $upload  the uploaded file
 108      *
 109      * @return void
 110      */
 111     function showResponse($upload)
 112     {
 113         $this->initDocument();
 114         $this->elementStart('rsp', array('stat' => 'ok'));
 115         $this->element('mediaid', null, $upload->fileRecord->id);
 116         $this->element('mediaurl', null, $upload->shortUrl());
 117         $this->elementEnd('rsp');
 118         $this->endDocument();
 119     }
 120
 121     /**
 122      * Overrided clientError to show a more Twitpic-like error
 123      *
 124      * @param String $msg an error message
 125      */
 126     function clientError($msg)
 127     {
 128         $this->initDocument();
 129         $this->elementStart('rsp', array('stat' => 'fail'));
 130
 131         // @todo add in error code
 132         $errAttr = array('msg' => $msg);
 133
 134         $this->element('err', $errAttr, null);
 135         $this->elementEnd('rsp');
 136         $this->endDocument();
 137     }
 138 }