2 * Originally based of this code... - refactored for Roo...
5 * @author Benjamin Arthur Lupton <contact@balupton.com>
6 * @copyright 2010-2011 Benjamin Arthur Lupton <contact@balupton.com>
7 * @license New BSD License <http://creativecommons.org/licenses/BSD/>
11 // this is not initialized automatically..
12 // must call Roo.History.init( { ... options... });
18 // ====================================================================
24 * How long should the interval be before hashchange checks
26 thishashChangeInterval : 100,
30 * How long should the interval be before safari poll checks
32 safariPollInterval : 500,
36 * How long should the interval be before we perform a double check
38 doubleCheckInterval : 500,
42 * Force this.not to append suid
48 * How long should we wait between store calls
54 * How long should we wait between busy events
60 * If true will enable debug messages to be logged
66 * What is the title of the initial state
72 * If true, will force HTMl4 mode (hashtags)
78 * Want to override default options and call init manually.
84 * Which bugs are present
88 * Safari 5 and Safari iOS 4 fail to return to the correct state once a hash is replaced by a `replaceState` call
89 * https://bugs.webkit.org/show_bug.cgi?id=56249
94 * Safari 5 and Safari iOS 4 sometimes fail to apply the state change under busy conditions
95 * https://bugs.webkit.org/show_bug.cgi?id=42940
100 * MSIE 6 and 7 sometimes do not apply a hash even it was told to (requiring a second call to the apply function)
102 ieDoubleCheck: false,
105 * MSIE 6 requires the entire hash to be encoded for the hashes to trigger the onHashChange event
110 // ========================================================================
116 sessionStorage : false, // sessionStorage
118 intervalList : false, // array normally.
121 * Is History enabled?
125 // ====================================================================
130 * The store for all session specific data
136 * 1-1: State ID to State Object
142 * 1-1: State String to State ID
148 * 1-1: State URL to State ID
154 * Store the states in an array
156 storedStates : false,
160 * Saved the states in an array
166 * The list of queues to use
167 * First In, First Out
176 // ====================================================================
180 * History.stateChanged
181 * States whether or not the state has changed since the last double check was initialised
183 stateChanged : false,
186 * History.doubleChecker
187 * Contains the timeout used for the double checks
189 doubleChecker : false,
192 // Initialise History
193 init : function(options)
196 var emptyFunction = function(){};
200 this.initialTitle = window.document.title;
205 this.storedStates=[];
209 Roo.apply(this,options)
211 // Check Load Status of Adapter
212 //if ( typeof this.Adapter === 'undefined' ) {
216 // Check Load Status of Core
217 if ( typeof this.initCore !== 'undefined' ) {
221 // Check Load Status of HTML4 Support
222 if ( typeof this.initHtml4 !== 'undefined' ) {
229 this.enabled = !this.emulated.pushState;
231 if ( this.emulated.pushState ) {
235 this.pushState = emptyFunction;
236 this.replaceState = emptyFunction;
244 this.Adapter.bind(window,'popstate',this.onPopState);
250 if ( this.sessionStorage ) {
253 this.store = JSON.parse(this.sessionStorage.getItem('Roo.History.store'))||{};
258 this.intervalList.push(setInterval(this.onUnload,this.storeInterval));
260 // For Other Browsers
261 this.Adapter.bind(window,'beforeunload',this.onUnload);
262 this.Adapter.bind(window,'unload',this.onUnload);
265 this.onUnload = emptyFunction;
269 this.normalizeStore();
271 * Clear Intervals on exit to prevent memory leaks
273 this.Adapter.bind(window,"unload",this.clearAllIntervals);
276 * Create the initial State
278 this.saveState(this.storeState(this.extractState(this.getLocationHref(),true)));
282 // Non-Native pushState Implementation
283 if ( !this.emulated.pushState ) {
284 // Be aware, the following is only for native pushState implementations
285 // If you are wanting to include something for all browsers
286 // Then include it above this if block
291 if ( this.bugs.safariPoll ) {
292 this.intervalList.push(setInterval(this.safariStatePoll, this.safariPollInterval));
296 * Ensure Cross Browser Compatibility
298 //if ( window.navigator.vendor === 'Apple Computer, Inc.' || (window.navigator.appCodeName||'') === 'Mozilla' ) {
303 * Fix Safari HashChange Issue
307 this.Adapter.bind(window,'hashchange',function(){
308 _this.Adapter.trigger(window,'popstate');
312 if ( this.getHash() ) {
313 this.Adapter.onDomLoad(function(){
314 _this.Adapter.trigger(window,'hashchange');
319 } // !History.emulated.pushState
329 // ========================================================================
333 initCore : function(options){
335 this.intervalList = [];
339 this.sessionStorage = window.sessionStorage; // This will throw an exception in some browsers when cookies/localStorage are explicitly disabled (i.e. Chrome)
340 this.sessionStorage.setItem('TEST', '1');
341 this.sessionStorage.removeItem('TEST');
343 this.sessionStorage = false;
347 if ( typeof this.initCore.initialized !== 'undefined' ) {
352 this.initCore.initialized = true;
361 * Clears all setInterval instances.
363 clearAllIntervals: function()
365 var i, il = this.intervalList;
366 if (typeof il !== "undefined" && il !== null) {
367 for (i = 0; i < il.length; i++) {
368 clearInterval(il[i]);
370 this.intervalList = null;
375 // ====================================================================
379 * debugLog(message,...)
380 * Logs the passed arguments if debug enabled
382 debugLog : function()
384 if ( (this.debug||false) ) {
385 Roo.log.apply(this,arguments);
391 // ====================================================================
395 * getInternetExplorerMajorVersion()
396 * Get's the major version of Internet Explorer
398 * @license Public Domain
399 * @author Benjamin Arthur Lupton <contact@balupton.com>
400 * @author James Padolsey <https://gist.github.com/527683>
402 getInternetExplorerMajorVersion : function(){
403 var result = this.getInternetExplorerMajorVersion.cached =
404 (typeof this.getInternetExplorerMajorVersion.cached !== 'undefined')
405 ? this.getInternetExplorerMajorVersion.cached
408 div = window.document.createElement('div'),
409 all = div.getElementsByTagName('i');
410 while ( (div.innerHTML = '<!--[if gt IE ' + (++v) + ']><i></i><![endif]-->') && all[0] ) {}
411 return (v > 4) ? v : false;
418 * isInternetExplorer()
419 * Are we using Internet Explorer?
421 * @license Public Domain
422 * @author Benjamin Arthur Lupton <contact@balupton.com>
424 isInternetExplorer : function(){
426 this.isInternetExplorer.cached =
427 (typeof this.isInternetExplorer.cached !== 'undefined')
428 ? this.isInternetExplorer.cached
429 : Boolean(this.getInternetExplorerMajorVersion())
435 * Which features require emulating?
443 initEmulated : function()
447 if (this.html4Mode) {
453 this.emulated.pushState = !Boolean(
454 window.history && window.history.pushState && window.history.replaceState
456 (/ Mobile\/([1-7][a-z]|(8([abcde]|f(1[0-8]))))/i).test(window.navigator.userAgent) /* disable for versions of iOS before version 4.3 (8F190) */
457 || (/AppleWebKit\/5([0-2]|3[0-2])/i).test(window.navigator.userAgent) /* disable for the mercury iOS browser, or at least older versions of the webkit engine */
460 this.emulated.hashChange = Boolean(
461 !(('onhashchange' in window) || ('onhashchange' in window.document))
463 (this.isInternetExplorer() && this.getInternetExplorerMajorVersion() < 8)
468 initBugs : function ()
474 * Safari 5 and Safari iOS 4 fail to return to the correct state once a hash is replaced by a `replaceState` call
475 * https://bugs.webkit.org/show_bug.cgi?id=56249
477 this.bugs.setHash = Boolean(!this.emulated.pushState && navigator.vendor === 'Apple Computer, Inc.'
478 && /AppleWebKit\/5([0-2]|3[0-3])/.test(navigator.userAgent));
481 * Safari 5 and Safari iOS 4 sometimes fail to apply the state change under busy conditions
482 * https://bugs.webkit.org/show_bug.cgi?id=42940
484 this.bugs.safariPoll = Boolean(!this.emulated.pushState && navigator.vendor === 'Apple Computer, Inc.'
485 && /AppleWebKit\/5([0-2]|3[0-3])/.test(navigator.userAgent));
488 * MSIE 6 and 7 sometimes do not apply a hash even it was told to (requiring a second call to the apply function)
490 this.bugs.ieDoubleCheck = Boolean(this.isInternetExplorer() && this.getInternetExplorerMajorVersion() < 8);
493 * MSIE 6 requires the entire hash to be encoded for the hashes to trigger the onHashChange event
495 this.bugs.hashEscape = Boolean(this.isInternetExplorer() && this.getInternetExplorerMajorVersion() < 7);
501 * Checks to see if the Object is Empty
502 * @param {Object} obj
505 isEmptyObject : function(obj) {
506 for ( var name in obj ) {
507 if ( obj.hasOwnProperty(name) ) {
516 * Clones a object and eliminate all references to the original contexts
517 * @param {Object} obj
520 cloneObject : function(obj) {
523 hash = JSON.stringify(obj);
524 newObj = JSON.parse(hash);
533 // ====================================================================
538 * Turns "http://mysite.com/dir/page.html?asd" into "http://mysite.com"
539 * @return {String} rootUrl
541 getRootUrl : function(){
543 var rootUrl = window.document.location.protocol+'//'+(window.document.location.hostname||window.document.location.host);
544 if ( window.document.location.port||false ) {
545 rootUrl += ':'+window.document.location.port;
555 * Fetches the `href` attribute of the `<base href="...">` element if it exists
556 * @return {String} baseHref
558 getBaseHref : function(){
561 baseElements = window.document.getElementsByTagName('base'),
565 // Test for Base Element
566 if ( baseElements.length === 1 ) {
567 // Prepare for Base Element
568 baseElement = baseElements[0];
569 baseHref = baseElement.href.replace(/[^\/]+$/,'');
572 // Adjust trailing slash
573 baseHref = baseHref.replace(/\/+$/,'');
574 if ( baseHref ) baseHref += '/';
582 * Fetches the baseHref or basePageUrl or rootUrl (whichever one exists first)
583 * @return {String} baseUrl
585 getBaseUrl : function(){
587 var baseUrl = this.getBaseHref()||this.getBasePageUrl()||this.getRootUrl();
595 * Fetches the URL of the current page
596 * @return {String} pageUrl
598 getPageUrl : function(){
601 State = this.getState(false,false),
602 stateUrl = (State||{}).url||this.getLocationHref(),
606 pageUrl = stateUrl.replace(/\/+$/,'').replace(/[^\/]+$/,function(part,index,string){
607 return (/\./).test(part) ? part : part+'/';
616 * Fetches the Url of the directory of the current page
617 * @return {String} basePageUrl
619 getBasePageUrl : function(){
621 var basePageUrl = (this.getLocationHref()).replace(/[#\?].*/,'').replace(/[^\/]+$/,function(part,index,string){
622 return (/[^\/]$/).test(part) ? '' : part;
623 }).replace(/\/+$/,'')+'/';
631 * Ensures that we have an absolute URL and not a relative URL
632 * @param {string} url
633 * @param {Boolean} allowBaseHref
634 * @return {string} fullUrl
636 getFullUrl : function(url,allowBaseHref){
638 var fullUrl = url, firstChar = url.substring(0,1);
639 allowBaseHref = (typeof allowBaseHref === 'undefined') ? true : allowBaseHref;
642 if ( /[a-z]+\:\/\//.test(url) ) {
645 else if ( firstChar === '/' ) {
647 fullUrl = this.getRootUrl()+url.replace(/^\/+/,'');
649 else if ( firstChar === '#' ) {
651 fullUrl = this.getPageUrl().replace(/#.*/,'')+url;
653 else if ( firstChar === '?' ) {
655 fullUrl = this.getPageUrl().replace(/[\?#].*/,'')+url;
659 if ( allowBaseHref ) {
660 fullUrl = this.getBaseUrl()+url.replace(/^(\.\/)+/,'');
662 fullUrl = this.getBasePageUrl()+url.replace(/^(\.\/)+/,'');
664 // We have an if condition above as we do not want hashes
665 // which are relative to the baseHref in our URLs
666 // as if the baseHref changes, then all our bookmarks
667 // would now point to different locations
668 // whereas the basePageUrl will always stay the same
672 return fullUrl.replace(/\#$/,'');
677 * Ensures that we have a relative URL and not a absolute URL
678 * @param {string} url
679 * @return {string} url
681 getShortUrl : function(url){
683 var shortUrl = url, baseUrl = this.getBaseUrl(), rootUrl = this.getRootUrl();
686 if ( this.emulated.pushState ) {
687 // We are in a if statement as when pushState is not emulated
688 // The actual url these short urls are relative to can change
689 // So within the same session, we the url may end up somewhere different
690 shortUrl = shortUrl.replace(baseUrl,'');
694 shortUrl = shortUrl.replace(rootUrl,'/');
696 // Ensure we can still detect it as a state
697 if ( this.isTraditionalAnchor(shortUrl) ) {
698 shortUrl = './'+shortUrl;
702 shortUrl = shortUrl.replace(/^(\.\/)+/g,'./').replace(/\#$/,'');
709 * getLocationHref(document)
710 * Returns a normalized version of document.location.href
711 * accounting for browser inconsistencies, etc.
713 * This URL will be URI-encoded and will include the hash
715 * @param {object} document
716 * @return {string} url
718 getLocationHref : function(doc) {
719 doc = doc || window.document;
721 // most of the time, this will be true
722 if (doc.URL === doc.location.href)
723 return doc.location.href;
725 // some versions of webkit URI-decode document.location.href
726 // but they leave document.URL in an encoded state
727 if (doc.location.href === decodeURIComponent(doc.URL))
730 // FF 3.6 only updates document.URL when a page is reloaded
731 // document.location.href is updated correctly
732 if (doc.location.hash && decodeURIComponent(doc.location.href.replace(/^[^#]+/, "")) === doc.location.hash)
733 return doc.location.href;
735 if (doc.URL.indexOf('#') == -1 && doc.location.href.indexOf('#') != -1)
736 return doc.location.href;
738 return doc.URL || doc.location.href;
745 * Noramlize the store by adding necessary values
747 normalizeStore : function()
750 this.store.idToState = this.store.idToState||{};
751 this.store.urlToId = this.store.urlToId||{};
752 this.store.stateToId = this.store.stateToId||{};
757 * Get an object containing the data, title and url of the current state
758 * @param {Boolean} friendly
759 * @param {Boolean} create
760 * @return {Object} State
762 getState : function(friendly,create){
764 if ( typeof friendly === 'undefined' ) { friendly = true; }
765 if ( typeof create === 'undefined' ) { create = true; }
768 var State = this.getLastSavedState();
771 if ( !State && create ) {
772 State = this.createStateObject();
777 State = this.cloneObject(State);
778 State.url = this.cleanUrl||State.url;
786 * getIdByState(State)
787 * Gets a ID for a State
788 * @param {State} newState
789 * @return {String} id
791 getIdByState : function(newState){
794 var id = this.extractId(newState.url),
798 // Find ID via State String
799 str = this.getStateString(newState);
800 if ( typeof this.stateToId[str] !== 'undefined' ) {
801 id = this.stateToId[str];
803 else if ( typeof this.store.stateToId[str] !== 'undefined' ) {
804 id = this.store.stateToId[str];
809 id = (new Date()).getTime() + String(Math.random()).replace(/\D/g,'');
810 if ( typeof this.idToState[id] === 'undefined' && typeof this.store.idToState[id] === 'undefined' ) {
815 // Apply the new State to the ID
816 this.stateToId[str] = id;
817 this.idToState[id] = newState;
826 * normalizeState(State)
827 * Expands a State Object
828 * @param {object} State
831 normalizeState : function(oldState){
833 var newState, dataNotEmpty;
836 if ( !oldState || (typeof oldState !== 'object') ) {
841 if ( typeof oldState.normalized !== 'undefined' ) {
846 if ( !oldState.data || (typeof oldState.data !== 'object') ) {
850 // ----------------------------------------------------------------
854 newState.normalized = true;
855 newState.title = oldState.title||'';
856 newState.url = this.getFullUrl(oldState.url?oldState.url:(this.getLocationHref()));
857 newState.hash = this.getShortUrl(newState.url);
858 newState.data = this.cloneObject(oldState.data);
861 newState.id = this.getIdByState(newState);
863 // ----------------------------------------------------------------
866 newState.cleanUrl = newState.url.replace(/\??\&_suid.*/,'');
867 newState.url = newState.cleanUrl;
869 // Check to see if we have more than just a url
870 dataNotEmpty = !this.isEmptyObject(newState.data);
873 if ( (newState.title || dataNotEmpty) && this.disableSuid !== true ) {
875 newState.hash = this.getShortUrl(newState.url).replace(/\??\&_suid.*/,'');
876 if ( !/\?/.test(newState.hash) ) {
877 newState.hash += '?';
879 newState.hash += '&_suid='+newState.id;
882 // Create the Hashed URL
883 newState.hashedUrl = this.getFullUrl(newState.hash);
885 // ----------------------------------------------------------------
887 // Update the URL if we have a duplicate
888 if ( (this.emulated.pushState || this.bugs.safariPoll) && this.hasUrlDuplicate(newState) ) {
889 newState.url = newState.hashedUrl;
892 // ----------------------------------------------------------------
899 * createStateObject(data,title,url)
900 * Creates a object based on the data, title and url state params
901 * @param {object} data
902 * @param {string} title
903 * @param {string} url
906 createStateObject : function(data,title,url){
915 State = this.normalizeState(State);
923 * Get a state by it's UID
926 getStateById : function(id){
931 var State = this.idToState[id] || this.store.idToState[id] || undefined;
938 * Get a State's String
939 * @param {State} passedState
941 getStateString : function(passedState){
943 var State, cleanedState, str;
946 State = this.normalizeState(passedState);
951 title: passedState.title,
956 str = JSON.stringify(cleanedState);
964 * @param {State} passedState
965 * @return {String} id
967 getStateId : function(passedState){
972 State = this.normalizeState(passedState);
982 * getHashByState(State)
983 * Creates a Hash for the State Object
984 * @param {State} passedState
985 * @return {String} hash
987 getHashByState : function(passedState){
992 State = this.normalizeState(passedState);
1002 * extractId(url_or_hash)
1003 * Get a State ID by it's URL or Hash
1004 * @param {string} url_or_hash
1005 * @return {string} id
1007 extractId : function ( url_or_hash ) {
1009 var id,parts,url, tmp;
1013 // If the URL has a #, use the id from before the #
1014 if (url_or_hash.indexOf('#') != -1)
1016 tmp = url_or_hash.split("#")[0];
1023 parts = /(.*)\&_suid=([0-9]+)$/.exec(tmp);
1024 url = parts ? (parts[1]||url_or_hash) : url_or_hash;
1025 id = parts ? String(parts[2]||'') : '';
1032 * isTraditionalAnchor
1033 * Checks to see if the url is a traditional anchor or not
1034 * @param {String} url_or_hash
1037 isTraditionalAnchor : function(url_or_hash){
1039 var isTraditional = !(/[\/\?\.]/.test(url_or_hash));
1042 return isTraditional;
1047 * Get a State by it's URL or Hash
1048 * @param {String} url_or_hash
1049 * @return {State|null}
1051 extractState : function(url_or_hash,create){
1053 var State = null, id, url;
1054 create = create||false;
1057 id = this.extractId(url_or_hash);
1059 State = this.getStateById(id);
1062 // Fetch SUID returned no State
1065 url = this.getFullUrl(url_or_hash);
1068 id = this.getIdByUrl(url)||false;
1070 State = this.getStateById(id);
1074 if ( !State && create && !this.isTraditionalAnchor(url_or_hash) ) {
1075 State = this.createStateObject(null,null,url);
1085 * Get a State ID by a State URL
1087 getIdByUrl : function(url){
1089 var id = this.urlToId[url] || this.store.urlToId[url] || undefined;
1096 * getLastSavedState()
1097 * Get an object containing the data, title and url of the current state
1098 * @return {Object} State
1100 getLastSavedState : function(){
1101 return this.savedStates[this.savedStates.length-1]||undefined;
1105 * getLastStoredState()
1106 * Get an object containing the data, title and url of the current state
1107 * @return {Object} State
1109 getLastStoredState : function(){
1110 return this.storedStates[this.storedStates.length-1]||undefined;
1115 * Checks if a Url will have a url conflict
1116 * @param {Object} newState
1117 * @return {Boolean} hasDuplicate
1119 hasUrlDuplicate : function(newState) {
1121 var hasDuplicate = false,
1125 oldState = this.extractState(newState.url);
1128 hasDuplicate = oldState && oldState.id !== newState.id;
1131 return hasDuplicate;
1137 * @param {Object} newState
1138 * @return {Object} newState
1140 storeState : function(newState){
1142 this.urlToId[newState.url] = newState.id;
1145 this.storedStates.push(this.cloneObject(newState));
1152 * isLastSavedState(newState)
1153 * Tests to see if the state is the last state
1154 * @param {Object} newState
1155 * @return {boolean} isLast
1157 isLastSavedState : function(newState){
1160 newId, oldState, oldId;
1163 if ( this.savedStates.length ) {
1164 newId = newState.id;
1165 oldState = this.getLastSavedState();
1166 oldId = oldState.id;
1169 isLast = (newId === oldId);
1179 * @param {Object} newState
1180 * @return {boolean} changed
1182 saveState : function(newState){
1184 if ( this.isLastSavedState(newState) ) {
1189 this.savedStates.push(this.cloneObject(newState));
1197 * Gets a state by the index
1198 * @param {integer} index
1201 getStateByIndex : function(index){
1206 if ( typeof index === 'undefined' ) {
1207 // Get the last inserted
1208 State = this.savedStates[this.savedStates.length-1];
1210 else if ( index < 0 ) {
1212 State = this.savedStates[this.savedStates.length+index];
1215 // Get from the beginning
1216 State = this.savedStates[index];
1225 * Gets the current index
1228 getCurrentIndex : function(){
1233 if(this.savedStates.length < 1) {
1237 index = this.savedStates.length-1;
1242 // ====================================================================
1247 * @param {Location=} location
1248 * Gets the current document hash
1249 * Note: unlike location.hash, this is guaranteed to return the escaped hash in all browsers
1252 getHash : function(doc){
1253 var url = this.getLocationHref(doc),
1255 hash = this.getHashByUrl(url);
1261 * normalize and Unescape a Hash
1262 * @param {String} hash
1265 unescapeHash : function(hash){
1267 var result = this.normalizeHash(hash);
1270 result = decodeURIComponent(result);
1278 * normalize a hash across browsers
1281 normalizeHash : function(hash){
1283 var result = hash.replace(/[^#]*#/,'').replace(/#.*/, '');
1291 * Sets the document hash
1292 * @param {string} hash
1293 * @return {Roo.History}
1295 setHash : function(hash,queue){
1300 if ( queue !== false && this.busy() ) {
1301 // Wait + Push to Queue
1302 //this.debug('this.setHash: we must wait', arguments);
1305 callback: this.setHash,
1313 //this.debug('this.setHash: called',hash);
1315 // Make Busy + Continue
1318 // Check if hash is a state
1319 State = this.extractState(hash,true);
1320 if ( State && !this.emulated.pushState ) {
1321 // Hash is a state so skip the setHash
1322 //this.debug('this.setHash: Hash is a state so skipping the hash set with a direct pushState call',arguments);
1325 this.pushState(State.data,State.title,State.url,false);
1327 else if ( this.getHash() !== hash ) {
1328 // Hash is a proper hash, so apply it
1330 // Handle browser bugs
1331 if ( this.bugs.setHash ) {
1332 // Fix Safari Bug https://bugs.webkit.org/show_bug.cgi?id=56249
1334 // Fetch the base page
1335 pageUrl = this.getPageUrl();
1337 // Safari hash apply
1338 this.pushState(null,null,pageUrl+'#'+hash,false);
1341 // Normal hash apply
1342 window.document.location.hash = hash;
1352 * normalize and Escape a Hash
1355 escapeHash : function(hash){
1357 var result = normalizeHash(hash);
1360 result = window.encodeURIComponent(result);
1363 if ( !this.bugs.hashEscape ) {
1364 // Restore common parts
1366 .replace(/\%21/g,'!')
1367 .replace(/\%26/g,'&')
1368 .replace(/\%3D/g,'=')
1369 .replace(/\%3F/g,'?');
1378 * Extracts the Hash from a URL
1379 * @param {string} url
1380 * @return {string} url
1382 getHashByUrl : function(url){
1384 var hash = String(url)
1385 .replace(/([^#]*)#?([^#]*)#?(.*)/, '$2')
1389 hash = this.unescapeHash(hash);
1397 * Applies the title to the document
1398 * @param {State} newState
1401 setTitle : function(newState){
1403 var title = newState.title,
1408 firstState = this.getStateByIndex(0);
1409 if ( firstState && firstState.url === newState.url ) {
1410 title = firstState.title||this.initialTitle;
1416 window.document.getElementsByTagName('title')[0].innerHTML = title.replace('<','<').replace('>','>').replace(' & ',' & ');
1418 catch ( Exception ) { }
1419 window.document.title = title;
1426 // ====================================================================
1432 * @param {boolean} value [optional]
1433 * @return {boolean} busy
1435 busy : function(value){
1437 if ( typeof value !== 'undefined' ) {
1438 //this.debug('this.busy: changing ['+(this.busy.flag||false)+'] to ['+(value||false)+']', this.queues.length);
1439 this.busy_flag = value;
1442 else if ( typeof this.busy_flag === 'undefined' ) {
1443 this.busy_flag = false;
1447 if ( !this.busy_flag ) {
1448 // Execute the next item in the queue
1449 window.clearTimeout(this.busy.timeout);
1450 var fireNext = function(){
1452 if ( this.busy_flag ) return;
1453 for ( i=this.queues.length-1; i >= 0; --i ) {
1454 queue = this.queues[i];
1455 if ( queue.length === 0 ) continue;
1456 item = queue.shift();
1457 this.fireQueueItem(item);
1458 this.busy.timeout = window.setTimeout(fireNext,this.busyDelay);
1461 this.busy.timeout = window.setTimeout(fireNext,this.busyDelay);
1465 return this.busy_flag;
1471 * fireQueueItem(item)
1473 * @param {Object} item
1474 * @return {Mixed} result
1476 fireQueueItem : function(item){
1477 return item.callback.apply(item.scope||this,item.args||[]);
1481 * pushQueue(callback,args)
1482 * Add an item to the queue
1483 * @param {Object} item [scope,callback,args,queue]
1485 pushQueue : function(item){
1486 // Prepare the queue
1487 this.queues[item.queue||0] = this.queues[item.queue||0]||[];
1490 this.queues[item.queue||0].push(item);
1497 * queue (item,queue), (func,queue), (func), (item)
1498 * Either firs the item now if not busy, or adds it to the queue
1500 queue : function(item,queue){
1502 if ( typeof item === 'function' ) {
1507 if ( typeof queue !== 'undefined' ) {
1512 if ( this.busy() ) {
1513 this.pushQueue(item);
1515 this.fireQueueItem(item);
1526 clearQueue : function(){
1527 this.busy_flag = false;
1535 * doubleCheckComplete()
1536 * Complete a double check
1537 * @return {Roo.History}
1539 doubleCheckComplete : function(){
1541 this.stateChanged = true;
1544 this.doubleCheckClear();
1551 * doubleCheckClear()
1552 * Clear a double check
1553 * @return {Roo.History}
1555 doubleCheckClear : function(){
1557 if ( this.doubleChecker ) {
1558 window.clearTimeout(this.doubleChecker);
1559 this.doubleChecker = false;
1568 * Create a double check
1569 * @return {Roo.History}
1571 doubleCheck : function(tryAgain){
1573 this.stateChanged = false;
1574 this.doubleCheckClear();
1576 // Fix IE6,IE7 bug where calling history.back or history.forward does not actually change the hash (whereas doing it manually does)
1577 // Fix Safari 5 bug where sometimes the state does not change: https://bugs.webkit.org/show_bug.cgi?id=42940
1578 if ( this.bugs.ieDoubleCheck ) {
1580 this.doubleChecker = window.setTimeout(
1582 this.doubleCheckClear();
1583 if ( !this.stateChanged ) {
1584 //this.debug('History.doubleCheck: State has not yet changed, trying again', arguments);
1590 this.doubleCheckInterval
1599 // ====================================================================
1604 * Poll the current state
1605 * @return {Roo.History}
1607 safariStatePoll : function(){
1610 // Get the Last State which has the new URL
1612 urlState = this.extractState(this.getLocationHref()),
1615 // Check for a difference
1616 if ( !this.isLastSavedState(urlState) ) {
1617 newState = urlState;
1623 // Check if we have a state with that url
1626 //this.debug('this.safariStatePoll: new');
1627 newState = this.createStateObject();
1630 // Apply the New State
1631 //this.debug('this.safariStatePoll: trigger');
1632 this.Adapter.trigger(window,'popstate');
1639 // ====================================================================
1644 * Send the browser history back one item
1645 * @param {Integer} queue [optional]
1647 back : function(queue){
1648 //this.debug('this.back: called', arguments);
1651 if ( queue !== false && this.busy() ) {
1652 // Wait + Push to Queue
1653 //this.debug('this.back: we must wait', arguments);
1656 callback: this.back,
1663 // Make Busy + Continue
1666 // Fix certain browser bugs that prevent the state from changing
1667 this.doubleCheck(function(){
1680 * Send the browser history forward one item
1681 * @param {Integer} queue [optional]
1683 forward : function(queue){
1684 //this.debug('this.forward: called', arguments);
1687 if ( queue !== false && this.busy() ) {
1688 // Wait + Push to Queue
1689 //this.debug('this.forward: we must wait', arguments);
1692 callback: this.forward,
1699 // Make Busy + Continue
1703 // Fix certain browser bugs that prevent the state from changing
1704 this.doubleCheck(function(){
1711 // End forward closure
1717 * Send the browser history back or forward index times
1718 * @param {Integer} queue [optional]
1720 go : function(index,queue){
1721 //this.debug('this.go: called', arguments);
1729 for ( i=1; i<=index; ++i ) {
1730 this.forward(queue);
1733 else if ( index < 0 ) {
1735 for ( i=-1; i>=index; --i ) {
1740 throw new Error('History.go: History.go requires a positive or negative integer passed.');
1748 // ====================================================================
1749 // HTML5 State Support
1753 * Use native HTML5 History API Implementation
1757 * onPopState(event,extra)
1758 * Refresh the Current State
1760 onPopState : function(event,extra){
1762 var stateId = false, newState = false, currentHash, currentState;
1764 // Reset the double check
1765 this.doubleCheckComplete();
1767 // Check for a Hash, and handle apporiatly
1768 currentHash = this.getHash();
1769 if ( currentHash ) {
1771 currentState = this.extractState(currentHash||this.getLocationHref(),true);
1772 if ( currentState ) {
1773 // We were able to parse it, it must be a State!
1774 // Let's forward to replaceState
1775 //this.debug('this.onPopState: state anchor', currentHash, currentState);
1776 this.replaceState(currentState.data, currentState.title, currentState.url, false);
1779 // Traditional Anchor
1780 //this.debug('this.onPopState: traditional anchor', currentHash);
1781 this.Adapter.trigger(window,'anchorchange');
1785 // We don't care for hashes
1786 this.expectedStateId = false;
1791 stateId = this.Adapter.extractEventData('state',event,extra) || false;
1795 // Vanilla: Back/forward button was used
1796 newState = this.getStateById(stateId);
1798 else if ( this.expectedStateId ) {
1799 // Vanilla: A new state was pushed, and popstate was called manually
1800 newState = this.getStateById(this.expectedStateId);
1804 newState = this.extractState(this.getLocationHref());
1807 // The State did not exist in our store
1809 // Regenerate the State
1810 newState = this.createStateObject(null,null,this.getLocationHref());
1814 this.expectedStateId = false;
1816 // Check if we are the same state
1817 if ( this.isLastSavedState(newState) ) {
1818 // There has been no change (just the page's hash has finally propagated)
1819 //this.debug('this.onPopState: no change', newState, this.savedStates);
1825 this.storeState(newState);
1826 this.saveState(newState);
1828 // Force update of the title
1829 this.setTitle(newState);
1832 this.Adapter.trigger(window,'statechange');
1846 * pushState(data,title,url)
1847 * Add a new State to the history object, become it, and trigger onpopstate
1848 * We have to trigger for HTML4 compatibility
1849 * @param {object} data
1850 * @param {string} title
1851 * @param {string} url
1854 pushState : function(data,title,url,queue){
1855 //this.debug('this.pushState: called', arguments);
1858 if ( this.getHashByUrl(url) && this.emulated.pushState ) {
1859 throw new Error('History.js does not support states with fragement-identifiers (hashes/anchors).');
1863 if ( queue !== false && this.busy() ) {
1864 // Wait + Push to Queue
1865 //this.debug('this.pushState: we must wait', arguments);
1868 callback: this.pushState,
1875 // Make Busy + Continue
1878 // Create the newState
1879 var newState = this.createStateObject(data,title,url);
1882 if ( this.isLastSavedState(newState) ) {
1883 // Won't be a change
1887 // Store the newState
1888 this.storeState(newState);
1889 this.expectedStateId = newState.id;
1891 // Push the newState
1892 history.pushState(newState.id,newState.title,newState.url);
1895 this.Adapter.trigger(window,'popstate');
1898 // End pushState closure
1903 * replaceState(data,title,url)
1904 * Replace the State and trigger onpopstate
1905 * We have to trigger for HTML4 compatibility
1906 * @param {object} data
1907 * @param {string} title
1908 * @param {string} url
1911 replaceState : function(data,title,url,queue){
1912 //this.debug('this.replaceState: called', arguments);
1915 if ( this.getHashByUrl(url) && this.emulated.pushState ) {
1916 throw new Error('this.js does not support states with fragement-identifiers (hashes/anchors).');
1920 if ( queue !== false && this.busy() ) {
1921 // Wait + Push to Queue
1922 //this.debug('this.replaceState: we must wait', arguments);
1925 callback: this.replaceState,
1932 // Make Busy + Continue
1935 // Create the newState
1936 var newState = this.createStateObject(data,title,url);
1939 if ( this.isLastSavedState(newState) ) {
1940 // Won't be a change
1944 // Store the newState
1945 this.storeState(newState);
1946 this.expectedStateId = newState.id;
1948 // Push the newState
1949 history.replaceState(newState.id,newState.title,newState.url);
1952 this.Adapter.trigger(window,'popstate');
1955 // End replaceState closure
1960 // ====================================================================
1964 * Bind for Saving Store
1967 // When the page is closed
1968 onUnload : function(){
1970 var currentStore, item, currentStoreString;
1974 currentStore = JSON.parse(this.sessionStorage.getItem('Roo.History.store'))||{};
1981 currentStore.idToState = currentStore.idToState || {};
1982 currentStore.urlToId = currentStore.urlToId || {};
1983 currentStore.stateToId = currentStore.stateToId || {};
1986 for ( item in this.idToState ) {
1987 if ( !this.idToState.hasOwnProperty(item) ) {
1990 currentStore.idToState[item] = this.idToState[item];
1992 for ( item in this.urlToId ) {
1993 if ( !this.urlToId.hasOwnProperty(item) ) {
1996 currentStore.urlToId[item] = this.urlToId[item];
1998 for ( item in this.stateToId ) {
1999 if ( !this.stateToId.hasOwnProperty(item) ) {
2002 currentStore.stateToId[item] = this.stateToId[item];
2006 this.store = currentStore;
2007 this.normalizeStore();
2009 // In Safari, going into Private Browsing mode causes the
2010 // Session Storage object to still exist but if you try and use
2011 // or set any property/function of it it throws the exception
2012 // "QUOTA_EXCEEDED_ERR: DOM Exception 22: An attempt was made to
2013 // add something to storage that exceeded the quota." infinitely
2015 currentStoreString = JSON.stringify(currentStore);
2018 this.sessionStorage.setItem('Roo.History.store', currentStoreString);
2021 if (e.code === DOMException.QUOTA_EXCEEDED_ERR) {
2022 if (this.sessionStorage.length) {
2023 // Workaround for a bug seen on iPads. Sometimes the quota exceeded error comes up and simply
2024 // removing/resetting the storage can work.
2025 this.sessionStorage.removeItem('Roo.History.store');
2026 this.sessionStorage.setItem('Roo.History.store', currentStoreString);
2028 // Otherwise, we're probably private browsing in Safari, so we'll ignore the exception.