summaryrefslogtreecommitdiff
path: root/actions/designadminpanel.php
blob: e3d772f7d1d18cfbd1fe339176ec5b32698851a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Design administration panel
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Settings
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @author    Zach Copley <zach@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
 * @copyright 2008-2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Administer design settings
 *
 * @category Admin
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @author   Zach Copley <zach@status.net>
 * @author   Sarven Capadisli <csarven@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class DesignadminpanelAction extends AdminPanelAction
{

    /* The default site design */
    var $design = null;

    /**
     * Returns the page title
     *
     * @return string page title
     */

    function title()
    {
        // TRANS: Message used as title for design settings for the site.
        return _('Design');
    }

    /**
     * Instructions for using this form.
     *
     * @return string instructions
     */

    function getInstructions()
    {
        return _('Design settings for this StatusNet site.');
    }

    /**
     * Get the default design and show the design admin panel form
     *
     * @return void
     */

    function showForm()
    {
        $this->design = Design::siteDesign();
        $form = new DesignAdminPanelForm($this);
        $form->show();
        return;
    }

    /**
     * Save settings from the form
     *
     * @return void
     */

    function saveSettings()
    {
        if ($this->arg('save')) {
            $this->saveDesignSettings();
        } else if ($this->arg('defaults')) {
            $this->restoreDefaults();
        } else {
            $this->clientError(_('Unexpected form submission.'));
        }
    }

    /**
     * Save the new design settings
     *
     * @return void
     */

    function saveDesignSettings()
    {
        // Workaround for PHP returning empty $_POST and $_FILES when POST
        // length > post_max_size in php.ini

        if (empty($_FILES)
            && empty($_POST)
            && ($_SERVER['CONTENT_LENGTH'] > 0)
        ) {
            $msg = _('The server was unable to handle that much POST ' .
                'data (%s bytes) due to its current configuration.');
            $this->clientException(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
            return;
        }

        // check for file uploads

        $bgimage = $this->saveBackgroundImage();
        $customTheme = $this->saveCustomTheme();

        $oldtheme = common_config('site', 'theme');
        if ($customTheme) {
            // This feels pretty hacky :D
            $this->args['theme'] = $customTheme;
            $themeChanged = true;
        } else {
            $themeChanged = ($this->trimmed('theme') != $oldtheme);
        }

        static $settings = array('theme', 'logo');

        $values = array();

        foreach ($settings as $setting) {
            $values[$setting] = $this->trimmed($setting);
        }

        $this->validate($values);

        $config = new Config();

        $config->query('BEGIN');

        if ($themeChanged) {
            // If the theme has changed, reset custom colors and let them pick
            // up the new theme's defaults.
            $colors = array('background', 'content', 'sidebar', 'text', 'link');
            foreach ($colors as $colorKey) {
                // Clear from global config so we see defaults on this page...
                $GLOBALS['config']['design'][$colorKey . 'color'] = false;

                // And remove old settings from DB...
                $this->deleteSetting('design', $colorKey . 'color');
            }
        } else {
            // Only save colors from the form if the theme has not changed.
            //
            // @fixme a future more ajaxy form should allow theme switch
            // and color customization in one step.

            $bgcolor = new WebColor($this->trimmed('design_background'));
            $ccolor  = new WebColor($this->trimmed('design_content'));
            $sbcolor = new WebColor($this->trimmed('design_sidebar'));
            $tcolor  = new WebColor($this->trimmed('design_text'));
            $lcolor  = new WebColor($this->trimmed('design_links'));

            Config::save('design', 'backgroundcolor', $bgcolor->intValue());
            Config::save('design', 'contentcolor', $ccolor->intValue());
            Config::save('design', 'sidebarcolor', $sbcolor->intValue());
            Config::save('design', 'textcolor', $tcolor->intValue());
            Config::save('design', 'linkcolor', $lcolor->intValue());
        }

        $onoff = $this->arg('design_background-image_onoff');

        $on   = false;
        $off  = false;

        if ($onoff == 'on') {
            $on = true;
        } else {
            $off = true;
        }

        $tile = $this->boolean('design_background-image_repeat');

        // Hack to use Design's bit setter
        $scratch = new Design();
        $scratch->setDisposition($on, $off, $tile);

        Config::save('design', 'disposition', $scratch->disposition);

        foreach ($settings as $setting) {
            Config::save('site', $setting, $values[$setting]);
        }

        if (isset($bgimage)) {
            Config::save('design', 'backgroundimage', $bgimage);
        }

        if (common_config('custom_css', 'enabled')) {
            $css = $this->arg('css');
            if ($css != common_config('custom_css', 'css')) {
                Config::save('custom_css', 'css', $css);
            }
        }

        $config->query('COMMIT');
    }

    /**
      * Restore the default design
      *
      * @return void
      */

    function restoreDefaults()
    {
        $this->deleteSetting('site', 'logo');
        $this->deleteSetting('site', 'theme');

        $settings = array(
            'theme', 'backgroundimage', 'backgroundcolor', 'contentcolor',
            'sidebarcolor', 'textcolor', 'linkcolor', 'disposition'
        );

        foreach ($settings as $setting) {
            $this->deleteSetting('design', $setting);
        }

        // XXX: Should we restore the default dir settings, etc.? --Z

        // XXX: I can't get it to show the new settings without forcing
        // this terrible reload -- FIX ME!
        common_redirect(common_local_url('designadminpanel'), 303);
    }

    /**
     * Save the background image if the user uploaded one
     *
     * @return string $filename the filename of the image
     */

    function saveBackgroundImage()
    {
        $filename = null;

        if ($_FILES['design_background-image_file']['error'] ==
            UPLOAD_ERR_OK) {

            $filepath = null;

            try {
                $imagefile =
                    ImageFile::fromUpload('design_background-image_file');
            } catch (Exception $e) {
                $this->clientError('Unable to save background image.');
                return;
            }

            // Note: site design background image has a special filename

            $filename = Design::filename('site-design-background',
                image_type_to_extension($imagefile->type),
                    common_timestamp());

            $filepath = Design::path($filename);

            move_uploaded_file($imagefile->filepath, $filepath);

            // delete any old backround img laying around

            if (isset($this->design->backgroundimage)) {
                @unlink(Design::path($design->backgroundimage));
            }

            return $filename;
        }
    }

    /**
     * Save the custom theme if the user uploaded one.
     * 
     * @return mixed custom theme name, if succesful, or null if no theme upload.
     * @throws ClientException for invalid theme archives
     * @throws ServerException if trouble saving the theme files
     */

    function saveCustomTheme()
    {
        if (common_config('theme_upload', 'enabled') &&
            $_FILES['design_upload_theme']['error'] == UPLOAD_ERR_OK) {

            $upload = ThemeUploader::fromUpload('design_upload_theme');
            $basedir = common_config('local', 'dir');
            if (empty($basedir)) {
                $basedir = INSTALLDIR . '/local';
            }
            $name = 'custom'; // @todo allow multiples, custom naming?
            $outdir = $basedir . '/theme/' . $name;
            $upload->extract($outdir);
            return $name;
        } else {
            return null;
        }
    }

    /**
     * Attempt to validate setting values
     *
     * @return void
     */

    function validate(&$values)
    {
        if (!empty($values['logo']) &&
            !Validate::uri($values['logo'], array('allowed_schemes' => array('http', 'https')))) {
            $this->clientError(_('Invalid logo URL.'));
        }

        if (!in_array($values['theme'], Theme::listAvailable())) {
            $this->clientError(sprintf(_("Theme not available: %s."), $values['theme']));
        }
    }

    /**
     * Add the Farbtastic stylesheet
     *
     * @return void
     */

    function showStylesheets()
    {
        parent::showStylesheets();
        $this->cssLink('js/farbtastic/farbtastic.css',null,'screen, projection, tv');
    }

    /**
     * Add the Farbtastic scripts
     *
     * @return void
     */

    function showScripts()
    {
        parent::showScripts();

        $this->script('farbtastic/farbtastic.js');
        $this->script('userdesign.go.js');

        $this->autofocus('design_background-image_file');
    }

}

class DesignAdminPanelForm extends AdminForm
{

    /**
     * ID of the form
     *
     * @return int ID of the form
     */

    function id()
    {
        return 'form_design_admin_panel';
    }

    /**
     * class of the form
     *
     * @return string class of the form
     */

    function formClass()
    {
        return 'form_settings';
    }

    /**
     * HTTP method used to submit the form
     *
     * For image data we need to send multipart/form-data
     * so we set that here too
     *
     * @return string the method to use for submitting
     */

    function method()
    {
        $this->enctype = 'multipart/form-data';

        return 'post';
    }

    /**
     * Action of the form
     *
     * @return string URL of the action
     */

    function action()
    {
        return common_local_url('designadminpanel');
    }

    /**
     * Data elements of the form
     *
     * @return void
     */

    function formData()
    {
        $this->showLogo();
        $this->showTheme();
        $this->showBackground();
        $this->showColors();
        $this->showAdvanced();
    }

    function showLogo()
    {
        $this->out->elementStart('fieldset', array('id' => 'settings_design_logo'));
        $this->out->element('legend', null, _('Change logo'));

        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->input('logo', _('Site logo'), 'Logo for the site (full URL)');
        $this->unli();

        $this->out->elementEnd('ul');

        $this->out->elementEnd('fieldset');

    }

    function showTheme()
    {
        $this->out->elementStart('fieldset', array('id' => 'settings_design_theme'));
        $this->out->element('legend', null, _('Change theme'));

        $this->out->elementStart('ul', 'form_data');

        $themes = Theme::listAvailable();

        // XXX: listAvailable() can return an empty list if you
        // screw up your settings, so just in case:

        if (empty($themes)) {
            $themes = array('default', 'default');
        }

        asort($themes);
        $themes = array_combine($themes, $themes);

        $this->li();
        $this->out->dropdown('theme', _('Site theme'),
                             $themes, _('Theme for the site.'),
                             false, $this->value('theme'));
        $this->unli();

        if (common_config('theme_upload', 'enabled')) {
            $this->li();
            $this->out->element('label', array('for' => 'design_upload_theme'), _('Custom theme'));
            $this->out->element('input', array('id' => 'design_upload_theme',
                                               'name' => 'design_upload_theme',
                                               'type' => 'file'));
            $this->out->element('p', 'form_guide', _('You can upload a custom StatusNet theme as a .ZIP archive.'));
            $this->unli();
        }

        $this->out->elementEnd('ul');

        $this->out->elementEnd('fieldset');
    }

    function showBackground()
    {
        $design = $this->out->design;

        $this->out->elementStart('fieldset', array('id' =>
            'settings_design_background-image'));
        $this->out->element('legend', null, _('Change background image'));
        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->out->element('label', array('for' => 'design_background-image_file'),
                                _('Background'));
        $this->out->element('input', array('name' => 'design_background-image_file',
                                     'type' => 'file',
                                     'id' => 'design_background-image_file'));
        $this->out->element('p', 'form_guide',
            sprintf(_('You can upload a background image for the site. ' .
              'The maximum file size is %1$s.'), ImageFile::maxFileSize()));
        $this->out->element('input', array('name' => 'MAX_FILE_SIZE',
                                          'type' => 'hidden',
                                          'id' => 'MAX_FILE_SIZE',
                                          'value' => ImageFile::maxFileSizeInt()));
        $this->unli();

        if (!empty($design->backgroundimage)) {

            $this->out->elementStart('li', array('id' =>
                'design_background-image_onoff'));

            $this->out->element('img', array('src' =>
                Design::url($design->backgroundimage)));

            $attrs = array('name' => 'design_background-image_onoff',
                           'type' => 'radio',
                           'id' => 'design_background-image_on',
                           'class' => 'radio',
                           'value' => 'on');

            if ($design->disposition & BACKGROUND_ON) {
                $attrs['checked'] = 'checked';
            }

            $this->out->element('input', $attrs);

            $this->out->element('label', array('for' => 'design_background-image_on',
                                          'class' => 'radio'),
                                          // TRANS: Used as radio button label to add a background image.
                                          _('On'));

            $attrs = array('name' => 'design_background-image_onoff',
                           'type' => 'radio',
                           'id' => 'design_background-image_off',
                           'class' => 'radio',
                           'value' => 'off');

            if ($design->disposition & BACKGROUND_OFF) {
                $attrs['checked'] = 'checked';
            }

            $this->out->element('input', $attrs);

            $this->out->element('label', array('for' => 'design_background-image_off',
                                          'class' => 'radio'),
                                          // TRANS: Used as radio button label to not add a background image.
                                          _('Off'));
            $this->out->element('p', 'form_guide', _('Turn background image on or off.'));
            $this->unli();

            $this->li();
            $this->out->checkbox('design_background-image_repeat',
                            _('Tile background image'),
                            ($design->disposition & BACKGROUND_TILE) ? true : false);
            $this->unli();
        }

        $this->out->elementEnd('ul');
        $this->out->elementEnd('fieldset');
    }

    function showColors()
    {
        $design = $this->out->design;

        $this->out->elementStart('fieldset', array('id' => 'settings_design_color'));
        $this->out->element('legend', null, _('Change colours'));

        $this->out->elementStart('ul', 'form_data');

        try {
            // @fixme avoid loop unrolling in non-performance-critical contexts like this

            $bgcolor = new WebColor($design->backgroundcolor);

            $this->li();
            $this->out->element('label', array('for' => 'swatch-1'), _('Background'));
            $this->out->element('input', array('name' => 'design_background',
                                          'type' => 'text',
                                          'id' => 'swatch-1',
                                          'class' => 'swatch',
                                          'maxlength' => '7',
                                          'size' => '7',
                                          'value' => ''));
            $this->unli();

            $ccolor = new WebColor($design->contentcolor);

            $this->li();
            $this->out->element('label', array('for' => 'swatch-2'), _('Content'));
            $this->out->element('input', array('name' => 'design_content',
                                          'type' => 'text',
                                          'id' => 'swatch-2',
                                          'class' => 'swatch',
                                          'maxlength' => '7',
                                          'size' => '7',
                                          'value' => ''));
            $this->unli();

            $sbcolor = new WebColor($design->sidebarcolor);

            $this->li();
            $this->out->element('label', array('for' => 'swatch-3'), _('Sidebar'));
            $this->out->element('input', array('name' => 'design_sidebar',
                                        'type' => 'text',
                                        'id' => 'swatch-3',
                                        'class' => 'swatch',
                                        'maxlength' => '7',
                                        'size' => '7',
                                        'value' => ''));
            $this->unli();

            $tcolor = new WebColor($design->textcolor);

            $this->li();
            $this->out->element('label', array('for' => 'swatch-4'), _('Text'));
            $this->out->element('input', array('name' => 'design_text',
                                        'type' => 'text',
                                        'id' => 'swatch-4',
                                        'class' => 'swatch',
                                        'maxlength' => '7',
                                        'size' => '7',
                                        'value' => ''));
            $this->unli();

            $lcolor = new WebColor($design->linkcolor);

            $this->li();
            $this->out->element('label', array('for' => 'swatch-5'), _('Links'));
            $this->out->element('input', array('name' => 'design_links',
                                         'type' => 'text',
                                         'id' => 'swatch-5',
                                         'class' => 'swatch',
                                         'maxlength' => '7',
                                         'size' => '7',
                                         'value' => ''));
            $this->unli();

        } catch (WebColorException $e) {
            // @fixme normalize them individually!
            common_log(LOG_ERR, 'Bad color values in site design: ' .
                $e->getMessage());
        }

        $this->out->elementEnd('fieldset');

        $this->out->elementEnd('ul');
    }

    function showAdvanced()
    {
        if (common_config('custom_css', 'enabled')) {
            $this->out->elementStart('fieldset', array('id' => 'settings_design_advanced'));
            $this->out->element('legend', null, _('Advanced'));
            $this->out->elementStart('ul', 'form_data');

            $this->li();
            $this->out->element('label', array('for' => 'css'), _('Custom CSS'));
            $this->out->element('textarea', array('name' => 'css',
                                            'id' => 'css',
                                            'cols' => '50',
                                            'rows' => '10'),
                                strval(common_config('custom_css', 'css')));
            $this->unli();

            $this->out->elementEnd('fieldset');
            $this->out->elementEnd('ul');
        }
    }

    /**
     * Action elements
     *
     * @return void
     */

    function formActions()
    {
        $this->out->submit('defaults', _('Use defaults'), 'submit form_action-default',
                'defaults', _('Restore default designs'));

        $this->out->element('input', array('id' => 'settings_design_reset',
                                         'type' => 'reset',
                                         'value' => 'Reset',
                                         'class' => 'submit form_action-primary',
                                         'title' => _('Reset back to default')));

        $this->out->submit('save', _('Save'), 'submit form_action-secondary',
                'save', _('Save design'));
    }

}