summaryrefslogtreecommitdiff
path: root/plugins/Irc/extlib/phergie/Phergie/Plugin/AutoJoin.php
blob: a6d1adfbb2516c3c6fddc7ad3d7f32d63595acc0 (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
<?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_AutoJoin
 * @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_AutoJoin
 */

/**
 * Automates the process of having the bot join one or more channels upon
 * connection to the server.
 *
 * The configuration setting autojoin.channels is used to determine which 
 * channels to join. This setting can point to a comma-delimited string or 
 * enumerated array containing a single list of channels or an associative 
 * array keyed by hostname where each value is a comma-delimited string or  
 * enumerated array containing a list of channels to join on the server  
 * corresponding to that hostname.
 *
 * @category Phergie 
 * @package  Phergie_Plugin_AutoJoin
 * @author   Phergie Development Team <team@phergie.org>
 * @license  http://phergie.org/license New BSD License
 * @link     http://pear.phergie.org/package/Phergie_Plugin_AutoJoin
 */
class Phergie_Plugin_AutoJoin extends Phergie_Plugin_Abstract
{
    /**
     * Intercepts the end of the "message of the day" response and responds by
     * joining the channels specified in the configuration file.
     *
     * @return void
     */
    public function onResponse()
    {
        switch ($this->getEvent()->getCode()) {
        case Phergie_Event_Response::RPL_ENDOFMOTD:
        case Phergie_Event_Response::ERR_NOMOTD:
            if ($channels = $this->config['autojoin.channels']) {
                if (is_array($channels)) {
                    // Support autojoin.channels being in these formats:
                    // 'hostname' => array('#channel1', '#channel2', ... )
                    $host = $this->getConnection()->getHost();
                    if (isset($channels[$host])) {
                        $channels = $channels[$host];
                    }
                    if (is_array($channels)) {
                        $channels = implode(',', $channels);
                    }
                }
                $this->doJoin($channels);
            }
            $this->getPluginHandler()->removePlugin($this);
        }
    }
}