Changeset 4367 in subversion

Timestamp:

Dec 23, 2010 1:25:18 PM (2 years ago)

Author:

alec

Message:

• Add debug handler support in rcube_imap_generic

Location:

trunk/roundcubemail/program/include

Files:

• rcmail.php (modified) (1 diff)
• rcube_imap.php (modified) (7 diffs)
• rcube_imap_generic.php (modified) (6 diffs)

trunk/roundcubemail/program/include/rcmail.php

@@ -504 +504 @@
       'auth_cid'    => $this->config->get('imap_auth_cid'),
       'auth_pw'     => $this->config->get('imap_auth_pw'),
-      'debug_mode'  => (bool) $this->config->get('imap_debug', 0),
+      'debug'       => (bool) $this->config->get('imap_debug', 0),
       'force_caps'  => (bool) $this->config->get('imap_force_caps'),
       'timeout'     => (int) $this->config->get('imap_timeout', 0),

trunk/roundcubemail/program/include/rcube_imap.php

@@ -149 +149 @@
         $this->options['port'] = $port;
 
+        if ($this->options['debug'])
+            $this->conn->setDebug(true, array($this, 'debug_handler'));
+
         $attempt = 0;
         do {
@@ -224 +227 @@
     function get_error_code()
     {
-        return ($this->conn) ? $this->conn->errornum : 0;
+        return $this->conn->errornum;
     }
 
@@ -235 +238 @@
     function get_error_str()
     {
-        return ($this->conn) ? $this->conn->error : null;
+        return $this->conn->error;
     }
 
@@ -246 +249 @@
     function get_response_code()
     {
-        if (!$this->conn)
-            return self::UNKNOWN;
-
         switch ($this->conn->resultcode) {
             case 'NOPERM':
@@ -279 +279 @@
     function get_response_str()
     {
-        return ($this->conn) ? $this->conn->result : null;
+        return $this->conn->result;
     }
 
@@ -547 +547 @@
         $imap_delimiter = $config->get('imap_delimiter');
 
-        if (!$this->conn)
+        if (!$this->conn->connected())
             return;
 
@@ -4741 +4741 @@
     }
 
+
+    /**
+     * This is our own debug handler for the IMAP connection
+     * @access public
+     */
+    public function debug_handler(&$imap, $message)
+    {
+        write_log('imap', $message);
+    }
+
 }  // end class rcube_imap
 

trunk/roundcubemail/program/include/rcube_imap_generic.php

@@ -110 +110 @@
     private $cmd_tag;
     private $cmd_num = 0;
+    private $_debug = false;
+    private $_debug_handler = false;
 
     const ERROR_OK = 0;
@@ -143 +145 @@
             return false;
 
-        if (!empty($this->prefs['debug_mode'])) {
-            write_log('imap', 'C: '. rtrim($string));
+        if ($this->_debug) {
+            $this->debug('C: '. rtrim($string));
         }
 
@@ -232 +234 @@
                 break;
             }
-            if (!empty($this->prefs['debug_mode'])) {
-                write_log('imap', 'S: '. rtrim($buffer));
+            if ($this->_debug) {
+                $this->debug('S: '. rtrim($buffer));
             }
             $line .= $buffer;
@@ -269 +271 @@
         {
             $d = fread($this->fp, $bytes-$len);
-            if (!empty($this->prefs['debug_mode'])) {
-                write_log('imap', 'S: '. $d);
+            if ($this->_debug) {
+                $this->debug('S: '. $d);
             }
             $data .= $d;
@@ -687 +689 @@
         $line = trim(fgets($this->fp, 8192));
 
-        if ($this->prefs['debug_mode'] && $line) {
-            write_log('imap', 'S: '. $line);
+        if ($this->_debug && $line) {
+            $this->debug('S: '. $line);
         }
 
@@ -3239 +3241 @@
     }
 
+    /**
+     * Set the value of the debugging flag.
+     *
+     * @param   boolean $debug      New value for the debugging flag.
+     *
+     * @access  public
+     * @since   0.5-stable
+     */
+    function setDebug($debug, $handler = null)
+    {
+        $this->_debug = $debug;
+        $this->_debug_handler = $handler;
+    }
+
+    /**
+     * Write the given debug text to the current debug output handler.
+     *
+     * @param   string  $message    Debug mesage text.
+     *
+     * @access  private
+     * @since   0.5-stable
+     */
+    private function debug($message)
+    {
+        if ($this->_debug_handler) {
+            call_user_func_array($this->_debug_handler, array(&$this, $message));
+        } else {
+            echo "DEBUG: $message\n";
+        }
+    }
+
 }