[mms] Add 'dynamic_prefs' hook to allow for changing of default value…

…s for browser-based preferences in dynamic view.
horde · Aug 15, 2014 · ce36d5e · ce36d5e
1 parent 2aab31c
commit ce36d5e
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 1 deletion.
diff --git a/imp/config/hooks.php.dist b/imp/config/hooks.php.dist
@@ -607,6 +607,43 @@ class IMP_Hooks
 //    }
 
 
+    /**
+     * Default browser-based preference values for the dynamic view.
+     * Any value not returned here will use the default value (listed below).
+     *
+     * @return array  The list of pref keys / default values.
+     */
+    public function dynamic_prefs()
+    {
+        return array(
+            /* Preview pane. Valid values:
+             *   - 'horiz': Horizontal mode
+             *   - 'vert': Vertical mode
+             *   - [empty value]: No preview */
+            // 'preview' => 'horiz',
+
+            /* Quicksearch field (search box on mailbox page). Valid values:
+             *  - 'all': Search entire message (body & headers)
+             *  - 'body': Search message body
+             *  - 'from': Search from header
+             *  - 'recip': Search recipients (To/CC/BCC) headers
+             *  - 'subject': Search subject */
+            // qsearch_field: 'all',
+
+            /* Splitbar (horizontal) height. Value is number of messages to
+             * show. 0 means auto-determine default size. */
+            // splitbar_horiz: 0,
+
+            /* Splitbar (vertical) width. Value is width (in pixels) of the
+             * mailbox listing. 0 means auto-determine default size. */
+            // splitbar_vert: 0,
+
+            /* Toggle headers in preview. 1 to show headers, 0 to hide. */
+            // toggle_hdrs: 0,
+        );
+    }
+
+
     /**
      * Dynamically disable composing messages.
      *

diff --git a/imp/docs/CHANGES b/imp/docs/CHANGES
@@ -2,6 +2,8 @@
 v6.3.0-git
 ----------
 
+[mms] Add 'dynamic_prefs' hook to allow for changing of default values for
+      browser-based preferences in dynamic view.
 [mms] Removed compose 'use_vfs' configuration option.
 [mjr] Add IMP_Api::addFlags().
 [mms] Allow multiple independent attachment actions on the dynamic compose

diff --git a/imp/docs/UPGRADING b/imp/docs/UPGRADING
@@ -53,6 +53,14 @@ The following options have been removed::
    $conf['compose']['use_vfs']
 
 
+Hooks (hooks.php)
+-----------------
+
+The following hooks have been added::
+
+   dynamic_prefs
+
+
 
 Upgrading IMP From 6.1.x To 6.2
 ===============================

diff --git a/imp/lib/Script/Package/DynamicBase.php b/imp/lib/Script/Package/DynamicBase.php
@@ -28,7 +28,20 @@ class IMP_Script_Package_DynamicBase extends Horde_Script_Package
      */
     public function __construct()
     {
-        $this->_files[] = new Horde_Script_File_JsDir('dimpcore.js', 'imp');
+        global $injector;
+
+        $ob = new Horde_Script_File_JsDir('dimpcore.js', 'imp');
+
+        try {
+            $hooks = $injector->getInstance('Horde_Core_Hooks');
+            $dprefs = $hooks->callHook('dynamic_prefs', 'imp');
+            foreach ($dprefs as $key => $val) {
+                $ob->jsvars['DimpCore.prefs.' . $key] = $val;
+            }
+        } catch (Horde_Exception $e) {}
+
+        $this->_files[] = $ob;
+
         $this->_files[] = new Horde_Script_File_JsDir('viewport_utils.js', 'imp');
         $this->_files[] = new Horde_Script_File_JsDir('contextsensitive.js', 'horde');
         $this->_files[] = new Horde_Script_File_JsDir('imple.js', 'horde');

diff --git a/imp/package.xml b/imp/package.xml
@@ -33,6 +33,7 @@
  </stability>
  <license uri="http://www.horde.org/licenses/gpl">GPL-2.0</license>
  <notes>
+* [mms] Add &apos;dynamic_prefs&apos; hook to allow for changing of default values for browser-based preferences in dynamic view.
 * [mms] Removed compose &apos;use_vfs&apos; configuration option.
 * [mjr] Add IMP_Api::addFlags().
 * [mms] Allow multiple independent attachment actions on the dynamic compose screen.