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      * Idle processing for io manager's execution loop.
  69      * Send keepalive pings to server.
  70      *
  71      * @return void
  72      */
  73     public function idle() {
  74         // Call Phergie's doTick methods if necessary
  75         $this->conn->handleEvents();
  76     }
  77
  78     /**
  79      * Process IRC events that have come in over the wire.
  80      *
  81      * @param resource $socket
  82      * @return void
  83      */
  84     public function handleInput($socket) {
  85         common_log(LOG_DEBUG, 'Servicing the IRC queue.');
  86         $this->stats('irc_process');
  87         $this->conn->handleEvents();
  88     }
  89
  90     /**
  91     * Initiate connection
  92     *
  93     * @return void
  94     */
  95     public function connect() {
  96         if (!$this->conn) {
  97             $this->conn = new Phergie_StatusnetBot;
  98
  99             $config = new Phergie_Config;
 100             $config->readArray(
 101                 array(
 102                     'connections' => array(
 103                         array(
 104                             'host' => $this->plugin->host,
 105                             'port' => $this->plugin->port,
 106                             'username' => $this->plugin->username,
 107                             'realname' => $this->plugin->realname,
 108                             'nick' => $this->plugin->nick,
 109                             'password' => $this->plugin->password,
 110                             'transport' => $this->plugin->transporttype,
 111                             'encoding' => $this->plugin->encoding
 112                         )
 113                     ),
 114
 115                     'driver' => 'statusnet',
 116
 117                     'processor' => 'async',
 118                     'processor.options' => array('sec' => 0, 'usec' => 0),
 119
 120                     'plugins' => array(
 121                         'Pong',
 122                         'NickServ',
 123                         'AutoJoin',
 124                         'Statusnet',
 125                     ),
 126
 127                     'plugins.autoload' => true,
 128
 129                     'ui.enabled' => true,
 130
 131                     'nickserv.password' => $this->plugin->nickservpassword,
 132                     'nickserv.identify_message' => $this->plugin->nickservidentifyregexp,
 133
 134                     'autojoin.channels' => $this->plugin->channels,
 135
 136                     'statusnet.messagecallback' => array($this, 'handle_irc_message'),
 137                     'statusnet.regcallback' => array($this, 'handle_reg_response'),
 138                     'statusnet.unregregexp' => $this->plugin->unregregexp,
 139                     'statusnet.regregexp' => $this->plugin->regregexp
 140                 )
 141             );
 142
 143             $this->conn->setConfig($config);
 144             $this->conn->connect();
 145         }
 146         return $this->conn;
 147     }
 148
 149     /**
 150     * Called via a callback when a message is received
 151     *
 152     * Passes it back to the queuing system
 153     *
 154     * @param array $data Data
 155     * @return boolean
 156     */
 157     public function handle_irc_message($data) {
 158         $this->plugin->enqueue_incoming_raw($data);
 159         return true;
 160     }
 161
 162     /**
 163     * Called via a callback when NickServ responds to
 164     * the bots query asking if a nick is registered
 165     *
 166     * @param array $data Data
 167     * @return void
 168     */
 169     public function handle_reg_response($data) {
 170         // Retrieve data
 171         $screenname = $data['screenname'];
 172         $nickdata = $this->regchecks[$screenname];
 173         $usernick = $nickdata['user']->nickname;
 174
 175         if (isset($this->regchecksLookup[$usernick])) {
 176             if ($data['registered']) {
 177                 // Send message
 178                 $this->plugin->send_confirmation_code($screenname, $nickdata['code'], $nickdata['user'], true);
 179             } else {
 180                 $this->plugin->send_message($screenname, _m('Your nickname is not registered so IRC connectivity cannot be enabled'));
 181
 182                 $confirm = new Confirm_address();
 183
 184                 $confirm->user_id      = $user->id;
 185                 $confirm->address_type = $this->plugin->transport;
 186
 187                 if ($confirm->find(true)) {
 188                     $result = $confirm->delete();
 189
 190                     if (!$result) {
 191                         common_log_db_error($confirm, 'DELETE', __FILE__);
 192                         // TRANS: Server error thrown on database error canceling IM address confirmation.
 193                         $this->serverError(_('Couldn\'t delete confirmation.'));
 194                         return;
 195                     }
 196                 }
 197             }
 198
 199             // Unset lookup value
 200             unset($this->regchecksLookup[$usernick]);
 201
 202             // Unset data
 203             unset($this->regchecks[$screename]);
 204         }
 205     }
 206
 207     /**
 208      * Send a message using the daemon
 209      *
 210      * @param $data Message
 211      * @return boolean true on success
 212      */
 213     public function send_raw_message($data) {
 214         $this->connect();
 215         if (!$this->conn) {
 216             return false;
 217         }
 218
 219         if ($data['type'] != 'message') {
 220             // Nick checking
 221             $nickdata = $data['nickdata'];
 222             $usernick = $nickdata['user']->nickname;
 223             $screenname = $nickdata['screenname'];
 224
 225             // Cancel any existing checks for this user
 226             if (isset($this->regchecksLookup[$usernick])) {
 227                 unset($this->regchecks[$this->regchecksLookup[$usernick]]);
 228             }
 229
 230             $this->regchecks[$screenname] = $nickdata;
 231             $this->regchecksLookup[$usernick] = $screenname;
 232         }
 233
 234         $args = $data['data']['args'];
 235         $lines = explode("\n", $args[1]);
 236         try {
 237             foreach ($lines as $line) {
 238                 $this->conn->send($data['data']['command'], array($args[0], $line));
 239             }
 240         } catch (Phergie_Driver_Exception $e) {
 241             $this->conn->reconnect();
 242             return false;
 243         }
 244
 245         return true;
 246     }
 247 }