plugins/Blacklist/Nickname_blacklist.php

   1 <?php
   2 /**
   3  * Data class for nickname blacklisting
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2009, StatusNet, Inc.
  15  *
  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.
  20  *
  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.
  25  *
  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/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
  35
  36 /**
  37  * Data class for Nickname blacklist
  38  *
  39  * @category Action
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  43  * @link     http://status.net/
  44  *
  45  * @see      DB_DataObject
  46  */
  47 class Nickname_blacklist extends Managed_DataObject
  48 {
  49     public $__table = 'nickname_blacklist'; // table name
  50     public $pattern;                        // string pattern
  51     public $created;                        // datetime
  52
  53     /**
  54      * return table definition for DB_DataObject
  55      *
  56      * @return array array of column definitions
  57      */
  58     function table()
  59     {
  60         return array('pattern' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  61                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  62     }
  63
  64     /**
  65      * return key definitions for DB_DataObject
  66      *
  67      * @return array key definitions
  68      */
  69     function keys()
  70     {
  71         return array_keys($this->keyTypes());
  72     }
  73
  74     /**
  75      * return key definitions for Memcached_DataObject
  76      *
  77      * @return array key definitions
  78      */
  79     function keyTypes()
  80     {
  81         return array('pattern' => 'K');
  82     }
  83
  84     /**
  85      * Return a list of patterns to check
  86      *
  87      * @return array string patterns to check
  88      */
  89     static function getPatterns()
  90     {
  91         $patterns = self::cacheGet('nickname_blacklist:patterns');
  92
  93         if ($patterns === false) {
  94
  95             $patterns = array();
  96
  97             $nb = new Nickname_blacklist();
  98
  99             $nb->find();
 100
 101             while ($nb->fetch()) {
 102                 $patterns[] = $nb->pattern;
 103             }
 104
 105             self::cacheSet('nickname_blacklist:patterns', $patterns);
 106         }
 107
 108         return $patterns;
 109     }
 110
 111     /**
 112      * Save new list of patterns
 113      *
 114      * @return array of patterns to check
 115      */
 116     static function saveNew($newPatterns)
 117     {
 118         $oldPatterns = self::getPatterns();
 119
 120         // Delete stuff that's old that not in new
 121         $toDelete = array_diff($oldPatterns, $newPatterns);
 122
 123         // Insert stuff that's in new and not in old
 124         $toInsert = array_diff($newPatterns, $oldPatterns);
 125
 126         foreach ($toDelete as $pattern) {
 127             $nb = Nickname_blacklist::getKV('pattern', $pattern);
 128             if (!empty($nb)) {
 129                 $nb->delete();
 130             }
 131         }
 132
 133         foreach ($toInsert as $pattern) {
 134             $nb = new Nickname_blacklist();
 135             $nb->pattern = $pattern;
 136             $nb->created = common_sql_now();
 137             $nb->insert();
 138         }
 139
 140         self::blow('nickname_blacklist:patterns');
 141     }
 142
 143     static function ensurePattern($pattern)
 144     {
 145         $nb = Nickname_blacklist::getKV('pattern', $pattern);
 146
 147         if (empty($nb)) {
 148             $nb = new Nickname_blacklist();
 149             $nb->pattern = $pattern;
 150             $nb->created = common_sql_now();
 151             $nb->insert();
 152             self::blow('nickname_blacklist:patterns');
 153         }
 154     }
 155 }