Bug 1322592 - [2.2] Add GeckoViewNavigation.jsm. r=snorp,jchen

mobile/android/modules/GeckoViewNavigation.jsm

@@ -0,0 +1,138 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+this.EXPORTED_SYMBOLS = ["GeckoViewNavigation"];
+
+const { classes: Cc, interfaces: Ci, utils: Cu, results: Cr } = Components;
+
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+
+XPCOMUtils.defineLazyModuleGetter(this, "EventDispatcher",
+  "resource://gre/modules/Messaging.jsm");
+
+var dump = Cu.import("resource://gre/modules/AndroidLog.jsm", {})
+           .AndroidLog.d.bind(null, "ViewNavigation");
+
+function debug(msg) {
+  // dump(msg);
+}
+
+// Handles navigation requests between Gecko and a GeckoView.
+// Implements GeckoView.loadUri via openURI.
+// Handles GeckoView:GoBack and :GoForward requests dispatched by
+// GeckoView.goBack and .goForward.
+// Dispatches GeckoView:LocationChange to the GeckoView on location change when
+// active.
+// Can be activated and deactivated by GeckoViewNavigation:Active and :Inactive
+// events.
+class GeckoViewNavigation {
+  constructor(window) {
+    this.window = window;
+    this.window.QueryInterface(Ci.nsIDOMChromeWindow).browserDOMWindow = this;
+
+    // We need to listen initially because the "GeckoViewNavigation:Active"
+    // event may be dispatched before this object is constructed.
+    this.registerProgressListener();
+
+    this.eventDispatcher.registerListener(this, [
+      "GeckoViewNavigation:Active",
+      "GeckoViewNavigation:Inactive",
+      "GeckoView:GoBack",
+      "GeckoView:GoForward",
+    ]);
+  }
+
+  get browser() {
+    return this.window.browser;
+  }
+
+  get messageManager() {
+    return this.browser.messageManager;
+  }
+
+  get eventDispatcher() {
+    return EventDispatcher.for(this.window);
+  }
+
+  // Bundle event handler.
+  onEvent(event, data, callback) {
+    debug("onEvent: event=" + event + ", data=" + JSON.stringify(data));
+
+    switch (event) {
+      case "GeckoViewNavigation:Active":
+        this.registerProgressListener();
+        break;
+      case "GeckoViewNavigation:Inactive":
+        this.unregisterProgressListener();
+        break;
+      case "GeckoView:GoBack":
+        this.browser.goBack();
+        break;
+      case "GeckoView:GoForward":
+        this.browser.goForward();
+        break;
+    }
+  }
+
+  // Message manager event handler.
+  receiveMessage(msg) {
+    debug("receiveMessage " + msg.name);
+  }
+
+  // nsIBrowserDOMWindow::openURI implementation.
+  openURI(uri, opener, where, flags) {
+    debug("openURI: uri.spec=" + uri.spec);
+    // nsIWebNavigation::loadURI(URI, loadFlags, referrer, postData, headers).
+    this.browser.loadURI(uri.spec, null, null, null);
+  }
+
+  // nsIBrowserDOMWindow::canClose implementation.
+  canClose() {
+    debug("canClose");
+    return false;
+  }
+
+  registerProgressListener() {
+    debug("registerProgressListener");
+    let flags = Ci.nsIWebProgress.NOTIFY_LOCATION;
+    this.progressFilter =
+      Cc["@mozilla.org/appshell/component/browser-status-filter;1"]
+      .createInstance(Ci.nsIWebProgress);
+    this.progressFilter.addProgressListener(this, flags);
+    this.browser.addProgressListener(this.progressFilter, flags);
+  }
+
+  unregisterProgressListener() {
+    debug("unregisterProgressListener");
+    if (!this.progressFilter) {
+      return;
+    }
+    this.progressFilter.removeProgressListener(this);
+    this.browser.removeProgressListener(this.progressFilter);
+  }
+
+  // WebProgress event handler.
+  onLocationChange(webProgress, request, locationURI, flags) {
+    debug("onLocationChange");
+
+    let fixedURI = locationURI;
+
+    try {
+      fixedURI = URIFixup.createExposableURI(locationURI);
+    } catch (ex) { }
+
+    let message = {
+      type: "GeckoView:LocationChange",
+      uri: fixedURI.spec,
+      canGoBack: this.browser.canGoBack,
+      canGoForward: this.browser.canGoForward,
+    };
+
+    debug("dispatch " + JSON.stringify(message));
+
+    this.eventDispatcher.sendRequest(message);
+  }
+}

mobile/android/modules/moz.build

@@ -33,5 +33,6 @@ EXTRA_JS_MODULES += [
 
 # GeckoView-sepcific modules added separately.
 EXTRA_JS_MODULES += [
-    'GeckoViewContent.jsm'
+    'GeckoViewContent.jsm',
+    'GeckoViewNavigation.jsm'
 ]