Blacklist admin panel
This commit is contained in:
Evan Prodromou
parent
6e5809586f
commit
b0a3105638
|
|
@ -47,19 +47,41 @@ class BlacklistPlugin extends Plugin
|
|||
|
||||
public $nicknames = array();
|
||||
public $urls = array();
|
||||
public $canAdmin = true;
|
||||
|
||||
private $_nicknamePatterns = array();
|
||||
private $_urlPatterns = array();
|
||||
private $_urlPatterns = array();
|
||||
|
||||
/**
|
||||
* Initialize the plugin
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
||||
function initialize()
|
||||
{
|
||||
$confNicknames = $this->_configArray('blacklist', 'nicknames')
|
||||
|
||||
$this->_nicknamePatterns = array_merge($this->nicknames,
|
||||
$this->_configArray('blacklist', 'nicknames'));
|
||||
$confNicknames);
|
||||
|
||||
$confURLs = $this->_configArray('blacklist', 'urls')
|
||||
|
||||
$this->_urlPatterns = array_merge($this->urls,
|
||||
$this->_configArray('blacklist', 'urls'));
|
||||
$confURLs);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an array from configuration
|
||||
*
|
||||
* Carefully checks a section.
|
||||
*
|
||||
* @param string $section Configuration section
|
||||
* @param string $setting Configuration setting
|
||||
*
|
||||
* @return array configuration values
|
||||
*/
|
||||
|
||||
function _configArray($section, $setting)
|
||||
{
|
||||
$config = common_config($section, $setting);
|
||||
|
|
@ -69,7 +91,7 @@ class BlacklistPlugin extends Plugin
|
|||
} else if (is_array($config)) {
|
||||
return $config;
|
||||
} else if (is_string($config)) {
|
||||
return explode("\t", $config);
|
||||
return explode("\r\n", $config);
|
||||
} else {
|
||||
throw new Exception("Unknown data type for config $section + $setting");
|
||||
}
|
||||
|
|
@ -201,6 +223,7 @@ class BlacklistPlugin extends Plugin
|
|||
private function _checkUrl($url)
|
||||
{
|
||||
foreach ($this->_urlPatterns as $pattern) {
|
||||
common_debug("Checking $url against $pattern");
|
||||
if (preg_match("/$pattern/", $url)) {
|
||||
return false;
|
||||
}
|
||||
|
|
@ -222,6 +245,7 @@ class BlacklistPlugin extends Plugin
|
|||
private function _checkNickname($nickname)
|
||||
{
|
||||
foreach ($this->_nicknamePatterns as $pattern) {
|
||||
common_debug("Checking $nickname against $pattern");
|
||||
if (preg_match("/$pattern/", $nickname)) {
|
||||
return false;
|
||||
}
|
||||
|
|
@ -230,14 +254,102 @@ class BlacklistPlugin extends Plugin
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add our actions to the URL router
|
||||
*
|
||||
* @param Net_URL_Mapper $m URL mapper for this hit
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onRouterInitialized($m)
|
||||
{
|
||||
$m->connect('admin/blacklist', array('action' => 'blacklistadminpanel'));
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Auto-load our classes if called
|
||||
*
|
||||
* @param string $cls Class to load
|
||||
*
|
||||
* @return boolean hook return
|
||||
*/
|
||||
|
||||
function onAutoload($cls)
|
||||
{
|
||||
switch (strtolower($cls))
|
||||
{
|
||||
case 'blacklistadminpanelaction':
|
||||
$base = strtolower(mb_substr($cls, 0, -6));
|
||||
include_once INSTALLDIR.'/plugins/Blacklist/'.$base.'.php';
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Plugin version data
|
||||
*
|
||||
* @param array &$versions array of version blocks
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onPluginVersion(&$versions)
|
||||
{
|
||||
$versions[] = array('name' => 'Blacklist',
|
||||
'version' => self::VERSION,
|
||||
'author' => 'Evan Prodromou',
|
||||
'homepage' => 'http://status.net/wiki/Plugin:Blacklist',
|
||||
'homepage' =>
|
||||
'http://status.net/wiki/Plugin:Blacklist',
|
||||
'description' =>
|
||||
_m('Keep a blacklist of forbidden nickname and URL patterns.'));
|
||||
_m('Keep a blacklist of forbidden nickname '.
|
||||
'and URL patterns.'));
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if our admin panel can be shown
|
||||
*
|
||||
* @param string $name name of the admin panel
|
||||
* @param boolean &$isOK result
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onAdminPanelCheck($name, &$isOK)
|
||||
{
|
||||
if ($name == 'blacklist') {
|
||||
$isOK = $this->canAdmin;
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add our tab to the admin panel
|
||||
*
|
||||
* @param Widget $nav Admin panel nav
|
||||
*
|
||||
* @return boolean hook value
|
||||
*/
|
||||
|
||||
function onEndAdminPanelNav($nav)
|
||||
{
|
||||
if (AdminPanelAction::canAdmin('blacklist')) {
|
||||
|
||||
$action_name = $nav->action->trimmed('action');
|
||||
|
||||
$nav->out->menuItem(common_local_url('blacklistadminpanel'),
|
||||
_('Blacklist'),
|
||||
_('Blacklist configuration'),
|
||||
$action_name == 'blacklistadminpanel',
|
||||
'nav_blacklist_admin_panel');
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,222 @@
|
|||
<?php
|
||||
/**
|
||||
* StatusNet, the distributed open-source microblogging tool
|
||||
*
|
||||
* Blacklist 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>
|
||||
* @copyright 2010 StatusNet, Inc.
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
|
||||
* @link http://status.net/
|
||||
*/
|
||||
|
||||
if (!defined('STATUSNET')) {
|
||||
exit(1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Administer blacklist
|
||||
*
|
||||
* @category Admin
|
||||
* @package StatusNet
|
||||
* @author Evan Prodromou <evan@status.net>
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
|
||||
* @link http://status.net/
|
||||
*/
|
||||
|
||||
class BlacklistadminpanelAction extends AdminPanelAction
|
||||
{
|
||||
/**
|
||||
* title of the admin panel
|
||||
*
|
||||
* @return string title
|
||||
*/
|
||||
|
||||
function title()
|
||||
{
|
||||
return _('Blacklist');
|
||||
}
|
||||
|
||||
/**
|
||||
* Panel instructions
|
||||
*
|
||||
* @return string instructions
|
||||
*/
|
||||
|
||||
function getInstructions()
|
||||
{
|
||||
return _('Blacklisted URLs and nicknames');
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the actual form
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @see BlacklistAdminPanelForm
|
||||
*/
|
||||
|
||||
function showForm()
|
||||
{
|
||||
$form = new BlacklistAdminPanelForm($this);
|
||||
$form->show();
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Save the form settings
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
||||
function saveSettings()
|
||||
{
|
||||
static $settings = array(
|
||||
'blacklist' => array('nicknames', 'urls'),
|
||||
);
|
||||
|
||||
$values = array();
|
||||
|
||||
foreach ($settings as $section => $parts) {
|
||||
foreach ($parts as $setting) {
|
||||
$values[$section][$setting] = $this->trimmed("$section-$setting");
|
||||
}
|
||||
}
|
||||
|
||||
// This throws an exception on validation errors
|
||||
|
||||
$this->validate($values);
|
||||
|
||||
// assert(all values are valid);
|
||||
|
||||
$config = new Config();
|
||||
|
||||
$config->query('BEGIN');
|
||||
|
||||
foreach ($settings as $section => $parts) {
|
||||
foreach ($parts as $setting) {
|
||||
Config::save($section, $setting, $values[$section][$setting]);
|
||||
}
|
||||
}
|
||||
|
||||
$config->query('COMMIT');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate the values
|
||||
*
|
||||
* @param array &$values 2d array of values to check
|
||||
*
|
||||
* @return boolean success flag
|
||||
*/
|
||||
|
||||
function validate(&$values)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Admin panel form for blacklist panel
|
||||
*
|
||||
* @category Admin
|
||||
* @package StatusNet
|
||||
* @author Evan Prodromou <evan@status.net>
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
|
||||
* @link http://status.net/
|
||||
*/
|
||||
|
||||
class BlacklistAdminPanelForm extends Form
|
||||
{
|
||||
/**
|
||||
* ID of the form
|
||||
*
|
||||
* @return string ID
|
||||
*/
|
||||
|
||||
function id()
|
||||
{
|
||||
return 'blacklistadminpanel';
|
||||
}
|
||||
|
||||
/**
|
||||
* Class of the form
|
||||
*
|
||||
* @return string class
|
||||
*/
|
||||
|
||||
function formClass()
|
||||
{
|
||||
return 'form_settings';
|
||||
}
|
||||
|
||||
/**
|
||||
* Action we post to
|
||||
*
|
||||
* @return string action URL
|
||||
*/
|
||||
|
||||
function action()
|
||||
{
|
||||
return common_local_url('blacklistadminpanel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the form controls
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
||||
function formData()
|
||||
{
|
||||
$this->out->elementStart('ul', 'form_data');
|
||||
|
||||
$this->out->elementStart('li');
|
||||
$this->out->textarea('blacklist-nicknames', _m('Nicknames'),
|
||||
common_config('blacklist', 'nicknames'),
|
||||
_('Patterns of nicknames to block, one per line'));
|
||||
$this->out->elementEnd('li');
|
||||
|
||||
$this->out->elementStart('li');
|
||||
$this->out->textarea('blacklist-urls', _m('URLs'),
|
||||
common_config('blacklist', 'urls'),
|
||||
_('Patterns of URLs to block, one per line'));
|
||||
$this->out->elementEnd('li');
|
||||
|
||||
$this->out->elementEnd('ul');
|
||||
}
|
||||
|
||||
/**
|
||||
* Buttons for submitting
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
||||
function formActions()
|
||||
{
|
||||
$this->out->submit('submit',
|
||||
_('Save'),
|
||||
'submit',
|
||||
null,
|
||||
_('Save site settings'));
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue