/js/vendor/socket.js

/*
 * Chrome Extension Socket
 * <https://github.com/jjNford/chrome-extension-socket>
 * 
 * Copyright (C) 2012, JJ Ford (jj.n.ford@gmail.com)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 */
(function() {

	// ---------------------------------------------------------------------------------------------
	// Override these methods <---------------------------------------------------------------------
	// ---------------------------------------------------------------------------------------------

	/**
	 * Triggered when the extension popup receives a message from the extension background page. 
	 * Executes on the extension popup.
	 * 
	 * @param msg A message object.
	 */
	function popupMessageReceived(msg) {};
	
	/**
	 * Triggered when extension background page receives a message from the extension popup. 
	 * Executes on the extension background page.
	 * 
	 * @param msg A message object.
	 */
	function backgroundMessageReceived(msg) {};
	
	/**
	 * Triggered when the extension background page receives a new task message. 
	 * Executes on the extension background page.
	 * 
	 * @param A message object.
	 */
	function taskReceived(msg) {
	    KipptExtension.taskReceived(msg);
	};
	
	/**
	 * Triggered when an extension background task is started. 
	 * Executes on the extension popup.
	 */
	function taskStarted() {};
	
	/**
	 * Triggered when all extension background tasks have been completed. 
	 * Executes on the extension popup.
	 */
	function tasksComplete() {};

	// ---------------------------------------------------------------------------------------------
	// WARNING: IF SOURCE IS ALTERED BEYOND THIS POINT THERE IS RISK OF BREAKING SOMETHING. --------
	// ---------------------------------------------------------------------------------------------

	window.Socket = {

		init: function() {
			this.tasks = 0;
			this.port = chrome.extension.connect({name: "down"});
			this.bind();
		},
		
		bind: function() {				
			chrome.extension.onConnect.addListener( function(port) {
				if(port.name === "down") {
					Socket.port = chrome.extension.connect({name: "up"});
				}				
				port.onMessage.addListener( function(msg) {
					Socket.onMessage(msg);
				});				
				Socket.port.onDisconnect.addListener( function(port) {
					port.onMessage.removeListener();
					Socket.port.onMessage.removeListener();
				});
			});
		},
		
		onMessage: function(msg) {
			try {
				if(msg.type === "message") {
					if(Socket.port.name == "up") {
						backgroundMessageReceived(msg);
					} else {
						popupMessageReceived(msg);
					}
				} else if(msg.type === "task") {
					Socket.tasks++;
					taskReceived(msg);
				} else if(msg.type === "taskComplete") {
					tasksComplete();					
				}
			} catch(UnknownMesssageType) {}
		},
		
		postMessage: function(msg) {
			try {
				if(!msg) {
					msg = {};
				}
				msg.type = "message";
				Socket.port.postMessage(msg);
			} catch(PortPostException) {}
		},

		postTask: function(msg) {
			if(Socket.port.name === "down") {
				taskStarted(msg);
			}	
			try {
				if(!msg) {
					msg = {};
				}
				msg.type = "task";
				Socket.port.postMessage(msg);
			} catch(PortPostException) {}
		},
		
		postTaskComplete: function() {
			if(Socket.tasks > 0) {
				--Socket.tasks;
			}
			if(Socket.tasks === 0) {
				try {
					Socket.port.postMessage({type: "taskComplete"});
				} catch(PortPostException) {}
			}
		}
	};

	Socket.init();
	
})();