Changeset 4130 in subversion

Timestamp:

Oct 25, 2010 5:11:49 AM (3 years ago)

Author:

alec

Message:

• Simplify some code, add some comments

Location:

trunk/roundcubemail/program/include

Files:

• rcube_imap.php (modified) (1 diff)
• rcube_imap_generic.php (modified) (9 diffs)

trunk/roundcubemail/program/include/rcube_imap.php

@@ -164 +164 @@
 
             // get server properties
-            if (!empty($this->conn->rootdir))
-                $this->set_rootdir($this->conn->rootdir);
+            $rootdir = $this->conn->getRootDir();
+            if (!empty($rootdir))
+                $this->set_rootdir($rootdir);
             if (empty($this->delimiter))
                     $this->get_hierarchy_delimiter();

trunk/roundcubemail/program/include/rcube_imap_generic.php

@@ -87 +87 @@
     public $errornum;
         public $message;
-        public $rootdir;
-        public $delimiter;
     public $data = array();
     public $flags = array(
@@ -129 +127 @@
     }
 
+    /**
+     * Send simple (one line) command to the connection stream
+     *
+     * @param string $string Command string
+     * @param bool   $endln  True if CRLF need to be added at the end of command
+     *
+     * @param int Number of bytes sent, False on error
+     */
     function putLine($string, $endln=true)
     {
@@ -148 +154 @@
     }
 
-    // $this->putLine replacement with Command Continuation Requests (RFC3501 7.5) support
+    /**
+     * Send command to the connection stream with Command Continuation
+     * Requests (RFC3501 7.5) and LITERAL+ (RFC2088) support
+     *
+     * @param string $string Command string
+     * @param bool   $endln  True if CRLF need to be added at the end of command
+     *
+     * @param int Number of bytes sent, False on error
+     */
     function putLineC($string, $endln=true)
     {
@@ -535 +549 @@
     }
 
+    /**
+     * Gets the root directory and delimiter (of personal namespace)
+     *
+     * @return mixed A root directory name, or false.
+     */
     function getRootDir()
     {
             if (isset($this->prefs['rootdir']) && is_string($this->prefs['rootdir'])) {
-                $this->rootdir = $this->prefs['rootdir'];
-                    return true;
+                return $this->prefs['rootdir'];
             }
 
@@ -552 +570 @@
 
             $first_userspace = $user_space_data[0];
-            if (count($first_userspace) !=2 ) {
+            if (count($first_userspace) !=2) {
                 return false;
             }
 
-            $this->rootdir            = $first_userspace[0];
-            $this->delimiter          = $first_userspace[1];
-            $this->prefs['rootdir']   = substr($this->rootdir, 0, -1);
-            $this->prefs['delimiter'] = $this->delimiter;
-
-            return true;
+        $rootdir                  = $first_userspace[0];
+            $this->prefs['delimiter'] = $first_userspace[1];
+            $this->prefs['rootdir']   = $rootdir ? substr($rootdir, 0, -1) : '';
+
+            return $this->prefs['rootdir'];
     }
 
@@ -575 +592 @@
     function getHierarchyDelimiter()
     {
-            if ($this->delimiter) {
-                return $this->delimiter;
+            if ($this->prefs['delimiter']) {
+                return $this->prefs['delimiter'];
             }
             if (!empty($this->prefs['delimiter'])) {
-            return ($this->delimiter = $this->prefs['delimiter']);
+            return $this->prefs['delimiter'];
             }
 
@@ -591 +608 @@
 
                 if (strlen($delimiter) > 0) {
-                    $this->delimiter = $delimiter;
-                    return $delimiter;
+                    return ($this->prefs['delimiter'] = $delimiter);
                 }
         }
@@ -615 +631 @@
 
             // extract delimiter
-            return $this->delimiter = $first_userspace[1];
+            return $this->prefs['delimiter'] = $first_userspace[1];
     }
 
@@ -1846 +1862 @@
                 $mailbox = '*';
             }
-
-            if (empty($ref) && $this->rootdir) {
-                $ref = $this->rootdir;
-            }
-
+/*
+            if (empty($ref) && $this->prefs['rootdir']) {
+                $ref = $this->prefs['rootdir'];
+            }
+*/
         $args = array($this->escape($ref), $this->escape($mailbox));