root/trunk/Phergie/Plugin/Karma.php @ 59

<?php

/**
* @see Phergie_Event_Handler
*/
require_once 'Phergie/Event/Handler.php';

/**
* Handles requests for incrementation or decrementation of a maintained list
* of counters for specified terms and antithrottling to prevent extreme
* inflation or depression of counters by any single individual.
*/
class Phergie_Plugin_Karma extends Phergie_Event_Handler
{
    /**
    * Stores the SQLite object
    *
    * @var resource
    */
    protected $db = null;

    /**
    * Retains the last garbage collection date
    *
    * @var array
    */
    protected $lastGc = null;

    /**
    * Logs the karma usages and limits users to one karma change per word
    * and per day
    *
    * @return void
    */
    protected $log = array();

    /**
    * Some fixed karma values, keys must be lowercase
    *
    * @var array
    */
    protected $fixedKarma;

    /**
    * Connects to the database containing karma ratings and initializes
    * class properties.
    *
    * @return void
    */
    public function init()
    {
        $this->db = null;
        $this->lastGc = null;
        $this->log = null;

        $this->fixedKarma = array
        (
            'pi' => 'pi has karma of ' . M_PI,
            'chucknorris' => 'pi has karma of Warning: Integer out of range',
            'c' => 'c has karma of 299 792 458 m/s',
            'e' => 'e has karma of ' . M_E,
            'euler' => 'euler has karma of ' . M_EULER,
            'mole' => 'mole has karma of 6.02214e23 molecules',
            'spoon' => 'spoon has no karma. There is no spoon.',
            strtolower($this->getIni('nick')) => $this->getIni('static'),
            'mc^2' => 'mc^2 has karma of e',
            'mc2' => 'mc2 has karma of e',
            'mc²' => 'mc² has karma of e',
        );

        // Check to ensure that the SQLite extension is loaded
        if (!extension_loaded('sqlite')) {
            return;
        }

        // Create a directory to contain the database if needed
        if (!file_exists(dirname(__FILE__).'/Karma'))
            mkdir(dirname(__FILE__).'/Karma');

        // Load or initialize the database
        $db = dirname(__FILE__).'/Karma/karma.db';
        if (!file_exists($db)) {
            $this->db = new SQLiteDatabase($db);
            $this->db->queryExec('
                CREATE TABLE karmas ( word VARCHAR ( 255 ) , karma MEDIUMINT ) ;
                CREATE UNIQUE INDEX word ON karmas ( word ) ;
                CREATE INDEX karmaIndex ON karmas ( karma ) ;
            ');
            $this->db->queryExec('
                CREATE TABLE comments ( wordid INT , comment VARCHAR ( 255 ) ) ;
                CREATE INDEX wordidIndex ON comments ( wordid ) ;
                CREATE UNIQUE INDEX commentUnique ON comments ( comment ) ;
            ');
        } else {
            $this->db = new SQLiteDatabase($db);
        }
    }

    /**
    * Handles requests for incrementation, decrementation, or lookup of karma
    * ratings sent via messages from users.
    *
    * @return void
    */
    public function onPrivmsg()
    {
        if ($this->db === null) {
            return;
        }
        $target = $this->getSource();
        $message = $this->event->getArgument(1);
            // Karma status request
        if (preg_match('#^karma (\S+?)$#i', $message, $m)) {
            // Return fixed value if set
            if(isset($this->fixedKarma[strtolower($m[1])])) {
                $this->doPrivmsg($source, $m[1] . ' ' . $this->fixedKarma[strtolower($m[1])]);
                return;
            }
            // Return current karma or neutral if not set yet
            $res = $this->db->query('SELECT karma FROM karmas WHERE word = \''.sqlite_escape_string(strtolower($m[1])).'\' LIMIT 1', SQLITE_NUM);
            if ($res->numRows() && $res->column(0) != 0) {
                    $this->doPrivmsg($source, $m[1].' has karma of '.$res->column(0));
            } else {
                    $this->doPrivmsg($source, $m[1].' has neutral karma');
            }
        // Incrementation/decrementation request
        } elseif (preg_match('#^(\S+?)(\+\+|--)\s*(.*)$#i', $message, $m)) {
            $word = strtolower($m[1]);
            // Do nothing if the karma fixed
            if (isset($this->fixedKarma[$word])) {
                return;
            }
            // Force a decrementation if someone tries to update his own karma
            if ($word == strtolower($this->event->getNick())) {
                $m[2] = '--';
            }
            // Antithrottling check
            $host = $this->event->getHost();
            $limit = $this->getIni('limit');
            if (isset ($this->log[$host][$word])
                && $limit
                && $this->log[$host][$word] > $limit) {
                return;
            } else {
                $this->log[$host][$word] = 0;
            }
            $this->log[$host][$word]++;
            // Get the current value then update or create entry
            $res = $this->db->query('SELECT karma, ROWID FROM karmas WHERE word = \''.sqlite_escape_string($word).'\' LIMIT 1', SQLITE_NUM);
            if ($res->numRows()) {
                $this->db->queryExec('UPDATE karmas SET karma = '.($res->column(0) + ($m[2]=='++' ? 1 : -1)).' WHERE word = \''.sqlite_escape_string($word).'\'');
                $id = $res->column(1);
            } else {
                $this->db->queryExec('INSERT INTO karmas (word, karma) VALUES (\''.sqlite_escape_string($word).'\', '.($m[2]=='++' ? '1' : '-1').')');
                $res = $this->db->query('SELECT ROWID FROM karmas WHERE word = \''.sqlite_escape_string($word).'\' LIMIT 1', SQLITE_NUM);
                $id = $res->column(0);
            }
            // Add comment
            if (!empty($m[3])) {
                $this->db->queryExec('INSERT OR IGNORE INTO comments (wordid, comment) VALUES ('.$id.', \''.sqlite_escape_string($m[3]).'\')');
            }
            // Perform garbage collection on the antithrottling log if needed
            if (date('d') !== $this->lastGc) {
                $this->doGc();
            }
        }
    }

    /**
     * Performs garbage collection on the antithrottling log.
     *
     * @return void
     */
    public function doGc()
    {
        unset ($this->log);
        $this->log = array();
        $this->lastGc = date('d');
    }
}