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' => 'async',
 107                     'processor.options' => array('usec' => 0),
 108
 109                     'plugins' => array(
 110                         'Pong',
 111                         'NickServ',
 112                         'AutoJoin',
 113                         'Statusnet',
 114                     ),
 115
 116                     'plugins.autoload' => true,
 117
 118                     'ui.enabled' => true,
 119
 120                     'nickserv.password' => $this->plugin->nickservpassword,
 121                     'autojoin.channels' => $this->plugin->channels,
 122                     'statusnet.messagecallback' => array($this, 'handle_irc_message'),
 123                     'statusnet.regcallback' => array($this, 'handle_reg_response')
 124                 )
 125             );
 126
 127             $this->conn->setConfig($config);
 128             $this->conn->connect();
 129         }
 130         return $this->conn;
 131     }
 132
 133     /**
 134     * Called via a callback when a message is received
 135     *
 136     * Passes it back to the queuing system
 137     *
 138     * @param array $data Data
 139     * @return boolean
 140     */
 141     public function handle_irc_message($data) {
 142         $this->plugin->enqueue_incoming_raw($data);
 143         return true;
 144     }
 145
 146     /**
 147     * Called via a callback when NickServ responds to
 148     * the bots query asking if a nick is registered
 149     *
 150     * @param array $data Data
 151     * @return void
 152     */
 153     public function handle_reg_response($data) {
 154         // Retrieve data
 155         $screenname = $data['screenname'];
 156         $nickdata = $this->regchecks[$screenname];
 157         $usernick = $nickdata['user']->nickname;
 158
 159         if (isset($this->regchecksLookup[$usernick])) {
 160             if ($data['registered']) {
 161                 // Send message
 162                 $this->plugin->send_confirmation_code($screenname, $nickdata['code'], $nickdata['user'], true);
 163             } else {
 164                 $this->plugin->send_message($screenname, _m('Your nickname is not registered so IRC connectivity cannot be enabled'));
 165
 166                 $confirm = new Confirm_address();
 167
 168                 $confirm->user_id      = $user->id;
 169                 $confirm->address_type = $this->plugin->transport;
 170
 171                 if ($confirm->find(true)) {
 172                     $result = $confirm->delete();
 173
 174                     if (!$result) {
 175                         common_log_db_error($confirm, 'DELETE', __FILE__);
 176                         // TRANS: Server error thrown on database error canceling IM address confirmation.
 177                         $this->serverError(_('Couldn\'t delete confirmation.'));
 178                         return;
 179                     }
 180                 }
 181             }
 182
 183             // Unset lookup value
 184             unset($this->regchecksLookup[$usernick]);
 185
 186             // Unset data
 187             unset($this->regchecks[$screename]);
 188         }
 189     }
 190
 191     /**
 192      * Send a message using the daemon
 193      *
 194      * @param $data Message
 195      * @return boolean true on success
 196      */
 197     public function send_raw_message($data) {
 198         $this->connect();
 199         if (!$this->conn) {
 200             return false;
 201         }
 202
 203         if ($data['type'] != 'message') {
 204             // Nick checking
 205             $nickdata = $data['nickdata'];
 206             $usernick = $nickdata['user']->nickname;
 207             $screenname = $nickdata['screenname'];
 208
 209             // Cancel any existing checks for this user
 210             if (isset($this->regchecksLookup[$usernick])) {
 211                 unset($this->regchecks[$this->regchecksLookup[$usernick]]);
 212             }
 213
 214             $this->regchecks[$screenname] = $nickdata;
 215             $this->regchecksLookup[$usernick] = $screenname;
 216         }
 217
 218         try {
 219             $this->conn->send($data['data']['command'], $data['data']['args']);
 220         } catch (Phergie_Driver_Exception $e) {
 221             $this->conn->reconnect();
 222             return false;
 223         }
 224
 225         return true;
 226     }
 227 }