diff --git a/mobile/android/examples/extensions/messaging_example/app/.gitignore b/mobile/android/examples/extensions/messaging_example/app/.gitignore new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/mobile/android/examples/extensions/messaging_example/app/build.gradle b/mobile/android/examples/extensions/messaging_example/app/build.gradle new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/build.gradle @@ -0,0 +1,51 @@ +buildDir "${topobjdir}/gradle/build/mobile/android/examples/messaging_example" + +apply plugin: 'com.android.application' + +apply from: "${topsrcdir}/mobile/android/gradle/product_flavors.gradle" + +android { + compileSdkVersion project.ext.compileSdkVersion + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + defaultConfig { + applicationId "org.mozilla.geckoview.example.messaging" + targetSdkVersion project.ext.targetSdkVersion + minSdkVersion project.ext.minSdkVersion + versionCode 1 + versionName "1.0" + testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + + // By default the android plugins ignores folders that start with `_`, but + // we need those in web extensions. + // See also: + // - https://issuetracker.google.com/issues/36911326 + // - https://stackoverflow.com/questions/9206117/how-to-workaround-autoomitting-fiiles-folders-starting-with-underscore-in + aaptOptions { + ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:!CVS:!thumbs.db:!picasa.ini:!*~' + } + + project.configureProductFlavors.delegate = it + project.configureProductFlavors() +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation "com.android.support:support-annotations:$support_library_version" + implementation "com.android.support:appcompat-v7:$support_library_version" + 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 project(path: ':geckoview') +} diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/AndroidManifest.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/AndroidManifest.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/AndroidManifest.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/assets/messaging/manifest.json b/mobile/android/examples/extensions/messaging_example/app/src/main/assets/messaging/manifest.json new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/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/mobile/android/examples/extensions/messaging_example/app/src/main/assets/messaging/messaging.js b/mobile/android/examples/extensions/messaging_example/app/src/main/assets/messaging/messaging.js new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/assets/messaging/messaging.js @@ -0,0 +1,14 @@ +/* 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/. */ + +let manifest = document.querySelector("head > link[rel=manifest]"); +let browser = window.docShell.chromeEventHandler; +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/mobile/android/examples/extensions/messaging_example/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java b/mobile/android/examples/extensions/messaging_example/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/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(extension, messageDelegate, "browser"); + + session.open(sRuntime); + view.setSession(session); + session.loadUri("https://mobile.twitter.com"); + } +} diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/drawable/ic_launcher_background.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/layout/activity_main.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/layout/activity_main.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,14 @@ + + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-hdpi/ic_launcher.png b/mobile/android/examples/extensions/messaging_example/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 GIT binary patch literal 0 Hc$@ + + #008577 + #00574B + #D81B60 + diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/values/strings.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/values/strings.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + MessagingExample + diff --git a/mobile/android/examples/extensions/messaging_example/app/src/main/res/values/styles.xml b/mobile/android/examples/extensions/messaging_example/app/src/main/res/values/styles.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/messaging_example/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/mobile/android/examples/extensions/port_messaging_example/app/.gitignore b/mobile/android/examples/extensions/port_messaging_example/app/.gitignore new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/mobile/android/examples/extensions/port_messaging_example/app/build.gradle b/mobile/android/examples/extensions/port_messaging_example/app/build.gradle new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/build.gradle @@ -0,0 +1,51 @@ +buildDir "${topobjdir}/gradle/build/mobile/android/examples/port_messaging_example" + +apply plugin: 'com.android.application' + +apply from: "${topsrcdir}/mobile/android/gradle/product_flavors.gradle" + +android { + compileSdkVersion project.ext.compileSdkVersion + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + defaultConfig { + applicationId "org.mozilla.geckoview.example.messaging" + targetSdkVersion project.ext.targetSdkVersion + minSdkVersion project.ext.minSdkVersion + versionCode 1 + versionName "1.0" + testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + + // By default the android plugins ignores folders that start with `_`, but + // we need those in web extensions. + // See also: + // - https://issuetracker.google.com/issues/36911326 + // - https://stackoverflow.com/questions/9206117/how-to-workaround-autoomitting-fiiles-folders-starting-with-underscore-in + aaptOptions { + ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:!CVS:!thumbs.db:!picasa.ini:!*~' + } + + project.configureProductFlavors.delegate = it + project.configureProductFlavors() +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation "com.android.support:support-annotations:$support_library_version" + implementation "com.android.support:appcompat-v7:$support_library_version" + 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 project(path: ':geckoview') +} diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/AndroidManifest.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/AndroidManifest.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/AndroidManifest.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/assets/messaging/background.js b/mobile/android/examples/extensions/port_messaging_example/app/src/main/assets/messaging/background.js new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/assets/messaging/background.js @@ -0,0 +1,12 @@ +/* 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/. */ + +// Establish connection with app +let browser = window.docShell.chromeEventHandler; +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/mobile/android/examples/extensions/port_messaging_example/app/src/main/assets/messaging/manifest.json b/mobile/android/examples/extensions/port_messaging_example/app/src/main/assets/messaging/manifest.json new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/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/mobile/android/examples/extensions/port_messaging_example/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java b/mobile/android/examples/extensions/port_messaging_example/app/src/main/java/org/mozilla/geckoview/example/messaging/MainActivity.java new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/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/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/drawable/ic_launcher_background.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/layout/activity_main.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/layout/activity_main.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,14 @@ + + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-hdpi/ic_launcher.png b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 GIT binary patch literal 0 Hc$@ + + #008577 + #00574B + #D81B60 + diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/values/strings.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/values/strings.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + MessagingExample + diff --git a/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/values/styles.xml b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/values/styles.xml new file mode 100644 --- /dev/null +++ b/mobile/android/examples/extensions/port_messaging_example/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/settings.gradle b/settings.gradle --- a/settings.gradle +++ b/settings.gradle @@ -43,12 +43,18 @@ include ':annotations' include ':geckoview' include ':geckoview_example' +include ':messaging_example' include ':omnijar' +include ':port_messaging_example' +include ':thirdparty' project(':annotations').projectDir = new File("${json.topsrcdir}/mobile/android/annotations") project(':geckoview').projectDir = new File("${json.topsrcdir}/mobile/android/geckoview") project(':geckoview_example').projectDir = new File("${json.topsrcdir}/mobile/android/geckoview_example") +project(':messaging_example').projectDir = new File("${json.topsrcdir}/mobile/android/examples/extensions/messaging_example/app") project(':omnijar').projectDir = new File("${json.topsrcdir}/mobile/android/app/omnijar") +project(':port_messaging_example').projectDir = new File("${json.topsrcdir}/mobile/android/examples/extensions/port_messaging_example/app") +project(':thirdparty').projectDir = new File("${json.topsrcdir}/mobile/android/thirdparty") // The Gradle instance is shared between settings.gradle and all the // other build.gradle files (see @@ -66,4 +72,4 @@ // build ...` commands from within Gradle. This avoids invalidating configure // based on the changed environment variables. def orig = slurper.parse(new File(json.topobjdir, '.mozconfig.json')) -gradle.ext.mozconfig.orig_mozconfig = orig.mozconfig +gradle.ext.mozconfig.orig_mozconfig = orig.mozconfig \ No newline at end of file