Changeset 2326 in subversion

Timestamp:

Mar 3, 2009 2:29:26 PM (4 years ago)

Author:

ziba

Message:

New Plugin: Use Imap Subscriptions Option - by default roundcube only lists subscribed folders, this introduces an option to ignore subscriptions
New Plugin Hook: list_mailboxes - allows a plugin to provide the list of mailboxes instead of roundcube core
New Plugin Hook: manage_folders - allows a plugin to modify the main table on the manage folders screen
New Plugin Hook: user_preferences_server_settings - allows a plugin to modify the user preferences server settings table
New Plugin Hook: save_preferences - allows a plugin to inject data into the array of preferences about to be saved
Change to html class: added a remove_column method to give plugins a greater ability to modify the interface

Location:

branches/devel-api

Files:

• plugins/subscriptions_option (added)
• plugins/subscriptions_option/localization (added)
• plugins/subscriptions_option/localization/en_US.inc (added)
• plugins/subscriptions_option/subscriptions_option.php (added)
• program/include/html.php (modified) (1 diff)
• program/include/rcube_imap.php (modified) (1 diff)
• program/steps/settings/func.inc (modified) (1 diff)
• program/steps/settings/manage_folders.inc (modified) (1 diff)
• program/steps/settings/save_prefs.inc (modified) (1 diff)

branches/devel-api/program/include/html.php

@@ -600 +600 @@
     }
 
+     /**
+     * Remove a column from a table
+     * Useful for plugins making alterations
+     * 
+     * @param string $class 
+     */
+    public function remove_column($class)
+    {
+        // Remove the header
+        foreach($this->header as $index=>$header){
+            if($header->attrib['class'] == $class){
+                unset($this->header[$index]);
+                break;
+            }
+        }
+
+        // Remove cells from rows
+        foreach($this->rows as $i=>$row){
+            foreach($row->cells as $j=>$cell){
+                if($cell->attrib['class'] == $class){
+                    unset($this->rows[$i]->cells[$j]);
+                    break;
+                }
+            }
+        }
+    }
+
+
     /**
      * Jump to next row

branches/devel-api/program/include/rcube_imap.php

@@ -427 +427 @@
       return $a_mboxes;
 
-    // retrieve list of folders from IMAP server
-    $a_folders = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox($root), $filter);
+    // Give plugins a chance to provide a list of mailboxes
+    $data = rcmail::get_instance()->plugins->exec_hook('list_mailboxes',array('root'=>$root,'filter'=>$filter));
+    if(isset($data['a_folders'])){
+        $a_folders = $data['a_folders'];
+    }
+    else{
+        // retrieve list of folders from IMAP server
+        $a_folders = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox($root), $filter);
+    }
+
     
     if (!is_array($a_folders) || !sizeof($a_folders))

branches/devel-api/program/steps/settings/func.inc

@@ -382 +382 @@
     }
 
+    rcmail::get_instance()->plugins->exec_hook('user_preferences_server_settings', array('table'=>$table));
+
     if ($table->size())
       $out = html::tag('fieldset', null, html::tag('legend', null, Q(rcube_label('serversettings'))) . $table->show($attrib));

branches/devel-api/program/steps/settings/manage_folders.inc

@@ -262 +262 @@
   }
 
+  rcmail::get_instance()->plugins->exec_hook('manage_folders', array('table'=>$table));
 
   $OUTPUT->add_gui_object('subscriptionlist', $attrib['id']);

branches/devel-api/program/steps/settings/save_prefs.inc

@@ -49 +49 @@
   );
 
+$data  =  rcmail::get_instance()->plugins->exec_hook('save_preferences', array('a_user_prefs'=>$a_user_prefs));
+$a_user_prefs = $data['a_user_prefs'];
+
 // don't override these parameters
 foreach ((array)$CONFIG['dont_override'] as $p)