3 * StatusNet, the distributed open-source microblogging tool
5 * Site 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')) {
37 * Administer site 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 SiteadminpanelAction extends AdminPanelAction
51 * Returns the page title
53 * @return string page title
62 * Instructions for using this form.
64 * @return string instructions
67 function getInstructions()
69 return _('Basic settings for this StatusNet site.');
73 * Show the site admin panel form
80 $form = new SiteAdminPanelForm($this);
86 * Save settings from the form
91 function saveSettings()
93 static $settings = array('site' => array('name', 'broughtby', 'broughtbyurl',
94 'email', 'timezone', 'language',
95 'site', 'textlimit', 'dupelimit'),
96 'snapshot' => array('run', 'reporturl', 'frequency'));
100 foreach ($settings as $section => $parts) {
101 foreach ($parts as $setting) {
102 $values[$section][$setting] = $this->trimmed($setting);
106 // This throws an exception on validation errors
108 $this->validate($values);
110 // assert(all values are valid);
112 $config = new Config();
114 $config->query('BEGIN');
116 foreach ($settings as $section => $parts) {
117 foreach ($parts as $setting) {
118 Config::save($section, $setting, $values[$section][$setting]);
122 $config->query('COMMIT');
127 function validate(&$values)
129 // Validate site name
131 if (empty($values['site']['name'])) {
132 $this->clientError(_("Site name must have non-zero length."));
137 $values['site']['email'] = common_canonical_email($values['site']['email']);
139 if (empty($values['site']['email'])) {
140 $this->clientError(_('You must have a valid contact email address.'));
142 if (!Validate::email($values['site']['email'], common_config('email', 'check_domain'))) {
143 $this->clientError(_('Not a valid email address.'));
148 if (is_null($values['site']['timezone']) ||
149 !in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) {
150 $this->clientError(_('Timezone not selected.'));
156 if (!is_null($values['site']['language']) &&
157 !in_array($values['site']['language'], array_keys(get_nice_language_list()))) {
158 $this->clientError(sprintf(_('Unknown language "%s".'), $values['site']['language']));
161 // Validate report URL
163 if (!is_null($values['snapshot']['reporturl']) &&
164 !Validate::uri($values['snapshot']['reporturl'], array('allowed_schemes' => array('http', 'https')))) {
165 $this->clientError(_("Invalid snapshot report URL."));
168 // Validate snapshot run value
170 if (!in_array($values['snapshot']['run'], array('web', 'cron', 'never'))) {
171 $this->clientError(_("Invalid snapshot run value."));
174 // Validate snapshot run value
176 if (!Validate::number($values['snapshot']['frequency'])) {
177 $this->clientError(_("Snapshot frequency must be a number."));
180 // Validate text limit
182 if (!Validate::number($values['site']['textlimit'], array('min' => 140))) {
183 $this->clientError(_("Minimum text limit is 140 characters."));
186 // Validate dupe limit
188 if (!Validate::number($values['site']['dupelimit'], array('min' => 1))) {
189 $this->clientError(_("Dupe limit must 1 or more seconds."));
195 class SiteAdminPanelForm extends AdminForm
200 * @return int ID of the form
205 return 'form_site_admin_panel';
211 * @return string class of the form
216 return 'form_settings';
222 * @return string URL of the action
227 return common_local_url('siteadminpanel');
231 * Data elements of the form
238 $this->out->elementStart('fieldset', array('id' => 'settings_admin_general'));
239 $this->out->element('legend', null, _('General'));
240 $this->out->elementStart('ul', 'form_data');
242 $this->input('name', _('Site name'),
243 _('The name of your site, like "Yourcompany Microblog"'));
247 $this->input('broughtby', _('Brought by'),
248 _('Text used for credits link in footer of each page'));
252 $this->input('broughtbyurl', _('Brought by URL'),
253 _('URL used for credits link in footer of each page'));
256 $this->input('email', _('Email'),
257 _('Contact email address for your site'));
259 $this->out->elementEnd('ul');
260 $this->out->elementEnd('fieldset');
262 $this->out->elementStart('fieldset', array('id' => 'settings_admin_local'));
263 $this->out->element('legend', null, _('Local'));
264 $this->out->elementStart('ul', 'form_data');
265 $timezones = array();
267 foreach (DateTimeZone::listIdentifiers() as $k => $v) {
274 $this->out->dropdown('timezone', _('Default timezone'),
275 $timezones, _('Default timezone for the site; usually UTC.'),
276 true, $this->value('timezone'));
280 $this->out->dropdown('language', _('Language'),
281 get_nice_language_list(), _('Default site language'),
282 false, $this->value('language'));
285 $this->out->elementEnd('ul');
286 $this->out->elementEnd('fieldset');
288 $this->out->elementStart('fieldset', array('id' => 'settings_admin_snapshots'));
289 $this->out->element('legend', null, _('Snapshots'));
290 $this->out->elementStart('ul', 'form_data');
292 $snapshot = array('web' => _('Randomly during Web hit'),
293 'cron' => _('In a scheduled job'),
294 'never' => _('Never'));
295 $this->out->dropdown('run', _('Data snapshots'),
296 $snapshot, _('When to send statistical data to status.net servers'),
297 false, $this->value('run', 'snapshot'));
301 $this->input('frequency', _('Frequency'),
302 _('Snapshots will be sent once every N web hits'),
307 $this->input('reporturl', _('Report URL'),
308 _('Snapshots will be sent to this URL'),
311 $this->out->elementEnd('ul');
312 $this->out->elementEnd('fieldset');
314 $this->out->elementStart('fieldset', array('id' => 'settings_admin_limits'));
315 $this->out->element('legend', null, _('Limits'));
316 $this->out->elementStart('ul', 'form_data');
318 $this->input('textlimit', _('Text limit'), _('Maximum number of characters for notices.'));
322 $this->input('dupelimit', _('Dupe limit'), _('How long users must wait (in seconds) to post the same thing again.'));
324 $this->out->elementEnd('ul');
325 $this->out->elementEnd('fieldset');
334 function formActions()
336 $this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));