Changeset 96

Timestamp:

03/01/08 20:50:42 (9 months ago)

Author:

Seldaek

Message:

+ Adds Keepalive/Timeout

Files:

• trunk/Phergie/Bot.php (modified) (1 diff)
• trunk/Phergie/Driver/Abstract.php (modified) (2 diffs)
• trunk/Phergie/Driver/Streams.php (modified) (5 diffs)
• trunk/Phergie/Plugin/Abstract/AdminCommand.php (modified) (2 diffs)
• trunk/Phergie/phergie.ini (modified) (8 diffs)

trunk/Phergie/Bot.php

@@ -162 +162 @@
-* Execute the event handling loop for the client
-*/
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

trunk/Phergie/Driver/Abstract.php

@@ -12 +12 @@
-abstract class Phergie_Driver_Abstract
-{
+        /**#@+
+         * Return codes for the run function, that tells the Bot script whether
+         * it should re-run or not
+         */
+        const RETURN_RECONNECT = "reconnect";
+        const RETURN_KEEPALIVE = "keepalive";
+        const RETURN_END = "end";
+        /**#@-*/
+
-    /**
-    * Associative array mapping configuration setting names to their
@@ -112 +121 @@
-    *
-    * @param string $reason Reason for connection termination (optional)
-
-
-
+
+
+
+
-
-    /**

trunk/Phergie/Driver/Streams.php

@@ -117 +117 @@
-    public function run()
-    {
+        $returnCode = $this->getIni('keepalive') ? self::RETURN_KEEPALIVE : self::RETURN_END;
-        $server = $this->getIni('server');
-        $port = $this->getIni('port');
@@ -128 +129 @@
-            $errstr
-        );
+
+        if ($this->getIni('timeout') !== null) {
+                stream_set_timeout($this->socket, $this->getIni('timeout') * 60);
+        } elseif ($this->getIni('keepalive')) {
+                stream_set_timeout($this->socket, 400);
+                }
-
-        unset($port);
@@ -166 +173 @@
-            while (empty ($buffer)) {
-                $buffer = fgets($this->socket, 512);
+
+                                $checkTimeout = stream_get_meta_data($this->socket);
+                                if ($checkTimeout['timed_out'] === true) {
+                                        $this->debug('Timed out');
+                        foreach ($this->plugins as $plugin) {
+                            $plugin->shutdown();
+                        }
+                                        break 2;
+                                }
-            }
-            $buffer = rtrim($buffer);
@@ -260 +276 @@
-                    $plugin->shutdown();
-                }
+                if (isset($this->queue['quit'][0][1])) {
+                        $returnCode = ($this->queue['quit'][0][1] === true ? self::RETURN_RECONNECT : self::RETURN_END);
+                }
-                $this->doQuit($reason);
-                break;
-            }
+
-            unset($this->queue, $event, $command, $arguments);
-        }
-
-        fclose($this->socket);
+
+        return $returnCode;
-    }
-
@@ -299 +321 @@
-    *
-    * @param string $reason Reason for connection termination (optional)
-
-
-
-
+
+
+
+
+
-    }
-

trunk/Phergie/Plugin/Abstract/AdminCommand.php

@@ -96 +96 @@
-                // Escape regex meta characters
-                $admin = str_replace(
-'^', '$', '.', '[', ']', '|', '(', ')', '?', '+', '{',
+  '^',   '$',   '.',   '[',   ']',   '|',   '(',   ')',   '?',   '+',   '{',  
-                    array('\\\\', '\\^', '\\$', '\\.', '\\[', '\\]', '\\|', '\\(', '\\)', '\\?', '\\+', '\\{', '\\}'),
-                    $admin
@@ -110 +110 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
- 
+
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise

trunk/Phergie/phergie.ini

@@ -29 +29 @@
-password =
-
+; keepalive :
+;    boolean flag indicating whether or not the bot should reconnect when it
+;    gets disconnected from the server, defaults to false.
+;    if this is set to true, you should set timeout value to 6 or above.
+keepalive = false
+
+; timeout :
+;    defines the number of minutes to wait until a connection times out, if the
+;    bot gets disconnected when it shouldn't (i.e. when your connection didn't
+;    die), increase the timeout value so it waits longer before disconnecting.
+;    0 means it will never time out, but if you use keepalive you should set
+;    this to 6 or above.
+timeout =
+
-; gender :
-;   M or F to indicate the gender of the bot for instances when the bot must
@@ -37 +51 @@
-;   boolean flag indicating whether or not the bot is allowed to use curses,
-;   bad words, etc. defaults to false.
-
+ false
-
-; plugins :
@@ -50 +64 @@
-;    class would be Autojoin)
-; plugins = all
-all
+"all"
-
-; debug :
@@ -57 +71 @@
-
-; log :
- 
+
-;    mode is enabled
-log = debug.log
@@ -68 +82 @@
-;    positive integer indicating the maximum number of possible meanings for
-;    an acronym that should be displayed in a given instance (defaults to 5)
-
+ 5
-
-; acronym.filter :
-;    comma- or space-delimited list of acronyms for which meanings should not
-;    be returned
-
+ ""
-
-;-----------------------------------------------------------------------------
@@ -83 +97 @@
-;    bot's admin features, must be enclosed by double quotes and entries are
-;    separated by spaces or commas
-
+ ""
-
-; admincommand.ops :
@@ -106 +120 @@
-;    a comma-delimited list of channels which the bot should automatically
-;    join upon successfully connecting
-
+ ""
-
-;-----------------------------------------------------------------------------
@@ -146 +160 @@
-; karma.static :
-;   If non-empty, the static karma response to use for the bot's nick
-
+ ""
-
-;-----------------------------------------------------------------------------