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,142 +44,150 @@ vAPI.storage = chrome.storage.local;
 
 /******************************************************************************/
 
-vAPI.tabs = {
+vAPI.tabs = {};
-    registerListeners: function() {
-        if (typeof this.onNavigation === 'function') {
-            chrome.webNavigation.onCommitted.addListener(this.onNavigation);
-        }
 
-        if (typeof this.onUpdated === 'function') {
+/******************************************************************************/
-            chrome.tabs.onUpdated.addListener(this.onUpdated);
-        }
 
-        if (typeof this.onClosed === 'function') {
+vAPI.tabs.registerListeners = function() {
-            chrome.tabs.onRemoved.addListener(this.onClosed);
+    if ( typeof this.onNavigation === 'function' ) {
-        }
+        chrome.webNavigation.onCommitted.addListener(this.onNavigation);
+    }
 
-        if (typeof this.onPopup === 'function') {
+    if ( typeof this.onUpdated === 'function' ) {
-            chrome.webNavigation.onCreatedNavigationTarget.addListener(this.onPopup);
+        chrome.tabs.onUpdated.addListener(this.onUpdated);
-        }
+    }
-    },
 
-    get: function(tabId, callback) {
+    if ( typeof this.onClosed === 'function' ) {
-        if (tabId === null) {
+        chrome.tabs.onRemoved.addListener(this.onClosed);
-            chrome.tabs.query(
+    }
-                {
-                    active: true,
-                    currentWindow: true
-                },
-                function(tabs) {
-                    callback(tabs[0]);
-                }
-            );
-        }
-        else {
-            chrome.tabs.get(tabId, callback);
-        }
-    },
-    /*open: function(details) {
-        // to keep incognito context?
-        chrome.windows.getCurrent(function(win) {
-            details.windowId = win.windowId;
-            chrome.tabs.create(details);
-        });
-    },*/
-    open: function(details) {
-        if (!details.url) {
-            return null;
-        }
-        // extension pages
-        else if (!details.url.match(/^\w{2,20}:/)) {
-            details.url = vAPI.getURL(details.url);
-        }
 
-        // dealing with Chrome's asynhronous API
+    if ( typeof this.onPopup === 'function' ) {
-        var wrapper = function() {
+        chrome.webNavigation.onCreatedNavigationTarget.addListener(this.onPopup);
-            if (details.active === undefined) {
+    }
-                details.active = true;
+};
-            }
 
-            var subWrapper = function() {
+/******************************************************************************/
-                var _details = {
-                    url: details.url,
-                    active: !!details.active
-                };
-
-                if (details.tabId) {
-                    // update doesn't accept index, must use move
-                    chrome.tabs.update(details.tabId, _details, function(tab) {
-                        // if the tab doesn't exist
-                        if ( vAPI.lastError() ) {
-                            chrome.tabs.create(_details);
-                        } else if ( details.index !== undefined ) {
-                            chrome.tabs.move(tab.id, {index: details.index});
-                        }
-                    });
-                }
-                else {
-                    if (details.index !== undefined) {
-                        _details.index = details.index;
-                    }
 
-                    chrome.tabs.create(_details);
+vAPI.tabs.get = function(tabId, callback) {
-                }
+    if ( tabId !== null ) {
+        chrome.tabs.get(tabId, callback);
+        return;
+    }
+    var onTabReceived = function(tabs) {
+        callback(tabs[0]);
+    };
+    chrome.tabs.query({ active: true, currentWindow: true }, onTabReceived);
+};
+
+/******************************************************************************/
+
+// properties of the details object:
+//   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
+    if ( /^[\w-]{2,}:/.test(url) !== true ) {
+        url = vAPI.getURL(url);
+    }
+
+    // dealing with Chrome's asynchronous API
+    var wrapper = function() {
+        if ( details.active === undefined ) {
+            details.active = true;
+        }
+
+        var subWrapper = function() {
+            var _details = {
+                url: details.url,
+                active: !!details.active
             };
 
-            if (details.index === -1) {
+            if ( details.tabId ) {
-                vAPI.tabs.get(null, function(tab) {
+                // update doesn't accept index, must use move
-                    if (tab) {
+                chrome.tabs.update(details.tabId, _details, function(tab) {
-                        details.index = tab.index + 1;
+                    // if the tab doesn't exist
+                    if ( vAPI.lastError() ) {
+                        chrome.tabs.create(_details);
+                    } else if ( details.index !== undefined ) {
+                        chrome.tabs.move(tab.id, {index: details.index});
                     }
-                    else {
-                        delete details.index;
-                    }
-
-                    subWrapper();
                 });
-            }
+            } else {
-            else {
+                if ( details.index !== undefined ) {
-                subWrapper();
+                    _details.index = details.index;
+                }
+
+                chrome.tabs.create(_details);
             }
         };
 
-        if (details.select) {
+        if ( details.index === -1 ) {
-            // note that currentWindow may be even the window of Developer Tools
+            vAPI.tabs.get(null, function(tab) {
-            // so, test with setTimeout...
+                if ( tab ) {
-            chrome.tabs.query({currentWindow: true}, function(tabs) {
+                    details.index = tab.index + 1;
-                var url = details.url.replace(rgxHash, '');
+                } else {
-                // this is questionable
+                    delete details.index;
-                var rgxHash = /#.*/;
-
-                tabs = tabs.some(function(tab) {
-                    if (tab.url.replace(rgxHash, '') === url) {
-                        chrome.tabs.update(tab.id, {active: true});
-                        return true;
-                    }
-                });
-
-                if (!tabs) {
-                    wrapper();
                 }
+
+                subWrapper();
             });
         }
         else {
-            wrapper();
+            subWrapper();
-        }
-    },
-    close: chrome.tabs.remove.bind(chrome.tabs),
-    injectScript: function(tabId, details, callback) {
-        if (!callback) {
-            callback = function(){};
         }
+    };
 
-        if (tabId) {
+    if ( details.select ) {
-            chrome.tabs.executeScript(tabId, details, callback);
+        chrome.tabs.query({ currentWindow: true }, function(tabs) {
-        }
+            var url = details.url.replace(rgxHash, '');
-        else {
+            // this is questionable
-            chrome.tabs.executeScript(details, callback);
+            var rgxHash = /#.*/;
+            var selected = tabs.some(function(tab) {
+                if ( tab.url.replace(rgxHash, '') === url ) {
+                    chrome.tabs.update(tab.id, { active: true });
+                    return true;
+                }
+            });
+
+            if ( selected.length === 0 ) {
+                wrapper();
+            }
+        });
+    }
+    else {
+        wrapper();
+    }
+};
+
+/******************************************************************************/
+
+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 {
+        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,71 +218,93 @@ vAPI.setIcon = function(tabId, img, badge) {
 vAPI.messaging = {
     ports: {},
     listeners: {},
-    connector: null,
+    defaultHandler: null,
+    UNHANDLED: 'vAPI.messaging.notHandled'
+};
 
-    listen: function(listenerName, callback) {
+/******************************************************************************/
-        this.listeners[listenerName] = callback;
+
-    },
+vAPI.messaging.listen = function(listenerName, callback) {
+    this.listeners[listenerName] = callback;
+};
+
+/******************************************************************************/
+
+vAPI.messaging.onConnect = function(port) {
+    var onMessage = function(request) {
+        var callback = function(response) {
+            if ( vAPI.lastError() || response === undefined ) {
+                return;
+            }
+
+            if ( request.requestId ) {
+                port.postMessage({
+                    requestId: request.requestId,
+                    portName: request.portName,
+                    msg: response
+                });
+            }
+        };
 
-    setup: function(connector) {
+        // Specific handler
-        if ( this.connector ) {
+        var r;
+        var listener = vAPI.messaging.listeners[request.portName];
+        if ( typeof listener === 'function' ) {
+            r = listener(request.msg, port.sender, callback);
+        }
+        if ( r !== vAPI.messaging.UNHANDLED ) {
             return;
         }
 
-        this.connector = function(port) {
+        // Default handler
-            var onMessage = function(request) {
+        r = vAPI.messaging.defaultHandler(request.msg, port.sender, callback);
-                var callback = function(response) {
+        if ( r !== vAPI.messaging.UNHANDLED ) {
-                    if ( vAPI.lastError() || response === undefined ) {
+            return;
-                        return;
+        }
-                    }
 
-                    if ( request.requestId ) {
+        console.error('µBlock> messaging > unknown request: %o', request);
-                        port.postMessage({
+    };
-                            requestId: request.requestId,
-                            portName: request.portName,
-                            msg: response
-                        });
-                    }
-                };
 
-                // Default handler
+    var onDisconnect = function(port) {
-                var listener = connector(request.msg, port.sender, callback);
+        port.onDisconnect.removeListener(onDisconnect);
-                if ( listener !== null ) {
+        port.onMessage.removeListener(onMessage);
-                    return;
+        delete vAPI.messaging.ports[port.name];
-                }
+    };
 
-                // Specific handler
+    port.onDisconnect.addListener(onDisconnect);
-                listener = vAPI.messaging.listeners[request.portName];
+    port.onMessage.addListener(onMessage);
-                if ( typeof listener === 'function' ) {
+    vAPI.messaging.ports[port.name] = port;
-                    listener(request.msg, port.sender, callback);
+};
-                } else {
-                    console.error('µBlock> messaging > unknown request: %o', request);
-                }
-            };
 
-            var onDisconnect = function(port) {
+/******************************************************************************/
-                port.onDisconnect.removeListener(onDisconnect);
-                port.onMessage.removeListener(onMessage);
-                delete vAPI.messaging.ports[port.name];
-            };
 
-            port.onDisconnect.addListener(onDisconnect);
+vAPI.messaging.setup = function(defaultHandler) {
-            port.onMessage.addListener(onMessage);
+    // Already setup?
-            vAPI.messaging.ports[port.name] = port;
+    if ( this.defaultHandler !== null ) {
-        };
+        return;
+    }
 
-        chrome.runtime.onConnect.addListener(this.connector);
+    if ( typeof defaultHandler !== 'function' ) {
-    },
+        defaultHandler = function(){ return null; };
+    };
+    this.defaultHandler = defaultHandler;
 
-    broadcast: function(message) {
+    chrome.runtime.onConnect.addListener(this.onConnect);
-        message = {
+};
-            broadcast: true,
+
-            msg: message
+/******************************************************************************/
-        };
+
+vAPI.messaging.broadcast = function(message) {
+    var messageWrapper = {
+        broadcast: true,
+        msg: message
+    };
 
-        for ( var portName in this.ports ) {
+    for ( var portName in this.ports ) {
-            this.ports[portName].postMessage(message);
+        if ( this.ports.hasOwnProperty(portName) === false ) {
+            continue;
         }
+        this.ports[portName].postMessage(messageWrapper);
     }
 };