plugins/Irc/ircmanager.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 /**
  23  * IRC background connection manager for IRC-using queue handlers,
  24  * allowing them to send outgoing messages on the right connection.
  25  *
  26  * Input is handled during socket select loop, keepalive pings during idle.
  27  * Any incoming messages will be handled.
  28  *
  29  * In a multi-site queuedaemon.php run, one connection will be instantiated
  30  * for each site being handled by the current process that has IRC enabled.
  31  */
  32
  33 class IrcManager extends ImManager {
  34     public $conn = null;
  35     public $regchecks = array();
  36     public $regchecksLookup = array();
  37
  38     /**
  39      * Initialize connection to server.
  40      *
  41      * @return boolean true on success
  42      */
  43     public function start($master) {
  44         if (parent::start($master)) {
  45             $this->connect();
  46             return true;
  47         } else {
  48             return false;
  49         }
  50     }
  51
  52     /**
  53     * Return any open sockets that the run loop should listen
  54     * for input on.
  55     *
  56     * @return array Array of socket resources
  57     */
  58     public function getSockets() {
  59         $this->connect();
  60         if ($this->conn) {
  61             return $this->conn->getSockets();
  62         } else {
  63             return array();
  64         }
  65     }
  66
  67     /**
  68      * Process IRC events that have come in over the wire.
  69      *
  70      * @param resource $socket
  71      * @return void
  72      */
  73     public function handleInput($socket) {
  74         common_log(LOG_DEBUG, 'Servicing the IRC queue.');
  75         $this->stats('irc_process');
  76         $this->conn->receive();
  77     }
  78
  79     /**
  80     * Initiate connection
  81     *
  82     * @return void
  83     */
  84     public function connect() {
  85         if (!$this->conn) {
  86             $this->conn = new Phergie_StatusnetBot;
  87
  88             $config = new Phergie_Config;
  89             $config->readArray(
  90                 array(
  91                     'connections' => array(
  92                         array(
  93                             'host' => $this->plugin->host,
  94                             'port' => $port,
  95                             'username' => $this->plugin->username,
  96                             'realname' => $this->plugin->realname,
  97                             'nick' => $this->plugin->nick,
  98                             'password' => $this->plugin->password,
  99                             'transport' => $this->plugin->transporttype,
 100                             'encoding' => $this->plugin->encoding
 101                         )
 102                     ),
 103
 104                     'driver' => 'statusnet',
 105
 106                     'processor' => 'statusnet',
 107
 108                     'plugins' => array(
 109                         'Pong',
 110                         'NickServ',
 111                         'AutoJoin',
 112                         'Statusnet',
 113                     ),
 114
 115                     'plugins.autoload' => true,
 116
 117                     'ui.enabled' => true,
 118
 119                     'nickserv.password' => $this->plugin->nickservpassword,
 120                     'autojoin.channels' => $this->plugin->channels,
 121                     'statusnet.messagecallback' => array($this, 'handle_irc_message'),
 122                     'statusnet.regcallback' => array($this, 'handle_reg_response')
 123                 )
 124             );
 125
 126             $this->conn->setConfig($config);
 127             $this->conn->connect();
 128         }
 129         return $this->conn;
 130     }
 131
 132     /**
 133     * Called via a callback when a message is received
 134     *
 135     * Passes it back to the queuing system
 136     *
 137     * @param array $data Data
 138     * @return boolean
 139     */
 140     public function handle_irc_message($data) {
 141         $this->plugin->enqueue_incoming_raw($data);
 142         return true;
 143     }
 144
 145     /**
 146     * Called via a callback when NickServ responds to
 147     * the bots query asking if a nick is registered
 148     *
 149     * @param array $data Data
 150     * @return void
 151     */
 152     public function handle_reg_response($data) {
 153         // Retrieve data
 154         $screenname = $data['screenname'];
 155         $nickdata = $this->regchecks[$screenname];
 156         $usernick = $nickdata['user']->nickname;
 157
 158         if (isset($this->regchecksLookup[$usernick])) {
 159             if ($data['registered']) {
 160                 // Send message
 161                 $this->plugin->send_confirmation_code($screenname, $nickdata['code'], $nickdata['user'], true);
 162             } else {
 163                 $this->plugin->send_message($screenname, _m('Your nickname is not registered so IRC connectivity cannot be enabled'));
 164
 165                 $confirm = new Confirm_address();
 166
 167                 $confirm->user_id      = $user->id;
 168                 $confirm->address_type = $this->plugin->transport;
 169
 170                 if ($confirm->find(true)) {
 171                     $result = $confirm->delete();
 172
 173                     if (!$result) {
 174                         common_log_db_error($confirm, 'DELETE', __FILE__);
 175                         // TRANS: Server error thrown on database error canceling IM address confirmation.
 176                         $this->serverError(_('Couldn\'t delete confirmation.'));
 177                         return;
 178                     }
 179                 }
 180             }
 181
 182             // Unset lookup value
 183             unset($this->regchecksLookup[$usernick]);
 184
 185             // Unset data
 186             unset($this->regchecks[$screename]);
 187         }
 188     }
 189
 190     /**
 191      * Send a message using the daemon
 192      *
 193      * @param $data Message
 194      * @return boolean true on success
 195      */
 196     public function send_raw_message($data) {
 197         $this->connect();
 198         if (!$this->conn) {
 199             return false;
 200         }
 201
 202         if ($data['type'] != 'message') {
 203             // Nick checking
 204             $nickdata = $data['nickdata'];
 205             $usernick = $nickdata['user']->nickname;
 206             $screenname = $nickdata['screenname'];
 207
 208             // Cancel any existing checks for this user
 209             if (isset($this->regchecksLookup[$usernick])) {
 210                 unset($this->regchecks[$this->regchecksLookup[$usernick]]);
 211             }
 212
 213             $this->regchecks[$screenname] = $nickdata;
 214             $this->regchecksLookup[$usernick] = $screenname;
 215         }
 216
 217         try {
 218             $this->conn->send($data['data']['command'], $data['data']['args']);
 219         } catch (Phergie_Driver_Exception $e) {
 220             $this->conn->reconnect();
 221             return false;
 222         }
 223
 224         return true;
 225     }
 226 }