summaryrefslogtreecommitdiff
path: root/plugins/Irc/extlib/phergie/Phergie/Plugin/Tld.php
blob: 5efc265c6403b2b479764092e89ea6ac4d863faa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?php

/**
 * Phergie
 *
 * PHP version 5
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.
 * It is also available through the world-wide-web at this URL:
 * http://phergie.org/license
 *
 * @category  Phergie
 * @package   Phergie_Plugin_Url
 * @author    Phergie Development Team <team@phergie.org>
 * @copyright 2008-2010 Phergie Development Team (http://phergie.org)
 * @license   http://phergie.org/license New BSD License
 * @link      http://pear.phergie.org/package/Phergie_Plugin_Url
 */

/**
 * Responds to a request for a TLD (formatted as .tld where tld is the TLD to
 * be looked up) with its corresponding description.
 *
 * @category Phergie
 * @package  Phergie_Plugin_Tld
 * @author   Phergie Development Team <team@phergie.org>
 * @license  http://phergie.org/license New BSD License
 * @link     http://pear.phergie.org/package/Phergie_Plugin_Tld
 * @uses     Phergie_Plugin_Http pear.phergie.org
 * @uses     extension PDO
 * @uses     extension pdo_sqlite
 *
 * @pluginDesc Provides information for a top level domain.
 */
class Phergie_Plugin_Tld extends Phergie_Plugin_Abstract
{
    /**
     * connection to the database
     * @var PDO
     */
    protected $db;
    /**
     * Some fixed TLD values, keys must be lowercase
     * @var array
     */
    protected static $fixedTlds;

    /**
     * Prepared statement for selecting a single tld
     * @var PDOStatement
     */
    protected $select;

    /**
     * Prepared statement for selecting all tlds
     * @var PDOStatement
     */
    protected $selectAll;

    /**
     * Checks for dependencies, sets up database and hard coded values
     *
     * @return void
     */
    public function onLoad()
    {
        $help = $this->getPluginHandler()->getPlugin('Help');
        $help->register($this);

        if (!is_array(self::$fixedTlds)) {
            self::$fixedTlds = array(
                'phergie' => 'You can find Phergie at http://www.phergie.org',
                'spoon'   => 'Don\'t you know? There is no spoon!',
                'poo'     => 'Do you really think that\'s funny?',
                'root'    => 'Diagnostic marker to indicate '
                . 'a root zone load was not truncated.'
            );
        }

        $dbFile = dirname(__FILE__) . '/Tld/tld.db';
        try {
            $this->db = new PDO('sqlite:' . $dbFile);

            $this->select = $this->db->prepare('
                SELECT type, description
                FROM tld
                WHERE LOWER(tld) = LOWER(:tld)
            ');

            $this->selectAll = $this->db->prepare('
                SELECT tld, type, description
                FROM btld
            ');
        } catch (PDOException $e) {
            $this->getPluginHandler()->removePlugin($this);
        }
    }

    /**
     * takes a tld in the format '.tld' and returns its related data
     *
     * @param string $tld tld to process
     *
     * @return null
     *
     * @pluginCmd .[tld] request details about the tld
     */
    public function onCommandTld($tld)
    {
        $tld = ltrim($tld, '.');
        $description = $this->getTld($tld);
        $this->doPrivmsg(
            $this->event->getSource(),
            "{$this->getEvent()->getNick()}: .{$tld} -> "
            . ($description ? $description : 'Unknown TLD')
        );
    }

    /**
     * Retrieves the definition for a given TLD if it exists
     *
     * @param string $tld TLD to search for
     *
     * @return string Definition of the given TLD
     */
    public function getTld($tld)
    {
        $tld = trim(strtolower($tld));
        if (isset(self::$fixedTlds[$tld])) {
            return self::$fixedTlds[$tld];
        } else {
            if ($this->select->execute(array('tld' => $tld))) {
                $tlds = $this->select->fetch();
                if (is_array($tlds)) {
                    return '(' . $tlds['type'] . ') ' . $tlds['description'];
                }
            }
        }
        return false;
    }

    /**
     * Retrieves a list of all the TLDs and their definitions
     *
     * @return array Array of all the TLDs and their definitions
     */
    public function getTlds()
    {
        if ($this->selectAll->execute()) {
            $tlds = $this->selectAll->fetchAll();
            if (is_array($tlds)) {
                $tldinfo = array();
                foreach ($tlds as $key => $tld) {
                    if (!empty($tld['tld'])) {
                        $tldinfo[$tld['tld']] = "({$tld['type']}) "
                        . $tld['description'];
                    }
                }
                unset($tlds);
                return $tldinfo;
            }
        }
        return false;
    }
}