gnu-social/actions/siteadminpanel.php

374 lines
9.9 KiB
PHP
Raw Normal View History

2009-11-08 13:17:52 +09:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Site 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 site 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 SiteadminpanelAction extends AdminPanelAction
{
/**
* Returns the page title
*
* @return string page title
*/
function title()
{
return _('Site');
}
/**
* Instructions for using this form.
*
* @return string instructions
*/
function getInstructions()
{
return _('Basic settings for this StatusNet site.');
}
/**
* Show the site admin panel form
*
* @return void
*/
function showForm()
{
$form = new SiteAdminPanelForm($this);
$form->show();
return;
}
/**
* Save settings from the form
*
* @return void
*/
function saveSettings()
{
2009-11-18 04:51:17 +09:00
static $settings = array('site' => array('name', 'broughtby', 'broughtbyurl',
'email', 'timezone', 'language'),
'snapshot' => array('run', 'reporturl', 'frequency'));
static $booleans = array('site' => array('private'));
$values = array();
2009-11-18 04:51:17 +09:00
foreach ($settings as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = $this->trimmed($setting);
}
}
2009-11-18 04:51:17 +09:00
foreach ($booleans as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = ($this->boolean($setting)) ? 1 : 0;
}
}
// This throws an exception on validation errors
$this->validate($values);
// assert(all values are valid);
2009-11-08 13:17:52 +09:00
$config = new Config();
$config->query('BEGIN');
2009-11-18 04:51:17 +09:00
foreach ($settings as $section => $parts) {
foreach ($parts as $setting) {
Config::save($section, $setting, $values[$section][$setting]);
}
}
foreach ($booleans as $section => $parts) {
foreach ($parts as $setting) {
Config::save($section, $setting, $values[$section][$setting]);
}
}
2009-11-08 13:17:52 +09:00
$config->query('COMMIT');
return;
}
function validate(&$values)
{
// Validate site name
2009-11-18 04:51:17 +09:00
if (empty($values['site']['name'])) {
$this->clientError(_("Site name must have non-zero length."));
}
// Validate email
2009-11-18 04:51:17 +09:00
$values['site']['email'] = common_canonical_email($values['site']['email']);
2009-11-18 04:51:17 +09:00
if (empty($values['site']['email'])) {
$this->clientError(_('You must have a valid contact email address'));
}
2009-11-18 04:51:17 +09:00
if (!Validate::email($values['site']['email'], common_config('email', 'check_domain'))) {
$this->clientError(_('Not a valid email address'));
}
// Validate timezone
2009-11-18 04:51:17 +09:00
if (is_null($values['site']['timezone']) ||
!in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) {
$this->clientError(_('Timezone not selected.'));
return;
}
// Validate language
2009-11-18 04:51:17 +09:00
if (!is_null($values['site']['language']) &&
!in_array($values['site']['language'], array_keys(get_nice_language_list()))) {
$this->clientError(sprintf(_('Unknown language "%s"'), $values['site']['language']));
}
// Validate report URL
if (!is_null($values['snapshot']['reporturl']) &&
!Validate::uri($values['snapshot']['reporturl'], array('allowed_schemes' => array('http', 'https')))) {
$this->clientError(_("Invalid snapshot report URL."));
}
// Validate snapshot run value
if (!in_array($values['snapshot']['run'], array('web', 'cron', 'never'))) {
$this->clientError(_("Invalid snapshot run value."));
}
2009-11-18 04:51:17 +09:00
// Validate snapshot run value
if (!Validate::number($values['snapshot']['frequency'])) {
$this->clientError(_("Snapshot frequency must be a number."));
}
}
2009-11-08 13:17:52 +09:00
}
class SiteAdminPanelForm extends Form
{
/**
* ID of the form
*
* @return int ID of the form
*/
function id()
{
return 'form_site_admin_panel';
2009-11-08 13:17:52 +09:00
}
/**
* class of the form
*
* @return string class of the form
*/
function formClass()
{
return 'form_settings';
2009-11-08 13:17:52 +09:00
}
/**
* Action of the form
*
* @return string URL of the action
*/
function action()
{
return common_local_url('siteadminpanel');
}
/**
* Data elements of the form
*
* @return void
*/
function formData()
{
$this->out->elementStart('ul', 'form_data');
$this->li();
$this->input('name', _('Site name'),
_('The name of your site, like "Yourcompany Microblog"'));
$this->unli();
$this->li();
$this->input('broughtby', _('Brought by'),
_('Text used for credits link in footer of each page'));
$this->unli();
$this->li();
$this->input('broughtbyurl', _('Brought by URL'),
_('URL used for credits link in footer of each page'));
$this->unli();
$this->li();
$this->input('email', _('Email'),
_('contact email address for your site'));
$this->unli();
$timezones = array();
foreach (DateTimeZone::listIdentifiers() as $k => $v) {
$timezones[$v] = $v;
}
asort($timezones);
$this->li();
$this->out->dropdown('timezone', _('Default timezone'),
$timezones, _('Default timezone for the site; usually UTC.'),
true, $this->value('timezone'));
$this->unli();
$this->li();
$this->out->dropdown('language', _('Language'),
get_nice_language_list(), _('Default site language'),
false, $this->value('language'));
$this->unli();
$this->li();
$this->out->checkbox('private', _('Private'),
(bool) $this->value('private'),
_('Prohibit anonymous users (not logged in) from viewing site?'));
$this->unli();
2009-11-18 04:51:17 +09:00
$this->li();
$snapshot = array('web' => _('Randomly during Web hit'),
'cron' => _('In a scheduled job'),
'never' => _('Never'));
$this->out->dropdown('run', _('Data snapshots'),
$snapshot, _('When to send statistical data to status.net servers'),
false, $this->value('run', 'snapshot'));
$this->unli();
$this->li();
$this->input('frequency', _('Frequency'),
_('Snapshots will be sent once every N Web hits'),
'snapshot');
$this->unli();
$this->li();
$this->input('reporturl', _('Report URL'),
_('Snapshots will be sent to this URL'),
'snapshot');
$this->unli();
$this->out->elementEnd('ul');
}
/**
* Utility to simplify some of the duplicated code around
* params and settings.
*
* @param string $setting Name of the setting
* @param string $title Title to use for the input
* @param string $instructions Instructions for this field
2009-11-18 04:51:17 +09:00
* @param string $section config section, default = 'site'
*
* @return void
*/
2009-11-18 04:51:17 +09:00
function input($setting, $title, $instructions, $section='site')
{
2009-11-18 04:51:17 +09:00
$this->out->input($setting, $title, $this->value($setting, $section), $instructions);
}
/**
* Utility to simplify getting the posted-or-stored setting value
*
* @param string $setting Name of the setting
2009-11-18 04:51:17 +09:00
* @param string $main configuration section, default = 'site'
*
* @return string param value if posted, or current config value
*/
2009-11-18 04:51:17 +09:00
function value($setting, $main='site')
{
$value = $this->out->trimmed($setting);
if (empty($value)) {
2009-11-18 04:51:17 +09:00
$value = common_config($main, $setting);
}
return $value;
2009-11-08 13:17:52 +09:00
}
function li()
{
$this->out->elementStart('li');
}
function unli()
{
$this->out->elementEnd('li');
}
2009-11-08 13:17:52 +09:00
/**
* Action elements
*
* @return void
*/
function formActions()
{
$this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
}
}