Site-wide notice text admin panel

This commit is contained in:
Zach Copley 2010-03-03 14:32:14 -08:00
parent 628338265c
commit 337b1aaaa1
4 changed files with 216 additions and 8 deletions

View File

@ -0,0 +1,201 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Site notice 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 Zach Copley <zach@status.net>
* @copyright 2010 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);
}
require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
/**
* Update the site-wide notice text
*
* @category Admin
* @package StatusNet
* @author Zach Copley <zach@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 SitenoticeadminpanelAction extends AdminPanelAction
{
/**
* Returns the page title
*
* @return string page title
*/
function title()
{
return _('Site Notice');
}
/**
* Instructions for using this form.
*
* @return string instructions
*/
function getInstructions()
{
return _('Edit site-wide message');
}
/**
* Show the site notice admin panel form
*
* @return void
*/
function showForm()
{
$form = new SiteNoticeAdminPanelForm($this);
$form->show();
return;
}
/**
* Save settings from the form
*
* @return void
*/
function saveSettings()
{
$siteNotice = $this->trimmed('site-notice');
// assert(all values are valid);
// This throws an exception on validation errors
$this->validate(&$siteNotice);
$config = new Config();
$result = Config::save('site', 'notice', $siteNotice);
if (!result) {
$this->ServerError(_("Unable to save site notice."));
}
}
function validate(&$siteNotice)
{
// Validate notice text
if (mb_strlen($siteNotice) > 255) {
$this->clientError(
_('Max length for the site-wide notice is 255 chars')
);
}
// scrub HTML input
$config = array(
'safe' => 1,
'deny_attribute' => 'id,style,on*'
);
$siteNotice = htmLawed($siteNotice, $config);
}
}
class SiteNoticeAdminPanelForm extends AdminForm
{
/**
* ID of the form
*
* @return int ID of the form
*/
function id()
{
return 'form_site_notice_admin_panel';
}
/**
* class of the form
*
* @return string class of the form
*/
function formClass()
{
return 'form_settings';
}
/**
* Action of the form
*
* @return string URL of the action
*/
function action()
{
return common_local_url('sitenoticeadminpanel');
}
/**
* Data elements of the form
*
* @return void
*/
function formData()
{
$this->out->elementStart('ul', 'form_data');
$this->out->elementStart('li');
$this->out->textarea(
'site-notice',
_('Site notice text'),
common_config('site', 'notice'),
_('Site-wide notice text (255 chars max; HTML okay)')
);
$this->out->elementEnd('li');
$this->out->elementEnd('ul');
}
/**
* Action elements
*
* @return void
*/
function formActions()
{
$this->out->submit(
'submit',
_('Save'),
'submit',
null,
_('Save site notice')
);
}
}

View File

@ -358,22 +358,27 @@ class AdminPanelNav extends Widget
if (AdminPanelAction::canAdmin('user')) { if (AdminPanelAction::canAdmin('user')) {
$this->out->menuItem(common_local_url('useradminpanel'), _('User'), $this->out->menuItem(common_local_url('useradminpanel'), _('User'),
_('User configuration'), $action_name == 'useradminpanel', 'nav_design_admin_panel'); _('User configuration'), $action_name == 'useradminpanel', 'nav_user_admin_panel');
} }
if (AdminPanelAction::canAdmin('access')) { if (AdminPanelAction::canAdmin('access')) {
$this->out->menuItem(common_local_url('accessadminpanel'), _('Access'), $this->out->menuItem(common_local_url('accessadminpanel'), _('Access'),
_('Access configuration'), $action_name == 'accessadminpanel', 'nav_design_admin_panel'); _('Access configuration'), $action_name == 'accessadminpanel', 'nav_access_admin_panel');
} }
if (AdminPanelAction::canAdmin('paths')) { if (AdminPanelAction::canAdmin('paths')) {
$this->out->menuItem(common_local_url('pathsadminpanel'), _('Paths'), $this->out->menuItem(common_local_url('pathsadminpanel'), _('Paths'),
_('Paths configuration'), $action_name == 'pathsadminpanel', 'nav_design_admin_panel'); _('Paths configuration'), $action_name == 'pathsadminpanel', 'nav_paths_admin_panel');
} }
if (AdminPanelAction::canAdmin('sessions')) { if (AdminPanelAction::canAdmin('sessions')) {
$this->out->menuItem(common_local_url('sessionsadminpanel'), _('Sessions'), $this->out->menuItem(common_local_url('sessionsadminpanel'), _('Sessions'),
_('Sessions configuration'), $action_name == 'sessionsadminpanel', 'nav_design_admin_panel'); _('Sessions configuration'), $action_name == 'sessionsadminpanel', 'nav_sessions_admin_panel');
}
if (AdminPanelAction::canAdmin('sitenotice')) {
$this->out->menuItem(common_local_url('sitenoticeadminpanel'), _('Site notice'),
_('Edit site notice'), $action_name == 'sitenoticeadminpanel', 'nav_sitenotice_admin_panel');
} }
Event::handle('EndAdminPanelNav', array($this)); Event::handle('EndAdminPanelNav', array($this));

View File

@ -54,10 +54,11 @@ $default =
'ssl' => 'never', 'ssl' => 'never',
'sslserver' => null, 'sslserver' => null,
'shorturllength' => 30, 'shorturllength' => 30,
'dupelimit' => 60, # default for same person saying the same thing 'dupelimit' => 60, // default for same person saying the same thing
'textlimit' => 140, 'textlimit' => 140,
'indent' => true, 'indent' => true,
'use_x_sendfile' => false 'use_x_sendfile' => false,
'notice' => null // site wide notice text
), ),
'db' => 'db' =>
array('database' => 'YOU HAVE TO SET THIS IN config.php', array('database' => 'YOU HAVE TO SET THIS IN config.php',
@ -283,7 +284,7 @@ $default =
'OpenID' => null), 'OpenID' => null),
), ),
'admin' => 'admin' =>
array('panels' => array('design', 'site', 'user', 'paths', 'access', 'sessions')), array('panels' => array('design', 'site', 'user', 'paths', 'access', 'sessions', 'sitenotice')),
'singleuser' => 'singleuser' =>
array('enabled' => false, array('enabled' => false,
'nickname' => null), 'nickname' => null),

View File

@ -649,6 +649,7 @@ class Router
$m->connect('admin/access', array('action' => 'accessadminpanel')); $m->connect('admin/access', array('action' => 'accessadminpanel'));
$m->connect('admin/paths', array('action' => 'pathsadminpanel')); $m->connect('admin/paths', array('action' => 'pathsadminpanel'));
$m->connect('admin/sessions', array('action' => 'sessionsadminpanel')); $m->connect('admin/sessions', array('action' => 'sessionsadminpanel'));
$m->connect('admin/sitenotice', array('action' => 'sitenoticeadminpanel'));
$m->connect('getfile/:filename', $m->connect('getfile/:filename',
array('action' => 'getfile'), array('action' => 'getfile'),