lib/settingsaction.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for settings actions
   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  Settings
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008-2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Base class for settings group of actions
  36  *
  37  * @category Settings
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@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  * @see      Widget
  44  */
  45
  46 class SettingsAction extends CurrentUserDesignAction
  47 {
  48     /**
  49      * A message for the user.
  50      */
  51
  52     var $msg = null;
  53
  54     /**
  55      * Whether the message is a good one or a bad one.
  56      */
  57
  58     var $success = false;
  59
  60     /**
  61      * Handle input and output a page
  62      *
  63      * @param array $args $_REQUEST arguments
  64      *
  65      * @return void
  66      */
  67
  68     function handle($args)
  69     {
  70         parent::handle($args);
  71         if (!common_logged_in()) {
  72             $this->clientError(_('Not logged in.'));
  73             return;
  74         } else if (!common_is_real_login()) {
  75             // Cookie theft means that automatic logins can't
  76             // change important settings or see private info, and
  77             // _all_ our settings are important
  78             common_set_returnto($this->selfUrl());
  79             $user = common_current_user();
  80             if (Event::handle('RedirectToLogin', array($this, $user))) {
  81                 common_redirect(common_local_url('login'), 303);
  82             }
  83         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  84             $this->handlePost();
  85         } else {
  86             $this->showForm();
  87         }
  88     }
  89
  90     /**
  91      * Handle a POST request
  92      *
  93      * @return boolean success flag
  94      */
  95
  96     function handlePost()
  97     {
  98         return false;
  99     }
 100
 101     /**
 102      * show the settings form
 103      *
 104      * @param string $msg     an extra message for the user
 105      * @param string $success good message or bad message?
 106      *
 107      * @return void
 108      */
 109
 110     function showForm($msg=null, $success=false)
 111     {
 112         $this->msg     = $msg;
 113         $this->success = $success;
 114
 115         $this->showPage();
 116     }
 117
 118     /**
 119      * show human-readable instructions for the page
 120      *
 121      * @return void
 122      */
 123
 124     function showPageNotice()
 125     {
 126         if ($this->msg) {
 127             $this->element('div', ($this->success) ? 'success' : 'error',
 128                            $this->msg);
 129         } else {
 130             $inst   = $this->getInstructions();
 131             $output = common_markup_to_html($inst);
 132
 133             $this->elementStart('div', 'instructions');
 134             $this->raw($output);
 135             $this->elementEnd('div');
 136         }
 137     }
 138
 139     /**
 140      * instructions recipe for sub-classes
 141      *
 142      * Subclasses should override this to return readable instructions. They'll
 143      * be processed by common_markup_to_html().
 144      *
 145      * @return string instructions text
 146      */
 147
 148     function getInstructions()
 149     {
 150         return '';
 151     }
 152
 153 }