lib/designsettings.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Change user password
   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    Sarven Capadisli <csarven@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2008-2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR . '/lib/accountsettingsaction.php';
  36 require_once INSTALLDIR . '/lib/webcolor.php';
  37
  38 /**
  39  * Base class for setting a user or group design
  40  *
  41  * Shows the design setting form and also handles some things like saving
  42  * background images, and fetching a default design
  43  *
  44  * @category Settings
  45  * @package  StatusNet
  46  * @author   Zach Copley <zach@status.net>
  47  * @author   Sarven Capadisli <csarven@status.net>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  */
  51
  52 class DesignSettingsAction extends AccountSettingsAction
  53 {
  54
  55     var $submitaction = null;
  56
  57     /**
  58      * Title of the page
  59      *
  60      * @return string Title of the page
  61      */
  62
  63     function title()
  64     {
  65         return _('Profile design');
  66     }
  67
  68     /**
  69      * Instructions for use
  70      *
  71      * @return instructions for use
  72      */
  73
  74     function getInstructions()
  75     {
  76         return _('Customize the way your profile looks ' .
  77         'with a background image and a colour palette of your choice.');
  78     }
  79
  80     /**
  81      * Shows the design settings form
  82      *
  83      * @param Design $design a working design to show
  84      *
  85      * @return nothing
  86      */
  87
  88     function showDesignForm($design)
  89     {
  90
  91         $this->elementStart('form', array('method' => 'post',
  92                                           'enctype' => 'multipart/form-data',
  93                                           'id' => 'form_settings_design',
  94                                           'class' => 'form_settings',
  95                                           'action' => $this->submitaction));
  96         $this->elementStart('fieldset');
  97         $this->hidden('token', common_session_token());
  98
  99         $this->elementStart('fieldset', array('id' =>
 100             'settings_design_background-image'));
 101         $this->element('legend', null, _('Change background image'));
 102         $this->elementStart('ul', 'form_data');
 103         $this->elementStart('li');
 104         $this->element('label', array('for' => 'design_background-image_file'),
 105                                 _('Upload file'));
 106         $this->element('input', array('name' => 'design_background-image_file',
 107                                       'type' => 'file',
 108                                       'id' => 'design_background-image_file'));
 109         $this->element('p', 'form_guide', _('You can upload your personal ' .
 110             'background image. The maximum file size is 2Mb.'));
 111         $this->element('input', array('name' => 'MAX_FILE_SIZE',
 112                                       'type' => 'hidden',
 113                                       'id' => 'MAX_FILE_SIZE',
 114                                       'value' => ImageFile::maxFileSizeInt()));
 115         $this->elementEnd('li');
 116
 117         if (!empty($design->backgroundimage)) {
 118
 119             $this->elementStart('li', array('id' =>
 120                 'design_background-image_onoff'));
 121
 122             $this->element('img', array('src' =>
 123                 Design::url($design->backgroundimage)));
 124
 125             $attrs = array('name' => 'design_background-image_onoff',
 126                            'type' => 'radio',
 127                            'id' => 'design_background-image_on',
 128                            'class' => 'radio',
 129                            'value' => 'on');
 130
 131             if ($design->disposition & BACKGROUND_ON) {
 132                 $attrs['checked'] = 'checked';
 133             }
 134
 135             $this->element('input', $attrs);
 136
 137             $this->element('label', array('for' => 'design_background-image_on',
 138                                           'class' => 'radio'),
 139                                           _('On'));
 140
 141             $attrs = array('name' => 'design_background-image_onoff',
 142                            'type' => 'radio',
 143                            'id' => 'design_background-image_off',
 144                            'class' => 'radio',
 145                            'value' => 'off');
 146
 147             if ($design->disposition & BACKGROUND_OFF) {
 148                 $attrs['checked'] = 'checked';
 149             }
 150
 151             $this->element('input', $attrs);
 152
 153             $this->element('label', array('for' => 'design_background-image_off',
 154                                           'class' => 'radio'),
 155                                           _('Off'));
 156             $this->element('p', 'form_guide', _('Turn background image on or off.'));
 157             $this->elementEnd('li');
 158
 159             $this->elementStart('li');
 160             $this->checkbox('design_background-image_repeat',
 161                             _('Tile background image'),
 162                             ($design->disposition & BACKGROUND_TILE) ? true : false);
 163             $this->elementEnd('li');
 164         }
 165
 166         $this->elementEnd('ul');
 167         $this->elementEnd('fieldset');
 168
 169         $this->elementStart('fieldset', array('id' => 'settings_design_color'));
 170         $this->element('legend', null, _('Change colours'));
 171         $this->elementStart('ul', 'form_data');
 172
 173         try {
 174
 175             $bgcolor = new WebColor($design->backgroundcolor);
 176
 177             $this->elementStart('li');
 178             $this->element('label', array('for' => 'swatch-1'), _('Background'));
 179             $this->element('input', array('name' => 'design_background',
 180                                           'type' => 'text',
 181                                           'id' => 'swatch-1',
 182                                           'class' => 'swatch',
 183                                           'maxlength' => '7',
 184                                           'size' => '7',
 185                                           'value' => ''));
 186             $this->elementEnd('li');
 187
 188             $ccolor = new WebColor($design->contentcolor);
 189
 190             $this->elementStart('li');
 191             $this->element('label', array('for' => 'swatch-2'), _('Content'));
 192             $this->element('input', array('name' => 'design_content',
 193                                           'type' => 'text',
 194                                           'id' => 'swatch-2',
 195                                           'class' => 'swatch',
 196                                           'maxlength' => '7',
 197                                           'size' => '7',
 198                                           'value' => ''));
 199             $this->elementEnd('li');
 200
 201             $sbcolor = new WebColor($design->sidebarcolor);
 202
 203             $this->elementStart('li');
 204             $this->element('label', array('for' => 'swatch-3'), _('Sidebar'));
 205             $this->element('input', array('name' => 'design_sidebar',
 206                                         'type' => 'text',
 207                                         'id' => 'swatch-3',
 208                                         'class' => 'swatch',
 209                                         'maxlength' => '7',
 210                                         'size' => '7',
 211                                         'value' => ''));
 212             $this->elementEnd('li');
 213
 214             $tcolor = new WebColor($design->textcolor);
 215
 216             $this->elementStart('li');
 217             $this->element('label', array('for' => 'swatch-4'), _('Text'));
 218             $this->element('input', array('name' => 'design_text',
 219                                         'type' => 'text',
 220                                         'id' => 'swatch-4',
 221                                         'class' => 'swatch',
 222                                         'maxlength' => '7',
 223                                         'size' => '7',
 224                                         'value' => ''));
 225             $this->elementEnd('li');
 226
 227             $lcolor = new WebColor($design->linkcolor);
 228
 229             $this->elementStart('li');
 230             $this->element('label', array('for' => 'swatch-5'), _('Links'));
 231             $this->element('input', array('name' => 'design_links',
 232                                          'type' => 'text',
 233                                          'id' => 'swatch-5',
 234                                          'class' => 'swatch',
 235                                          'maxlength' => '7',
 236                                          'size' => '7',
 237                                          'value' => ''));
 238             $this->elementEnd('li');
 239
 240         } catch (WebColorException $e) {
 241             common_log(LOG_ERR, 'Bad color values in design ID: ' .$design->id);
 242         }
 243
 244         $this->elementEnd('ul');
 245         $this->elementEnd('fieldset');
 246
 247         $this->submit('defaults', _('Use defaults'), 'submit form_action-default',
 248             'defaults', _('Restore default designs'));
 249
 250         $this->element('input', array('id' => 'settings_design_reset',
 251                                      'type' => 'reset',
 252                                      'value' => 'Reset',
 253                                      'class' => 'submit form_action-primary',
 254                                      'title' => _('Reset back to default')));
 255
 256         $this->submit('save', _('Save'), 'submit form_action-secondary',
 257             'save', _('Save design'));
 258
 259         $this->elementEnd('fieldset');
 260         $this->elementEnd('form');
 261     }
 262
 263     /**
 264      * Handle a post
 265      *
 266      * Validate input and save changes. Reload the form with a success
 267      * or error message.
 268      *
 269      * @return void
 270      */
 271
 272     function handlePost()
 273     {
 274         // XXX: Robin's workaround for a bug in PHP where $_POST
 275         // and $_FILE are empty in the case that the uploaded
 276         // file is bigger than PHP is configured to handle.
 277
 278         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 279             if (empty($_POST) && $_SERVER['CONTENT_LENGTH']) {
 280
 281                 $msg = _('The server was unable to handle that much POST ' .
 282                     'data (%s bytes) due to its current configuration.');
 283
 284                 $this->showForm(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
 285             }
 286         }
 287
 288         // CSRF protection
 289         $token = $this->trimmed('token');
 290         if (!$token || $token != common_session_token()) {
 291             $this->showForm(_('There was a problem with your session token. '.
 292                               'Try again, please.'));
 293             return;
 294         }
 295
 296         if ($this->arg('save')) {
 297             $this->saveDesign();
 298         } else if ($this->arg('defaults')) {
 299             $this->restoreDefaults();
 300         } else {
 301             $this->showForm(_('Unexpected form submission.'));
 302         }
 303     }
 304
 305     /**
 306      * Add the Farbtastic stylesheet
 307      *
 308      * @return void
 309      */
 310
 311     function showStylesheets()
 312     {
 313         parent::showStylesheets();
 314         $this->cssLink('css/farbtastic.css','base','screen, projection, tv');
 315     }
 316
 317     /**
 318      * Add the Farbtastic scripts
 319      *
 320      * @return void
 321      */
 322
 323     function showScripts()
 324     {
 325         parent::showScripts();
 326
 327         $this->script('js/farbtastic/farbtastic.js');
 328         $this->script('js/farbtastic/farbtastic.go.js');
 329         $this->script('js/userdesign.go.js');
 330     }
 331
 332     /**
 333      * Get a default design
 334      *
 335      * @return Design design
 336      */
 337
 338     function defaultDesign()
 339     {
 340         $defaults = common_config('site', 'design');
 341
 342         $design = new Design();
 343
 344         try {
 345
 346             $color = new WebColor();
 347
 348             $color->parseColor($defaults['backgroundcolor']);
 349             $design->backgroundcolor = $color->intValue();
 350
 351             $color->parseColor($defaults['contentcolor']);
 352             $design->contentcolor = $color->intValue();
 353
 354             $color->parseColor($defaults['sidebarcolor']);
 355             $design->sidebarcolor = $color->intValue();
 356
 357             $color->parseColor($defaults['textcolor']);
 358             $design->textcolor = $color->intValue();
 359
 360             $color->parseColor($defaults['linkcolor']);
 361             $design->linkcolor = $color->intValue();
 362
 363             $design->backgroundimage = $defaults['backgroundimage'];
 364
 365             $design->disposition = $defaults['disposition'];
 366
 367         } catch (WebColorException $e) {
 368             common_log(LOG_ERR, _('Bad default color settings: ' .
 369                 $e->getMessage()));
 370         }
 371
 372         return $design;
 373     }
 374
 375     /**
 376      * Save the background image, if any, and set its disposition
 377      *
 378      * @param Design $design a working design to attach the img to
 379      *
 380      * @return nothing
 381      */
 382
 383     function saveBackgroundImage($design)
 384     {
 385
 386         // Now that we have a Design ID we can add a file to the design.
 387         // XXX: This is an additional DB hit, but figured having the image
 388         // associated with the Design rather than the User was worth
 389         // it. -- Zach
 390
 391         if ($_FILES['design_background-image_file']['error'] ==
 392             UPLOAD_ERR_OK) {
 393
 394             $filepath = null;
 395
 396             try {
 397                 $imagefile =
 398                     ImageFile::fromUpload('design_background-image_file');
 399             } catch (Exception $e) {
 400                 $this->showForm($e->getMessage());
 401                 return;
 402             }
 403
 404             $filename = Design::filename($design->id,
 405                 image_type_to_extension($imagefile->type),
 406                     common_timestamp());
 407
 408             $filepath = Design::path($filename);
 409
 410             move_uploaded_file($imagefile->filepath, $filepath);
 411
 412             // delete any old backround img laying around
 413
 414             if (isset($design->backgroundimage)) {
 415                 @unlink(Design::path($design->backgroundimage));
 416             }
 417
 418             $original = clone($design);
 419
 420             $design->backgroundimage = $filename;
 421
 422             // default to on, no tile
 423
 424             $design->setDisposition(true, false, false);
 425
 426             $result = $design->update($original);
 427
 428             if ($result === false) {
 429                 common_log_db_error($design, 'UPDATE', __FILE__);
 430                 $this->showForm(_('Couldn\'t update your design.'));
 431                 return;
 432             }
 433         }
 434     }
 435
 436     /**
 437      * Restore the user or group design to system defaults
 438      *
 439      * @return nothing
 440      */
 441
 442     function restoreDefaults()
 443     {
 444         $design   = $this->getWorkingDesign();
 445         $default  = $this->defaultDesign();
 446         $original = clone($design);
 447
 448         $design->backgroundcolor = $default->backgroundcolor;
 449         $design->contentcolor    = $default->contentcolor;
 450         $design->sidebarcolor    = $default->sidebarcolor;
 451         $design->textcolor       = $default->textcolor;
 452         $design->linkcolor       = $default->linkcolor;
 453
 454         $design->setDisposition(false, true, false);
 455
 456         $result = $design->update($original);
 457
 458         if ($result === false) {
 459             common_log_db_error($design, 'UPDATE', __FILE__);
 460             $this->showForm(_('Couldn\'t update your design.'));
 461             return;
 462         }
 463
 464         $this->showForm(_('Design defaults restored.'), true);
 465     }
 466
 467 }