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', 'email');
  94
  95         $values = array();
  96
  97         foreach ($settings as $setting) {
  98             $values[$setting] = $this->trimmed($setting);
  99         }
 100
 101         // This throws an exception on validation errors
 102
 103         $this->validate($values);
 104
 105         // assert(all values are valid);
 106
 107         $config = new Config();
 108
 109         $config->query('BEGIN');
 110
 111         foreach ($settings as $setting) {
 112             Config::save('site', $setting, $values[$setting]);
 113         }
 114
 115         $config->query('COMMIT');
 116
 117         return;
 118     }
 119
 120     function validate(&$values)
 121     {
 122         // Validate site name
 123
 124         if (empty($values['name'])) {
 125             $this->clientError(_("Site name must have non-zero length."));
 126         }
 127
 128         // Validate email
 129
 130         $values['email'] = common_canonical_email($values['email']);
 131
 132         if (empty($values['email'])) {
 133             $this->clientError(_('You must have a valid contact email address'));
 134         }
 135         if (!Validate::email($values['email'], common_config('email', 'check_domain'))) {
 136             $this->clientError(_('Not a valid email address'));
 137         }
 138     }
 139 }
 140
 141 class SiteAdminPanelForm extends Form
 142 {
 143     /**
 144      * ID of the form
 145      *
 146      * @return int ID of the form
 147      */
 148
 149     function id()
 150     {
 151         return 'siteadminpanel';
 152     }
 153
 154     /**
 155      * class of the form
 156      *
 157      * @return string class of the form
 158      */
 159
 160     function formClass()
 161     {
 162         return 'form_site_admin_panel';
 163     }
 164
 165     /**
 166      * Action of the form
 167      *
 168      * @return string URL of the action
 169      */
 170
 171     function action()
 172     {
 173         return common_local_url('siteadminpanel');
 174     }
 175
 176     /**
 177      * Data elements of the form
 178      *
 179      * @return void
 180      */
 181
 182     function formData()
 183     {
 184         $this->input('name', _('Site name'),
 185                      _('The name of your site, like "Yourcompany Microblog"'));
 186         $this->input('broughtby', _('Brought by'),
 187                      _('Text used for credits link in footer of each page'));
 188         $this->input('broughtbyurl', _('Brought by URL'),
 189                      _('URL used for credits link in footer of each page'));
 190         $this->input('email', _('Email'),
 191                      _('contact email address for your site'));
 192     }
 193
 194     /**
 195      * Utility to simplify some of the duplicated code around
 196      * params and settings.
 197      *
 198      * @param string $setting      Name of the setting
 199      * @param string $title        Title to use for the input
 200      * @param string $instructions Instructions for this field
 201      *
 202      * @return void
 203      */
 204
 205     function input($setting, $title, $instructions)
 206     {
 207         $value = $this->out->trimmed($setting);
 208         if (empty($value)) {
 209             $value = common_config('site', $setting);
 210         }
 211         $this->out->input($setting, $title, $value, $instructions);
 212     }
 213
 214     /**
 215      * Action elements
 216      *
 217      * @return void
 218      */
 219
 220     function formActions()
 221     {
 222         $this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
 223     }
 224 }