gnu-social/actions/siteadminpanel.php

403 lines
12 KiB
PHP
Raw Normal View History

2009-11-08 04:17:52 +00:00
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
2009-11-08 04:17:52 +00:00
/**
* Site administration panel
*
* @category Settings
* @package GNUsocial
2009-11-08 04:17:52 +00:00
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2008-2011 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2009-11-08 04:17:52 +00:00
*/
defined('GNUSOCIAL') || die();
2009-11-08 04:17:52 +00:00
/**
* Administer site settings
*
* @category Admin
* @package GNUsocial
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2009-11-08 04:17:52 +00:00
*/
class SiteadminpanelAction extends AdminPanelAction
{
/**
* Returns the page title
*
* @return string page title
*/
public function title()
2009-11-08 04:17:52 +00:00
{
// TRANS: Title for site administration panel.
return _m('TITLE', 'Site');
2009-11-08 04:17:52 +00:00
}
/**
* Instructions for using this form.
*
* @return string instructions
*/
public function getInstructions()
2009-11-08 04:17:52 +00:00
{
// TRANS: Instructions for site administration panel.
return _m('Basic settings for this StatusNet site');
2009-11-08 04:17:52 +00:00
}
/**
* Show the site admin panel form
*
* @return void
*/
public function showForm()
2009-11-08 04:17:52 +00:00
{
$form = new SiteAdminPanelForm($this);
$form->show();
return;
}
/**
* Save settings from the form
*
* @return void
*/
public function saveSettings()
2009-11-08 04:17:52 +00:00
{
static $settings = array(
'site' => array(
'name',
'broughtby',
'broughtbyurl',
'email',
'timezone',
'language',
'site',
'textlimit',
'dupelimit',
'logo',
'ssllogo'
)
);
2009-11-17 19:51:17 +00:00
$values = [];
2009-11-17 19:51:17 +00:00
foreach ($settings as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = $this->trimmed($setting);
}
}
// This throws an exception on validation errors
$this->validate($values);
// assert(all values are valid);
2009-11-08 04:17:52 +00:00
$config = new Config();
$config->query('START TRANSACTION');
2009-11-08 04:17:52 +00:00
2009-11-17 19:51:17 +00:00
foreach ($settings as $section => $parts) {
foreach ($parts as $setting) {
Config::save($section, $setting, $values[$section][$setting]);
}
}
2009-11-08 04:17:52 +00:00
$config->query('COMMIT');
return;
}
public function validate(&$values)
{
// Validate site name
2009-11-17 19:51:17 +00:00
if (empty($values['site']['name'])) {
// TRANS: Client error displayed trying to save an empty site name.
$this->clientError(_m('Site name must have non-zero length.'));
}
// Validate email
2009-11-17 19:51:17 +00:00
$values['site']['email'] = common_canonical_email($values['site']['email']);
2009-11-17 19:51:17 +00:00
if (empty($values['site']['email'])) {
// TRANS: Client error displayed trying to save site settings without a contact address.
$this->clientError(_m('You must have a valid contact email address.'));
}
2009-11-17 19:51:17 +00:00
if (!Validate::email($values['site']['email'], common_config('email', 'check_domain'))) {
// TRANS: Client error displayed trying to save site settings without a valid contact address.
$this->clientError(_m('Not a valid email address.'));
}
// Validate logos
if (!empty($values['site']['logo']) &&
!common_valid_http_url($values['site']['logo'])) {
// TRANS: Client error displayed when a logo URL is not valid.
$this->clientError(_m('Invalid logo URL.'));
}
if (!empty($values['site']['ssllogo']) &&
!common_valid_http_url($values['site']['ssllogo'], true)) {
// TRANS: Client error displayed when a SSL logo URL is invalid.
$this->clientError(_m('Invalid SSL logo URL.'));
}
// Validate timezone
2009-11-17 19:51:17 +00:00
if (is_null($values['site']['timezone']) ||
!in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) {
// TRANS: Client error displayed trying to save site settings without a timezone.
$this->clientError(_m('Timezone not selected.'));
}
// Validate language
2009-11-17 19:51:17 +00:00
if (!is_null($values['site']['language']) &&
!in_array($values['site']['language'], array_keys(get_nice_language_list()))) {
// TRANS: Client error displayed trying to save site settings with an invalid language code.
// TRANS: %s is the invalid language code.
$this->clientError(sprintf(_m('Unknown language "%s".'), $values['site']['language']));
2009-11-17 19:51:17 +00:00
}
// Validate text limit
if (!Validate::number($values['site']['textlimit'], array('min' => 0))) {
// TRANS: Client error displayed trying to save site settings with a text limit below 0.
$this->clientError(_m('Minimum text limit is 0 (unlimited).'));
}
// Validate dupe limit
if (!Validate::number($values['site']['dupelimit'], array('min' => 1))) {
// TRANS: Client error displayed trying to save site settings with a text limit below 1.
$this->clientError(_m('Dupe limit must be one or more seconds.'));
}
}
2009-11-08 04:17:52 +00:00
}
// @todo FIXME: Class documentation missing.
2009-11-19 02:25:36 +00:00
class SiteAdminPanelForm extends AdminForm
2009-11-08 04:17:52 +00:00
{
/**
* ID of the form
*
* @return int ID of the form
*/
public function id()
2009-11-08 04:17:52 +00:00
{
return 'form_site_admin_panel';
2009-11-08 04:17:52 +00:00
}
/**
* class of the form
*
* @return string class of the form
*/
public function formClass()
2009-11-08 04:17:52 +00:00
{
return 'form_settings';
2009-11-08 04:17:52 +00:00
}
/**
* Action of the form
*
* @return string URL of the action
*/
public function action()
2009-11-08 04:17:52 +00:00
{
return common_local_url('siteadminpanel');
}
/**
* Data elements of the form
*
* @return void
*/
public function formData()
2009-11-08 04:17:52 +00:00
{
2009-11-19 10:34:43 +00:00
$this->out->elementStart('fieldset', array('id' => 'settings_admin_general'));
// TRANS: Fieldset legend on site settings panel.
$this->out->element('legend', null, _m('LEGEND', 'General'));
$this->out->elementStart('ul', 'form_data');
$this->li();
// TRANS: Field label on site settings panel.
$this->input(
'name',
_m('LABEL', 'Site name'),
// TRANS: Field title on site settings panel.
_m('The name of your site, like "Yourcompany Microblog".')
);
$this->unli();
2009-11-19 10:34:43 +00:00
$this->li();
// TRANS: Field label on site settings panel.
$this->input(
'broughtby',
_m('Brought by'),
// TRANS: Field title on site settings panel.
_m('Text used for credits link in footer of each page.')
);
$this->unli();
2009-11-19 10:34:43 +00:00
$this->li();
// TRANS: Field label on site settings panel.
$this->input(
'broughtbyurl',
_m('Brought by URL'),
// TRANS: Field title on site settings panel.
_m('URL used for credits link in footer of each page.')
);
$this->unli();
$this->li();
// TRANS: Field label on site settings panel.
$this->input(
'email',
_m('Email'),
// TRANS: Field title on site settings panel.
_m('Contact email address for your site.')
);
$this->unli();
2009-11-19 10:34:43 +00:00
$this->out->elementEnd('ul');
$this->out->elementEnd('fieldset');
$this->showLogo();
2009-11-19 10:34:43 +00:00
$this->out->elementStart('fieldset', array('id' => 'settings_admin_local'));
// TRANS: Fieldset legend on site settings panel.
$this->out->element('legend', null, _m('LEGEND', 'Local'));
2009-11-19 10:34:43 +00:00
$this->out->elementStart('ul', 'form_data');
$timezones = [];
foreach (DateTimeZone::listIdentifiers() as $k => $v) {
$timezones[$v] = $v;
}
asort($timezones);
$this->li();
// TRANS: Dropdown label on site settings panel.
$this->out->dropdown(
'timezone',
_m('Default timezone'),
// TRANS: Dropdown title on site settings panel.
$timezones,
_m('Default timezone for the site; usually UTC.'),
true,
$this->value('timezone')
);
$this->unli();
2009-11-19 10:34:43 +00:00
$this->li();
$this->out->dropdown(
'language',
// TRANS: Dropdown label on site settings panel.
_m('Default language'),
get_nice_language_list(),
// TRANS: Dropdown title on site settings panel.
_m('The site language when autodetection from browser settings is not available.'),
false,
$this->value('language')
);
$this->unli();
2009-11-19 10:34:43 +00:00
$this->out->elementEnd('ul');
$this->out->elementEnd('fieldset');
2009-11-19 10:34:43 +00:00
$this->out->elementStart('fieldset', array('id' => 'settings_admin_limits'));
// TRANS: Fieldset legend on site settings panel.
$this->out->element('legend', null, _m('LEGEND', 'Limits'));
2009-11-19 10:34:43 +00:00
$this->out->elementStart('ul', 'form_data');
$this->li();
$this->input(
'textlimit',
// TRANS: Field label on site settings panel.
_m('Text limit'),
// TRANS: Field title on site settings panel.
_m('Maximum number of characters for notices.')
);
$this->unli();
$this->li();
$this->input(
'dupelimit',
// TRANS: Field label on site settings panel.
_m('Dupe limit'),
// TRANS: Field title on site settings panel.
_m('How long users must wait (in seconds) to post the same thing again.')
);
$this->unli();
$this->out->elementEnd('ul');
2009-11-19 10:34:43 +00:00
$this->out->elementEnd('fieldset');
}
public function showLogo()
{
$this->out->elementStart('fieldset', ['id' => 'settings_site_logo']);
// TRANS: Fieldset legend for form to change logo.
$this->out->element('legend', null, _m('Logo'));
$this->out->elementStart('ul', 'form_data');
$this->li();
$this->input(
'logo',
// TRANS: Field label for GNU social site logo.
_m('Site logo'),
// TRANS: Title for field label for GNU social site logo.
'Logo for the site (full URL).'
);
$this->unli();
$this->li();
$this->input(
'ssllogo',
// TRANS: Field label for SSL GNU social site logo.
_m('SSL logo'),
// TRANS: Title for field label for SSL GNU social site logo.
'Logo to show on SSL pages (full URL).'
);
$this->unli();
$this->out->elementEnd('ul');
$this->out->elementEnd('fieldset');
}
2009-11-08 04:17:52 +00:00
/**
* Action elements
*
* @return void
*/
public function formActions()
2009-11-08 04:17:52 +00:00
{
$this->out->submit(
'submit',
// TRANS: Button text for saving site settings.
_m('BUTTON', 'Save'),
'submit',
null,
// TRANS: Button title for saving site settings.
_m('Save the site settings.')
);
2009-11-08 04:17:52 +00:00
}
}