actions/pathsadminpanel.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Paths 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  * Paths 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 PathsadminpanelAction extends AdminPanelAction
  49 {
  50
  51     /**
  52      * Returns the page title
  53      *
  54      * @return string page title
  55      */
  56
  57     function title()
  58     {
  59         return _('Paths');
  60     }
  61
  62     /**
  63      * Instructions for using this form.
  64      *
  65      * @return string instructions
  66      */
  67
  68     function getInstructions()
  69     {
  70         return _('Path and server settings for this StatusNet site.');
  71     }
  72
  73     /**
  74      * Show the paths admin panel form
  75      *
  76      * @return void
  77      */
  78
  79     function showForm()
  80     {
  81         $form = new PathsAdminPanelForm($this);
  82         $form->show();
  83         return;
  84     }
  85
  86     /**
  87      * Save settings from the form
  88      *
  89      * @return void
  90      */
  91
  92     function saveSettings()
  93     {
  94         static $settings = array(
  95             'site' => array('path', 'locale_path', 'ssl', 'sslserver'),
  96             'theme' => array('server', 'dir', 'path'),
  97             'avatar' => array('server', 'dir', 'path'),
  98             'background' => array('server', 'dir', 'path')
  99         );
 100
 101         $values = array();
 102
 103         foreach ($settings as $section => $parts) {
 104             foreach ($parts as $setting) {
 105                 $values[$section][$setting] = $this->trimmed("$section-$setting");
 106             }
 107         }
 108
 109         $this->validate($values);
 110
 111         // assert(all values are valid);
 112
 113         $config = new Config();
 114
 115         $config->query('BEGIN');
 116
 117         foreach ($settings as $section => $parts) {
 118             foreach ($parts as $setting) {
 119                 Config::save($section, $setting, $values[$section][$setting]);
 120             }
 121         }
 122
 123         $config->query('COMMIT');
 124
 125         return;
 126     }
 127
 128     /**
 129      * Attempt to validate setting values
 130      *
 131      * @return void
 132      */
 133
 134     function validate(&$values)
 135     {
 136
 137         // Validate theme dir
 138
 139         if (!empty($values['theme']['dir']) && !is_readable($values['theme']['dir'])) {
 140             $this->clientError(sprintf(_("Theme directory not readable: %s"), $values['theme']['dir']));
 141         }
 142
 143         // Validate avatar dir
 144
 145         if (empty($values['avatar']['dir']) || !is_writable($values['avatar']['dir'])) {
 146             $this->clientError(sprintf(_("Avatar directory not writable: %s"), $values['avatar']['dir']));
 147         }
 148
 149         // Validate background dir
 150
 151         if (empty($values['background']['dir']) || !is_writable($values['background']['dir'])) {
 152             $this->clientError(sprintf(_("Background directory not writable: %s"), $values['background']['dir']));
 153         }
 154
 155         // Validate locales dir
 156
 157         // XXX: What else do we need to validate for lacales path here? --Z
 158
 159         if (!empty($values['site']['locale_path']) && !is_readable($values['site']['locale_path'])) {
 160             $this->clientError(sprintf(_("Locales directory not readable: %s"), $values['site']['locale_path']));
 161         }
 162
 163         // Validate SSL setup
 164
 165         if (mb_strlen($values['site']['sslserver']) > 255) {
 166             $this->clientError(_("Invalid SSL server. The maximum length is 255 characters."));
 167         }
 168     }
 169
 170 }
 171
 172 class PathsAdminPanelForm extends AdminForm
 173 {
 174
 175     /**
 176      * ID of the form
 177      *
 178      * @return int ID of the form
 179      */
 180
 181     function id()
 182     {
 183         return 'form_paths_admin_panel';
 184     }
 185
 186     /**
 187      * class of the form
 188      *
 189      * @return string class of the form
 190      */
 191
 192     function formClass()
 193     {
 194         return 'form_settings';
 195     }
 196
 197     /**
 198      * Action of the form
 199      *
 200      * @return string URL of the action
 201      */
 202
 203     function action()
 204     {
 205         return common_local_url('pathsadminpanel');
 206     }
 207
 208     /**
 209      * Data elements of the form
 210      *
 211      * @return void
 212      */
 213
 214     function formData()
 215     {
 216         $this->out->elementStart('fieldset', array('id' => 'settings_paths_locale'));
 217         $this->out->element('legend', null, _('Site'), 'site');
 218         $this->out->elementStart('ul', 'form_data');
 219
 220         $this->li();
 221         $this->input('path', _('Path'), _('Site path'));
 222         $this->unli();
 223
 224         $this->li();
 225         $this->input('locale_path', _('Path to locales'), _('Directory path to locales'), 'site');
 226         $this->unli();
 227
 228         $this->out->elementEnd('ul');
 229         $this->out->elementEnd('fieldset');
 230
 231         $this->out->elementStart('fieldset', array('id' => 'settings_paths_theme'));
 232         $this->out->element('legend', null, _('Theme'));
 233
 234         $this->out->elementStart('ul', 'form_data');
 235
 236         $this->li();
 237         $this->input('server', _('Theme server'), 'Server for themes', 'theme');
 238         $this->unli();
 239
 240         $this->li();
 241         $this->input('path', _('Theme path'), 'Web path to themes', 'theme');
 242         $this->unli();
 243
 244         $this->li();
 245         $this->input('dir', _('Theme directory'), 'Directory where themes are located', 'theme');
 246         $this->unli();
 247
 248         $this->out->elementEnd('ul');
 249
 250         $this->out->elementEnd('fieldset');
 251         $this->out->elementStart('fieldset', array('id' => 'settings_avatar-paths'));
 252         $this->out->element('legend', null, _('Avatars'));
 253
 254         $this->out->elementStart('ul', 'form_data');
 255
 256         $this->li();
 257         $this->input('server', _('Avatar server'), 'Server for avatars', 'avatar');
 258         $this->unli();
 259
 260         $this->li();
 261         $this->input('path', _('Avatar path'), 'Web path to avatars', 'avatar');
 262         $this->unli();
 263
 264         $this->li();
 265         $this->input('dir', _('Avatar directory'), 'Directory where avatars are located', 'avatar');
 266         $this->unli();
 267
 268         $this->out->elementEnd('ul');
 269
 270         $this->out->elementEnd('fieldset');
 271
 272         $this->out->elementStart('fieldset', array('id' =>
 273             'settings_design_background-paths'));
 274         $this->out->element('legend', null, _('Backgrounds'));
 275         $this->out->elementStart('ul', 'form_data');
 276
 277         $this->li();
 278         $this->input('server', _('Background server'), 'Server for backgrounds', 'background');
 279         $this->unli();
 280
 281         $this->li();
 282         $this->input('path', _('Background path'), 'Web path to backgrounds', 'background');
 283         $this->unli();
 284
 285         $this->li();
 286         $this->input('dir', _('Background directory'), 'Directory where backgrounds are located', 'background');
 287         $this->unli();
 288
 289         $this->out->elementEnd('ul');
 290         $this->out->elementEnd('fieldset');
 291
 292         $this->out->elementStart('fieldset', array('id' => 'settings_admin_ssl'));
 293         $this->out->element('legend', null, _('SSL'));
 294         $this->out->elementStart('ul', 'form_data');
 295         $this->li();
 296         $ssl = array('never' => _('Never'),
 297                      'sometimes' => _('Sometimes'),
 298                      'always' => _('Always'));
 299
 300         common_debug("site ssl = " . $this->value('site', 'ssl'));
 301
 302         $this->out->dropdown('site-ssl', _('Use SSL'),
 303                              $ssl, _('When to use SSL'),
 304                              false, $this->value('ssl', 'site'));
 305         $this->unli();
 306
 307         $this->li();
 308         $this->input('sslserver', _('SSL server'),
 309                      _('Server to direct SSL requests to'), 'site');
 310         $this->unli();
 311         $this->out->elementEnd('ul');
 312         $this->out->elementEnd('fieldset');
 313
 314     }
 315
 316     /**
 317      * Action elements
 318      *
 319      * @return void
 320      */
 321
 322     function formActions()
 323     {
 324         $this->out->submit('save', _('Save'), 'submit',
 325                 'save', _('Save paths'));
 326     }
 327
 328     /**
 329      * Utility to simplify some of the duplicated code around
 330      * params and settings. Overriding the input() in the base class
 331      * to handle a whole bunch of cases of settings with the same
 332      * name under different sections.
 333      *
 334      * @param string $setting      Name of the setting
 335      * @param string $title        Title to use for the input
 336      * @param string $instructions Instructions for this field
 337      * @param string $section      config section, default = 'site'
 338      *
 339      * @return void
 340      */
 341
 342     function input($setting, $title, $instructions, $section='site')
 343     {
 344         $this->out->input("$section-$setting", $title, $this->value($setting, $section), $instructions);
 345     }
 346
 347 }