* IRC background connection manager for IRC-using queue handlers,
* allowing them to send outgoing messages on the right connection.
*
- * Input is handled during socket select loop, keepalive pings during idle.
- * Any incoming messages will be handled.
+ * Input is handled during socket select loop, Any incoming messages will be handled.
*
* In a multi-site queuedaemon.php run, one connection will be instantiated
* for each site being handled by the current process that has IRC enabled.
*/
class IrcManager extends ImManager {
+ protected $conn = null;
+ protected $regchecks = array();
+ protected $regchecksLookup = array();
- public $conn = null;
/**
* Initialize connection to server.
+ *
* @return boolean true on success
*/
public function start($master) {
}
}
+ /**
+ * Return any open sockets that the run loop should listen
+ * for input on.
+ *
+ * @return array Array of socket resources
+ */
public function getSockets() {
$this->connect();
if ($this->conn) {
- return array($this->conn->myConnection);
+ return $this->conn->getSockets();
} else {
return array();
}
/**
* Process IRC events that have come in over the wire.
- * @param resource $socket
+ *
+ * @param resource $socket Socket to handle input on
+ * @return void
*/
public function handleInput($socket) {
- common_log(LOG_DEBUG, "Servicing the IRC queue.");
+ common_log(LOG_DEBUG, 'Servicing the IRC queue.');
$this->stats('irc_process');
- $this->conn->receive();
+
+ try {
+ $this->conn->handleEvents();
+ } catch (Phergie_Driver_Exception $e) {
+ $this->conn->reconnect();
+ }
}
- function connect() {
+ /**
+ * Initiate connection
+ *
+ * @return void
+ */
+ public function connect() {
if (!$this->conn) {
- $this->conn = new Phergie_Bot;
-
- $password = isset($this->plugin->password) ? $this->plugin->password : NULL;
- $transport = isset($this->plugin->transport) ? $this->plugin->transport : 'tcp';
- $encoding = isset($this->plugin->encoding) ? $this->plugin->encoding : 'ISO-8859-1';
+ $this->conn = new Phergie_StatusnetBot;
- $config = new Phergie_Extended_Config;
+ $config = new Phergie_Config;
$config->readArray(
array(
- // One array per connection, pretty self-explanatory
'connections' => array(
- // Ex: All connection info for the Freenode network
array(
'host' => $this->plugin->host,
'port' => $this->plugin->port,
'username' => $this->plugin->username,
'realname' => $this->plugin->realname,
- 'nick' => $this->plugin->nickname,
- 'password' => $password,
- 'transport' => $transport,
- 'encoding' => $encoding
+ 'nick' => $this->plugin->nick,
+ 'password' => $this->plugin->password,
+ 'transport' => $this->plugin->transporttype,
+ 'encoding' => $this->plugin->encoding
)
),
- 'processor' => 'async',
- 'processor.options' => array('usec' => 200000),
- // Time zone. See: http://www.php.net/manual/en/timezones.php
- 'timezone' => 'UTC',
-
- // Whitelist of plugins to load
- 'plugins' => array(
- // To enable a plugin, simply add a string to this array containing
- // the short name of the plugin as shown below.
-
- // 'ShortPluginName',
-
- // Below is an example of enabling the AutoJoin plugin, for which
- // the corresponding PEAR package is Phergie_Plugin_AutoJoin. This
- // plugin allows you to set a list of channels in this configuration
- // file that the bot will automatically join when it connects to a
- // server. If you'd like to enable this plugin, simply install it,
- // uncomment the line below, and set a value for the setting
- // autojoin.channels (examples for which are located further down in
- // this file).
-
- // 'AutoJoin',
-
- // A few other recommended plugins:
-
- // Servers randomly send PING events to clients to ensure that
- // they're still connected and will eventually terminate the
-
- // connection if a PONG response is not received. The Pong plugin
- // handles sending these responses.
-
- // 'Pong',
-
- // It's sometimes difficult to distinguish between a lack of
- // activity on a server and the client not receiving data even
- // though a connection remains open. The Ping plugin performs a self
- // CTCP PING sporadically to ensure that its connection is still
- // functioning and, if not, terminates the bot.
-
- // 'Ping',
-
- // Sometimes it's desirable to have the bot disconnect gracefully
- // when issued a command to do so via a PRIVMSG event. The Quit
- // plugin implements this using the Command plugin to intercept the
- // command.
-
- // 'Quit',
- ),
-
- // If set to true, this allows any plugin dependencies for plugins
- // listed in the 'plugins' option to be loaded even if they are not
- // explicitly included in that list
- 'plugins.autoload' => true,
+ 'driver' => 'statusnet',
- // Enables shell output describing bot events via Phergie_Ui_Console
- 'ui.enabled' => true,
+ 'processor' => 'async',
+ 'processor.options' => array('sec' => 0, 'usec' => 0),
- // Examples of supported values for autojoins.channel:
- // 'autojoin.channels' => '#channel1,#channel2',
- // 'autojoin.channels' => array('#channel1', '#channel2'),
- // 'autojoin.channels' => array(
- // 'host1' => '#channel1,#channel2',
- // 'host2' => array('#channel3', '#channel4')
- // ),
+ 'plugins' => array(
+ 'Pong',
+ 'NickServ',
+ 'AutoJoin',
+ 'Statusnet',
+ ),
- // Examples of setting values for Ping plugin settings
+ 'plugins.autoload' => true,
- // This is the amount of time in seconds that the Ping plugin will wait
- // to receive an event from the server before it initiates a self-ping
+ 'ui.enabled' => true,
- // 'ping.event' => 300, // 5 minutes
+ 'nickserv.password' => $this->plugin->nickservpassword,
+ 'nickserv.identify_message' => $this->plugin->nickservidentifyregexp,
- // This is the amount of time in seconds that the Ping plugin will wait
- // following a self-ping attempt before it assumes that a response will
- // never be received and terminates the connection
+ 'autojoin.channels' => $this->plugin->channels,
- // 'ping.ping' => 10, // 10 seconds
+ 'statusnet.messagecallback' => array($this, 'handle_irc_message'),
+ 'statusnet.regcallback' => array($this, 'handle_reg_response'),
+ 'statusnet.unregregexp' => $this->plugin->unregregexp,
+ 'statusnet.regregexp' => $this->plugin->regregexp
+ )
+ );
-));
- $this->conn=new Aim($this->plugin->user,$this->plugin->password,4);
- $this->conn->registerHandler("IMIn",array($this,"handle_aim_message"));
- $this->conn->myServer="toc.oscar.aol.com";
- $this->conn->signon();
- $this->conn->setProfile(_m('Send me a message to post a notice'), false);
+ $this->conn->setConfig($config);
+ $this->conn->connect();
}
return $this->conn;
}
- function handle_irc_message($data) {
+ /**
+ * Called via a callback when a message is received
+ * Passes it back to the queuing system
+ *
+ * @param array $data Data
+ * @return boolean
+ */
+ public function handle_irc_message($data) {
$this->plugin->enqueue_incoming_raw($data);
return true;
}
- function send_raw_message($data) {
+ /**
+ * Called via a callback when NickServ responds to
+ * the bots query asking if a nick is registered
+ *
+ * @param array $data Data
+ * @return void
+ */
+ public function handle_reg_response($data) {
+ // Retrieve data
+ $screenname = $data['screenname'];
+ $nickdata = $this->regchecks[$screenname];
+ $usernick = $nickdata['user']->nickname;
+
+ if (isset($this->regchecksLookup[$usernick])) {
+ if ($data['registered']) {
+ // Send message
+ $this->plugin->send_confirmation_code($screenname, $nickdata['code'], $nickdata['user'], true);
+ } else {
+ $this->plugin->send_message($screenname, _m('Your nickname is not registered so IRC connectivity cannot be enabled'));
+
+ $confirm = new Confirm_address();
+
+ $confirm->user_id = $user->id;
+ $confirm->address_type = $this->plugin->transport;
+
+ if ($confirm->find(true)) {
+ $result = $confirm->delete();
+
+ if (!$result) {
+ common_log_db_error($confirm, 'DELETE', __FILE__);
+ // TRANS: Server error thrown on database error canceling IM address confirmation.
+ $this->serverError(_('Couldn\'t delete confirmation.'));
+ return;
+ }
+ }
+ }
+
+ // Unset lookup value
+ unset($this->regchecksLookup[$usernick]);
+
+ // Unset data
+ unset($this->regchecks[$screename]);
+ }
+ }
+
+ /**
+ * Send a message using the daemon
+ *
+ * @param $data Message data
+ * @return boolean true on success
+ */
+ public function send_raw_message($data) {
$this->connect();
if (!$this->conn) {
return false;
}
- $this->conn->sflapSend($data[0],$data[1],$data[2],$data[3]);
+
+ if ($data['type'] != 'message') {
+ // Nick checking
+ $nickdata = $data['nickdata'];
+ $usernick = $nickdata['user']->nickname;
+ $screenname = $nickdata['screenname'];
+
+ // Cancel any existing checks for this user
+ if (isset($this->regchecksLookup[$usernick])) {
+ unset($this->regchecks[$this->regchecksLookup[$usernick]]);
+ }
+
+ $this->regchecks[$screenname] = $nickdata;
+ $this->regchecksLookup[$usernick] = $screenname;
+ }
+
+ try {
+ $this->conn->send($data['data']['command'], $data['data']['args']);
+ } catch (Phergie_Driver_Exception $e) {
+ $this->conn->reconnect();
+ return false;
+ }
+
return true;
}
}
projects / quix0rs-gnu-social.git / blobdiff