3 * StatusNet, the distributed open-source microblogging tool
5 * Design administration panel
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.
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.
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/>.
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/
32 if (!defined('STATUSNET')) {
37 * Administer design settings
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/
48 class DesignadminpanelAction extends AdminPanelAction
51 /* The default site design */
55 * Returns the page title
57 * @return string page title
66 * Instructions for using this form.
68 * @return string instructions
71 function getInstructions()
73 return _('Design settings for this StatusNet site.');
77 * Show the site admin panel form
84 $this->design = Design::siteDesign();
86 $form = new DesignAdminPanelForm($this);
92 * Save settings from the form
97 function saveSettings()
99 if ($this->arg('save')) {
100 $this->saveDesignSettings();
101 } else if ($this->arg('defaults')) {
102 $this->restoreDefaults();
104 $this->success = false;
105 $this->message = 'Unexpected form submission.';
110 * Save the new design settings
115 function saveDesignSettings()
118 // Workaround for PHP returning empty $_POST and $_FILES when POST
119 // length > post_max_size in php.ini
123 && ($_SERVER['CONTENT_LENGTH'] > 0)
125 $msg = _('The server was unable to handle that much POST ' .
126 'data (%s bytes) due to its current configuration.');
127 $this->success = false;
128 $this->msg = $e->getMessage(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
132 // check for an image upload
134 $bgimage = $this->saveBackgroundImage();
136 static $settings = array('theme');
139 foreach ($settings as $setting) {
140 $values[$setting] = $this->trimmed($setting);
143 // This throws an exception on validation errors
145 $bgcolor = new WebColor($this->trimmed('design_background'));
146 $ccolor = new WebColor($this->trimmed('design_content'));
147 $sbcolor = new WebColor($this->trimmed('design_sidebar'));
148 $tcolor = new WebColor($this->trimmed('design_text'));
149 $lcolor = new WebColor($this->trimmed('design_links'));
150 } catch (WebColorException $e) {
151 $this->success = false;
152 $this->msg = $e->getMessage();
156 $onoff = $this->arg('design_background-image_onoff');
161 if ($onoff == 'on') {
167 $tile = $this->boolean('design_background-image_repeat');
169 $this->validate($values);
171 // assert(all values are valid);
173 $config = new Config();
175 $config->query('BEGIN');
177 foreach ($settings as $setting) {
178 Config::save('site', $setting, $values[$setting]);
181 if (isset($bgimage)) {
182 Config::save('design', 'backgroundimage', $bgimage);
185 Config::save('design', 'backgroundcolor', $bgcolor->intValue());
186 Config::save('design', 'contentcolor', $ccolor->intValue());
187 Config::save('design', 'sidebarcolor', $sbcolor->intValue());
188 Config::save('design', 'textcolor', $tcolor->intValue());
189 Config::save('design', 'linkcolor', $lcolor->intValue());
191 // Hack to use Design's bit setter
192 $scratch = new Design();
193 $scratch->setDisposition($on, $off, $tile);
195 Config::save('design', 'disposition', $scratch->disposition);
197 $config->query('COMMIT');
204 * Delete a design setting
206 * @return mixed $result false if something didn't work
209 function deleteSetting($section, $setting)
211 $config = new Config();
213 $config->section = $section;
214 $config->setting = $setting;
216 if ($config->find(true)) {
217 $result = $config->delete();
219 common_log_db_error($config, 'DELETE', __FILE__);
220 $this->clientError(_("Unable to delete design setting."));
229 * Restore the default design
234 function restoreDefaults()
236 $this->deleteSetting('site', 'theme');
239 'theme', 'backgroundimage', 'backgroundcolor', 'contentcolor',
240 'sidebarcolor', 'textcolor', 'linkcolor', 'disposition'
243 foreach ($settings as $setting) {
244 $this->deleteSetting('design', $setting);
249 * Save the background image if the user uploaded one
251 * @return string $filename the filename of the image
254 function saveBackgroundImage()
258 if ($_FILES['design_background-image_file']['error'] ==
265 ImageFile::fromUpload('design_background-image_file');
266 } catch (Exception $e) {
267 $this->success = false;
268 $this->msg = $e->getMessage();
272 // Note: site design background image has a special filename
274 $filename = Design::filename('site-design-background',
275 image_type_to_extension($imagefile->type),
278 $filepath = Design::path($filename);
280 move_uploaded_file($imagefile->filepath, $filepath);
282 // delete any old backround img laying around
284 if (isset($this->design->backgroundimage)) {
285 @unlink(Design::path($design->backgroundimage));
293 * Attempt to validate setting values
298 function validate(&$values)
300 if (!in_array($values['theme'], Theme::listAvailable())) {
301 $this->clientError(sprintf(_("Theme not available: %s"), $values['theme']));
306 * Add the Farbtastic stylesheet
311 function showStylesheets()
313 parent::showStylesheets();
314 $this->cssLink('css/farbtastic.css','base','screen, projection, tv');
318 * Add the Farbtastic scripts
323 function showScripts()
325 parent::showScripts();
327 $this->script('js/farbtastic/farbtastic.js');
328 $this->script('js/userdesign.go.js');
330 $this->autofocus('design_background-image_file');
335 class DesignAdminPanelForm extends Form
341 * @return int ID of the form
346 return 'form_design_admin_panel';
352 * @return string class of the form
357 return 'form_settings';
361 * HTTP method used to submit the form
363 * For image data we need to send multipart/form-data
364 * so we set that here too
366 * @return string the method to use for submitting
371 $this->enctype = 'multipart/form-data';
379 * @return string URL of the action
384 return common_local_url('designadminpanel');
388 * Data elements of the form
396 $design = $this->out->design;
398 $themes = Theme::listAvailable();
402 $themes = array_combine($themes, $themes);
404 $this->out->elementStart('fieldset', array('id' =>
405 'settings_design_theme'));
406 $this->out->element('legend', null, _('Change theme'));
407 $this->out->elementStart('ul', 'form_data');
409 $this->out->elementStart('li');
410 $this->out->dropdown('theme', _('Theme'),
411 $themes, _('Theme for the site.'),
412 false, $this->value('theme'));
413 $this->out->elementEnd('li');
414 $this->out->elementEnd('ul');
415 $this->out->elementEnd('fieldset');
418 $this->out->elementStart('fieldset', array('id' =>
419 'settings_design_background-image'));
420 $this->out->element('legend', null, _('Change background image'));
421 $this->out->elementStart('ul', 'form_data');
422 $this->out->elementStart('li');
423 $this->out->element('label', array('for' => 'design_background-image_file'),
425 $this->out->element('input', array('name' => 'design_background-image_file',
427 'id' => 'design_background-image_file'));
428 $this->out->element('p', 'form_guide',
429 sprintf(_('You can upload a background image for the site. ' .
430 'The maximum file size is %1$s.'), ImageFile::maxFileSize()));
431 $this->out->element('input', array('name' => 'MAX_FILE_SIZE',
433 'id' => 'MAX_FILE_SIZE',
434 'value' => ImageFile::maxFileSizeInt()));
435 $this->out->elementEnd('li');
437 if (!empty($design->backgroundimage)) {
439 $this->out->elementStart('li', array('id' =>
440 'design_background-image_onoff'));
442 $this->out->element('img', array('src' =>
443 Design::url($design->backgroundimage)));
445 $attrs = array('name' => 'design_background-image_onoff',
447 'id' => 'design_background-image_on',
451 if ($design->disposition & BACKGROUND_ON) {
452 $attrs['checked'] = 'checked';
455 $this->out->element('input', $attrs);
457 $this->out->element('label', array('for' => 'design_background-image_on',
461 $attrs = array('name' => 'design_background-image_onoff',
463 'id' => 'design_background-image_off',
467 if ($design->disposition & BACKGROUND_OFF) {
468 $attrs['checked'] = 'checked';
471 $this->out->element('input', $attrs);
473 $this->out->element('label', array('for' => 'design_background-image_off',
476 $this->out->element('p', 'form_guide', _('Turn background image on or off.'));
477 $this->out->elementEnd('li');
479 $this->out->elementStart('li');
480 $this->out->checkbox('design_background-image_repeat',
481 _('Tile background image'),
482 ($design->disposition & BACKGROUND_TILE) ? true : false);
483 $this->out->elementEnd('li');
486 $this->out->elementEnd('ul');
487 $this->out->elementEnd('fieldset');
489 $this->out->elementStart('fieldset', array('id' => 'settings_design_color'));
490 $this->out->element('legend', null, _('Change colours'));
491 $this->out->elementStart('ul', 'form_data');
495 $bgcolor = new WebColor($design->backgroundcolor);
497 $this->out->elementStart('li');
498 $this->out->element('label', array('for' => 'swatch-1'), _('Background'));
499 $this->out->element('input', array('name' => 'design_background',
506 $this->out->elementEnd('li');
508 $ccolor = new WebColor($design->contentcolor);
510 $this->out->elementStart('li');
511 $this->out->element('label', array('for' => 'swatch-2'), _('Content'));
512 $this->out->element('input', array('name' => 'design_content',
519 $this->out->elementEnd('li');
521 $sbcolor = new WebColor($design->sidebarcolor);
523 $this->out->elementStart('li');
524 $this->out->element('label', array('for' => 'swatch-3'), _('Sidebar'));
525 $this->out->element('input', array('name' => 'design_sidebar',
532 $this->out->elementEnd('li');
534 $tcolor = new WebColor($design->textcolor);
536 $this->out->elementStart('li');
537 $this->out->element('label', array('for' => 'swatch-4'), _('Text'));
538 $this->out->element('input', array('name' => 'design_text',
545 $this->out->elementEnd('li');
547 $lcolor = new WebColor($design->linkcolor);
549 $this->out->elementStart('li');
550 $this->out->element('label', array('for' => 'swatch-5'), _('Links'));
551 $this->out->element('input', array('name' => 'design_links',
558 $this->out->elementEnd('li');
560 } catch (WebColorException $e) {
561 common_log(LOG_ERR, 'Bad color values in site design: ' .
565 $this->out->elementEnd('ul');
566 $this->out->elementEnd('fieldset');
571 * Utility to simplify some of the duplicated code around
572 * params and settings.
574 * @param string $setting Name of the setting
575 * @param string $title Title to use for the input
576 * @param string $instructions Instructions for this field
581 function input($setting, $title, $instructions)
583 $this->out->input($setting, $title, $this->value($setting), $instructions);
587 * Utility to simplify getting the posted-or-stored setting value
589 * @param string $setting Name of the setting
591 * @return string param value if posted, or current config value
594 function value($setting)
596 $value = $this->out->trimmed($setting);
598 $value = common_config('site', $setting);
609 function formActions()
611 $this->out->submit('defaults', _('Use defaults'), 'submit form_action-default',
612 'defaults', _('Restore default designs'));
614 $this->out->element('input', array('id' => 'settings_design_reset',
617 'class' => 'submit form_action-primary',
618 'title' => _('Reset back to default')));
620 $this->out->submit('save', _('Save'), 'submit form_action-secondary',
621 'save', _('Save design')); }