diff --git a/README.md b/README.md index d9f30de194..c2a85b33a7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ## Get Started with GeckoView * [GeckoView Quick Start Guide][1] +* [Interacting with Web content and WebExtension][7] ## API Documentation @@ -25,4 +26,5 @@ You can read more about GeckoView on the [wiki](https://wiki.mozilla.org/Mobile/ [3]:tutorials/geckoview-quick-start.md [4]:tutorials/mc-quick-start.md [5]:tutorials/contributing-to-mc.md -[6]:tutorials/native-debugging.md \ No newline at end of file +[6]:tutorials/native-debugging.md +[7]:docs/web-extensions.md diff --git a/docs/web-extensions.md b/docs/web-extensions.md new file mode 100644 index 0000000000..e62b4b6a1b --- /dev/null +++ b/docs/web-extensions.md @@ -0,0 +1,329 @@ +--- +layout: default +title: Interacting with Web content +nav_order: 3 +summary: How to interact with Web content and register WebExtensions in GeckoView. +--- +# Interacting with Web content and WebExtensions + +GeckoView allows embedder applications to register and run [WebExtensions][8] +in a GeckoView instance. WebExtensions are the preferred way to interact with +Web content. + +## Running WebExtensions in GeckoView + +WebExtensions bundled with applications can be provided either in compressed +`.xpi` files or in regular folders. Like ordinary WebExtensions, every +WebExtension requires a [`manifest.json`][23] file. + +To run a WebExtension in GeckoView, simply create a [`WebExtension`][3] object +and register it in your [`GeckoRuntime`][24] instance. + +```java +WebExtension extension = new WebExtension( + // The location where the web extension is installed, if the location is a + // folder make sure the path ends with a "/" character. + "resource://android/assets/messaging/", + // This is the id and must be unique for every web extension + "myextension@example.com", + // Extra flags can be specified here + WebExtension.Flags.NONE); + +// Run the WebExtension +runtime.registerWebExtension(extension); +``` + +Note that the lifetime of the WebExtension is tied with the lifetime of the +[`GeckoRuntime`][24] instance. The WebExtension will need to be registered +every time the runtime is created and will not persist once the runtime is +closed. + +To locate files bundled with the APK, GeckoView provides a shorthand +`resource://android/` that points to the root of the APK. + +E.g. `resource://android/assets/messaging/` will point to the +`/assets/messaging/` folder present in the APK. + +## Communicating with Web Content +GeckoView allows bidirectional communication with Web pages through +WebExtensions. + +When using GeckoView, [native messaging][11] can be used for communicating to +and from the browser. +* [`runtime.sendNativeMessage`][12] for one-off messages. +* [`runtime.connectNative`][13] for connection-based messaging. + +Note: these APIs are only available when the `geckoViewAddons` [permission][17] +is present in the `manifest.json` file of the WebExtension. + +### One-off messages + +The easiest way to send messages from a [content script][9] or a [background +script][10] is using [`runtime.sendNativeMessage`][12]. The app will set up a +message delegate on the same `nativeApp` that the WebExtension is using to send +messages. In our example we will use the `"browser"` native app identifier. + +To receive messages from the background script, call [`setMessageDelegate`][14] +on the [`WebExtension`][3] object. + +[`GeckoSession.setMessageDelegate`][16] allows the app to receive messages from +content scripts. + +Note: WebExtensions can only send messages from content scripts if explicitly +authorized by the app setting +[`WebExtension.Flags.ALLOW_CONTENT_MESSAGING`][22] in the [constructor][15]. + +### Example + +Let's set up an activity that registers a WebExtension located in the +`/assets/messaging/` folder of the APK. This activity will set up a +[`MessageDelegate`][18] that will be used to communicate with Web Content. + +You can find the full example here: [MessagingExample][20]. + +##### Activity.java +```java +WebExtension.MessageDelegate messageDelegate = new WebExtension.MessageDelegate() { + @Nullable + public GeckoResult onMessage(final @NonNull Object message, + final @NonNull WebExtension.MessageSender sender) { + // The sender object contains information about the session that + // originated this message and can be used to validate that the message + // has been sent from the expected location. + + // Be careful when handling the type of message as it depends on what + // type of object was sent from the WebExtension script. + if (message instanceof JSONObject) { + // Do something with message + } + return null; + } +}; + +WebExtension extension = new WebExtension( + "resource://android/assets/messaging/", + "myextension@example.com", + WebExtension.Flags.ALLOW_CONTENT_MESSAGING); + +// Run the WebExtension +runtime.registerWebExtension(extension); + +// Set the delegate that will receive messages coming from this WebExtension. +session.setMessageDelegate(messageDelegate, "browser"); +``` + +Now add the `geckoViewAddons` and `nativeMessaging` permissions to your +`manifest.json` file. + +##### /assets/messaging/manifest.json +```json +{ + "manifest_version": 2, + "name": "messaging", + "version": "1.0", + "description": "Example messaging web extension.", + "content_scripts": [ + { + "matches": ["*://*.twitter.com/*"], + "js": ["messaging.js"] + } + ], + "permissions": [ + "nativeMessaging", + "geckoViewAddons" + ] +} +``` + +And finally, write a content script that will send a message to the app when a +certain event occurs. For example, you could send a message whenever a [WPA +manifest][19] is found on the page. Note that our `nativeApp` identifier used +for `sendNativeMessage` is the same as the one used in the `setMessageDelegate` +call in [`Activity.java`](#activityjava). + +##### /assets/messaging/messaging.js +```javascript +let manifest = document.querySelector("head > link[rel=manifest]"); +if (manifest) { + fetch(manifest.href) + .then(response => response.json()) + .then(json => { + let message = {type: "WPAManifest", manifest: json}; + browser.runtime.sendNativeMessage("browser", message); + }); +} +``` + +You can handle this message in the `onMessage` method in the `messageDelegate` +[above](#activityjava). + +```java +@Nullable +public GeckoResult onMessage(final @NonNull Object message, + final @NonNull WebExtension.MessageSender sender) { + if (message instanceof JSONObject) { + JSONObject json = (JSONObject) message; + try { + if (json.has("type") && "WPAManifest".equals(json.getString("type"))) { + JSONObject manifest = json.getJSONObject("manifest"); + Log.d("MessageDelegate", "Found WPA manifest: " + manifest); + } + } catch (JSONException ex) { + Log.e("MessageDelegate", "Invalid manifest", ex); + } + } + return null; +} +``` + +Note that, in the case of content scripts, `sender.session` will be a reference +to the `GeckoSession` instance from which the message originated. For +background scripts, `sender.session` will always be `null`. + +Also note that the type of `message` will depend on what was sent from the +WebExtension. + +The type of `message` will be `JSONObject` when the WebExtension sends a +javascript object, but could also be a primitive type if the WebExtension sends +one, e.g. for + +```javascript +runtime.browser.sendNativeMessage("browser", "Hello World!"); +``` + +the type of `message` will be `java.util.String`. + +## Connection-based messaging + +For more complex scenarios or for when you want to send messages _from_ the app +to the WebExtension, [`runtime.connectNative`][13] is the appropriate API to +use. + +`connectNative` returns a [`runtime.Port`][6] that can be used to send messages +to the app. On the app side, implementing [`MessageDelegate#onConnect`][1] will +allow you to receive a [`Port`][7] object that can be used to receive and send +messages to the WebExtension. + +The following example can be found [here][21]. + +For this example, the WebExtension side will do the following: + * open a port on the background script using `connectNative` + * listen on the port and log to console every message received + * send a message immediately after opening the port. + +##### /assets/messaging/background.js +```javascript +// Establish connection with app +let port = browser.runtime.connectNative("browser"); +port.onMessage.addListener(response => { + // Let's just echo the message back + port.postMessage(`Received: ${JSON.stringify(response)}`); +}); +port.postMessage("Hello from WebExtension!"); +``` + +On the app side, following the [above](#activityjava) example, `onConnect` will +be storing the `Port` object in a member variable and then using it when +needed. + +```java +private WebExtension.Port mPort; + +@Override +protected void onCreate(Bundle savedInstanceState) { + // ... initialize GeckoView + + // This delegate will handle all communications from and to a specific Port + // object + WebExtension.PortDelegate portDelegate = new WebExtension.PortDelegate() { + public WebExtension.Port port = null; + + public void onPortMessage(final @NonNull Object message, + final @NonNull WebExtension.Port port) { + // This method will be called every time a message is sent from the + // WebExtension through this port. For now, let's just log a + // message. + Log.d("PortDelegate", "Received message from WebExtension: " + + message); + } + + public void onDisconnect(final @NonNull WebExtension.Port port) { + // After this method is called, this port is not usable anymore. + if (port == mPort) { + mPort = null; + } + } + }; + + // This delegate will handle requests to open a port coming from the + // WebExtension + WebExtension.MessageDelegate messageDelegate = new WebExtension.MessageDelegate() { + @Nullable + public void onConnect(final @NonNull WebExtension.Port port) { + // Let's store the Port object in a member variable so it can be + // used later to exchange messages with the WebExtension. + mPort = port; + + // Registering the delegate will allow us to receive messages sent + // through this port. + mPort.setDelegate(portDelegate); + } + }; + + WebExtension extension = new WebExtension( + "resource://android/assets/messaging/"); + + // Register message delegate for the background script + extension.setMessageDelegate(messageDelegate, "browser"); + + // ... other +} +``` + +For example, let's send a message to the WebExtension every time the user long +presses on a key on the virtual keyboard, e.g. on the back button. + +```java +@Override +public boolean onKeyLongPress(int keyCode, KeyEvent event) { + if (mPort == null) { + // No WebExtension registered yet, let's ignore this message + return false; + } + + JSONObject message = new JSONObject(); + try { + message.put("keyCode", keyCode); + message.put("event", KeyEvent.keyCodeToString(event.getKeyCode())); + } catch (JSONException ex) { + throw new RuntimeException(ex); + } + + mPort.postMessage(message); + return true; +} +``` + +This allows bidirectional communication between the app and the WebExtension. + +[1]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.MessageDelegate.html#onConnect-org.mozilla.geckoview.WebExtension.Port- +[3]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.html +[6]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/Port +[7]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.Port.html +[8]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions +[9]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts +[10]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Anatomy_of_a_WebExtension#Background_scripts +[11]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging#Exchanging_messages +[12]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/sendNativeMessage +[13]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/connectNative +[14]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.html#setMessageDelegate-org.mozilla.geckoview.WebExtension.MessageDelegate-java.lang.String- +[15]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.html#WebExtension-java.lang.String-java.lang.String-long- +[16]: ../javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession.html#setMessageDelegate-org.mozilla.geckoview.WebExtension.MessageDelegate-java.lang.String- +[17]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions +[18]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.MessageDelegate.html +[19]: https://developer.mozilla.org/en-US/docs/Web/Manifest +[20]: https://github.com/mozilla/geckoview/tree/gh-pages/examples/extensions/MessagingExample/ +[21]: https://github.com/mozilla/geckoview/tree/gh-pages/examples/extensions/PortMessagingExample/ +[22]: ../javadoc/mozilla-central/org/mozilla/geckoview/WebExtension.Flags.html#ALLOW_CONTENT_MESSAGING +[23]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json +[24]: ../javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html diff --git a/examples/extensions/MessagingExample/app/.gitignore b/examples/extensions/MessagingExample/app/.gitignore new file mode 100644 index 0000000000..796b96d1c4 --- /dev/null +++ b/examples/extensions/MessagingExample/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/examples/extensions/MessagingExample/app/build.gradle b/examples/extensions/MessagingExample/app/build.gradle new file mode 100644 index 0000000000..d7338652fb --- /dev/null +++ b/examples/extensions/MessagingExample/app/build.gradle @@ -0,0 +1,33 @@ +apply plugin: 'com.android.application' + +android { + compileSdkVersion 26 + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + defaultConfig { + applicationId "org.mozilla.geckoview.example.messaging" + minSdkVersion 21 + targetSdkVersion 26 + versionCode 1 + versionName "1.0" + testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation 'com.android.support:appcompat-v7:26.1.0' + implementation 'com.android.support.constraint:constraint-layout:1.1.3' + testImplementation 'junit:junit:4.12' + androidTestImplementation 'com.android.support.test:runner:1.0.2' + androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2' + implementation "org.mozilla.geckoview:geckoview-${geckoviewChannel}-arm64-v8a:${geckoviewVersion}" +} diff --git a/examples/extensions/MessagingExample/app/src/main/AndroidManifest.xml b/examples/extensions/MessagingExample/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000000..518024f79f --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/AndroidManifest.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/extensions/MessagingExample/app/src/main/assets/messaging/manifest.json b/examples/extensions/MessagingExample/app/src/main/assets/messaging/manifest.json new file mode 100644 index 0000000000..83f6935ffd --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/assets/messaging/manifest.json @@ -0,0 +1,16 @@ +{ + "manifest_version": 2, + "name": "messaging", + "version": "1.0", + "description": "Example messaging web extension.", + "content_scripts": [ + { + "matches": ["*://*.twitter.com/*"], + "js": ["messaging.js"] + } + ], + "permissions": [ + "nativeMessaging", + "geckoViewAddons" + ] +} diff --git a/examples/extensions/MessagingExample/app/src/main/assets/messaging/messaging.js b/examples/extensions/MessagingExample/app/src/main/assets/messaging/messaging.js new file mode 100644 index 0000000000..a64f5cc0e9 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/assets/messaging/messaging.js @@ -0,0 +1,9 @@ +let manifest = document.querySelector("head > link[rel=manifest]"); +if (manifest) { + fetch(manifest.href) + .then(response => response.json()) + .then(json => { + let message = {type: "WPAManifest", manifest: json}; + browser.runtime.sendNativeMessage("browser", message); + }); +} diff --git a/examples/extensions/MessagingExample/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java b/examples/extensions/MessagingExample/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java new file mode 100644 index 0000000000..e3026c1dc6 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java @@ -0,0 +1,67 @@ +package org.mozilla.geckoview.example.messaging; + +import android.support.annotation.NonNull; +import android.support.annotation.Nullable; +import android.support.v7.app.AppCompatActivity; +import android.os.Bundle; +import android.util.Log; + +import org.json.JSONException; +import org.json.JSONObject; +import org.mozilla.geckoview.GeckoResult; +import org.mozilla.geckoview.GeckoRuntime; +import org.mozilla.geckoview.GeckoSession; +import org.mozilla.geckoview.GeckoView; +import org.mozilla.geckoview.WebExtension; + +public class MainActivity extends AppCompatActivity { + private static GeckoRuntime sRuntime; + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_main); + + GeckoView view = findViewById(R.id.geckoview); + GeckoSession session = new GeckoSession(); + + if (sRuntime == null) { + sRuntime = GeckoRuntime.create(this); + } + + WebExtension.MessageDelegate messageDelegate = new WebExtension.MessageDelegate() { + @Nullable + public GeckoResult onMessage(final @NonNull Object message, + final @NonNull WebExtension.MessageSender sender) { + if (message instanceof JSONObject) { + JSONObject json = (JSONObject) message; + try { + if (json.has("type") && "WPAManifest".equals(json.getString("type"))) { + JSONObject manifest = json.getJSONObject("manifest"); + Log.d("MessageDelegate", "Found WPA manifest: " + manifest); + } + } catch (JSONException ex) { + Log.e("MessageDelegate", "Invalid manifest", ex); + } + } + return null; + } + }; + + WebExtension extension = new WebExtension( + "resource://android/assets/messaging/", + "myextension", + WebExtension.Flags.ALLOW_CONTENT_MESSAGING); + + sRuntime.registerWebExtension(extension).exceptionally(e -> { + Log.e("MessageDelegate", "Error registering WebExtension", e); + return null; + }); + + session.setMessageDelegate(messageDelegate, "browser"); + + session.open(sRuntime); + view.setSession(session); + session.loadUri("https://mobile.twitter.com"); + } +} diff --git a/examples/extensions/MessagingExample/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/examples/extensions/MessagingExample/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 index 0000000000..1f6bb29060 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + diff --git a/examples/extensions/MessagingExample/app/src/main/res/drawable/ic_launcher_background.xml b/examples/extensions/MessagingExample/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000000..0d025f9bf6 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/examples/extensions/MessagingExample/app/src/main/res/layout/activity_main.xml b/examples/extensions/MessagingExample/app/src/main/res/layout/activity_main.xml new file mode 100644 index 0000000000..478fa4e6c7 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,14 @@ + + + + + + \ No newline at end of file diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/examples/extensions/MessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 0000000000..eca70cfe52 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/examples/extensions/MessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 0000000000..eca70cfe52 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000000..898f3ed59a Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher_round.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 0000000000..dffca3601e Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher_round.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000000..64ba76f75e Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher_round.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 0000000000..dae5e08234 Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher_round.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000000..e5ed46597e Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 0000000000..14ed0af350 Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000000..b0907cac3b Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 0000000000..d8ae031549 Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000000..2c18de9e66 Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 0000000000..beed3cdd2c Binary files /dev/null and b/examples/extensions/MessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/examples/extensions/MessagingExample/app/src/main/res/values/colors.xml b/examples/extensions/MessagingExample/app/src/main/res/values/colors.xml new file mode 100644 index 0000000000..69b22338c6 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/values/colors.xml @@ -0,0 +1,6 @@ + + + #008577 + #00574B + #D81B60 + diff --git a/examples/extensions/MessagingExample/app/src/main/res/values/strings.xml b/examples/extensions/MessagingExample/app/src/main/res/values/strings.xml new file mode 100644 index 0000000000..a963269cad --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + MessagingExample + diff --git a/examples/extensions/MessagingExample/app/src/main/res/values/styles.xml b/examples/extensions/MessagingExample/app/src/main/res/values/styles.xml new file mode 100644 index 0000000000..5885930df6 --- /dev/null +++ b/examples/extensions/MessagingExample/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/examples/extensions/MessagingExample/build.gradle b/examples/extensions/MessagingExample/build.gradle new file mode 100644 index 0000000000..31e6ba6799 --- /dev/null +++ b/examples/extensions/MessagingExample/build.gradle @@ -0,0 +1,30 @@ +buildscript { + repositories { + google() + jcenter() + + } + dependencies { + classpath 'com.android.tools.build:gradle:3.3.2' + } +} + +allprojects { + repositories { + maven { + url "https://maven.mozilla.org/maven2/" + } + google() + jcenter() + + } +} + +ext { + geckoviewChannel = "nightly" + geckoviewVersion = "68.0.20190424095359" +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/examples/extensions/MessagingExample/gradle.properties b/examples/extensions/MessagingExample/gradle.properties new file mode 100644 index 0000000000..82618cecb4 --- /dev/null +++ b/examples/extensions/MessagingExample/gradle.properties @@ -0,0 +1,15 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx1536m +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true + + diff --git a/examples/extensions/MessagingExample/gradle/wrapper/gradle-wrapper.jar b/examples/extensions/MessagingExample/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..f6b961fd5a Binary files /dev/null and b/examples/extensions/MessagingExample/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/extensions/MessagingExample/gradle/wrapper/gradle-wrapper.properties b/examples/extensions/MessagingExample/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..f7c2cbfc9f --- /dev/null +++ b/examples/extensions/MessagingExample/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Thu Apr 18 07:32:04 PDT 2019 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.1-all.zip diff --git a/examples/extensions/MessagingExample/gradlew b/examples/extensions/MessagingExample/gradlew new file mode 100755 index 0000000000..cccdd3d517 --- /dev/null +++ b/examples/extensions/MessagingExample/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/examples/extensions/MessagingExample/gradlew.bat b/examples/extensions/MessagingExample/gradlew.bat new file mode 100644 index 0000000000..e95643d6a2 --- /dev/null +++ b/examples/extensions/MessagingExample/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/extensions/MessagingExample/settings.gradle b/examples/extensions/MessagingExample/settings.gradle new file mode 100644 index 0000000000..e7b4def49c --- /dev/null +++ b/examples/extensions/MessagingExample/settings.gradle @@ -0,0 +1 @@ +include ':app' diff --git a/examples/extensions/PortMessagingExample/app/.gitignore b/examples/extensions/PortMessagingExample/app/.gitignore new file mode 100644 index 0000000000..796b96d1c4 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/examples/extensions/PortMessagingExample/app/build.gradle b/examples/extensions/PortMessagingExample/app/build.gradle new file mode 100644 index 0000000000..d7338652fb --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/build.gradle @@ -0,0 +1,33 @@ +apply plugin: 'com.android.application' + +android { + compileSdkVersion 26 + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + defaultConfig { + applicationId "org.mozilla.geckoview.example.messaging" + minSdkVersion 21 + targetSdkVersion 26 + versionCode 1 + versionName "1.0" + testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation 'com.android.support:appcompat-v7:26.1.0' + implementation 'com.android.support.constraint:constraint-layout:1.1.3' + testImplementation 'junit:junit:4.12' + androidTestImplementation 'com.android.support.test:runner:1.0.2' + androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2' + implementation "org.mozilla.geckoview:geckoview-${geckoviewChannel}-arm64-v8a:${geckoviewVersion}" +} diff --git a/examples/extensions/PortMessagingExample/app/src/main/AndroidManifest.xml b/examples/extensions/PortMessagingExample/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000000..518024f79f --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/AndroidManifest.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/extensions/PortMessagingExample/app/src/main/assets/messaging/background.js b/examples/extensions/PortMessagingExample/app/src/main/assets/messaging/background.js new file mode 100644 index 0000000000..490d972207 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/assets/messaging/background.js @@ -0,0 +1,7 @@ +// Establish connection with app +let port = browser.runtime.connectNative("browser"); +port.onMessage.addListener(response => { + // Let's just echo the message back + port.postMessage(`Received: ${JSON.stringify(response)}`); +}); +port.postMessage("Hello from WebExtension!"); diff --git a/examples/extensions/PortMessagingExample/app/src/main/assets/messaging/manifest.json b/examples/extensions/PortMessagingExample/app/src/main/assets/messaging/manifest.json new file mode 100644 index 0000000000..84a737c085 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/assets/messaging/manifest.json @@ -0,0 +1,13 @@ +{ + "manifest_version": 2, + "name": "messaging", + "version": "1.0", + "description": "Example messaging web extension.", + "background": { + "scripts": ["background.js"] + }, + "permissions": [ + "nativeMessaging", + "geckoViewAddons" + ] +} diff --git a/examples/extensions/PortMessagingExample/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java b/examples/extensions/PortMessagingExample/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java new file mode 100644 index 0000000000..718551d692 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java @@ -0,0 +1,93 @@ +package org.mozilla.geckoview.example.messaging; + +import android.support.annotation.NonNull; +import android.support.annotation.Nullable; +import android.support.v7.app.AppCompatActivity; +import android.os.Bundle; +import android.util.Log; +import android.view.KeyEvent; + +import org.json.JSONException; +import org.json.JSONObject; +import org.mozilla.geckoview.GeckoResult; +import org.mozilla.geckoview.GeckoRuntime; +import org.mozilla.geckoview.GeckoSession; +import org.mozilla.geckoview.GeckoView; +import org.mozilla.geckoview.WebExtension; + +public class MainActivity extends AppCompatActivity { + private static GeckoRuntime sRuntime; + + private WebExtension.Port mPort; + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_main); + + GeckoView view = findViewById(R.id.geckoview); + GeckoSession session = new GeckoSession(); + + if (sRuntime == null) { + sRuntime = GeckoRuntime.create(this); + } + + WebExtension.PortDelegate portDelegate = new WebExtension.PortDelegate() { + public WebExtension.Port port = null; + + public void onPortMessage(final @NonNull Object message, + final @NonNull WebExtension.Port port) { + Log.d("PortDelegate", "Received message from WebExtension: " + + message); + } + + public void onDisconnect(final @NonNull WebExtension.Port port) { + // This port is not usable anymore. + if (port == mPort) { + mPort = null; + } + } + }; + + WebExtension.MessageDelegate messageDelegate = new WebExtension.MessageDelegate() { + @Nullable + public void onConnect(final @NonNull WebExtension.Port port) { + mPort = port; + mPort.setDelegate(portDelegate); + } + }; + + WebExtension extension = new WebExtension( + "resource://android/assets/messaging/"); + + extension.setMessageDelegate(messageDelegate, "browser"); + + sRuntime.registerWebExtension(extension).exceptionally(e -> { + Log.e("MessageDelegate", "Error registering WebExtension", e); + return null; + }); + + session.open(sRuntime); + view.setSession(session); + session.loadUri("https://mobile.twitter.com"); + } + + @Override + public boolean onKeyLongPress(int keyCode, KeyEvent event) { + if (mPort == null) { + // No WebExtension registered yet, let's ignore this message + return false; + } + + JSONObject message = new JSONObject(); + try { + message.put("keyCode", keyCode); + message.put("event", KeyEvent.keyCodeToString(event.getKeyCode())); + } catch (JSONException ex) { + throw new RuntimeException(ex); + } + + mPort.postMessage(message); + return true; + } +} diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/examples/extensions/PortMessagingExample/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 index 0000000000..1f6bb29060 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/drawable/ic_launcher_background.xml b/examples/extensions/PortMessagingExample/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000000..0d025f9bf6 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/layout/activity_main.xml b/examples/extensions/PortMessagingExample/app/src/main/res/layout/activity_main.xml new file mode 100644 index 0000000000..478fa4e6c7 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,14 @@ + + + + + + \ No newline at end of file diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 0000000000..eca70cfe52 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 0000000000..eca70cfe52 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000000..898f3ed59a Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher_round.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 0000000000..dffca3601e Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-hdpi/ic_launcher_round.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000000..64ba76f75e Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher_round.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 0000000000..dae5e08234 Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-mdpi/ic_launcher_round.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000000..e5ed46597e Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 0000000000..14ed0af350 Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000000..b0907cac3b Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 0000000000..d8ae031549 Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000000..2c18de9e66 Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 0000000000..beed3cdd2c Binary files /dev/null and b/examples/extensions/PortMessagingExample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/values/colors.xml b/examples/extensions/PortMessagingExample/app/src/main/res/values/colors.xml new file mode 100644 index 0000000000..69b22338c6 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/values/colors.xml @@ -0,0 +1,6 @@ + + + #008577 + #00574B + #D81B60 + diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/values/strings.xml b/examples/extensions/PortMessagingExample/app/src/main/res/values/strings.xml new file mode 100644 index 0000000000..a963269cad --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + MessagingExample + diff --git a/examples/extensions/PortMessagingExample/app/src/main/res/values/styles.xml b/examples/extensions/PortMessagingExample/app/src/main/res/values/styles.xml new file mode 100644 index 0000000000..5885930df6 --- /dev/null +++ b/examples/extensions/PortMessagingExample/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/examples/extensions/PortMessagingExample/build.gradle b/examples/extensions/PortMessagingExample/build.gradle new file mode 100644 index 0000000000..31e6ba6799 --- /dev/null +++ b/examples/extensions/PortMessagingExample/build.gradle @@ -0,0 +1,30 @@ +buildscript { + repositories { + google() + jcenter() + + } + dependencies { + classpath 'com.android.tools.build:gradle:3.3.2' + } +} + +allprojects { + repositories { + maven { + url "https://maven.mozilla.org/maven2/" + } + google() + jcenter() + + } +} + +ext { + geckoviewChannel = "nightly" + geckoviewVersion = "68.0.20190424095359" +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/examples/extensions/PortMessagingExample/gradle.properties b/examples/extensions/PortMessagingExample/gradle.properties new file mode 100644 index 0000000000..82618cecb4 --- /dev/null +++ b/examples/extensions/PortMessagingExample/gradle.properties @@ -0,0 +1,15 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx1536m +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true + + diff --git a/examples/extensions/PortMessagingExample/gradle/wrapper/gradle-wrapper.jar b/examples/extensions/PortMessagingExample/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..f6b961fd5a Binary files /dev/null and b/examples/extensions/PortMessagingExample/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/extensions/PortMessagingExample/gradle/wrapper/gradle-wrapper.properties b/examples/extensions/PortMessagingExample/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..f7c2cbfc9f --- /dev/null +++ b/examples/extensions/PortMessagingExample/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Thu Apr 18 07:32:04 PDT 2019 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.1-all.zip diff --git a/examples/extensions/PortMessagingExample/gradlew b/examples/extensions/PortMessagingExample/gradlew new file mode 100755 index 0000000000..cccdd3d517 --- /dev/null +++ b/examples/extensions/PortMessagingExample/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/examples/extensions/PortMessagingExample/gradlew.bat b/examples/extensions/PortMessagingExample/gradlew.bat new file mode 100644 index 0000000000..e95643d6a2 --- /dev/null +++ b/examples/extensions/PortMessagingExample/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/extensions/PortMessagingExample/settings.gradle b/examples/extensions/PortMessagingExample/settings.gradle new file mode 100644 index 0000000000..e7b4def49c --- /dev/null +++ b/examples/extensions/PortMessagingExample/settings.gradle @@ -0,0 +1 @@ +include ':app'