3 * Data class for nickname blacklisting
9 * @author Evan Prodromou <evan@status.net>
10 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11 * @link http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2009, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
37 * Data class for Nickname blacklist
41 * @author Evan Prodromou <evan@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
43 * @link http://status.net/
47 class Nickname_blacklist extends Memcached_DataObject
49 public $__table = 'nickname_blacklist'; // table name
50 public $pattern; // string pattern
51 public $created; // datetime
54 * Get an instance by key
56 * This is a utility method to get a single instance with a given key value.
58 * @param string $k Key to use to lookup
59 * @param mixed $v Value to lookup
61 * @return Nickname_blacklist object found, or null for no hits
64 function staticGet($k, $v=null)
66 return Memcached_DataObject::staticGet('Nickname_blacklist', $k, $v);
70 * return table definition for DB_DataObject
72 * @return array array of column definitions
76 return array('pattern' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
77 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
81 * return key definitions for DB_DataObject
83 * @return array key definitions
87 return array_keys($this->keyTypes());
91 * return key definitions for Memcached_DataObject
93 * @return array key definitions
97 return array('pattern' => 'K');
101 * Return a list of patterns to check
103 * @return array string patterns to check
105 static function getPatterns()
107 $patterns = self::cacheGet('nickname_blacklist:patterns');
109 if ($patterns === false) {
113 $nb = new Nickname_blacklist();
117 while ($nb->fetch()) {
118 $patterns[] = $nb->pattern;
121 self::cacheSet('nickname_blacklist:patterns', $patterns);
128 * Save new list of patterns
130 * @return array of patterns to check
132 static function saveNew($newPatterns)
134 $oldPatterns = self::getPatterns();
136 // Delete stuff that's old that not in new
137 $toDelete = array_diff($oldPatterns, $newPatterns);
139 // Insert stuff that's in new and not in old
140 $toInsert = array_diff($newPatterns, $oldPatterns);
142 foreach ($toDelete as $pattern) {
143 $nb = Nickname_blacklist::staticGet('pattern', $pattern);
149 foreach ($toInsert as $pattern) {
150 $nb = new Nickname_blacklist();
151 $nb->pattern = $pattern;
152 $nb->created = common_sql_now();
156 self::blow('nickname_blacklist:patterns');
159 static function ensurePattern($pattern)
161 $nb = Nickname_blacklist::staticGet('pattern', $pattern);
164 $nb = new Nickname_blacklist();
165 $nb->pattern = $pattern;
166 $nb->created = common_sql_now();
168 self::blow('nickname_blacklist:patterns');