/**
 * jQuery History Plugin (balupton edition) - Simple History Handler/Remote for Hash, State, Bookmarking, and Forward Back Buttons
 * Copyright (C) 2008-2009 Benjamin Arthur Lupton
 * http://www.balupton.com/projects/jquery_history/
 *
 * This file is part of jQuery History Plugin (balupton edition).
 * 
 * jQuery History Plugin (balupton edition) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * jQuery History Plugin (balupton edition) 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with jQuery History Plugin (balupton edition).  If not, see <http://www.gnu.org/licenses/>.
 *
 * @name jqsmarty: jquery.history.js
 * @package jQuery History Plugin (balupton edition)
 * @version 1.1.0-final
 * @date July 14, 2009
 * @category jquery plugin
 * @author Benjamin "balupton" Lupton {@link http://www.balupton.com}
 * @copyright (c) 2008-2009 Benjamin Arthur Lupton {@link http://www.balupton.com}
 * @license GNU Affero General Public License - {@link http://www.gnu.org/licenses/agpl.html}
 * @example Visit {@link http://jquery.com/plugins/project/jquery_history_bal} for more information.
 * 
 * 
 * I would like to take this space to thank the following projects, blogs, articles and people:
 * - jQuery {@link http://jquery.com/}
 * - jQuery UI History - Klaus Hartl {@link http://www.stilbuero.de/jquery/ui_history/}
 * - Really Simple History - Brian Dillard and Brad Neuberg {@link http://code.google.com/p/reallysimplehistory/}
 * - jQuery History Plugin - Taku Sano (Mikage Sawatari) {@link http://www.mikage.to/jquery/jquery_history.html}
 * - jQuery History Remote Plugin - Klaus Hartl {@link http://stilbuero.de/jquery/history/}
 * - Content With Style: Fixing the back button and enabling bookmarking for ajax apps - Mike Stenhouse {@link http://www.contentwithstyle.co.uk/Articles/38/fixing-the-back-button-and-enabling-bookmarking-for-ajax-apps}
 * - Bookmarks and Back Buttons {@link http://ajax.howtosetup.info/options-and-efficiencies/bookmarks-and-back-buttons/}
 * - Ajax: How to handle bookmarks and back buttons - Brad Neuberg {@link http://dev.aol.com/ajax-handling-bookmarks-and-back-button}
 *
 **
 ***
 * CHANGELOG
 **
 * v1.1.0-final, July 14, 2009
 * - Rewrote IE<8 hash code
 * - Cut down format to accept all hash types
 * 
 * v1.0.1-final, July 11, 2009
 * - Restructured a little bit
 * - Documented
 * - Cleaned go/request
 *
 * v1.0.0-final, June 19, 2009
 * - Been stable for over a year now, pushing live.
 * 
 * v0.1.0-dev, July 24, 2008
 * - Initial Release
 * 
 */

