support for fennec

2 files changed, 343 insertions, 0 deletions

diff --git a/platform/fennec/frameModule.js b/platform/fennec/frameModule.js
new file mode 100644
index 0000000..e0915eb
--- /dev/null
+++ b/platform/fennec/frameModule.js
@@ -0,0 +1,305 @@
+/*******************************************************************************
+
+    µBlock - a browser extension to block requests.
+    Copyright (C) 2014 The µBlock authors
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see {http://www.gnu.org/licenses/}.
+
+    Home: https://github.com/gorhill/uBlock
+*/
+
+'use strict';
+
+/******************************************************************************/
+
+this.EXPORTED_SYMBOLS = ['contentObserver'];
+
+const {interfaces: Ci, utils: Cu} = Components;
+const {Services} = Cu.import('resource://gre/modules/Services.jsm', null);
+const hostName = Services.io.newURI(Components.stack.filename, null, null).host;
+
+// Cu.import('resource://gre/modules/devtools/Console.jsm');
+
+/******************************************************************************/
+
+const getMessageManager = function(win) {
+    return win
+        .QueryInterface(Ci.nsIInterfaceRequestor)
+        .getInterface(Ci.nsIDocShell)
+        .sameTypeRootTreeItem
+        .QueryInterface(Ci.nsIDocShell)
+        .QueryInterface(Ci.nsIInterfaceRequestor)
+        .getInterface(Ci.nsIContentFrameMessageManager);
+};
+
+/******************************************************************************/
+
+const contentObserver = {
+    classDescription: 'content-policy for ' + hostName,
+    classID: Components.ID('{e6d173c8-8dbf-4189-a6fd-189e8acffd27}'),
+    contractID: '@' + hostName + '/content-policy;1',
+    ACCEPT: Ci.nsIContentPolicy.ACCEPT,
+    MAIN_FRAME: Ci.nsIContentPolicy.TYPE_DOCUMENT,
+    contentBaseURI: 'chrome://' + hostName + '/content/js/',
+    cpMessageName: hostName + ':shouldLoad',
+    ignoredPopups: new WeakMap(),
+    uniqueSandboxId: 1,
+
+    get componentRegistrar() {
+        return Components.manager.QueryInterface(Ci.nsIComponentRegistrar);
+    },
+
+    get categoryManager() {
+        return Components.classes['@mozilla.org/categorymanager;1']
+                .getService(Ci.nsICategoryManager);
+    },
+
+    QueryInterface: (function() {
+        let {XPCOMUtils} = Cu.import('resource://gre/modules/XPCOMUtils.jsm', null);
+
+        return XPCOMUtils.generateQI([
+            Ci.nsIFactory,
+            Ci.nsIObserver,
+            Ci.nsIContentPolicy,
+            Ci.nsISupportsWeakReference
+        ]);
+    })(),
+
+    createInstance: function(outer, iid) {
+        if ( outer ) {
+            throw Components.results.NS_ERROR_NO_AGGREGATION;
+        }
+
+        return this.QueryInterface(iid);
+    },
+
+    register: function() {
+        Services.obs.addObserver(this, 'document-element-inserted', true);
+
+        this.componentRegistrar.registerFactory(
+            this.classID,
+            this.classDescription,
+            this.contractID,
+            this
+        );
+        this.categoryManager.addCategoryEntry(
+            'content-policy',
+            this.contractID,
+            this.contractID,
+            false,
+            true
+        );
+    },
+
+    unregister: function() {
+        Services.obs.removeObserver(this, 'document-element-inserted');
+
+        this.componentRegistrar.unregisterFactory(this.classID, this);
+        this.categoryManager.deleteCategoryEntry(
+            'content-policy',
+            this.contractID,
+            false
+        );
+    },
+
+    getFrameId: function(win) {
+        return win
+            .QueryInterface(Ci.nsIInterfaceRequestor)
+            .getInterface(Ci.nsIDOMWindowUtils)
+            .outerWindowID;
+    },
+
+    // https://bugzil.la/612921
+    shouldLoad: function(type, location, origin, context) {
+        if ( !context ) {
+            return this.ACCEPT;
+        }
+
+        if ( !location.schemeIs('http') && !location.schemeIs('https') ) {
+            return this.ACCEPT;
+        }
+
+        let openerURL = null;
+
+        if ( type === this.MAIN_FRAME ) {
+            context = context.contentWindow || context;
+
+            if ( context.opener && context.opener !== context
+                && this.ignoredPopups.has(context) === false ) {
+                openerURL = context.opener.location.href;
+            }
+        } else {
+            context = (context.ownerDocument || context).defaultView;
+        }
+
+        // The context for the toolbar popup is an iframe element here,
+        // so check context.top instead of context
+        if ( !context.top || !context.location ) {
+            return this.ACCEPT;
+        }
+
+        // https://github.com/gorhill/uBlock/issues/795
+        // Only the top main frame can be an orphan
+        let isTopLevel = context === context.top;
+        let parentFrameId;
+
+        if ( isTopLevel && type === this.MAIN_FRAME ) {
+            parentFrameId = -1;
+        } else if ( context.parent === context.top ) {
+            parentFrameId = 0;
+        } else {
+            parentFrameId = this.getFrameId(context.parent);
+        }
+
+        let messageManager = getMessageManager(context);
+        let details = {
+            frameId: isTopLevel ? 0 : this.getFrameId(context),
+            openerURL: openerURL,
+            parentFrameId: parentFrameId,
+            type: type,
+            url: location.spec
+        };
+
+        if ( typeof messageManager.sendRpcMessage === 'function' ) {
+            // https://bugzil.la/1092216
+            messageManager.sendRpcMessage(this.cpMessageName, details);
+        } else {
+            // Compatibility for older versions
+            messageManager.sendSyncMessage(this.cpMessageName, details);
+        }
+
+        return this.ACCEPT;
+    },
+
+    initContentScripts: function(win, sandbox) {
+        let messager = getMessageManager(win);
+        let sandboxId = hostName + ':sb:' + this.uniqueSandboxId++;
+
+        if ( sandbox ) {
+            let sandboxName = [
+                win.location.href.slice(0, 100),
+                win.document.title.slice(0, 100)
+            ].join(' | ');
+
+            sandbox = Cu.Sandbox([win], {
+                sandboxName: sandboxId + '[' + sandboxName + ']',
+                sandboxPrototype: win,
+                wantComponents: false,
+                wantXHRConstructor: false
+            });
+
+            sandbox.injectScript = function(script) {
+                Services.scriptloader.loadSubScript(script, sandbox);
+            };
+        }
+        else {
+            sandbox = win;
+        }
+
+        sandbox._sandboxId_ = sandboxId;
+        sandbox.sendAsyncMessage = messager.sendAsyncMessage;
+
+        sandbox.addMessageListener = function(callback) {
+            if ( sandbox._messageListener_ ) {
+                sandbox.removeMessageListener();
+            }
+
+            sandbox._messageListener_ = function(message) {
+                callback(message.data);
+            };
+
+            messager.addMessageListener(
+                sandbox._sandboxId_,
+                sandbox._messageListener_
+            );
+            messager.addMessageListener(
+                hostName + ':broadcast',
+                sandbox._messageListener_
+            );
+        };
+
+        sandbox.removeMessageListener = function() {
+            try {
+                messager.removeMessageListener(
+                    sandbox._sandboxId_,
+                    sandbox._messageListener_
+                );
+                messager.removeMessageListener(
+                    hostName + ':broadcast',
+                    sandbox._messageListener_
+                );
+            } catch (ex) {
+                // It throws sometimes, mostly when the popup closes
+            }
+
+            sandbox._messageListener_ = null;
+        };
+
+        return sandbox;
+    },
+
+    ignorePopup: function(e) {
+        if ( e.isTrusted === false ) {
+            return;
+        }
+
+        let contObs = contentObserver;
+        contObs.ignoredPopups.set(this, true);
+        this.removeEventListener('keydown', contObs.ignorePopup, true);
+        this.removeEventListener('mousedown', contObs.ignorePopup, true);
+    },
+
+    observe: function(subject) {
+        let win = subject.defaultView;
+
+        if ( !win ) {
+            return;
+        }
+
+        if ( win.opener && this.ignoredPopups.has(win) === false ) {
+            win.addEventListener('keydown', this.ignorePopup, true);
+            win.addEventListener('mousedown', this.ignorePopup, true);
+        }
+
+        let loc = win.location;
+
+        if ( loc.protocol !== 'http:' && loc.protocol !== 'https:' ) {
+            if ( loc.protocol === 'chrome:' && loc.host === hostName ) {
+                this.initContentScripts(win);
+            }
+
+            // What about data: and about:blank?
+            return;
+        }
+
+        let lss = Services.scriptloader.loadSubScript;
+        let sandbox = this.initContentScripts(win, true);
+
+        lss(this.contentBaseURI + 'vapi-client.js', sandbox);
+        lss(this.contentBaseURI + 'contentscript-start.js', sandbox);
+
+        let docReady = function(e) {
+            this.removeEventListener(e.type, docReady, true);
+            lss(contentObserver.contentBaseURI + 'contentscript-end.js', sandbox);
+        };
+
+        subject.addEventListener('DOMContentLoaded', docReady, true);
+    }
+};
+
+/******************************************************************************/
+
+contentObserver.register();
+
+/******************************************************************************/
diff --git a/tools/make-fennec.sh b/tools/make-fennec.sh
new file mode 100755
index 0000000..6e7ed04
--- /dev/null
+++ b/tools/make-fennec.sh
@@ -0,0 +1,38 @@
+#!/bin/bash
+#
+# This script assumes a linux environment
+
+echo "*** uBlock.fennec: Copying files"
+
+DES=dist/build/uBlock.fennec
+rm -rf $DES
+mkdir -p $DES
+
+cp -R assets $DES/
+rm $DES/assets/*.sh
+cp -R src/css $DES/
+cp -R src/img $DES/
+cp -R src/js $DES/
+cp -R src/lib $DES/
+cp -R src/_locales $DES/
+cp src/*.html $DES/
+mv $DES/img/icon_128.png $DES/icon.png
+cp platform/firefox/vapi-*.js $DES/js/
+cp platform/firefox/bootstrap.js $DES/
+cp platform/firefox/frameScript.js $DES/
+cp platform/firefox/chrome.manifest $DES/
+cp platform/firefox/install.rdf $DES/
+cp platform/fennec/frameModule.js $DES/
+cp LICENSE.txt $DES/
+
+echo "*** uBlock.fennec: Generating meta..."
+python tools/make-firefox-meta.py $DES/
+
+if [ "$1" = all ]; then
+    echo "*** uBlock.fennec: Creating package..."
+    pushd $DES/
+    zip ../uBlock.fennec.xpi -qr *
+    popd
+fi
+
+echo "*** uBlock.fennec: Package done."