plugins/Blacklist/Homepage_blacklist.php

   1 <?php
   2 /**
   3  * Data class for homepage 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 Homepage 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 Homepage_blacklist extends Memcached_DataObject
  48 {
  49     public $__table = 'homepage_blacklist'; // table name
  50     public $pattern;                        // string pattern
  51     public $created;                        // datetime
  52
  53     /**
  54      * Get an instance by key
  55      *
  56      * This is a utility method to get a single instance with a given key value.
  57      *
  58      * @param string $k Key to use to lookup (usually 'user_id' for this class)
  59      * @param mixed  $v Value to lookup
  60      *
  61      * @return Homepage_blacklist object found, or null for no hits
  62      *
  63      */
  64     function staticGet($k, $v=null)
  65     {
  66         return Memcached_DataObject::staticGet('Homepage_blacklist', $k, $v);
  67     }
  68
  69     /**
  70      * return table definition for DB_DataObject
  71      *
  72      * DB_DataObject needs to know something about the table to manipulate
  73      * instances. This method provides all the DB_DataObject needs to know.
  74      *
  75      * @return array array of column definitions
  76      */
  77     function table()
  78     {
  79         return array('pattern' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  80                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  81     }
  82
  83     /**
  84      * return key definitions for DB_DataObject
  85      *
  86      * DB_DataObject needs to know about keys that the table has; this function
  87      * defines them.
  88      *
  89      * @return array key definitions
  90      */
  91     function keys()
  92     {
  93         return array_keys($this->keyTypes());
  94     }
  95
  96     /**
  97      * return key definitions for Memcached_DataObject
  98      *
  99      * Our caching system uses the same key definitions, but uses a different
 100      * method to get them.
 101      *
 102      * @return array key definitions
 103      */
 104     function keyTypes()
 105     {
 106         return array('pattern' => 'K');
 107     }
 108
 109     /**
 110      * Return a list of patterns to check
 111      *
 112      * @return array string patterns to check
 113      */
 114     static function getPatterns()
 115     {
 116         $patterns = self::cacheGet('homepage_blacklist:patterns');
 117
 118         if ($patterns === false) {
 119
 120             $patterns = array();
 121
 122             $nb = new Homepage_blacklist();
 123
 124             $nb->find();
 125
 126             while ($nb->fetch()) {
 127                 $patterns[] = $nb->pattern;
 128             }
 129
 130             self::cacheSet('homepage_blacklist:patterns', $patterns);
 131         }
 132
 133         return $patterns;
 134     }
 135
 136     /**
 137      * Save new list of patterns
 138      *
 139      * @return array of patterns to check
 140      */
 141     static function saveNew($newPatterns)
 142     {
 143         $oldPatterns = self::getPatterns();
 144
 145         // Delete stuff that's old that not in new
 146         $toDelete = array_diff($oldPatterns, $newPatterns);
 147
 148         // Insert stuff that's in new and not in old
 149         $toInsert = array_diff($newPatterns, $oldPatterns);
 150
 151         foreach ($toDelete as $pattern) {
 152             $nb = Homepage_blacklist::staticGet('pattern', $pattern);
 153             if (!empty($nb)) {
 154                 $nb->delete();
 155             }
 156         }
 157
 158         foreach ($toInsert as $pattern) {
 159             $nb = new Homepage_blacklist();
 160             $nb->pattern = $pattern;
 161             $nb->created = common_sql_now();
 162             $nb->insert();
 163         }
 164
 165         self::blow('homepage_blacklist:patterns');
 166     }
 167
 168     static function ensurePattern($pattern)
 169     {
 170         $hb = Homepage_blacklist::staticGet('pattern', $pattern);
 171
 172         if (empty($nb)) {
 173             $hb = new Homepage_blacklist();
 174             $hb->pattern = $pattern;
 175             $hb->created = common_sql_now();
 176             $hb->insert();
 177             self::blow('homepage_blacklist:patterns');
 178         }
 179     }
 180 }