gnu-social/plugins/Blacklist/Nickname_blacklist.php

172 lines
4.5 KiB
PHP
Raw Normal View History

<?php
/**
* Data class for nickname blacklisting
*
* PHP version 5
*
* @category Data
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2009, StatusNet, Inc.
*
* 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/>.
*/
if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
/**
* Data class for Nickname blacklist
*
* @category Action
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*
* @see DB_DataObject
*/
class Nickname_blacklist extends Memcached_DataObject
{
public $__table = 'nickname_blacklist'; // table name
public $pattern; // string pattern
public $created; // datetime
/**
* Get an instance by key
*
* This is a utility method to get a single instance with a given key value.
*
* @param string $k Key to use to lookup
* @param mixed $v Value to lookup
*
* @return Nickname_blacklist object found, or null for no hits
*
*/
function staticGet($k, $v=null)
{
return Memcached_DataObject::staticGet('Nickname_blacklist', $k, $v);
}
/**
* return table definition for DB_DataObject
*
* @return array array of column definitions
*/
function table()
{
return array('pattern' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
}
/**
* return key definitions for DB_DataObject
*
* @return array key definitions
*/
function keys()
{
return array_keys($this->keyTypes());
}
/**
* return key definitions for Memcached_DataObject
*
* @return array key definitions
*/
function keyTypes()
{
return array('pattern' => 'K');
}
/**
* Return a list of patterns to check
*
* @return array string patterns to check
*/
static function getPatterns()
{
$patterns = self::cacheGet('nickname_blacklist:patterns');
if ($patterns === false) {
$patterns = array();
$nb = new Nickname_blacklist();
$nb->find();
while ($nb->fetch()) {
$patterns[] = $nb->pattern;
}
self::cacheSet('nickname_blacklist:patterns', $patterns);
}
return $patterns;
}
/**
* Save new list of patterns
*
* @return array of patterns to check
*/
static function saveNew($newPatterns)
{
$oldPatterns = self::getPatterns();
// Delete stuff that's old that not in new
$toDelete = array_diff($oldPatterns, $newPatterns);
// Insert stuff that's in new and not in old
$toInsert = array_diff($newPatterns, $oldPatterns);
foreach ($toDelete as $pattern) {
$nb = Nickname_blacklist::staticGet('pattern', $pattern);
if (!empty($nb)) {
$nb->delete();
}
}
foreach ($toInsert as $pattern) {
$nb = new Nickname_blacklist();
$nb->pattern = $pattern;
$nb->created = common_sql_now();
$nb->insert();
}
self::blow('nickname_blacklist:patterns');
}
static function ensurePattern($pattern)
{
$nb = Nickname_blacklist::staticGet('pattern', $pattern);
if (empty($nb)) {
$nb = new Nickname_blacklist();
$nb->pattern = $pattern;
$nb->created = common_sql_now();
$nb->insert();
self::blow('nickname_blacklist:patterns');
}
}
}