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 (in_array($values['site']['ssl'], array('sometimes', 'always'))) {
 166             if (empty($values['site']['sslserver'])) {
 167                 $this->clientError(_("You must set an SSL server when enabling SSL."));
 168             }
 169         }
 170
 171     }
 172
 173 }
 174
 175 class PathsAdminPanelForm extends AdminForm
 176 {
 177
 178     /**
 179      * ID of the form
 180      *
 181      * @return int ID of the form
 182      */
 183
 184     function id()
 185     {
 186         return 'form_paths_admin_panel';
 187     }
 188
 189     /**
 190      * class of the form
 191      *
 192      * @return string class of the form
 193      */
 194
 195     function formClass()
 196     {
 197         return 'form_settings';
 198     }
 199
 200     /**
 201      * Action of the form
 202      *
 203      * @return string URL of the action
 204      */
 205
 206     function action()
 207     {
 208         return common_local_url('pathsadminpanel');
 209     }
 210
 211     /**
 212      * Data elements of the form
 213      *
 214      * @return void
 215      */
 216
 217     function formData()
 218     {
 219         $this->out->elementStart('fieldset', array('id' => 'settings_paths_locale'));
 220         $this->out->element('legend', null, _('Site'), 'site');
 221         $this->out->elementStart('ul', 'form_data');
 222
 223         $this->li();
 224         $this->input('path', _('Path'), _('Site path'));
 225         $this->unli();
 226
 227         $this->li();
 228         $this->input('locale_path', _('Path to locales'), _('Directory path to locales'), 'site');
 229         $this->unli();
 230
 231         $this->out->elementEnd('ul');
 232         $this->out->elementEnd('fieldset');
 233
 234         $this->out->elementStart('fieldset', array('id' => 'settings_paths_theme'));
 235         $this->out->element('legend', null, _('Theme'));
 236
 237         $this->out->elementStart('ul', 'form_data');
 238
 239         $this->li();
 240         $this->input('server', _('Theme server'), 'Server for themes', 'theme');
 241         $this->unli();
 242
 243         $this->li();
 244         $this->input('path', _('Theme path'), 'Web path to themes', 'theme');
 245         $this->unli();
 246
 247         $this->li();
 248         $this->input('dir', _('Theme directory'), 'Directory where themes are located', 'theme');
 249         $this->unli();
 250
 251         $this->out->elementEnd('ul');
 252
 253         $this->out->elementEnd('fieldset');
 254         $this->out->elementStart('fieldset', array('id' => 'settings_avatar-paths'));
 255         $this->out->element('legend', null, _('Avatars'));
 256
 257         $this->out->elementStart('ul', 'form_data');
 258
 259         $this->li();
 260         $this->input('server', _('Avatar server'), 'Server for avatars', 'avatar');
 261         $this->unli();
 262
 263         $this->li();
 264         $this->input('path', _('Avatar path'), 'Web path to avatars', 'avatar');
 265         $this->unli();
 266
 267         $this->li();
 268         $this->input('dir', _('Avatar directory'), 'Directory where avatars are located', 'avatar');
 269         $this->unli();
 270
 271         $this->out->elementEnd('ul');
 272
 273         $this->out->elementEnd('fieldset');
 274
 275         $this->out->elementStart('fieldset', array('id' =>
 276             'settings_design_background-paths'));
 277         $this->out->element('legend', null, _('Backgrounds'));
 278         $this->out->elementStart('ul', 'form_data');
 279
 280         $this->li();
 281         $this->input('server', _('Background server'), 'Server for backgrounds', 'background');
 282         $this->unli();
 283
 284         $this->li();
 285         $this->input('path', _('Background path'), 'Web path to backgrounds', 'background');
 286         $this->unli();
 287
 288         $this->li();
 289         $this->input('dir', _('Background directory'), 'Directory where backgrounds are located', 'background');
 290         $this->unli();
 291
 292         $this->out->elementEnd('ul');
 293         $this->out->elementEnd('fieldset');
 294
 295         $this->out->elementStart('fieldset', array('id' => 'settings_admin_ssl'));
 296         $this->out->element('legend', null, _('SSL'));
 297         $this->out->elementStart('ul', 'form_data');
 298         $this->li();
 299         $ssl = array('never' => _('Never'),
 300                      'sometimes' => _('Sometimes'),
 301                      'always' => _('Always'));
 302
 303         common_debug("site ssl = " . $this->value('site', 'ssl'));
 304
 305         $this->out->dropdown('site-ssl', _('Use SSL'),
 306                              $ssl, _('When to use SSL'),
 307                              false, $this->value('ssl', 'site'));
 308         $this->unli();
 309
 310         $this->li();
 311         $this->input('sslserver', _('SSL Server'),
 312                      _('Server to direct SSL requests to'), 'site');
 313         $this->unli();
 314         $this->out->elementEnd('ul');
 315         $this->out->elementEnd('fieldset');
 316
 317     }
 318
 319     /**
 320      * Action elements
 321      *
 322      * @return void
 323      */
 324
 325     function formActions()
 326     {
 327         $this->out->submit('save', _('Save'), 'submit',
 328                 'save', _('Save paths'));
 329     }
 330
 331     /**
 332      * Utility to simplify some of the duplicated code around
 333      * params and settings. Overriding the input() in the base class
 334      * to handle a whole bunch of cases of settings with the same
 335      * name under different sections.
 336      *
 337      * @param string $setting      Name of the setting
 338      * @param string $title        Title to use for the input
 339      * @param string $instructions Instructions for this field
 340      * @param string $section      config section, default = 'site'
 341      *
 342      * @return void
 343      */
 344
 345     function input($setting, $title, $instructions, $section='site')
 346     {
 347         $this->out->input("$section-$setting", $title, $this->value($setting, $section), $instructions);
 348     }
 349
 350 }