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/
48 class Nickname_blacklist extends Memcached_DataObject
50 public $__table = 'nickname_blacklist'; // table name
51 public $pattern; // string pattern
52 public $created; // datetime
55 * Get an instance by key
57 * This is a utility method to get a single instance with a given key value.
59 * @param string $k Key to use to lookup
60 * @param mixed $v Value to lookup
62 * @return Nickname_blacklist object found, or null for no hits
66 function staticGet($k, $v=null)
68 return Memcached_DataObject::staticGet('Nickname_blacklist', $k, $v);
72 * return table definition for DB_DataObject
74 * @return array array of column definitions
79 return array('pattern' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
80 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
84 * return key definitions for DB_DataObject
86 * @return array key definitions
91 return array('pattern' => 'K');
95 * return key definitions for Memcached_DataObject
97 * @return array key definitions
102 return $this->keys();
106 * Return a list of patterns to check
108 * @return array string patterns to check
111 static function getPatterns()
113 $patterns = self::cacheGet('nickname_blacklist:patterns');
115 if ($patterns === false) {
119 $nb = new Nickname_blacklist();
123 while ($nb->fetch()) {
124 $patterns[] = $nb->pattern;
127 self::cacheSet('nickname_blacklist:patterns', $patterns);
134 * Save new list of patterns
136 * @return array of patterns to check
139 static function saveNew($newPatterns)
141 $oldPatterns = self::getPatterns();
143 // Delete stuff that's old that not in new
145 $toDelete = array_diff($oldPatterns, $newPatterns);
147 // Insert stuff that's in new and not in old
149 $toInsert = array_diff($newPatterns, $oldPatterns);
151 foreach ($toDelete as $pattern) {
152 $nb = Nickname_blacklist::staticGet('pattern', $pattern);
158 foreach ($toInsert as $pattern) {
159 $nb = new Nickname_blacklist();
160 $nb->pattern = $pattern;
161 $nb->created = common_sql_now();
165 self::blow('nickname_blacklist:patterns');
168 static function ensurePattern($pattern)
170 $nb = Nickname_blacklist::staticGet('pattern', $pattern);
173 $nb = new Nickname_blacklist();
174 $nb->pattern = $pattern;
175 $nb->created = common_sql_now();
177 self::blow('nickname_blacklist:patterns');