// Start of our jQuery Plugin
(function($) {	// Create our Plugin function, with $ as the argument (we pass the jQuery object over later)
	// More info: http://docs.jquery.com/Plugins/Authoring#Custom_Alias

	// Debug
	if (typeof console === 'undefined') {
		console = typeof window.console !== 'undefined' ? window.console : {};
	}
	console.log = console.log || function() { };
	console.debug = console.debug || console.log;
	console.warn = console.warn || console.log;
	console.error = console.error || function() { var args = []; for (var i = 0; i < arguments.length; i++) { args.push(arguments[i]); } alert(args.join("\n")); };
	console.trace = console.trace || console.log;
	console.group = console.group || console.log;
	console.groupEnd = console.groupEnd || console.log;
	console.profile = console.profile || console.log;
	console.profileEnd = console.profileEnd || console.log;

	// Declare our class
	$.History = {
		// Our Plugin definition

		// -----------------
		// Options

		options: {
			debug: false
		},

		// -----------------
		// Variables

		state: '',
		$window: null,
		$iframe: null,
		handlers: {
			generic: [],
			specific: {},
			exception: []
		},

		// --------------------------------------------------
		// Functions

		/**
		* Format a hash into a proper state
		* @param {String} hash
		*/
		format: function(hash) {
			// Format the hash

			hash = hash
				.replace(/^.*#/g, '') /* strip anything before the anchor in case we were passed a url */
				;

			// Return the hash
			return hash;
		},

		/**
		* Get the current state of the application
		*/
		getState: function() {
			var History = $.History;

			// Get the current state
			return History.state;
		},
		/**
		* Set the current state of the application
		* @param {String} hash
		*/
		setState: function(state) {
			var History = $.History;
			// Format the state
			state = History.format(state)

			// Apply the state
			History.state = state;

			// Return the state
			return History.state;
		},

		/**
		* Get the current hash of the browser
		*/
		getHash: function() {
			var History = $.History;

			// Get the hash
			var hash = History.format(window.location.hash || location.hash);

			// Return the hash
			return hash;
		},

		/**
		* Set the current hash of the browser and iframe if present
		* @param {String} hash
		*/
		setHash: function(hash) {
			var History = $.History;

			// Prepare hash
			hash = History.format(hash);

			// Write hash
			if (typeof window.location.hash !== 'undefined') {
				if (window.location.hash !== hash) {
					window.location.hash = hash;
				}
			} else if (location.hash !== hash) {
				location.hash = hash;
			}

			// Done
			return hash;
		},

		/**
		* Go to the specific state - does not force a history entry like setHash
		* @param {String} to
		*/
		go: function(to) {
			var History = $.History;

			// Format
			to = History.format(to);

			// Get current
			var hash = History.getHash();
			var state = History.getState();

			// Has the hash changed
			if (to !== hash) {
				// Yes, update the hash
				// And wait for the next automatic fire
				History.setHash(to);
			} else {
				// Hash the state changed?
				if (to !== state) {
					// Yes, Update the state
					History.setState(to);
				}

				// Trigger our change
				History.trigger();
			}

			// Done
			return true;
		},

		/**
		* Handle when the hash has changed
		* @param {Event} e
		*/
		hashchange: function(e) {
			var History = $.History;
			var hasException = false;
			var searchRegExp = "";

			// Get Hash
			var hash = History.getHash();

			// Test Exceptions
			list = History.handlers.exception;
			for (i = 0, n = list.length; i < n; ++i) {
				searchRegExp = new RegExp(list[i], "g");
				if (searchRegExp.test(hash)) hasException = true;
			}

			// Handle the new hash
			if (!hasException) History.go(hash);
			else History.setState(hash);

			// All done
			return true;
		},

		/**
		* Bind a handler to a hash
		* @param {Object} state
		* @param {Object} handler
		* @params {Bool} update [optional]
		*/
		bind: function(state, handler, update) {
			var History = $.History;
			if (typeof update === "undefined") update = false;
			// 
			if (handler) {
				// We have a state specific handler
				// Prepare
				if (typeof History.handlers.specific[state] === 'undefined' || update) {	// Make it an array
					History.handlers.specific[state] = [];
				}
				// Push new handler
				History.handlers.specific[state].push(handler);
			}
			else {
				// We have a generic handler
				handler = state;
				History.handlers.generic.push(handler);
			}

			// Done
			return true;
		},

		/**
		* Bind a exception handler to a hash
		* @param {String} regExp
		*/
		bindException: function(regExp) {
			var History = $.History;

			History.handlers.exception.push(regExp);
			// Done
			return true;
		},

		/**
		* Check if state exist
		* @param {String} state
		*/
		stateExists: function(state) {
			var History = $.History;
			return typeof History.handlers.specific[state] !== "undefined";
		},

		/**
		* Trigger a handler for a state
		* @param {String} state
		*/
		trigger: function(state) {
			var History = $.History;

			// Prepare
			if (typeof state === 'undefined') {
				// Use current
				state = History.getState();
			}
			var i, n, handler, list;

			// Fire specific
			if (typeof History.handlers.specific[state] !== 'undefined') {
				// We have specific handlers
				list = History.handlers.specific[state];
				for (i = 0, n = list.length; i < n; ++i) {
					// Fire the specific handler
					handler = list[i];
					handler(state);
				}
			}

			// Fire generics
			list = History.handlers.generic;
			for (i = 0, n = list.length; i < n; ++i) {
				// Fire the specific handler
				handler = list[i];
				handler(state);
			}

			// Done
			return true;
		},

		// --------------------------------------------------
		// Constructors

		/**
		* Construct our application
		*/
		construct: function() {
			var History = $.History;

			// Modify the document
			$(document).ready(function() {
				// Prepare the document
				History.domReady();
			});

			// Done
			return true;
		},

		/**
		* Configure our application
		* @param {Object} options
		*/
		configure: function(options) {
			var History = $.History;

			// Set options
			History.options = $.extend(History.options, options);

			// Done
			return true;
		},

		domReadied: false,
		domReady: function() {
			var History = $.History;

			// Runonce
			if (History.domRedied) {
				return;
			}
			History.domRedied = true;

			// Define window
			History.$window = $(window);

			// Apply the hashchange function
			History.$window.bind('hashchange', this.hashchange);

			// Force hashchange support for all browsers
			setTimeout(History.hashchangeLoader, 200);

			// All done
			return true;
		},

		/**
		* Enable hashchange for all browsers
		*/
		hashchangeLoader: function() {

			var _n = navigator, _w = window, _d = document;
			var version = "NA";
			var na = _n.userAgent;
			var ieDocMode = "NA";
			var ie8BrowserMode = "NA";

			if (/msie/i.test(na) && (!_w.opera)) {
				if (_w.attachEvent && _w.ActiveXObject) {
					version = (na.match(/.+ie\s([\d.]+)/i) || [])[1];
					if (parseInt(version) == 7) {

						if (_d.documentMode) {
							version = 8;

							if (/trident\/\d/i.test(na)) {
								ie8BrowserMode = "Compat Mode";
							} else {
								ie8BrowserMode = "IE 7 Mode";
							}
						}
					} else if (parseInt(version) == 8) {
						if (_d.documentMode) { ie8BrowserMode = "IE 8 Mode"; }
					}

					ieDocMode = (_d.documentMode) ? _d.documentMode : (_d.compatMode && _d.compatMode == "CSS1Compat") ? 7 : 5;
				}
			}

			var History = $.History;

			// More is needed for non IE8 browsers
			if (!($.browser.msie && parseInt($.browser.version) >= 8) || ieDocMode == 7) {
				// We are not IE8

				// State our checker function, it is used to constantly check the location to detect a change
				var checker;

				// Handle depending on the browser
				if ($.browser.msie) {
					// We are still IE
					// IE6, IE7, etc

					// Append and $iframe to the document, as $iframes are required for back and forward
					// Create a hidden $iframe for hash change tracking
					History.$iframe = $('<iframe id="jquery-history-iframe" style="display: none;"></$iframe>').prependTo(document.body)[0];

					// Create initial history entry
					History.$iframe.contentWindow.document.open();
					History.$iframe.contentWindow.document.close();

					// Define the checker function (for bookmarks)
					var iframeHit = false;
					checker = function() {

						// Fetch
						var hash = History.getHash();
						var state = History.getState();
						var iframeHash = History.format(History.$iframe.contentWindow.document.location.hash);

						// Check if the browser hash is different
						if (state !== hash) {
							// Browser hash is different

							// Check if we need to update the iframe
							if (!iframeHit) {
								// Write a iframe/history entry in the browsers back and forward
								// alert('update iframe entry');
								History.$iframe.contentWindow.document.open();
								History.$iframe.contentWindow.document.close();
								// alert('update iframe entry.');

								// Update the iframe hash
								// alert('update iframe hash');
								History.$iframe.contentWindow.document.location.hash = hash;
								// alert('update iframe hash.');
							}

							// Reset
							iframeHit = false;

							// Fire
							// alert('hashchange');
							History.$window.trigger('hashchange');
							// alert('hashchange.');
						}
						else {
							// Browser hash is not different

							// Check if the iframe hash is different from the iframe state
							if (state !== iframeHash) {
								// Specify we were hit from the iframe
								iframeHit = true;

								// Update the browser hash
								// alert('set hash from iframe');
								History.setHash(iframeHash);
								// alert('set hash from iframe.');
							}
						}

					};
				}
				else {
					// We are not IE
					// Firefox, Opera, Etc

					// Define the checker function (for bookmarks, back, forward)
					checker = function() {
						var hash = History.getHash();
						var state = History.getState();
						// Check
						if (state !== hash) {
							// State change
							History.$window.trigger('hashchange');
						}
					};
				}

				// Apply the checker function
				setInterval(checker, 200);
			}
			else {
				// We are IE8

				// Fire the initial
				var hash = History.getHash();
				if (hash) {
					History.$window.trigger('hashchange');
				}
			}

			// Done
			return true;
		}

	}; // We have finished extending/defining our Plugin

	// --------------------------------------------------
	// Finish up

	// Instantiate
	$.History.construct();

	// Finished definition

})(jQuery);            // We are done with our plugin, so lets call it with jQuery as the argument