give specific message handlers priority over default one

meta/crx/vapi-background.js

@@ -19,9 +19,9 @@
     Home: https://github.com/gorhill/uBlock
 */
 
-// For background page
+/* global self */
 
-/* global SafariBrowserTab, Services, XPCOMUtils */
+// For background page
 
 /******************************************************************************/
 
@@ -44,8 +44,11 @@ vAPI.storage = chrome.storage.local;
 
 /******************************************************************************/
 
-vAPI.tabs = {
+vAPI.tabs = {};
-    registerListeners: function() {
+
+/******************************************************************************/
+
+vAPI.tabs.registerListeners = function() {
     if ( typeof this.onNavigation === 'function' ) {
         chrome.webNavigation.onCommitted.addListener(this.onNavigation);
     }
@@ -61,41 +64,41 @@ vAPI.tabs = {
     if ( typeof this.onPopup === 'function' ) {
         chrome.webNavigation.onCreatedNavigationTarget.addListener(this.onPopup);
     }
-    },
+};
 
-    get: function(tabId, callback) {
+/******************************************************************************/
-        if (tabId === null) {
+
-            chrome.tabs.query(
+vAPI.tabs.get = function(tabId, callback) {
-                {
+    if ( tabId !== null ) {
-                    active: true,
-                    currentWindow: true
-                },
-                function(tabs) {
-                    callback(tabs[0]);
-                }
-            );
-        }
-        else {
         chrome.tabs.get(tabId, callback);
+        return;
     }
-    },
+    var onTabReceived = function(tabs) {
-    /*open: function(details) {
+        callback(tabs[0]);
-        // to keep incognito context?
+    };
-        chrome.windows.getCurrent(function(win) {
+    chrome.tabs.query({ active: true, currentWindow: true }, onTabReceived);
-            details.windowId = win.windowId;
+};
-            chrome.tabs.create(details);
+
-        });
+/******************************************************************************/
-    },*/
+
-    open: function(details) {
+// properties of the details object:
-        if (!details.url) {
+//   url: 'URL', // the address that will be opened
+//   tabId: 1, // the tab is used if set, instead of creating a new one
+//   index: -1, // undefined: end of the list, -1: following tab, or after index
+//   active: false, // opens the tab in background - true and undefined: foreground
+//   select: true // if a tab is already opened with that url, then select it instead of opening a new one
+
+vAPI.tabs.open = function(details) {
+    var url = details.url;
+    if ( typeof url !== 'string' || url === '' ) {
         return null;
     }
     // extension pages
-        else if (!details.url.match(/^\w{2,20}:/)) {
+    if ( /^[\w-]{2,}:/.test(url) !== true ) {
-            details.url = vAPI.getURL(details.url);
+        url = vAPI.getURL(url);
     }
 
-        // dealing with Chrome's asynhronous API
+    // dealing with Chrome's asynchronous API
     var wrapper = function() {
         if ( details.active === undefined ) {
             details.active = true;
@@ -117,8 +120,7 @@ vAPI.tabs = {
                         chrome.tabs.move(tab.id, {index: details.index});
                     }
                 });
-                }
+            } else {
-                else {
                 if ( details.index !== undefined ) {
                     _details.index = details.index;
                 }
@@ -131,8 +133,7 @@ vAPI.tabs = {
             vAPI.tabs.get(null, function(tab) {
                 if ( tab ) {
                     details.index = tab.index + 1;
-                    }
+                } else {
-                    else {
                     delete details.index;
                 }
 
@@ -145,21 +146,18 @@ vAPI.tabs = {
     };
 
     if ( details.select ) {
-            // note that currentWindow may be even the window of Developer Tools
-            // so, test with setTimeout...
         chrome.tabs.query({ currentWindow: true }, function(tabs) {
             var url = details.url.replace(rgxHash, '');
             // this is questionable
             var rgxHash = /#.*/;
-
+            var selected = tabs.some(function(tab) {
-                tabs = tabs.some(function(tab) {
                 if ( tab.url.replace(rgxHash, '') === url ) {
                     chrome.tabs.update(tab.id, { active: true });
                     return true;
                 }
             });
 
-                if (!tabs) {
+            if ( selected.length === 0 ) {
                 wrapper();
             }
         });
@@ -167,20 +165,30 @@ vAPI.tabs = {
     else {
         wrapper();
     }
-    },
+};
-    close: chrome.tabs.remove.bind(chrome.tabs),
+
-    injectScript: function(tabId, details, callback) {
+/******************************************************************************/
-        if (!callback) {
+
+vAPI.tabs.remove = function(tabId) {
+    var onTabRemoved = function() {
+        if ( vAPI.lastError() ) {
+        }
+    };
+    chrome.tabs.remove(tabId, onTabRemoved);
+};
+
+/******************************************************************************/
+
+vAPI.tabs.injectScript = function(tabId, details, callback) {
+    if ( typeof callback !== 'function' ) {
         callback = function(){};
     }
 
     if ( tabId ) {
         chrome.tabs.executeScript(tabId, details, callback);
-        }
+    } else {
-        else {
         chrome.tabs.executeScript(details, callback);
     }
-    }
 };
 
 /******************************************************************************/
@@ -197,9 +205,7 @@ vAPI.setIcon = function(tabId, img, badge) {
         if ( vAPI.lastError() ) {
             return;
         }
-
         chrome.browserAction.setBadgeText({ tabId: tabId, text: badge });
-
         if ( badge !== '' ) {
             chrome.browserAction.setBadgeBackgroundColor({ tabId: tabId, color: '#666' });
         }
@@ -212,18 +218,19 @@ vAPI.setIcon = function(tabId, img, badge) {
 vAPI.messaging = {
     ports: {},
     listeners: {},
-    connector: null,
+    defaultHandler: null,
+    UNHANDLED: 'vAPI.messaging.notHandled'
+};
 
-    listen: function(listenerName, callback) {
+/******************************************************************************/
+
+vAPI.messaging.listen = function(listenerName, callback) {
     this.listeners[listenerName] = callback;
-    },
+};
 
-    setup: function(connector) {
+/******************************************************************************/
-        if ( this.connector ) {
-            return;
-        }
 
-        this.connector = function(port) {
+vAPI.messaging.onConnect = function(port) {
     var onMessage = function(request) {
         var callback = function(response) {
             if ( vAPI.lastError() || response === undefined ) {
@@ -239,19 +246,23 @@ vAPI.messaging = {
             }
         };
 
-                // Default handler
+        // Specific handler
-                var listener = connector(request.msg, port.sender, callback);
+        var r;
-                if ( listener !== null ) {
+        var listener = vAPI.messaging.listeners[request.portName];
+        if ( typeof listener === 'function' ) {
+            r = listener(request.msg, port.sender, callback);
+        }
+        if ( r !== vAPI.messaging.UNHANDLED ) {
             return;
         }
 
-                // Specific handler
+        // Default handler
-                listener = vAPI.messaging.listeners[request.portName];
+        r = vAPI.messaging.defaultHandler(request.msg, port.sender, callback);
-                if ( typeof listener === 'function' ) {
+        if ( r !== vAPI.messaging.UNHANDLED ) {
-                    listener(request.msg, port.sender, callback);
+            return;
-                } else {
-                    console.error('µBlock> messaging > unknown request: %o', request);
         }
+
+        console.error('µBlock> messaging > unknown request: %o', request);
     };
 
     var onDisconnect = function(port) {
@@ -265,18 +276,35 @@ vAPI.messaging = {
     vAPI.messaging.ports[port.name] = port;
 };
 
-        chrome.runtime.onConnect.addListener(this.connector);
+/******************************************************************************/
-    },
 
-    broadcast: function(message) {
+vAPI.messaging.setup = function(defaultHandler) {
-        message = {
+    // Already setup?
+    if ( this.defaultHandler !== null ) {
+        return;
+    }
+
+    if ( typeof defaultHandler !== 'function' ) {
+        defaultHandler = function(){ return null; };
+    };
+    this.defaultHandler = defaultHandler;
+
+    chrome.runtime.onConnect.addListener(this.onConnect);
+};
+
+/******************************************************************************/
+
+vAPI.messaging.broadcast = function(message) {
+    var messageWrapper = {
         broadcast: true,
         msg: message
     };
 
     for ( var portName in this.ports ) {
-            this.ports[portName].postMessage(message);
+        if ( this.ports.hasOwnProperty(portName) === false ) {
+            continue;
         }
+        this.ports[portName].postMessage(messageWrapper);
     }
 };
 

meta/safariextz/vapi-background.js

@@ -471,7 +471,7 @@ vAPI.messaging = {
 
             var listener = connector(request.message.msg, sender, callback);
 
-            if (listener === null) {
+            if (listener === vAPI.messaging.UNHANDLED) {
                 listener = vAPI.messaging.listeners[request.message.portName];
 
                 if (typeof listener === 'function') {

src/js/messaging.js

@@ -19,13 +19,15 @@
     Home: https://github.com/gorhill/uBlock
 */
 
-/* global µBlock, YaMD5 */
+/* global µBlock, vAPI, YaMD5 */
 
 'use strict';
 
+/******************************************************************************/
 /******************************************************************************/
 
-// message router and default handler
+// Message router and default handler
+
 vAPI.messaging.setup(function(request, sender, callback) {
     var µb = µBlock;
 
@@ -45,10 +47,6 @@ vAPI.messaging.setup(function(request, sender, callback) {
             µb.contextMenuClientY = request.clientY;
             break;
 
-        /*case 'forceReloadTab':
-            µb.forceReload(request.pageURL);
-            break;*/
-
         case 'getUserSettings':
             callback(µb.userSettings);
             break;
@@ -66,12 +64,10 @@ vAPI.messaging.setup(function(request, sender, callback) {
             break;
 
         default:
-            // if none of the above, then check the channel listeners
+            return vAPI.messaging.UNHANDLED;
-            return null;
     }
 });
 
-
 /******************************************************************************/
 /******************************************************************************/
 
@@ -169,6 +165,9 @@ var onMessage = function(request, sender, callback) {
                 response['.'] = getDynamicFilterResults(request.pageHostname);
             }
             break;
+
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -214,6 +213,9 @@ var onMessage = function(request, sender, callback) {
                 response = µb.cosmeticFilteringEngine.retrieveDomainSelectors(request);
             }
             break;
+
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -340,6 +342,9 @@ var onMessage = function(details, sender, callback) {
                 response = filterRequest(pageStore, details);
             }
             break;
+
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -399,6 +404,8 @@ var onMessage = function(request, sender, callback) {
             µb.appendUserFilters(request.filters);
             break;
 
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -471,6 +478,8 @@ var onMessage = function(request, sender, callback) {
             µb.assets.purge(request.path);
             break;
 
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -512,6 +521,8 @@ var onMessage = function(request, sender, callback) {
     var response;
 
     switch ( request.what ) {
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -556,6 +567,8 @@ var onMessage = function(request, sender, callback) {
             µb.saveWhitelist();
             break;
 
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);
@@ -631,6 +644,10 @@ var getPageDetails = function(µb, tabId) {
 var onMessage = function(request, sender, callback) {
     // Async
     switch ( request.what ) {
+        case 'getTabForStats':
+            vAPI.tabs.get(request.tabId, callback);
+            return;
+
         default:
             break;
     }
@@ -647,9 +664,8 @@ var onMessage = function(request, sender, callback) {
             response = getPageDetails(µb, request.tabId);
             break;
 
-        case 'getTabForStats':
+        default:
-            vAPI.tabs.get(request.tabId, callback);
+            return vAPI.messaging.UNHANDLED;
-            return;
     }
 
     callback(response);
@@ -745,6 +761,9 @@ var onMessage = function(request, sender, callback) {
         case 'resetUserData':
             resetUserData();
             break;
+
+        default:
+            return vAPI.messaging.UNHANDLED;
     }
 
     callback(response);

src/js/tab.js

@@ -81,13 +81,14 @@ vAPI.tabs.onPopup = function(details) {
     // Blocked
 
     // Safari blocks before the pop-up opens, so there is no window to remove.
+    // TODO: Can't this test be done within the platform-specific code?
     if ( vAPI.safari ) {
         return true;
     }
 
     // It is a popup, block and remove the tab.
     µBlock.unbindTabFromPageStats(details.tabId);
-    µBlock.XAL.destroyTab(details.tabId);
+    vAPI.tabs.remove(details.tabId);
 };
 
 vAPI.tabs.registerListeners();

src/js/traffic.js

@@ -207,7 +207,7 @@ var onBeforeSendHeaders = function(details) {
 
     // It is a popup, block and remove the tab.
     µb.unbindTabFromPageStats(tabId);
-    µb.XAL.destroyTab(tabId);
+    vAPI.tabs.remove(tabId);
 
     return { 'cancel': true };
 };

src/js/vapi-background.js

@@ -695,7 +695,7 @@ if (self.chrome) {
 
                 var listener = connector(request.message.msg, sender, callback);
 
-                if (listener === null) {
+                if (listener === vAPI.messaging.UNHANDLED) {
                     listener = vAPI.messaging.listeners[request.message.portName];
 
                     if (typeof listener === 'function') {

src/js/xal.js

@@ -62,16 +62,6 @@ exports.restart = function() {
 
 /******************************************************************************/
 
-exports.destroyTab = function(tabId) {
-    vAPI.tabs.remove(tabId, function() {
-        // required by chrome API, or else warnings at console (also, mind jshint)
-        if ( chrome.runtime.lastError ) {
-        }
-    });
-};
-
-/******************************************************************************/
-
 return exports;
 
 /******************************************************************************/