Better encapsulate preview and mailbox JSON responses

diff --git a/imp/js/DimpBase.js b/imp/js/DimpBase.js
index c94eda1..a97b7fa 100644 (file)
--- a/imp/js/DimpBase.js
+++ b/imp/js/DimpBase.js
@@ -725,7 +725,7 @@ var DimpBase = {
         case 'ctx_vfolder_delete':
             tmp = baseelt.up('LI');
             if (window.confirm(DIMP.text.delete_folder.replace(/%s/, tmp.readAttribute('title')))) {
-                DimpCore.doAction('DeleteMailbox', { mbox: tmp.retrieve('mbox') }, { callback: this._folderCallback.bind(this) });
+                DimpCore.doAction('DeleteMailbox', { mbox: tmp.retrieve('mbox') }, { callback: this._mailboxCallback.bind(this) });
             }
             break;
 
@@ -1144,7 +1144,7 @@ var DimpBase = {
     {
         var bg, ppuid, row, search, tmp,
             pm = $('previewMsg'),
-            r = resp.response,
+            r = resp.response.preview,
             t = $('msgHeadersContent').down('THEAD');
 
         bg = (this.pp &&
@@ -1575,7 +1575,7 @@ var DimpBase = {
             dropbase = (drop == $('dropbase'));
             if (dropbase ||
                 (ftype != 'special' && !this.isSubfolder(drag, drop))) {
-                DimpCore.doAction('RenameMailbox', { old_name: drag.retrieve('mbox'), new_parent: dropbase ? '' : foldername, new_name: drag.retrieve('l') }, { callback: this._folderCallback.bind(this) });
+                DimpCore.doAction('RenameMailbox', { old_name: drag.retrieve('mbox'), new_parent: dropbase ? '' : foldername, new_name: drag.retrieve('l') }, { callback: this._mailboxCallback.bind(this) });
             }
         } else if (ftype != 'container') {
             sel = this.viewport.getSelected();
@@ -2197,15 +2197,16 @@ var DimpBase = {
             }
 
             if (action) {
-                DimpCore.doAction(action, params, { callback: this._folderCallback.bind(this) });
+                DimpCore.doAction(action, params, { callback: this._mailboxCallback.bind(this) });
             }
         }
     },
 
-    /* Folder action callback functions. */
-    _folderCallback: function(r)
+    /* Mailbox action callback functions. */
+    _mailboxCallback: function(r)
     {
-        r = r.response;
+        r = r.response.mailbox;
+
         if (r.d) {
             r.d.each(this.deleteFolder.bind(this));
         }
@@ -2289,7 +2290,7 @@ var DimpBase = {
 
     _folderLoadCallback: function(r, callback)
     {
-        this._folderCallback(r);
+        this._mailboxCallback(r);
 
         if (callback) {
             callback();

diff --git a/imp/lib/Ajax/Application.php b/imp/lib/Ajax/Application.php
index 2327da2..56cbb8d 100644 (file)
--- a/imp/lib/Ajax/Application.php
+++ b/imp/lib/Ajax/Application.php
@@ -44,9 +44,11 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
      * @return mixed  False on failure, or an object with the following
      *                entries:
      * <pre>
-     * 'a' - (array) Mailboxes that were added.
-     * 'c' - (array) Mailboxes that were changed.
-     * 'd' - (array) Mailboxes that were deleted.
+     * 'mailbox' - (object) Mailboxes that were altered. Contains the
+     *             following properties:
+     *   'a' - (array) Mailboxes that were added.
+     *   'c' - (array) Mailboxes that were changed.
+     *   'd' - (array) Mailboxes that were deleted.
      * </pre>
      */
     public function CreateMailbox($vars)
@@ -63,9 +65,9 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
         $new = Horde_String::convertCharset($vars->mbox, Horde_Nls::getCharset(), 'UTF7-IMAP');
         try {
             $new = $imptree->createMailboxName($vars->parent, $new);
-            $result = $imp_folder->create($new, $GLOBALS['prefs']->getValue('subscribe'));
-            if ($result) {
-                $result = IMP_Dimp::getFolderResponse($imptree);
+            if ($result = $imp_folder->create($new, $GLOBALS['prefs']->getValue('subscribe'))) {
+                $result = new stdClass;
+                $result->mailbox = IMP_Dimp::getFolderResponse($imptree);
             }
         } catch (Horde_Exception $e) {
             $GLOBALS['notification']->push($e, 'horde.error');
@@ -86,9 +88,11 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
      * @return mixed  False on failure, or an object with the following
      *                entries:
      * <pre>
-     * 'a' - (array) Mailboxes that were added.
-     * 'c' - (array) Mailboxes that were changed.
-     * 'd' - (array) Mailboxes that were deleted.
+     * 'mailbox' - (object) Mailboxes that were altered. Contains the
+     *             following properties:
+     *   'a' - (array) Mailboxes that were added.
+     *   'c' - (array) Mailboxes that were changed.
+     *   'd' - (array) Mailboxes that were deleted.
      * </pre>
      */
     public function DeleteMailbox($vars)
@@ -109,9 +113,12 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
             $result = $imp_folder->delete(array($vars->mbox));
         }
 
-        return $result
-            ? IMP_Dimp::getFolderResponse($imptree)
-            : $result;
+        if ($result) {
+            $result = new stdClass;
+            $result->mailbox = IMP_Dimp::getFolderResponse($imptree);
+        }
+
+        return $result;
     }
 
     /**
@@ -127,9 +134,11 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
      * @return mixed  False on failure, or an object with the following
      *                entries:
      * <pre>
-     * 'a' - (array) Mailboxes that were added.
-     * 'c' - (array) Mailboxes that were changed.
-     * 'd' - (array) Mailboxes that were deleted.
+     * 'mailbox' - (object) Mailboxes that were altered. Contains the
+     *             following properties:
+     *   'a' - (array) Mailboxes that were added.
+     *   'c' - (array) Mailboxes that were changed.
+     *   'd' - (array) Mailboxes that were deleted.
      * </pre>
      */
     public function RenameMailbox($vars)
@@ -149,7 +158,9 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
 
             if (($vars->old_name != $new) &&
                 $imp_folder->rename($vars->old_name, $new)) {
-                $result = IMP_Dimp::getFolderResponse($imptree);
+
+                $result = new stdClass;
+                $result->mailbox = IMP_Dimp::getFolderResponse($imptree);
             }
         } catch (Horde_Exception $e) {
             $GLOBALS['notification']->push($e, 'horde.error');
@@ -251,9 +262,11 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
      * @return mixed  False on failure, or an object with the following
      *                entries:
      * <pre>
-     * 'a' - (array) Mailboxes that were added.
-     * 'c' - (array) Mailboxes that were changed.
-     * 'd' - (array) Mailboxes that were deleted.
+     * 'mailbox' - (object) Mailboxes that were altered. Contains the
+     *             following properties:
+     *   'a' - (array) Mailboxes that were added.
+     *   'c' - (array) Mailboxes that were changed.
+     *   'd' - (array) Mailboxes that were deleted.
      * 'quota' - (array) See _getQuota().
      * </pre>
      */
@@ -295,7 +308,8 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
             }
         }
 
-        $result = IMP_Dimp::getFolderResponse($imptree, array(
+        $result = new stdClass;
+        $result->mailbox = IMP_Dimp::getFolderResponse($imptree, array(
             'a' => array_values($folder_list),
             'c' => array(),
             'd' => array()
@@ -778,8 +792,9 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
      *         string) - must be single index.
      * </pre>
      *
-     * @return mixed  False on failure, or an object with the keys defined
-     *                in IMP_View_ShowMessage::showMessage().
+     * @return mixed  False on failure, or an object with the 'preview'
+     *                property containing the return value from
+     *                IMP_View_ShowMessage::showMessage().
      */
     public function ShowPreview($vars)
     {
@@ -794,6 +809,8 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
             'preview' => true,
             'uid' => intval(reset($ptr['value']))
         );
+        $result = new stdClass;
+        $result->preview = new stdClass;
 
         try {
             /* We know we are going to be exclusively dealing with this
@@ -801,16 +818,15 @@ class IMP_Ajax_Application extends Horde_Ajax_Application_Base
              * calls). Open R/W to clear the RECENT flag. */
             $GLOBALS['imp_imap']->ob()->openMailbox($ptr['key'], Horde_Imap_Client::OPEN_READWRITE);
             $show_msg = new IMP_Views_ShowMessage();
-            $result = (object)$show_msg->showMessage($args);
-            if (isset($result->error)) {
+            $result->preview = (object)$show_msg->showMessage($args);
+            if (isset($result->preview->error)) {
                 $result = $this->_checkUidvalidity($vars, $result);
             }
         } catch (Horde_Imap_Client_Exception $e) {
-            $result = new stdClass;
-            $result->error = $e->getMessage();
-            $result->errortype = 'horde.error';
-            $result->mailbox = $args['mailbox'];
-            $result->uid = $args['uid'];
+            $result->preview->error = $e->getMessage();
+            $result->preview->errortype = 'horde.error';
+            $result->preview->mailbox = $args['mailbox'];
+            $result->preview->uid = $args['uid'];
         }
 
         return $result;