summaryrefslogtreecommitdiff
path: root/actions/pathsadminpanel.php
blob: c6daa173456dd24b80d153e90ee391adf502b11d (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
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Paths 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);
}

/**
 * Paths 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 PathsadminpanelAction extends AdminPanelAction
{

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

    function title()
    {
        return _('Paths');
    }

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

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

    /**
     * Show the paths admin panel form
     *
     * @return void
     */

    function showForm()
    {
        $form = new PathsAdminPanelForm($this);
        $form->show();
        return;
    }

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

    function saveSettings()
    {
        static $settings = array(
            'site' => array('path', 'locale_path', 'ssl', 'sslserver'),
            'theme' => array('server', 'dir', 'path'),
            'avatar' => array('server', 'dir', 'path'),
            'background' => array('server', 'dir', 'path')
        );

        $values = array();

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

        $this->validate($values);

        // assert(all values are valid);

        $config = new Config();

        $config->query('BEGIN');

        foreach ($settings as $section => $parts) {
            foreach ($parts as $setting) {
                Config::save($section, $setting, $values[$section][$setting]);
            }
        }

        $config->query('COMMIT');

        return;
    }

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

    function validate(&$values)
    {

        // Validate theme dir

        if (!empty($values['theme']['dir']) && !is_readable($values['theme']['dir'])) {
            $this->clientError(sprintf(_("Theme directory not readable: %s"), $values['theme']['dir']));
        }

        // Validate avatar dir

        if (empty($values['avatar']['dir']) || !is_writable($values['avatar']['dir'])) {
            $this->clientError(sprintf(_("Avatar directory not writable: %s"), $values['avatar']['dir']));
        }

        // Validate background dir

        if (empty($values['background']['dir']) || !is_writable($values['background']['dir'])) {
            $this->clientError(sprintf(_("Background directory not writable: %s"), $values['background']['dir']));
        }

        // Validate locales dir

        // XXX: What else do we need to validate for lacales path here? --Z

        if (!empty($values['site']['locale_path']) && !is_readable($values['site']['locale_path'])) {
            $this->clientError(sprintf(_("Locales directory not readable: %s"), $values['site']['locale_path']));
        }

        // Validate SSL setup

        if (in_array($values['site']['ssl'], array('sometimes', 'always'))) {
            if (empty($values['site']['sslserver'])) {
                $this->clientError(_("You must set an SSL server when enabling SSL."));
            }
        }

    }

}

class PathsAdminPanelForm extends AdminForm
{

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

    function id()
    {
        return 'form_paths_admin_panel';
    }

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

    function formClass()
    {
        return 'form_settings';
    }

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

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

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

    function formData()
    {
        $this->out->elementStart('fieldset', array('id' => 'settings_paths_locale'));
        $this->out->element('legend', null, _('Site'), 'site');
        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->input('path', _('Path'), _('Site path'));
        $this->unli();

        $this->li();
        $this->input('locale_path', _('Path to locales'), _('Directory path to locales'), 'site');
        $this->unli();

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

        $this->out->elementStart('fieldset', array('id' => 'settings_paths_theme'));
        $this->out->element('legend', null, _('Theme'));

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

        $this->li();
        $this->input('server', _('Theme server'), 'Server for themes', 'theme');
        $this->unli();

        $this->li();
        $this->input('path', _('Theme path'), 'Web path to themes', 'theme');
        $this->unli();

        $this->li();
        $this->input('dir', _('Theme directory'), 'Directory where themes are located', 'theme');
        $this->unli();

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

        $this->out->elementEnd('fieldset');
        $this->out->elementStart('fieldset', array('id' => 'settings_avatar-paths'));
        $this->out->element('legend', null, _('Avatars'));

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

        $this->li();
        $this->input('server', _('Avatar server'), 'Server for avatars', 'avatar');
        $this->unli();

        $this->li();
        $this->input('path', _('Avatar path'), 'Web path to avatars', 'avatar');
        $this->unli();

        $this->li();
        $this->input('dir', _('Avatar directory'), 'Directory where avatars are located', 'avatar');
        $this->unli();

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

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

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

        $this->li();
        $this->input('server', _('Background server'), 'Server for backgrounds', 'background');
        $this->unli();

        $this->li();
        $this->input('path', _('Background path'), 'Web path to backgrounds', 'background');
        $this->unli();

        $this->li();
        $this->input('dir', _('Background directory'), 'Directory where backgrounds are located', 'background');
        $this->unli();

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

        $this->out->elementStart('fieldset', array('id' => 'settings_admin_ssl'));
        $this->out->element('legend', null, _('SSL'));
        $this->out->elementStart('ul', 'form_data');
        $this->li();
        $ssl = array('never' => _('Never'),
                     'sometimes' => _('Sometimes'),
                     'always' => _('Always'));

        common_debug("site ssl = " . $this->value('site', 'ssl'));

        $this->out->dropdown('site-ssl', _('Use SSL'),
                             $ssl, _('When to use SSL'),
                             false, $this->value('ssl', 'site'));
        $this->unli();

        $this->li();
        $this->input('sslserver', _('SSL Server'),
                     _('Server to direct SSL requests to'), 'site');
        $this->unli();
        $this->out->elementEnd('ul');
        $this->out->elementEnd('fieldset');

    }

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

    function formActions()
    {
        $this->out->submit('save', _('Save'), 'submit',
                'save', _('Save paths'));
    }

    /**
     * Utility to simplify some of the duplicated code around
     * params and settings. Overriding the input() in the base class
     * to handle a whole bunch of cases of settings with the same
     * name under different sections.
     *
     * @param string $setting      Name of the setting
     * @param string $title        Title to use for the input
     * @param string $instructions Instructions for this field
     * @param string $section      config section, default = 'site'
     *
     * @return void
     */

    function input($setting, $title, $instructions, $section='site')
    {
        $this->out->input("$section-$setting", $title, $this->value($setting, $section), $instructions);
    }

}