uBlock/platform/firefox/vapi-client.js

/*******************************************************************************

    µ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
*/

/* global addMessageListener, removeMessageListener, sendAsyncMessage */

// For non background pages

/******************************************************************************/

(function(self) {

'use strict';

/******************************************************************************/

var vAPI = self.vAPI = self.vAPI || {};
vAPI.firefox = true;
vAPI.sessionId = String.fromCharCode(Date.now() % 26 + 97) +
    Math.random().toString(36).slice(2);

/******************************************************************************/

vAPI.setTimeout = vAPI.setTimeout || function(callback, delay, extra) {
    return setTimeout(function(a) { callback(a); }, delay, extra);
};

/******************************************************************************/

vAPI.shutdown = (function() {
    var jobs = [];

    var add = function(job) {
        jobs.push(job);
    };

    var exec = function() {
        //console.debug('Shutting down...');
        var job;
        while ( job = jobs.pop() ) {
            job();
        }
    };

    return {
        add: add,
        exec: exec
    };
})();

/******************************************************************************/

var MessagingListeners = function(callback) {
    this.listeners = [];
    if ( typeof callback === 'function' ) {
        this.listeners.push(callback);
    }
};

MessagingListeners.prototype.add = function(callback) {
    if ( typeof callback !== 'function' ) {
        return;
    }
    if ( this.listeners.indexOf(callback) !== -1 ) {
        throw new Error('Duplicate listener.');
    }
    this.listeners.push(callback);
};

MessagingListeners.prototype.remove = function(callback) {
    if ( typeof callback !== 'function' ) {
        return;
    }
    if ( this.listeners.indexOf(callback) === -1 ) {
        throw new Error('Listener not found.');
    }
    this.listeners.splice(this.listeners.indexOf(callback), 1);
};

MessagingListeners.prototype.removeAll = function() {
    this.listeners = [];
};

MessagingListeners.prototype.process = function(msg) {
    var listeners = this.listeners;
    var n = listeners.length;
    for ( var i = 0; i < n; i++ ) {
        listeners[i](msg);
    }
};

/******************************************************************************/

var messagingConnector = function(response) {
    if ( !response ) {
        return;
    }

    var messaging = vAPI.messaging;
    var channels = messaging.channels;
    var channel;

    // Sent to all channels
    if ( response.broadcast === true && !response.channelName ) {
        for ( channel in channels ) {
            if ( channels[channel] instanceof MessagingChannel === false ) {
                continue;
            }
            channels[channel].listeners.process(response.msg);
        }
        return;
    }

    // Response to specific message previously sent
    if ( response.requestId ) {
        var listener = messaging.pending[response.requestId];
        delete messaging.pending[response.requestId];
        delete response.requestId; // TODO: why?
        if ( listener ) {
            listener(response.msg);
            return;
        }
    }

    // Sent to a specific channel
    channel = channels[response.channelName];
    if ( channel instanceof MessagingChannel ) {
        channel.listeners.process(response.msg);
    }
};

/******************************************************************************/

var MessagingChannel = function(name, callback) {
    this.channelName = name;
    this.listeners = new MessagingListeners(callback);
    this.refCount = 1;
    if ( typeof callback === 'function' ) {
        var messaging = vAPI.messaging;
        if ( !messaging.connected ) {
            messaging.setup();
        }
    }
};

MessagingChannel.prototype.send = function(message, callback) {
    var messaging = vAPI.messaging;
    if ( !messaging.connected ) {
        messaging.setup();
    }
    var requestId;
    if ( callback ) {
        requestId = messaging.requestId++;
        messaging.pending[requestId] = callback;
    }
    sendAsyncMessage('ublock0:background', {
        channelName: self._sandboxId_ + '|' + this.channelName,
        requestId: requestId,
        msg: message
    });
};

MessagingChannel.prototype.close = function() {
    this.refCount -= 1;
    if ( this.refCount !== 0 ) {
        return;
    }
    delete vAPI.messaging.channels[this.channelName];
};

MessagingChannel.prototype.addListener = function(callback) {
    if ( typeof callback !== 'function' ) {
        return;
    }
    this.listeners.add(callback);
    var messaging = vAPI.messaging;
    if ( !messaging.connected ) {
        messaging.setup();
    }
};

MessagingChannel.prototype.removeListener = function(callback) {
    if ( typeof callback !== 'function' ) {
        return;
    }
    this.listeners.remove(callback);
};

MessagingChannel.prototype.removeAllListeners = function() {
    this.listeners.removeAll();
};

/******************************************************************************/

vAPI.messaging = {
    channels: {},
    pending: {},
    requestId: 1,
    connected: false,
    connector: function(msg) {
        messagingConnector(JSON.parse(msg));
    },

    setup: function() {
        addMessageListener(this.connector);
        this.connected = true;
        this.channels['vAPI'] = new MessagingChannel('vAPI', function(msg) {
            if ( msg.cmd === 'injectScript' ) {
                var details = msg.details;
                if ( !details.allFrames && window !== window.top ) {
                    return;
                }
                // TODO: investigate why this happens, and if this happens
                // legitimately (content scripts not injected I suspect, so
                // that would make this legitimate).
                // Case: open popup UI from icon in uBlock's logger
                if ( typeof self.injectScript === 'function' )  {
                    self.injectScript(details.file);
                }
            }
        });
    },

    close: function() {
        if ( !this.connected ) {
            return;
        }
        removeMessageListener();
        this.connected = false;
        this.channels = {};
        this.pending = {};
    },

    channel: function(channelName, callback) {
        if ( !channelName ) {
            return;
        }
        var channel = this.channels[channelName];
        if ( channel instanceof MessagingChannel ) {
            channel.addListener(callback);
            channel.refCount += 1;
        } else {
            channel = this.channels[channelName] = new MessagingChannel(channelName, callback);
        }
        return channel;
    },

    toggleListener: function({type, persisted}) {
        if ( !vAPI.messaging.connected ) {
            return;
        }

        if ( type === 'pagehide' ) {
            removeMessageListener();
            return;
        }

        if ( persisted ) {
            addMessageListener(vAPI.messaging.connector);
        }
    }
};

window.addEventListener('pagehide', vAPI.messaging.toggleListener, true);
window.addEventListener('pageshow', vAPI.messaging.toggleListener, true);

/******************************************************************************/

// No need to have vAPI client linger around after shutdown if
// we are not a top window (because element picker can still
// be injected in top window).
if ( window !== window.top ) {
    // Can anything be done?
}

/******************************************************************************/

})(this);

/******************************************************************************/