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