actions/designadminpanel.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Design 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 design 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 DesignadminpanelAction extends AdminPanelAction
  49 {
  50
  51     /* The default site design */
  52     var $design = null;
  53
  54     /**
  55      * Returns the page title
  56      *
  57      * @return string page title
  58      */
  59
  60     function title()
  61     {
  62         return _('Design');
  63     }
  64
  65     /**
  66      * Instructions for using this form.
  67      *
  68      * @return string instructions
  69      */
  70
  71     function getInstructions()
  72     {
  73         return _('Design settings for this StatusNet site.');
  74     }
  75
  76     /**
  77      * Get the default design and show the design admin panel form
  78      *
  79      * @return void
  80      */
  81
  82     function showForm()
  83     {
  84         $this->design = Design::siteDesign();
  85         $form = new DesignAdminPanelForm($this);
  86         $form->show();
  87         return;
  88     }
  89
  90     /**
  91      * Save settings from the form
  92      *
  93      * @return void
  94      */
  95
  96     function saveSettings()
  97     {
  98         if ($this->arg('save')) {
  99             $this->saveDesignSettings();
 100         } else if ($this->arg('defaults')) {
 101             $this->restoreDefaults();
 102         } else {
 103             $this->clientError(_('Unexpected form submission.'));
 104         }
 105     }
 106
 107     /**
 108      * Save the new design settings
 109      *
 110      * @return void
 111      */
 112
 113     function saveDesignSettings()
 114     {
 115         // Workaround for PHP returning empty $_POST and $_FILES when POST
 116         // length > post_max_size in php.ini
 117
 118         if (empty($_FILES)
 119             && empty($_POST)
 120             && ($_SERVER['CONTENT_LENGTH'] > 0)
 121         ) {
 122             $msg = _('The server was unable to handle that much POST ' .
 123                 'data (%s bytes) due to its current configuration.');
 124             $this->clientException(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
 125             return;
 126         }
 127
 128         // check for an image upload
 129
 130         $bgimage = $this->saveBackgroundImage();
 131
 132         static $settings = array('theme', 'logo');
 133
 134         $values = array();
 135
 136         foreach ($settings as $setting) {
 137             $values[$setting] = $this->trimmed($setting);
 138         }
 139
 140         $this->validate($values);
 141
 142         $oldtheme = common_config('site', 'theme');
 143
 144         $config = new Config();
 145
 146         $config->query('BEGIN');
 147
 148         // Only update colors if the theme has not changed.
 149
 150         if ($oldtheme == $values['theme']) {
 151
 152             $bgcolor = new WebColor($this->trimmed('design_background'));
 153             $ccolor  = new WebColor($this->trimmed('design_content'));
 154             $sbcolor = new WebColor($this->trimmed('design_sidebar'));
 155             $tcolor  = new WebColor($this->trimmed('design_text'));
 156             $lcolor  = new WebColor($this->trimmed('design_links'));
 157
 158             Config::save('design', 'backgroundcolor', $bgcolor->intValue());
 159             Config::save('design', 'contentcolor', $ccolor->intValue());
 160             Config::save('design', 'sidebarcolor', $sbcolor->intValue());
 161             Config::save('design', 'textcolor', $tcolor->intValue());
 162             Config::save('design', 'linkcolor', $lcolor->intValue());
 163         }
 164
 165         $onoff = $this->arg('design_background-image_onoff');
 166
 167         $on   = false;
 168         $off  = false;
 169
 170         if ($onoff == 'on') {
 171             $on = true;
 172         } else {
 173             $off = true;
 174         }
 175
 176         $tile = $this->boolean('design_background-image_repeat');
 177
 178         // Hack to use Design's bit setter
 179         $scratch = new Design();
 180         $scratch->setDisposition($on, $off, $tile);
 181
 182         Config::save('design', 'disposition', $scratch->disposition);
 183
 184         foreach ($settings as $setting) {
 185             Config::save('site', $setting, $values[$setting]);
 186         }
 187
 188         if (isset($bgimage)) {
 189             Config::save('design', 'backgroundimage', $bgimage);
 190         }
 191
 192         $config->query('COMMIT');
 193     }
 194
 195     /**
 196       * Restore the default design
 197       *
 198       * @return void
 199       */
 200
 201     function restoreDefaults()
 202     {
 203         $this->deleteSetting('site', 'logo');
 204         $this->deleteSetting('site', 'theme');
 205
 206         $settings = array(
 207             'theme', 'backgroundimage', 'backgroundcolor', 'contentcolor',
 208             'sidebarcolor', 'textcolor', 'linkcolor', 'disposition'
 209         );
 210
 211         foreach ($settings as $setting) {
 212             $this->deleteSetting('design', $setting);
 213         }
 214
 215         // XXX: Should we restore the default dir settings, etc.? --Z
 216     }
 217
 218     /**
 219      * Save the background image if the user uploaded one
 220      *
 221      * @return string $filename the filename of the image
 222      */
 223
 224     function saveBackgroundImage()
 225     {
 226         $filename = null;
 227
 228         if ($_FILES['design_background-image_file']['error'] ==
 229             UPLOAD_ERR_OK) {
 230
 231             $filepath = null;
 232
 233             try {
 234                 $imagefile =
 235                     ImageFile::fromUpload('design_background-image_file');
 236             } catch (Exception $e) {
 237                 $this->clientError('Unable to save background image.');
 238                 return;
 239             }
 240
 241             // Note: site design background image has a special filename
 242
 243             $filename = Design::filename('site-design-background',
 244                 image_type_to_extension($imagefile->type),
 245                     common_timestamp());
 246
 247             $filepath = Design::path($filename);
 248
 249             move_uploaded_file($imagefile->filepath, $filepath);
 250
 251             // delete any old backround img laying around
 252
 253             if (isset($this->design->backgroundimage)) {
 254                 @unlink(Design::path($design->backgroundimage));
 255             }
 256
 257             return $filename;
 258         }
 259     }
 260
 261     /**
 262      * Attempt to validate setting values
 263      *
 264      * @return void
 265      */
 266
 267     function validate(&$values)
 268     {
 269         if (!empty($values['logo']) &&
 270             !Validate::uri($values['logo'], array('allowed_schemes' => array('http', 'https')))) {
 271             $this->clientError(_("Invalid logo URL."));
 272         }
 273
 274         if (!in_array($values['theme'], Theme::listAvailable())) {
 275             $this->clientError(sprintf(_("Theme not available: %s"), $values['theme']));
 276         }
 277     }
 278
 279     /**
 280      * Add the Farbtastic stylesheet
 281      *
 282      * @return void
 283      */
 284
 285     function showStylesheets()
 286     {
 287         parent::showStylesheets();
 288         $this->cssLink('css/farbtastic.css','base','screen, projection, tv');
 289     }
 290
 291     /**
 292      * Add the Farbtastic scripts
 293      *
 294      * @return void
 295      */
 296
 297     function showScripts()
 298     {
 299         parent::showScripts();
 300
 301         $this->script('js/farbtastic/farbtastic.js');
 302         $this->script('js/userdesign.go.js');
 303
 304         $this->autofocus('design_background-image_file');
 305     }
 306
 307 }
 308
 309 class DesignAdminPanelForm extends AdminForm
 310 {
 311
 312     /**
 313      * ID of the form
 314      *
 315      * @return int ID of the form
 316      */
 317
 318     function id()
 319     {
 320         return 'form_design_admin_panel';
 321     }
 322
 323     /**
 324      * class of the form
 325      *
 326      * @return string class of the form
 327      */
 328
 329     function formClass()
 330     {
 331         return 'form_settings';
 332     }
 333
 334     /**
 335      * HTTP method used to submit the form
 336      *
 337      * For image data we need to send multipart/form-data
 338      * so we set that here too
 339      *
 340      * @return string the method to use for submitting
 341      */
 342
 343     function method()
 344     {
 345         $this->enctype = 'multipart/form-data';
 346
 347         return 'post';
 348     }
 349
 350     /**
 351      * Action of the form
 352      *
 353      * @return string URL of the action
 354      */
 355
 356     function action()
 357     {
 358         return common_local_url('designadminpanel');
 359     }
 360
 361     /**
 362      * Data elements of the form
 363      *
 364      * @return void
 365      */
 366
 367     function formData()
 368     {
 369
 370         $this->out->elementStart('fieldset', array('id' => 'settings_design_logo'));
 371         $this->out->element('legend', null, _('Change logo'));
 372
 373         $this->out->elementStart('ul', 'form_data');
 374
 375         $this->li();
 376         $this->input('logo', _('Site logo'), 'Logo for the site (full URL)');
 377         $this->unli();
 378
 379         $this->out->elementEnd('ul');
 380
 381         $this->out->elementEnd('fieldset');
 382         $this->out->elementStart('fieldset', array('id' => 'settings_design_theme'));
 383         $this->out->element('legend', null, _('Change theme'));
 384
 385         $this->out->elementStart('ul', 'form_data');
 386
 387         $themes = Theme::listAvailable();
 388
 389         // XXX: listAvailable() can return an empty list if you
 390         // screw up your settings, so just in case:
 391
 392         if (empty($themes)) {
 393             $themes = array('default', 'default');
 394         }
 395
 396         asort($themes);
 397         $themes = array_combine($themes, $themes);
 398
 399         $this->li();
 400         $this->out->dropdown('theme', _('Site theme'),
 401                              $themes, _('Theme for the site.'),
 402                              false, $this->value('theme'));
 403         $this->unli();
 404
 405         $this->out->elementEnd('ul');
 406
 407         $this->out->elementEnd('fieldset');
 408
 409         $design = $this->out->design;
 410
 411         $this->out->elementStart('fieldset', array('id' =>
 412             'settings_design_background-image'));
 413         $this->out->element('legend', null, _('Change background image'));
 414         $this->out->elementStart('ul', 'form_data');
 415
 416         $this->li();
 417         $this->out->element('label', array('for' => 'design_background-image_file'),
 418                                 _('Background'));
 419         $this->out->element('input', array('name' => 'design_background-image_file',
 420                                      'type' => 'file',
 421                                      'id' => 'design_background-image_file'));
 422         $this->out->element('p', 'form_guide',
 423             sprintf(_('You can upload a background image for the site. ' .
 424               'The maximum file size is %1$s.'), ImageFile::maxFileSize()));
 425         $this->out->element('input', array('name' => 'MAX_FILE_SIZE',
 426                                           'type' => 'hidden',
 427                                           'id' => 'MAX_FILE_SIZE',
 428                                           'value' => ImageFile::maxFileSizeInt()));
 429         $this->unli();
 430
 431         if (!empty($design->backgroundimage)) {
 432
 433             $this->out->elementStart('li', array('id' =>
 434                 'design_background-image_onoff'));
 435
 436             $this->out->element('img', array('src' =>
 437                 Design::url($design->backgroundimage)));
 438
 439             $attrs = array('name' => 'design_background-image_onoff',
 440                            'type' => 'radio',
 441                            'id' => 'design_background-image_on',
 442                            'class' => 'radio',
 443                            'value' => 'on');
 444
 445             if ($design->disposition & BACKGROUND_ON) {
 446                 $attrs['checked'] = 'checked';
 447             }
 448
 449             $this->out->element('input', $attrs);
 450
 451             $this->out->element('label', array('for' => 'design_background-image_on',
 452                                           'class' => 'radio'),
 453                                           _('On'));
 454
 455             $attrs = array('name' => 'design_background-image_onoff',
 456                            'type' => 'radio',
 457                            'id' => 'design_background-image_off',
 458                            'class' => 'radio',
 459                            'value' => 'off');
 460
 461             if ($design->disposition & BACKGROUND_OFF) {
 462                 $attrs['checked'] = 'checked';
 463             }
 464
 465             $this->out->element('input', $attrs);
 466
 467             $this->out->element('label', array('for' => 'design_background-image_off',
 468                                           'class' => 'radio'),
 469                                           _('Off'));
 470             $this->out->element('p', 'form_guide', _('Turn background image on or off.'));
 471             $this->unli();
 472
 473             $this->li();
 474             $this->out->checkbox('design_background-image_repeat',
 475                             _('Tile background image'),
 476                             ($design->disposition & BACKGROUND_TILE) ? true : false);
 477             $this->unli();
 478         }
 479
 480         $this->out->elementEnd('ul');
 481         $this->out->elementEnd('fieldset');
 482
 483         $this->out->elementStart('fieldset', array('id' => 'settings_design_color'));
 484         $this->out->element('legend', null, _('Change colours'));
 485
 486         $this->out->elementStart('ul', 'form_data');
 487
 488         try {
 489
 490             $bgcolor = new WebColor($design->backgroundcolor);
 491
 492             $this->li();
 493             $this->out->element('label', array('for' => 'swatch-1'), _('Background'));
 494             $this->out->element('input', array('name' => 'design_background',
 495                                           'type' => 'text',
 496                                           'id' => 'swatch-1',
 497                                           'class' => 'swatch',
 498                                           'maxlength' => '7',
 499                                           'size' => '7',
 500                                           'value' => ''));
 501             $this->unli();
 502
 503             $ccolor = new WebColor($design->contentcolor);
 504
 505             $this->li();
 506             $this->out->element('label', array('for' => 'swatch-2'), _('Content'));
 507             $this->out->element('input', array('name' => 'design_content',
 508                                           'type' => 'text',
 509                                           'id' => 'swatch-2',
 510                                           'class' => 'swatch',
 511                                           'maxlength' => '7',
 512                                           'size' => '7',
 513                                           'value' => ''));
 514             $this->unli();
 515
 516             $sbcolor = new WebColor($design->sidebarcolor);
 517
 518             $this->li();
 519             $this->out->element('label', array('for' => 'swatch-3'), _('Sidebar'));
 520             $this->out->element('input', array('name' => 'design_sidebar',
 521                                         'type' => 'text',
 522                                         'id' => 'swatch-3',
 523                                         'class' => 'swatch',
 524                                         'maxlength' => '7',
 525                                         'size' => '7',
 526                                         'value' => ''));
 527             $this->unli();
 528
 529             $tcolor = new WebColor($design->textcolor);
 530
 531             $this->li();
 532             $this->out->element('label', array('for' => 'swatch-4'), _('Text'));
 533             $this->out->element('input', array('name' => 'design_text',
 534                                         'type' => 'text',
 535                                         'id' => 'swatch-4',
 536                                         'class' => 'swatch',
 537                                         'maxlength' => '7',
 538                                         'size' => '7',
 539                                         'value' => ''));
 540             $this->unli();
 541
 542             $lcolor = new WebColor($design->linkcolor);
 543
 544             $this->li();
 545             $this->out->element('label', array('for' => 'swatch-5'), _('Links'));
 546             $this->out->element('input', array('name' => 'design_links',
 547                                          'type' => 'text',
 548                                          'id' => 'swatch-5',
 549                                          'class' => 'swatch',
 550                                          'maxlength' => '7',
 551                                          'size' => '7',
 552                                          'value' => ''));
 553             $this->unli();
 554
 555         } catch (WebColorException $e) {
 556             common_log(LOG_ERR, 'Bad color values in site design: ' .
 557                 $e->getMessage());
 558         }
 559
 560         $this->out->elementEnd('fieldset');
 561
 562         $this->out->elementEnd('ul');
 563     }
 564
 565     /**
 566      * Action elements
 567      *
 568      * @return void
 569      */
 570
 571     function formActions()
 572     {
 573         $this->out->submit('defaults', _('Use defaults'), 'submit form_action-default',
 574                 'defaults', _('Restore default designs'));
 575
 576         $this->out->element('input', array('id' => 'settings_design_reset',
 577                                          'type' => 'reset',
 578                                          'value' => 'Reset',
 579                                          'class' => 'submit form_action-primary',
 580                                          'title' => _('Reset back to default')));
 581
 582         $this->out->submit('save', _('Save'), 'submit form_action-secondary',
 583                 'save', _('Save design'));
 584     }
 585
 586 }