actions/siteadminpanel.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Site administration panel
   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  * @author    Zach Copley <zach@status.net>
  26  * @author    Sarven Capadisli <csarven@status.net>
  27  * @copyright 2008-2009 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 /**
  37  * Administer site settings
  38  *
  39  * @category Admin
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @author   Zach Copley <zach@status.net>
  43  * @author   Sarven Capadisli <csarven@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class SiteadminpanelAction extends AdminPanelAction
  49 {
  50     /**
  51      * Returns the page title
  52      *
  53      * @return string page title
  54      */
  55
  56     function title()
  57     {
  58         return _('Site');
  59     }
  60
  61     /**
  62      * Instructions for using this form.
  63      *
  64      * @return string instructions
  65      */
  66
  67     function getInstructions()
  68     {
  69         return _('Basic settings for this StatusNet site.');
  70     }
  71
  72     /**
  73      * Show the site admin panel form
  74      *
  75      * @return void
  76      */
  77
  78     function showForm()
  79     {
  80         $form = new SiteAdminPanelForm($this);
  81         $form->show();
  82         return;
  83     }
  84
  85     /**
  86      * Save settings from the form
  87      *
  88      * @return void
  89      */
  90
  91     function saveSettings()
  92     {
  93         static $settings = array('name', 'broughtby', 'broughtbyurl',
  94                                  'email', 'timezone', 'language');
  95
  96         $values = array();
  97
  98         foreach ($settings as $setting) {
  99             $values[$setting] = $this->trimmed($setting);
 100         }
 101
 102         // This throws an exception on validation errors
 103
 104         $this->validate($values);
 105
 106         // assert(all values are valid);
 107
 108         $config = new Config();
 109
 110         $config->query('BEGIN');
 111
 112         foreach ($settings as $setting) {
 113             Config::save('site', $setting, $values[$setting]);
 114         }
 115
 116         $config->query('COMMIT');
 117
 118         return;
 119     }
 120
 121     function validate(&$values)
 122     {
 123         // Validate site name
 124
 125         if (empty($values['name'])) {
 126             $this->clientError(_("Site name must have non-zero length."));
 127         }
 128
 129         // Validate email
 130
 131         $values['email'] = common_canonical_email($values['email']);
 132
 133         if (empty($values['email'])) {
 134             $this->clientError(_('You must have a valid contact email address'));
 135         }
 136         if (!Validate::email($values['email'], common_config('email', 'check_domain'))) {
 137             $this->clientError(_('Not a valid email address'));
 138         }
 139
 140         // Validate timezone
 141
 142         if (is_null($values['timezone']) ||
 143             !in_array($values['timezone'], DateTimeZone::listIdentifiers())) {
 144             $this->clientError(_('Timezone not selected.'));
 145             return;
 146         }
 147
 148         // Validate language
 149
 150         if (!is_null($language) && !in_array($language, array_keys(get_nice_language_list()))) {
 151             $this->clientError(sprintf(_('Unknown language "%s"'), $language));
 152         }
 153     }
 154 }
 155
 156 class SiteAdminPanelForm extends Form
 157 {
 158     /**
 159      * ID of the form
 160      *
 161      * @return int ID of the form
 162      */
 163
 164     function id()
 165     {
 166         return 'siteadminpanel';
 167     }
 168
 169     /**
 170      * class of the form
 171      *
 172      * @return string class of the form
 173      */
 174
 175     function formClass()
 176     {
 177         return 'form_site_admin_panel';
 178     }
 179
 180     /**
 181      * Action of the form
 182      *
 183      * @return string URL of the action
 184      */
 185
 186     function action()
 187     {
 188         return common_local_url('siteadminpanel');
 189     }
 190
 191     /**
 192      * Data elements of the form
 193      *
 194      * @return void
 195      */
 196
 197     function formData()
 198     {
 199         $this->input('name', _('Site name'),
 200                      _('The name of your site, like "Yourcompany Microblog"'));
 201         $this->input('broughtby', _('Brought by'),
 202                      _('Text used for credits link in footer of each page'));
 203         $this->input('broughtbyurl', _('Brought by URL'),
 204                      _('URL used for credits link in footer of each page'));
 205         $this->input('email', _('Email'),
 206                      _('contact email address for your site'));
 207
 208         $timezones = array();
 209
 210         foreach (DateTimeZone::listIdentifiers() as $k => $v) {
 211             $timezones[$v] = $v;
 212         }
 213
 214         asort($timezones);
 215
 216         $this->out->dropdown('timezone', _('Default timezone'),
 217                              $timezones, _('Default timezone for the site; usually UTC.'),
 218                              true, $this->value('timezone'));
 219
 220         $this->out->dropdown('language', _('Language'),
 221                              get_nice_language_list(), _('Default site language'),
 222                              false, $this->value('language'));
 223     }
 224
 225     /**
 226      * Utility to simplify some of the duplicated code around
 227      * params and settings.
 228      *
 229      * @param string $setting      Name of the setting
 230      * @param string $title        Title to use for the input
 231      * @param string $instructions Instructions for this field
 232      *
 233      * @return void
 234      */
 235
 236     function input($setting, $title, $instructions)
 237     {
 238         $this->out->input($setting, $title, $this->value($setting), $instructions);
 239     }
 240
 241     /**
 242      * Utility to simplify getting the posted-or-stored setting value
 243      *
 244      * @param string $setting Name of the setting
 245      *
 246      * @return string param value if posted, or current config value
 247      */
 248
 249     function value($setting)
 250     {
 251         $value = $this->out->trimmed($setting);
 252         if (empty($value)) {
 253             $value = common_config('site', $setting);
 254         }
 255         return $value;
 256     }
 257
 258     /**
 259      * Action elements
 260      *
 261      * @return void
 262      */
 263
 264     function formActions()
 265     {
 266         $this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
 267     }
 268 }