Bug 972098 - Refresh DynamicPanels when the dataset changes (r=margaret)

mobile/android/base/home/DynamicPanel.java

@@ -5,12 +5,18 @@
 
 package org.mozilla.gecko.home;
 
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import org.mozilla.gecko.GeckoAppShell;
 import org.mozilla.gecko.db.BrowserContract.HomeItems;
 import org.mozilla.gecko.db.DBUtils;
 import org.mozilla.gecko.home.HomeConfig.PanelConfig;
 import org.mozilla.gecko.home.HomePager.OnUrlOpenListener;
 import org.mozilla.gecko.home.PanelLayout.DatasetHandler;
 import org.mozilla.gecko.home.PanelLayout.DatasetRequest;
+import org.mozilla.gecko.util.GeckoEventListener;
+import org.mozilla.gecko.util.ThreadUtils;
 
 import android.app.Activity;
 import android.content.ContentResolver;
@@ -45,7 +51,8 @@ import android.view.ViewGroup;
  * See {@code PanelLayout} for more details on how {@code DynamicPanel}
  * receives dataset requests and delivers them back to the {@code PanelLayout}.
  */
-public class DynamicPanel extends HomeFragment {
+public class DynamicPanel extends HomeFragment
+                          implements GeckoEventListener {
     private static final String LOGTAG = "GeckoDynamicPanel";
 
     // Dataset ID to be used by the loader
@@ -116,12 +123,15 @@ public class DynamicPanel extends HomeFragment {
     @Override
     public void onViewCreated(View view, Bundle savedInstanceState) {
         super.onViewCreated(view, savedInstanceState);
+        GeckoAppShell.registerEventListener("HomePanels:RefreshDataset", this);
     }
 
     @Override
     public void onDestroyView() {
         super.onDestroyView();
         mLayout = null;
+
+        GeckoAppShell.unregisterEventListener("HomePanels:RefreshDataset", this);
     }
 
     @Override
@@ -152,10 +162,60 @@ public class DynamicPanel extends HomeFragment {
         mLayout.load();
     }
 
+    @Override
+    public void handleMessage(String event, final JSONObject message) {
+        if (event.equals("HomePanels:RefreshDataset")) {
+            ThreadUtils.postToUiThread(new Runnable() {
+                @Override
+                public void run() {
+                    handleDatasetRefreshRequest(message);
+                }
+            });
+        }
+    }
+
     private static int generateLoaderId(String datasetId) {
         return datasetId.hashCode();
     }
 
+    /**
+     * Handles a dataset refresh request from Gecko. This is usually
+     * triggered by a HomeStorage.save() call in an add-on.
+     */
+    private void handleDatasetRefreshRequest(JSONObject message) {
+        final String datasetId;
+        try {
+            datasetId = message.getString("datasetId");
+        } catch (JSONException e) {
+            Log.e(LOGTAG, "Failed to handle dataset refresh", e);
+            return;
+        }
+
+        Log.d(LOGTAG, "Refresh request for dataset: " + datasetId);
+
+        final int loaderId = generateLoaderId(datasetId);
+
+        final LoaderManager lm = getLoaderManager();
+        final Loader<?> loader = (Loader<?>) lm.getLoader(loaderId);
+
+        // Only restart a loader if there's already an active one
+        // for the given dataset ID. Do nothing otherwise.
+        if (loader != null) {
+            final PanelDatasetLoader datasetLoader = (PanelDatasetLoader) loader;
+            final DatasetRequest request = datasetLoader.getRequest();
+
+            // Ensure the refresh request doesn't affect the view's filter
+            // stack (i.e. use DATASET_LOAD type) but keep the current
+            // dataset ID and filter.
+            final DatasetRequest newRequest =
+                   new DatasetRequest(DatasetRequest.Type.DATASET_LOAD,
+                                      request.getDatasetId(),
+                                      request.getFilterDetail());
+
+            restartDatasetLoader(newRequest);
+        }
+    }
+
     private void restartDatasetLoader(DatasetRequest request) {
         final Bundle bundle = new Bundle();
         bundle.putParcelable(DATASET_REQUEST, request);

mobile/android/modules/HomeProvider.jsm

@@ -9,6 +9,7 @@ this.EXPORTED_SYMBOLS = [ "HomeProvider" ];
 
 const { utils: Cu, classes: Cc, interfaces: Ci } = Components;
 
+Cu.import("resource://gre/modules/Messaging.jsm");
 Cu.import("resource://gre/modules/osfile.jsm");
 Cu.import("resource://gre/modules/Promise.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
@@ -315,6 +316,11 @@ HomeStorage.prototype = {
       } finally {
         yield db.close();
       }
+
+      sendMessageToJava({
+        type: "HomePanels:RefreshDataset",
+        datasetId: this.datasetId,
+      });
     }.bind(this));
   },
 
@@ -333,6 +339,11 @@ HomeStorage.prototype = {
       } finally {
         yield db.close();
       }
+
+      sendMessageToJava({
+        type: "HomePanels:RefreshDataset",
+        datasetId: this.datasetId,
+      });
     }.bind(this));
   }
 };