3 * StatusNet, the distributed open-source microblogging tool
5 * Paths 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-2010 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')) {
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 PathsadminpanelAction extends AdminPanelAction
52 * Returns the page title
54 * @return string page title
63 * Instructions for using this form.
65 * @return string instructions
68 function getInstructions()
70 return _('Path and server settings for this StatusNet site.');
74 * Show the paths admin panel form
81 $form = new PathsAdminPanelForm($this);
87 * Save settings from the form
92 function saveSettings()
94 static $settings = array(
95 'site' => array('path', 'locale_path', 'ssl', 'sslserver'),
96 'theme' => array('server', 'dir', 'path'),
97 'avatar' => array('server', 'dir', 'path'),
98 'background' => array('server', 'dir', 'path')
101 // XXX: If we're only going to have one boolean on thi page we
102 // can remove some of the boolean processing code --Z
104 static $booleans = array('site' => array('fancy'));
108 foreach ($settings as $section => $parts) {
109 foreach ($parts as $setting) {
110 $values[$section][$setting] = $this->trimmed("$section-$setting");
114 foreach ($booleans as $section => $parts) {
115 foreach ($parts as $setting) {
116 $values[$section][$setting] = ($this->boolean($setting)) ? 1 : 0;
120 $this->validate($values);
122 // assert(all values are valid);
124 $config = new Config();
126 $config->query('BEGIN');
128 foreach ($settings as $section => $parts) {
129 foreach ($parts as $setting) {
130 Config::save($section, $setting, $values[$section][$setting]);
134 foreach ($booleans as $section => $parts) {
135 foreach ($parts as $setting) {
136 Config::save($section, $setting, $values[$section][$setting]);
140 $config->query('COMMIT');
146 * Attempt to validate setting values
151 function validate(&$values)
154 // Validate theme dir
156 if (!empty($values['theme']['dir']) && !is_readable($values['theme']['dir'])) {
157 $this->clientError(sprintf(_("Theme directory not readable: %s"), $values['theme']['dir']));
160 // Validate avatar dir
162 if (empty($values['avatar']['dir']) || !is_writable($values['avatar']['dir'])) {
163 $this->clientError(sprintf(_("Avatar directory not writable: %s"), $values['avatar']['dir']));
166 // Validate background dir
168 if (empty($values['background']['dir']) || !is_writable($values['background']['dir'])) {
169 $this->clientError(sprintf(_("Background directory not writable: %s"), $values['background']['dir']));
172 // Validate locales dir
174 // XXX: What else do we need to validate for lacales path here? --Z
176 if (!empty($values['site']['locale_path']) && !is_readable($values['site']['locale_path'])) {
177 $this->clientError(sprintf(_("Locales directory not readable: %s"), $values['site']['locale_path']));
180 // Validate SSL setup
182 if (mb_strlen($values['site']['sslserver']) > 255) {
183 $this->clientError(_("Invalid SSL server. The maximum length is 255 characters."));
189 class PathsAdminPanelForm extends AdminForm
195 * @return int ID of the form
200 return 'form_paths_admin_panel';
206 * @return string class of the form
211 return 'form_settings';
217 * @return string URL of the action
222 return common_local_url('pathsadminpanel');
226 * Data elements of the form
233 $this->out->elementStart('fieldset', array('id' => 'settings_paths_locale'));
234 $this->out->element('legend', null, _('Site'), 'site');
235 $this->out->elementStart('ul', 'form_data');
238 $this->input('server', _('Server'), _('Site\'s server hostname.'));
242 $this->input('path', _('Path'), _('Site path'));
246 $this->input('locale_path', _('Path to locales'), _('Directory path to locales'), 'site');
250 $this->out->checkbox('fancy', _('Fancy URLs'),
251 (bool) $this->value('fancy'),
252 _('Use fancy (more readable and memorable) URLs?'));
255 $this->out->elementEnd('ul');
256 $this->out->elementEnd('fieldset');
258 $this->out->elementStart('fieldset', array('id' => 'settings_paths_theme'));
259 $this->out->element('legend', null, _('Theme'));
261 $this->out->elementStart('ul', 'form_data');
264 $this->input('server', _('Theme server'), 'Server for themes', 'theme');
268 $this->input('path', _('Theme path'), 'Web path to themes', 'theme');
272 $this->input('dir', _('Theme directory'), 'Directory where themes are located', 'theme');
275 $this->out->elementEnd('ul');
277 $this->out->elementEnd('fieldset');
278 $this->out->elementStart('fieldset', array('id' => 'settings_avatar-paths'));
279 $this->out->element('legend', null, _('Avatars'));
281 $this->out->elementStart('ul', 'form_data');
284 $this->input('server', _('Avatar server'), 'Server for avatars', 'avatar');
288 $this->input('path', _('Avatar path'), 'Web path to avatars', 'avatar');
292 $this->input('dir', _('Avatar directory'), 'Directory where avatars are located', 'avatar');
295 $this->out->elementEnd('ul');
297 $this->out->elementEnd('fieldset');
299 $this->out->elementStart('fieldset', array('id' =>
300 'settings_design_background-paths'));
301 $this->out->element('legend', null, _('Backgrounds'));
302 $this->out->elementStart('ul', 'form_data');
305 $this->input('server', _('Background server'), 'Server for backgrounds', 'background');
309 $this->input('path', _('Background path'), 'Web path to backgrounds', 'background');
313 $this->input('dir', _('Background directory'), 'Directory where backgrounds are located', 'background');
316 $this->out->elementEnd('ul');
317 $this->out->elementEnd('fieldset');
319 $this->out->elementStart('fieldset', array('id' => 'settings_admin_ssl'));
320 $this->out->element('legend', null, _('SSL'));
321 $this->out->elementStart('ul', 'form_data');
323 $ssl = array('never' => _('Never'),
324 'sometimes' => _('Sometimes'),
325 'always' => _('Always'));
327 common_debug("site ssl = " . $this->value('site', 'ssl'));
329 $this->out->dropdown('site-ssl', _('Use SSL'),
330 $ssl, _('When to use SSL'),
331 false, $this->value('ssl', 'site'));
335 $this->input('sslserver', _('SSL server'),
336 _('Server to direct SSL requests to'), 'site');
338 $this->out->elementEnd('ul');
339 $this->out->elementEnd('fieldset');
349 function formActions()
351 $this->out->submit('save', _('Save'), 'submit',
352 'save', _('Save paths'));
356 * Utility to simplify some of the duplicated code around
357 * params and settings. Overriding the input() in the base class
358 * to handle a whole bunch of cases of settings with the same
359 * name under different sections.
361 * @param string $setting Name of the setting
362 * @param string $title Title to use for the input
363 * @param string $instructions Instructions for this field
364 * @param string $section config section, default = 'site'
369 function input($setting, $title, $instructions, $section='site')
371 $this->out->input("$section-$setting", $title, $this->value($setting, $section), $instructions);