lib/formaction.php

   1 <?php
   2 /**
   3  * Form action extendable class.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2008, 2009, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Form action extendable class
  36  *
  37  * @category Action
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @author   Mikael Nordfeldth <evan@status.net>
  41  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  42  * @link     http://status.net/
  43  */
  44 class FormAction extends Action
  45 {
  46     protected $form = null;
  47     protected $type = null;
  48     protected $needLogin = true;
  49
  50     protected function prepare(array $args=array()) {
  51         parent::prepare($args);
  52
  53         $this->form = $this->form ?: $this->action;
  54         $this->args['form'] = $this->form;
  55
  56         $this->type = !is_null($this->type) ? $this->type : $this->trimmed('type');
  57         $this->args['context'] = $this->trimmed('action');  // reply for notice for example
  58
  59         if (!$this->type) {
  60             $this->type = null;
  61         }
  62
  63         return true;
  64     }
  65
  66     protected function handle()
  67     {
  68         parent::handle();
  69
  70         if ($this->isPost()) {
  71             try {
  72                 $msg = $this->handlePost();
  73                 $this->showForm($msg, true);
  74             } catch (Exception $e) {
  75                 $this->showForm($e->getMessage());
  76             }
  77         } else {
  78             $this->showForm();
  79         }
  80     }
  81
  82     public function isReadOnly($args) {
  83         return !$this->isPost();
  84     }
  85
  86     public function showPageNotice()
  87     {
  88         $this->showInstructions();
  89         if ($msg = $this->getError()) {
  90             $this->element('div', 'error', $msg);
  91         }
  92         if ($msg = $this->getInfo()) {
  93             $this->element('div', 'info', $msg);
  94         }
  95     }
  96
  97     /**
  98      * Outputs the instructions for the form
  99      *
 100      * SHOULD overload
 101      */
 102     public function showInstructions()
 103     {
 104         // instructions are nice, so users know what to do
 105     }
 106
 107     public function showForm($msg=null, $success=false)
 108     {
 109         if ($success) {
 110             $this->msg = $msg;
 111         } else {
 112             $this->error = $msg;
 113         }
 114         $this->showPage();
 115     }
 116
 117     /**
 118      * Gets called from handle() if isPost() is true;
 119      * @return void
 120      */
 121     protected function handlePost()
 122     {
 123         // check for this before token since all POST and FILES data
 124         // is losts when size is exceeded
 125         if (empty($_POST) && $_SERVER['CONTENT_LENGTH']>0) {
 126             // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
 127             // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
 128             $msg = _m('The server was unable to handle that much POST data (%s MiB) due to its current configuration.',
 129                       'The server was unable to handle that much POST data (%s MiB) due to its current configuration.',
 130                       round($_SERVER['CONTENT_LENGTH']/1024/1024,2));
 131             throw new ClientException($msg);
 132         }
 133
 134         $this->checkSessionToken();
 135     }
 136 }