root/trunk/Phergie/Plugin/Acronym.php @ 72

<?php

/**
* @see Phergie_Plugin_Abstract_Base
*/
require_once 'Phergie/Plugin/Abstract/Base.php';

/**
* Searches received messages for consecutive sequences of two or more capital
* letters followed by a question mark, performs an acronym lookup for each
* sequence, and either returns a limited number of possible meanings for the
* acronym or performs a random action should no results be returned.
*
* The limit configuration setting should be set to the maximum number of
* potential meanings to return for any single given acronym.
*
* @todo Add a cache to avoid exceeding the acronymfinder.com daily lookup
*       limit. Cache should be flushed daily.
*/
class Phergie_Plugin_Acronym extends Phergie_Plugin_Abstract_Base
{
    /**
    * Maximum number of meanings to return for a single acronym
    *
    * @var int
    */
    protected $limit;

    /**
    * List of acronyms for which responses should not be sent
    *
    * @var array
    */
    protected $filter;

    /**
    * Possible reactions to return when no result is returned
    *
    * @var array
    */
    protected $reactions = array(
        'shrugs',
        'blinks',
        'giggles',
        'sighs',
        'yawns',
        'hides behind %randomuser%'
    );

    /**
    * Initializes the limit of meanings to return per acronym.
    *
    * @return void
    */
    public function init()
    {
        $limit = $this->getPluginIni('limit');
        if ($limit < 0 || $limit === null) {
            $this->limit = 5;
        } else {
            $this->limit = (int) $limit;
        }

        $this->filter = array_filter(preg_split('/[ ,]/', $this->getPluginIni('filter')), 'strlen');
    }

    /**
    * Returns a random action, meant for cases where an acronym lookup
    * returns no results.
    *
    * @param string $target Channel name or user nick to receive the action
    * @return void
    */
    protected function randomAction($target)
    {
        do {
            $reaction = $this->reactions[rand(0, count($this->reactions) - 1)];
            $randomUser = strpos($reaction, '%randomuser%');
        } while ($target[0] != '#' && $randomUser);
        if ($randomUser) {
            $nick = $this->getIni('nick');
            do {
                $user = Phergie_Plugin_Users::getRandomUser($target);
            } while ($user == $nick);
            $reaction = str_replace('%randomuser%', $user, $reaction);
        }
        $this->doAction($target, $reaction . '.');
    }

    /**
    * Processes acronym lookups and returns results when available, or
    * returns a random action when a lookup returns no results.
    *
    * @return void
    */
    public function onPrivmsg()
    {
        $target = $this->event->getSource();
        $message = $this->event->getArgument(1);

        // Matches an optional "Nick: " followed by an acronym formatted as A.B.C. or ABC
        if (!preg_match('/^(?:[A-Za-z0-9\[\]`|{}_-]+: )?((?:[A-Z]\.?){2,})\?$/', $message, $acronym)) {
            return;
        }

        $acronym = str_replace('.', '', $acronym[1]);

        if (in_array($acronym, $this->filter)) {
            return;
        }

        if (in_array($acronym, array('WHO', 'WHAT', 'WHERE', 'WHEN', 'WHY', 'HOW'))) {
            $this->doAction($target, 'shrugs.');
            return;
        }

        $opts = array('http' =>
            array(
                'timeout' => 5,
                'method' => 'GET',
                'header' => 'Content-type: application/x-www-form-urlencoded',
                'user_agent' => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.12) Gecko/20080201 Firefox/2.0.0.12',
                'content' => http_build_query(array('terms' => $acronym, 'andor' => 'or', 'acronym' => 'on'))
            )
        );
        $context = stream_context_create($opts);
        $url = 'http://www.acronymfinder.com/af-query.asp?Acronym=' . urlencode($acronym) . '&Find=find';
        $contents = @file_get_contents($url, false, $context);

        if (empty ($contents)
            || strpos($contents, 'no abbreviation matches') !== false
            || strpos($contents, 'has exceeded the daily query limit') !== false) {
            $this->randomAction($target);
        } else {
            $matches = array();
            $offset = 0;

            do {
                $count = preg_match(
                    '/<td width="65%"[^>]+>([^<]+)</i',
                    $contents,
                    $match,
                    PREG_OFFSET_CAPTURE,
                    $offset
                );
                if ($count == 1) {
                    $matches[] = $match[1][0];
                    $offset = $match[1][1];
                }
            } while (($this->limit == 0 || count($matches) < $this->limit) && $count == 1);

            $text = 'Possible matches for ' . $acronym . ': ' . implode(', ', $matches);
            $this->doPrivmsg($target, $text);
        }
    }
}