]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Irc/ircmanager.php
Rename Phergie_ExtendedBot to Phergie_StatusnetBot
[quix0rs-gnu-social.git] / plugins / Irc / ircmanager.php
index 6a86e34fd3a20f49d7f8474600df2edcf588e981..ea98263a539c5ac31811da9ce2f920514a8107ce 100644 (file)
@@ -31,10 +31,11 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  */
 
 class IrcManager extends ImManager {
-
     public $conn = null;
+
     /**
      * Initialize connection to server.
+     *
      * @return boolean true on success
      */
     public function start($master) {
@@ -46,10 +47,16 @@ class IrcManager extends ImManager {
         }
     }
 
+    /**
+    * 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();
         }
@@ -57,139 +64,100 @@ class IrcManager extends ImManager {
 
     /**
      * Process IRC events that have come in over the wire.
+     *
      * @param resource $socket
+     * @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();
     }
 
-    function connect() {
+    /**
+    * Initiate connection
+    *
+    * @return void
+    */
+    public function connect() {
         if (!$this->conn) {
-            $this->conn = new Phergie_Bot;
+            $this->conn = new Phergie_StatusnetBot;
 
-            $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';
+            $port = empty($this->plugin->port) ? 6667 : $this->plugin->port;
+            $password = empty($this->plugin->password) ? '' : $this->plugin->password;
+            $transport = empty($this->plugin->transporttype) ? 'tcp' : $this->plugin->transporttype;
+            $encoding = empty($this->plugin->encoding) ? 'UTF-8' : $this->plugin->encoding;
+            $nickservpassword = empty($this->plugin->nickservpassword) ? '' : $this->plugin->nickservpassword;
+            $channels = empty($this->plugin->channels) ? array() : $this->plugin->channels;
 
-            $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,
+                            'port' => $port,
                             'username' => $this->plugin->username,
                             'realname' => $this->plugin->realname,
-                            'nick' => $this->plugin->nickname,
+                            'nick' => $this->plugin->nick,
                             'password' => $password,
                             'transport' => $transport,
                             'encoding' => $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',
+                    'driver' => 'statusnet',
 
-        // 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.
+                    'processor' => 'statusnet',
 
-        // '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,
-
-    // Enables shell output describing bot events via Phergie_Ui_Console
-    'ui.enabled' => true,
-
-    // 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')
-    //                        ),
-
-    // Examples of setting values for Ping plugin settings
-
-    // 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
+                    'plugins' => array(
+                        'Pong',
+                        'NickServ',
+                        'AutoJoin',
+                        'Statusnet_Callback',
+                    ),
 
-    // 'ping.event' => 300, // 5 minutes
+                    'plugins.autoload' => true,
 
-    // 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
+                    'ui.enabled' => true,
 
-    // 'ping.ping' => 10, // 10 seconds
+                    'nickserv.password' => $nickservpassword,
+                    'autojoin.channels' => $channels,
+                    'statusnet_callback.callback' => array($this, 'handle_irc_message')
+                )
+            );
 
-));
-            $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) {
+    /**
+     * Send a message using the daemon
+     *
+     * @param $data Message
+     * @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]);
+        $this->conn->send($data[0], $data[1]);
         return true;
     }
 }