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
62 // TRANS: Message used as title for design settings for the site.
67 * Instructions for using this form.
69 * @return string instructions
72 function getInstructions()
74 return _('Design settings for this StatusNet site.');
78 * Get the default design and show the design admin panel form
85 $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->clientError(_('Unexpected form submission.'));
109 * Save the new design settings
114 function saveDesignSettings()
116 // Workaround for PHP returning empty $_POST and $_FILES when POST
117 // length > post_max_size in php.ini
121 && ($_SERVER['CONTENT_LENGTH'] > 0)
123 $msg = _('The server was unable to handle that much POST ' .
124 'data (%s bytes) due to its current configuration.');
125 $this->clientException(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
129 // check for an image upload
131 $bgimage = $this->saveBackgroundImage();
133 static $settings = array('theme', 'logo');
137 foreach ($settings as $setting) {
138 $values[$setting] = $this->trimmed($setting);
141 $this->validate($values);
143 $oldtheme = common_config('site', 'theme');
145 $config = new Config();
147 $config->query('BEGIN');
149 // Only update colors if the theme has not changed.
151 if ($oldtheme == $values['theme']) {
153 $bgcolor = new WebColor($this->trimmed('design_background'));
154 $ccolor = new WebColor($this->trimmed('design_content'));
155 $sbcolor = new WebColor($this->trimmed('design_sidebar'));
156 $tcolor = new WebColor($this->trimmed('design_text'));
157 $lcolor = new WebColor($this->trimmed('design_links'));
159 Config::save('design', 'backgroundcolor', $bgcolor->intValue());
160 Config::save('design', 'contentcolor', $ccolor->intValue());
161 Config::save('design', 'sidebarcolor', $sbcolor->intValue());
162 Config::save('design', 'textcolor', $tcolor->intValue());
163 Config::save('design', 'linkcolor', $lcolor->intValue());
166 $onoff = $this->arg('design_background-image_onoff');
171 if ($onoff == 'on') {
177 $tile = $this->boolean('design_background-image_repeat');
179 // Hack to use Design's bit setter
180 $scratch = new Design();
181 $scratch->setDisposition($on, $off, $tile);
183 Config::save('design', 'disposition', $scratch->disposition);
185 foreach ($settings as $setting) {
186 Config::save('site', $setting, $values[$setting]);
189 if (isset($bgimage)) {
190 Config::save('design', 'backgroundimage', $bgimage);
193 $config->query('COMMIT');
197 * Restore the default design
202 function restoreDefaults()
204 $this->deleteSetting('site', 'logo');
205 $this->deleteSetting('site', 'theme');
208 'theme', 'backgroundimage', 'backgroundcolor', 'contentcolor',
209 'sidebarcolor', 'textcolor', 'linkcolor', 'disposition'
212 foreach ($settings as $setting) {
213 $this->deleteSetting('design', $setting);
216 // XXX: Should we restore the default dir settings, etc.? --Z
218 // XXX: I can't get it to show the new settings without forcing
219 // this terrible reload -- FIX ME!
220 common_redirect(common_local_url('designadminpanel'), 303);
224 * Save the background image if the user uploaded one
226 * @return string $filename the filename of the image
229 function saveBackgroundImage()
233 if ($_FILES['design_background-image_file']['error'] ==
240 ImageFile::fromUpload('design_background-image_file');
241 } catch (Exception $e) {
242 $this->clientError('Unable to save background image.');
246 // Note: site design background image has a special filename
248 $filename = Design::filename('site-design-background',
249 image_type_to_extension($imagefile->type),
252 $filepath = Design::path($filename);
254 move_uploaded_file($imagefile->filepath, $filepath);
256 // delete any old backround img laying around
258 if (isset($this->design->backgroundimage)) {
259 @unlink(Design::path($design->backgroundimage));
267 * Attempt to validate setting values
272 function validate(&$values)
274 if (!empty($values['logo']) &&
275 !Validate::uri($values['logo'], array('allowed_schemes' => array('http', 'https')))) {
276 $this->clientError(_('Invalid logo URL.'));
279 if (!in_array($values['theme'], Theme::listAvailable())) {
280 $this->clientError(sprintf(_("Theme not available: %s."), $values['theme']));
285 * Add the Farbtastic stylesheet
290 function showStylesheets()
292 parent::showStylesheets();
293 $this->cssLink('js/farbtastic/farbtastic.css',null,'screen, projection, tv');
297 * Add the Farbtastic scripts
302 function showScripts()
304 parent::showScripts();
306 $this->script('farbtastic/farbtastic.js');
307 $this->script('userdesign.go.js');
309 $this->autofocus('design_background-image_file');
314 class DesignAdminPanelForm extends AdminForm
320 * @return int ID of the form
325 return 'form_design_admin_panel';
331 * @return string class of the form
336 return 'form_settings';
340 * HTTP method used to submit the form
342 * For image data we need to send multipart/form-data
343 * so we set that here too
345 * @return string the method to use for submitting
350 $this->enctype = 'multipart/form-data';
358 * @return string URL of the action
363 return common_local_url('designadminpanel');
367 * Data elements of the form
375 $this->out->elementStart('fieldset', array('id' => 'settings_design_logo'));
376 $this->out->element('legend', null, _('Change logo'));
378 $this->out->elementStart('ul', 'form_data');
381 $this->input('logo', _('Site logo'), 'Logo for the site (full URL)');
384 $this->out->elementEnd('ul');
386 $this->out->elementEnd('fieldset');
387 $this->out->elementStart('fieldset', array('id' => 'settings_design_theme'));
388 $this->out->element('legend', null, _('Change theme'));
390 $this->out->elementStart('ul', 'form_data');
392 $themes = Theme::listAvailable();
394 // XXX: listAvailable() can return an empty list if you
395 // screw up your settings, so just in case:
397 if (empty($themes)) {
398 $themes = array('default', 'default');
402 $themes = array_combine($themes, $themes);
405 $this->out->dropdown('theme', _('Site theme'),
406 $themes, _('Theme for the site.'),
407 false, $this->value('theme'));
410 $this->out->elementEnd('ul');
412 $this->out->elementEnd('fieldset');
414 $design = $this->out->design;
416 $this->out->elementStart('fieldset', array('id' =>
417 'settings_design_background-image'));
418 $this->out->element('legend', null, _('Change background image'));
419 $this->out->elementStart('ul', 'form_data');
422 $this->out->element('label', array('for' => 'design_background-image_file'),
424 $this->out->element('input', array('name' => 'design_background-image_file',
426 'id' => 'design_background-image_file'));
427 $this->out->element('p', 'form_guide',
428 sprintf(_('You can upload a background image for the site. ' .
429 'The maximum file size is %1$s.'), ImageFile::maxFileSize()));
430 $this->out->element('input', array('name' => 'MAX_FILE_SIZE',
432 'id' => 'MAX_FILE_SIZE',
433 'value' => ImageFile::maxFileSizeInt()));
436 if (!empty($design->backgroundimage)) {
438 $this->out->elementStart('li', array('id' =>
439 'design_background-image_onoff'));
441 $this->out->element('img', array('src' =>
442 Design::url($design->backgroundimage)));
444 $attrs = array('name' => 'design_background-image_onoff',
446 'id' => 'design_background-image_on',
450 if ($design->disposition & BACKGROUND_ON) {
451 $attrs['checked'] = 'checked';
454 $this->out->element('input', $attrs);
456 $this->out->element('label', array('for' => 'design_background-image_on',
458 // TRANS: Used as radio button label to add a background image.
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',
475 // TRANS: Used as radio button label to not add a background image.
477 $this->out->element('p', 'form_guide', _('Turn background image on or off.'));
481 $this->out->checkbox('design_background-image_repeat',
482 _('Tile background image'),
483 ($design->disposition & BACKGROUND_TILE) ? true : false);
487 $this->out->elementEnd('ul');
488 $this->out->elementEnd('fieldset');
490 $this->out->elementStart('fieldset', array('id' => 'settings_design_color'));
491 $this->out->element('legend', null, _('Change colours'));
493 $this->out->elementStart('ul', 'form_data');
497 $bgcolor = new WebColor($design->backgroundcolor);
500 $this->out->element('label', array('for' => 'swatch-1'), _('Background'));
501 $this->out->element('input', array('name' => 'design_background',
510 $ccolor = new WebColor($design->contentcolor);
513 $this->out->element('label', array('for' => 'swatch-2'), _('Content'));
514 $this->out->element('input', array('name' => 'design_content',
523 $sbcolor = new WebColor($design->sidebarcolor);
526 $this->out->element('label', array('for' => 'swatch-3'), _('Sidebar'));
527 $this->out->element('input', array('name' => 'design_sidebar',
536 $tcolor = new WebColor($design->textcolor);
539 $this->out->element('label', array('for' => 'swatch-4'), _('Text'));
540 $this->out->element('input', array('name' => 'design_text',
549 $lcolor = new WebColor($design->linkcolor);
552 $this->out->element('label', array('for' => 'swatch-5'), _('Links'));
553 $this->out->element('input', array('name' => 'design_links',
562 } catch (WebColorException $e) {
563 common_log(LOG_ERR, 'Bad color values in site design: ' .
567 $this->out->elementEnd('fieldset');
569 $this->out->elementEnd('ul');
578 function formActions()
580 $this->out->submit('defaults', _('Use defaults'), 'submit form_action-default',
581 'defaults', _('Restore default designs'));
583 $this->out->element('input', array('id' => 'settings_design_reset',
586 'class' => 'submit form_action-primary',
587 'title' => _('Reset back to default')));
589 $this->out->submit('save', _('Save'), 'submit form_action-secondary',
590 'save', _('Save design'));