gnu-social/actions/useradminpanel.php

314 lines
9.3 KiB
PHP
Raw Permalink Normal View History

<?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/>.
/**
* User administration panel
*
* @category Settings
* @package GNUsocial
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2008-2010 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/**
* Administer user 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
*/
class UseradminpanelAction extends AdminPanelAction
{
/**
* Returns the page title
*
* @return string page title
*/
public function title()
{
// TRANS: User admin panel title.
return _m('TITLE', 'User');
}
/**
* Instructions for using this form.
*
* @return string instructions
*/
public function getInstructions()
{
// TRANS: Instruction for user admin panel.
return _('User settings for this StatusNet site');
}
/**
* Show the site admin panel form
*
* @return void
*/
public function showForm()
{
$form = new UserAdminPanelForm($this);
$form->show();
return;
}
/**
* Save settings from the form
*
* @return void
*/
public function saveSettings()
{
2009-11-19 23:02:25 +00:00
static $settings = array(
'profile' => array('biolimit'),
'newuser' => array('welcome', 'default')
);
static $booleans = array(
'invite' => array('enabled')
);
$values = array();
2009-11-19 23:02:25 +00:00
foreach ($settings as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = $this->trimmed("$section-$setting");
}
}
foreach ($booleans as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = ($this->boolean("$section-$setting")) ? 1 : 0;
}
}
// This throws an exception on validation errors
$this->validate($values);
// assert(all values are valid);
$config = new Config();
$config->query('START TRANSACTION');
2009-11-19 23:02:25 +00: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]);
}
}
$config->query('COMMIT');
return;
}
public function validate(&$values)
{
// Validate biolimit
if (!Validate::number($values['profile']['biolimit'])) {
// TRANS: Form validation error in user admin panel when a non-numeric character limit was set.
$this->clientError(_('Invalid bio limit. Must be numeric.'));
}
// Validate welcome text
if (mb_strlen($values['newuser']['welcome']) > 255) {
// TRANS: Form validation error in user admin panel when welcome text is too long.
$this->clientError(_('Invalid welcome text. Maximum length is 255 characters.'));
}
// Validate default subscription
if (!empty($values['newuser']['default'])) {
$defuser = User::getKV('nickname', trim($values['newuser']['default']));
if (empty($defuser)) {
$this->clientError(
sprintf(
// TRANS: Client error displayed when trying to set a non-existing user as default subscription for new
// TRANS: users in user admin panel. %1$s is the invalid nickname.
_('Invalid default subscripton: "%1$s" is not a user.'),
$values['newuser']['default']
)
);
}
}
}
}
// @todo FIXME: Class documentation missing.
2009-11-19 23:02:25 +00:00
class UserAdminPanelForm extends AdminForm
{
/**
* ID of the form
*
* @return int ID of the form
*/
public function id()
{
return 'useradminpanel';
}
/**
* class of the form
*
* @return string class of the form
*/
public function formClass()
{
2009-11-19 23:02:25 +00:00
return 'form_settings';
}
/**
* Action of the form
*
* @return string URL of the action
*/
public function action()
{
return common_local_url('useradminpanel');
}
/**
* Data elements of the form
*
* @return void
*/
public function formData()
{
2009-11-19 23:02:25 +00:00
$this->out->elementStart('fieldset', array('id' => 'settings_user-profile'));
// TRANS: Fieldset legend in user administration panel.
$this->out->element('legend', null, _m('LEGEND', 'Profile'));
2009-11-19 23:02:25 +00:00
$this->out->elementStart('ul', 'form_data');
$this->li();
// TRANS: Field label in user admin panel for setting the character limit for the bio field.
$this->input(
'biolimit',
_('Bio Limit'),
// TRANS: Tooltip in user admin panel for setting the character limit for the bio field.
_('Maximum length of a profile bio in characters.'),
'profile'
);
2009-11-19 23:02:25 +00:00
$this->unli();
$this->out->elementEnd('ul');
$this->out->elementEnd('fieldset');
$this->out->elementStart('fieldset', array('id' => 'settings_user-newusers'));
// TRANS: Form legend in user admin panel.
2009-11-19 23:02:25 +00:00
$this->out->element('legend', null, _('New users'));
$this->out->elementStart('ul', 'form_data');
2009-11-19 23:02:25 +00:00
$this->li();
// TRANS: Field label in user admin panel for setting new user welcome text.
$this->input(
'welcome',
_('New user welcome'),
// TRANS: Tooltip in user admin panel for setting new user welcome text.
_('Welcome text for new users (maximum 255 characters).'),
'newuser'
);
2009-11-19 23:02:25 +00:00
$this->unli();
2009-11-19 23:02:25 +00:00
$this->li();
// TRANS: Field label in user admin panel for setting default subscription for new users.
$this->input(
'default',
_('Default subscription'),
// TRANS: Tooltip in user admin panel for setting default subscription for new users.
_('Automatically subscribe new users to this user.'),
'newuser'
);
$this->unli();
2009-11-19 23:02:25 +00:00
$this->out->elementEnd('ul');
$this->out->elementEnd('fieldset');
$this->out->elementStart('fieldset', array('id' => 'settings_user-invitations'));
// TRANS: Form legend in user admin panel.
2009-11-19 23:02:25 +00:00
$this->out->element('legend', null, _('Invitations'));
$this->out->elementStart('ul', 'form_data');
$this->li();
// TRANS: Field label for checkbox in user admin panel for allowing users to invite friend using site e-mail.
$this->out->checkbox(
'invite-enabled',
_('Invitations enabled'),
(bool) $this->value('enabled', 'invite'),
// TRANS: Tooltip for checkbox in user admin panel for allowing users to invite friend using site e-mail.
_('Whether to allow users to invite new users.')
);
2009-11-19 23:02:25 +00:00
$this->unli();
$this->out->elementEnd('ul');
$this->out->elementEnd('fieldset');
}
/**
* Utility to simplify some of the duplicated code around
2009-11-19 23:02:25 +00:00
* params and settings. Overrided from base class to be
* more specific about input ids.
*
* @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-19 23:02:25 +00:00
* @param string $section config section, default = 'site'
*
* @return void
*/
public function input($setting, $title, $instructions, $section='site')
{
2009-11-19 23:02:25 +00:00
$this->out->input("$section-$setting", $title, $this->value($setting, $section), $instructions);
}
/**
* Action elements
*
* @return void
*/
public function formActions()
{
$this->out->submit(
'submit',
// TRANS: Button text to save user settings in user admin panel.
_m('BUTTON', 'Save'),
'submit',
null,
// TRANS: Button title to save user settings in user admin panel.
_('Save user settings.')
);
}
}