lib/managedaction.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for all actions with automatic showPage() call in handle()
   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  Action
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 class ManagedAction extends Action
  34 {
  35     protected function prepare(array $args=array())
  36     {
  37         if (!parent::prepare($args)) {
  38             return false;
  39         }
  40         $this->doPreparation();
  41         return true;
  42     }
  43
  44     protected function doPreparation()
  45     {
  46         // pass by default
  47     }
  48
  49     /**
  50      * Handler method
  51      */
  52     protected function handle()
  53     {
  54         parent::handle();
  55
  56         if ($this->canPost && $this->isPost()) {
  57             try {
  58                 $this->msg = $this->handlePost();
  59             } catch (Exception $e) {
  60                 $this->error = $e->getMessage();
  61             }
  62         }
  63
  64         $this->showPage();
  65     }
  66
  67     /**
  68      * If this is extended in child classes, they should
  69      * end with 'return parent::handlePost();' - and they
  70      * should only extend this function if what they do
  71      * cannot be handled in ->doPost()
  72      */
  73     protected function handlePost()
  74     {
  75         // This will only be run if the Action has the property canPost==true
  76         assert($this->canPost);
  77
  78         // check for this before token since all POST and FILES data
  79         // is losts when size is exceeded
  80         if (empty($_POST) && $_SERVER['CONTENT_LENGTH']>0) {
  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 MiB) due to its current configuration.',
  84                       'The server was unable to handle that much POST data (%s MiB) due to its current configuration.',
  85                       round($_SERVER['CONTENT_LENGTH']/1024/1024,2));
  86             throw new ClientException($msg);
  87         }
  88
  89         $this->checkSessionToken();
  90         return $this->doPost();
  91     }
  92
  93     /**
  94      * Do Post stuff. Return a string if successful,
  95      * describing what has been done. Always throw an
  96      * exception on failure, with a descriptive message.
  97      */
  98     protected function doPost() {
  99         return false;
 100     }
 101 }