jquery.pjax.js 22.4 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
// jquery.pjax.js
// copyright chris wanstrath
// https://github.com/defunkt/jquery-pjax

(function($){

// When called on a container with a selector, fetches the href with
// ajax into the container or with the data-pjax attribute on the link
// itself.
//
// Tries to make sure the back button and ctrl+click work the way
// you'd expect.
//
// Exported as $.fn.pjax
//
// Accepts a jQuery ajax options object that may include these
// pjax specific options:
//
//
// container - Where to stick the response body. Usually a String selector.
//             $(container).html(xhr.responseBody)
//             (default: current jquery context)
//      push - Whether to pushState the URL. Defaults to true (of course).
//   replace - Want to use replaceState instead? That's cool.
//
// For convenience the second parameter can be either the container or
// the options object.
//
// Returns the jQuery object
Qiang Xue committed
30 31 32 33 34 35 36 37 38
	function fnPjax(selector, container, options) {
		var context = this
		return this.on('click.pjax', selector, function(event) {
			var opts = $.extend({}, optionsFor(container, options))
			if (!opts.container)
				opts.container = $(this).attr('data-pjax') || context
			handleClick(event, opts)
		})
	}
Qiang Xue committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

// Public: pjax on click handler
//
// Exported as $.pjax.click.
//
// event   - "click" jQuery.Event
// options - pjax options
//
// Examples
//
//   $(document).on('click', 'a', $.pjax.click)
//   // is the same as
//   $(document).pjax('a')
//
//  $(document).on('click', 'a', function(event) {
//    var container = $(this).closest('[data-pjax-container]')
//    $.pjax.click(event, container)
//  })
//
// Returns nothing.
Qiang Xue committed
59 60
	function handleClick(event, container, options) {
		options = optionsFor(container, options)
Qiang Xue committed
61

Qiang Xue committed
62
		var link = event.currentTarget
Qiang Xue committed
63

Qiang Xue committed
64 65
		if (link.tagName.toUpperCase() !== 'A')
			throw "$.fn.pjax or $.pjax.click requires an anchor element"
Qiang Xue committed
66

Qiang Xue committed
67 68 69 70
		// Middle click, cmd click, and ctrl click should open
		// links in a new tab as normal.
		if ( event.which > 1 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey )
			return
Qiang Xue committed
71

Qiang Xue committed
72 73 74
		// Ignore cross origin links
		if ( location.protocol !== link.protocol || location.hostname !== link.hostname )
			return
Qiang Xue committed
75

Qiang Xue committed
76 77 78 79
		// Ignore anchors on the same page
		if (link.hash && link.href.replace(link.hash, '') ===
			location.href.replace(location.hash, ''))
			return
Qiang Xue committed
80

Qiang Xue committed
81 82 83
		// Ignore empty anchor "foo.html#"
		if (link.href === location.href + '#')
			return
Qiang Xue committed
84

Qiang Xue committed
85 86 87 88 89
		var defaults = {
			url: link.href,
			container: $(link).attr('data-pjax'),
			target: link
		}
Qiang Xue committed
90

Qiang Xue committed
91 92 93
		var opts = $.extend({}, defaults, options)
		var clickEvent = $.Event('pjax:click')
		$(link).trigger(clickEvent, [opts])
Qiang Xue committed
94

Qiang Xue committed
95 96 97 98 99 100
		if (!clickEvent.isDefaultPrevented()) {
			pjax(opts)
			event.preventDefault()
			$(link).trigger('pjax:clicked', [opts])
		}
	}
Qiang Xue committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

// Public: pjax on form submit handler
//
// Exported as $.pjax.submit
//
// event   - "click" jQuery.Event
// options - pjax options
//
// Examples
//
//  $(document).on('submit', 'form', function(event) {
//    var container = $(this).closest('[data-pjax-container]')
//    $.pjax.submit(event, container)
//  })
//
// Returns nothing.
Qiang Xue committed
117 118
	function handleSubmit(event, container, options) {
		options = optionsFor(container, options)
Qiang Xue committed
119

Qiang Xue committed
120
		var form = event.currentTarget
Qiang Xue committed
121

Qiang Xue committed
122 123
		if (form.tagName.toUpperCase() !== 'FORM')
			throw "$.pjax.submit requires a form element"
Qiang Xue committed
124

Qiang Xue committed
125 126 127 128 129 130 131
		var defaults = {
			type: form.method.toUpperCase(),
			url: form.action,
			data: $(form).serializeArray(),
			container: $(form).attr('data-pjax'),
			target: form
		}
Qiang Xue committed
132

Qiang Xue committed
133
		pjax($.extend({}, defaults, options))
Qiang Xue committed
134

Qiang Xue committed
135 136
		event.preventDefault()
	}
Qiang Xue committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156

// Loads a URL with ajax, puts the response body inside a container,
// then pushState()'s the loaded URL.
//
// Works just like $.ajax in that it accepts a jQuery ajax
// settings object (with keys like url, type, data, etc).
//
// Accepts these extra keys:
//
// container - Where to stick the response body.
//             $(container).html(xhr.responseBody)
//      push - Whether to pushState the URL. Defaults to true (of course).
//   replace - Want to use replaceState instead? That's cool.
//
// Use it just like $.ajax:
//
//   var xhr = $.pjax({ url: this.href, container: '#main' })
//   console.log( xhr.readyState )
//
// Returns whatever $.ajax returns.
Qiang Xue committed
157 158 159 160 161 162 163 164 165 166
	function pjax(options) {
		options = $.extend(true, {}, $.ajaxSettings, pjax.defaults, options)

		if ($.isFunction(options.url)) {
			options.url = options.url()
		}

		var target = options.target

		var hash = parseURL(options.url).hash
Qiang Xue committed
167

Qiang Xue committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
		var context = options.context = findContainerFor(options.container)

		// We want the browser to maintain two separate internal caches: one
		// for pjax'd partial page loads and one for normal page loads.
		// Without adding this secret parameter, some browsers will often
		// confuse the two.
		if (!options.data) options.data = {}
		options.data._pjax = context.selector

		function fire(type, args) {
			var event = $.Event(type, { relatedTarget: target })
			context.trigger(event, args)
			return !event.isDefaultPrevented()
		}

		var timeoutTimer

		options.beforeSend = function(xhr, settings) {
			// No timeout for non-GET requests
			// Its not safe to request the resource again with a fallback method.
			if (settings.type !== 'GET') {
				settings.timeout = 0
			}

			xhr.setRequestHeader('X-PJAX', 'true')
			xhr.setRequestHeader('X-PJAX-Container', context.selector)

			if (!fire('pjax:beforeSend', [xhr, settings]))
				return false

			if (settings.timeout > 0) {
				timeoutTimer = setTimeout(function() {
					if (fire('pjax:timeout', [xhr, options]))
						xhr.abort('timeout')
				}, settings.timeout)

				// Clear timeout setting so jquerys internal timeout isn't invoked
				settings.timeout = 0
			}

			options.requestUrl = parseURL(settings.url).href
		}

		options.complete = function(xhr, textStatus) {
			if (timeoutTimer)
				clearTimeout(timeoutTimer)

			fire('pjax:complete', [xhr, textStatus, options])

			fire('pjax:end', [xhr, options])
		}

		options.error = function(xhr, textStatus, errorThrown) {
			var container = extractContainer("", xhr, options)

			var allowed = fire('pjax:error', [xhr, textStatus, errorThrown, options])
			if (options.type == 'GET' && textStatus !== 'abort' && allowed) {
				locationReplace(container.url)
			}
		}

		options.success = function(data, status, xhr) {
			// If $.pjax.defaults.version is a function, invoke it first.
			// Otherwise it can be a static string.
			var currentVersion = (typeof $.pjax.defaults.version === 'function') ?
				$.pjax.defaults.version() :
				$.pjax.defaults.version

			var latestVersion = xhr.getResponseHeader('X-PJAX-Version')

			var container = extractContainer(data, xhr, options)

			// If there is a layout version mismatch, hard load the new url
			if (currentVersion && latestVersion && currentVersion !== latestVersion) {
				locationReplace(container.url)
				return
			}

			// If the new response is missing a body, hard load the page
			if (!container.contents) {
				locationReplace(container.url)
				return
			}

			pjax.state = {
				id: options.id || uniqueId(),
				url: container.url,
				title: container.title,
				container: context.selector,
				fragment: options.fragment,
				timeout: options.timeout
			}

			if (options.push || options.replace) {
				window.history.replaceState(pjax.state, container.title, container.url)
			}

			// Clear out any focused controls before inserting new page contents.
			document.activeElement.blur()

			if (container.title) document.title = container.title
			context.html(container.contents)

			// FF bug: Won't autofocus fields that are inserted via JS.
			// This behavior is incorrect. So if theres no current focus, autofocus
			// the last field.
			//
			// http://www.w3.org/html/wg/drafts/html/master/forms.html
			var autofocusEl = context.find('input[autofocus], textarea[autofocus]').last()[0]
			if (autofocusEl && document.activeElement !== autofocusEl) {
				autofocusEl.focus();
			}

			executeScriptTags(container.scripts)

			// Scroll to top by default
			if (typeof options.scrollTo === 'number')
				$(window).scrollTop(options.scrollTo)

			// If the URL has a hash in it, make sure the browser
			// knows to navigate to the hash.
			if ( hash !== '' ) {
				// Avoid using simple hash set here. Will add another history
				// entry. Replace the url with replaceState and scroll to target
				// by hand.
				//
				//   window.location.hash = hash
				var url = parseURL(container.url)
				url.hash = hash

				pjax.state.url = url.href
				window.history.replaceState(pjax.state, container.title, url.href)

				var target = $(url.hash)
				if (target.length) $(window).scrollTop(target.offset().top)
			}

			fire('pjax:success', [data, status, xhr, options])
		}


		// Initialize pjax.state for the initial page load. Assume we're
		// using the container and options of the link we're loading for the
		// back button to the initial page. This ensures good back button
		// behavior.
		if (!pjax.state) {
			pjax.state = {
				id: uniqueId(),
				url: window.location.href,
				title: document.title,
				container: context.selector,
				fragment: options.fragment,
				timeout: options.timeout
			}
			window.history.replaceState(pjax.state, document.title)
		}

		// Cancel the current request if we're already pjaxing
		var xhr = pjax.xhr
		if ( xhr && xhr.readyState < 4) {
			xhr.onreadystatechange = $.noop
			xhr.abort()
		}

		pjax.options = options
		var xhr = pjax.xhr = $.ajax(options)

		if (xhr.readyState > 0) {
			if (options.push && !options.replace) {
				// Cache current container element before replacing it
				cachePush(pjax.state.id, context.clone().contents())

				window.history.pushState(null, "", stripPjaxParam(options.requestUrl))
			}

			fire('pjax:start', [xhr, options])
			fire('pjax:send', [xhr, options])
		}

		return pjax.xhr
	}
Qiang Xue committed
349 350 351 352

// Public: Reload current page with pjax.
//
// Returns whatever $.pjax returns.
Qiang Xue committed
353 354 355 356 357 358 359
	function pjaxReload(container, options) {
		var defaults = {
			url: window.location.href,
			push: false,
			replace: true,
			scrollTo: false
		}
Qiang Xue committed
360

Qiang Xue committed
361 362
		return pjax($.extend(defaults, optionsFor(container, options)))
	}
Qiang Xue committed
363 364 365 366 367 368 369

// Internal: Hard replace current state with url.
//
// Work for around WebKit
//   https://bugs.webkit.org/show_bug.cgi?id=93506
//
// Returns nothing.
Qiang Xue committed
370 371 372 373
	function locationReplace(url) {
		window.history.replaceState(null, "", "#")
		window.location.replace(url)
	}
Qiang Xue committed
374 375


Qiang Xue committed
376 377 378
	var initialPop = true
	var initialURL = window.location.href
	var initialState = window.history.state
Qiang Xue committed
379 380 381 382

// Initialize $.pjax.state if possible
// Happens when reloading a page and coming forward from a different
// session history.
Qiang Xue committed
383 384 385
	if (initialState && initialState.container) {
		pjax.state = initialState
	}
Qiang Xue committed
386 387

// Non-webkit browsers don't fire an initial popstate event
Qiang Xue committed
388 389 390
	if ('state' in window.history) {
		initialPop = false
	}
Qiang Xue committed
391 392 393 394 395

// popstate handler takes care of the back and forward buttons
//
// You probably shouldn't use pjax on pages with other pushState
// stuff yet.
Qiang Xue committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
	function onPjaxPopstate(event) {
		var state = event.state

		if (state && state.container) {
			// When coming forward from a separate history session, will get an
			// initial pop with a state we are already at. Skip reloading the current
			// page.
			if (initialPop && initialURL == state.url) return

			// If popping back to the same state, just skip.
			// Could be clicking back from hashchange rather than a pushState.
			if (pjax.state.id === state.id) return

			var container = $(state.container)
			if (container.length) {
				var direction, contents = cacheMapping[state.id]

				if (pjax.state) {
					// Since state ids always increase, we can deduce the history
					// direction from the previous state.
					direction = pjax.state.id < state.id ? 'forward' : 'back'

					// Cache current container before replacement and inform the
					// cache which direction the history shifted.
					cachePop(direction, pjax.state.id, container.clone().contents())
				}

				var popstateEvent = $.Event('pjax:popstate', {
					state: state,
					direction: direction
				})
				container.trigger(popstateEvent)

				var options = {
					id: state.id,
					url: state.url,
					container: container,
					push: false,
					fragment: state.fragment,
					timeout: state.timeout,
					scrollTo: false
				}

				if (contents) {
					container.trigger('pjax:start', [null, options])

					if (state.title) document.title = state.title
					container.html(contents)
					pjax.state = state

					container.trigger('pjax:end', [null, options])
				} else {
					pjax(options)
				}

				// Force reflow/relayout before the browser tries to restore the
				// scroll position.
				container[0].offsetHeight
			} else {
				locationReplace(location.href)
			}
		}
		initialPop = false
	}
Qiang Xue committed
460 461 462 463 464

// Fallback version of main pjax function for browsers that don't
// support pushState.
//
// Returns nothing since it retriggers a hard form submission.
Qiang Xue committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
	function fallbackPjax(options) {
		var url = $.isFunction(options.url) ? options.url() : options.url,
			method = options.type ? options.type.toUpperCase() : 'GET'

		var form = $('<form>', {
			method: method === 'GET' ? 'GET' : 'POST',
			action: url,
			style: 'display:none'
		})

		if (method !== 'GET' && method !== 'POST') {
			form.append($('<input>', {
				type: 'hidden',
				name: '_method',
				value: method.toLowerCase()
			}))
		}

		var data = options.data
		if (typeof data === 'string') {
			$.each(data.split('&'), function(index, value) {
				var pair = value.split('=')
				form.append($('<input>', {type: 'hidden', name: pair[0], value: pair[1]}))
			})
		} else if (typeof data === 'object') {
			for (key in data)
				form.append($('<input>', {type: 'hidden', name: key, value: data[key]}))
		}

		$(document.body).append(form)
		form.submit()
	}
Qiang Xue committed
497 498 499 500 501 502 503

// Internal: Generate unique id for state object.
//
// Use a timestamp instead of a counter since ids should still be
// unique across page loads.
//
// Returns Number.
Qiang Xue committed
504 505 506
	function uniqueId() {
		return (new Date).getTime()
	}
Qiang Xue committed
507 508 509 510 511 512

// Internal: Strips _pjax param from url
//
// url - String
//
// Returns String.
Qiang Xue committed
513 514 515 516 517 518
	function stripPjaxParam(url) {
		return url
			.replace(/\?_pjax=[^&]+&?/, '?')
			.replace(/_pjax=[^&]+&?/, '')
			.replace(/[\?&]$/, '')
	}
Qiang Xue committed
519 520 521 522 523 524

// Internal: Parse URL components and returns a Locationish object.
//
// url - String URL
//
// Returns HTMLAnchorElement that acts like Location.
Qiang Xue committed
525 526 527 528 529
	function parseURL(url) {
		var a = document.createElement('a')
		a.href = url
		return a
	}
Qiang Xue committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

// Internal: Build options Object for arguments.
//
// For convenience the first parameter can be either the container or
// the options object.
//
// Examples
//
//   optionsFor('#container')
//   // => {container: '#container'}
//
//   optionsFor('#container', {push: true})
//   // => {container: '#container', push: true}
//
//   optionsFor({container: '#container', push: true})
//   // => {container: '#container', push: true}
//
// Returns options Object.
Qiang Xue committed
548 549 550 551
	function optionsFor(container, options) {
		// Both container and options
		if ( container && options )
			options.container = container
Qiang Xue committed
552

Qiang Xue committed
553 554 555
		// First argument is options Object
		else if ( $.isPlainObject(container) )
			options = container
Qiang Xue committed
556

Qiang Xue committed
557 558 559
		// Only container
		else
			options = {container: container}
Qiang Xue committed
560

Qiang Xue committed
561 562 563
		// Find and validate container
		if (options.container)
			options.container = findContainerFor(options.container)
Qiang Xue committed
564

Qiang Xue committed
565 566
		return options
	}
Qiang Xue committed
567 568 569 570 571 572 573 574 575

// Internal: Find container element for a variety of inputs.
//
// Because we can't persist elements using the history API, we must be
// able to find a String selector that will consistently find the Element.
//
// container - A selector String, jQuery object, or DOM Element.
//
// Returns a jQuery object whose context is `document` and has a selector.
Qiang Xue committed
576 577 578 579 580 581 582 583 584 585 586 587 588
	function findContainerFor(container) {
		container = $(container)

		if ( !container.length ) {
			throw "no pjax container for " + container.selector
		} else if ( container.selector !== '' && container.context === document ) {
			return container
		} else if ( container.attr('id') ) {
			return $('#' + container.attr('id'))
		} else {
			throw "cant get selector for pjax container!"
		}
	}
Qiang Xue committed
589 590 591 592 593 594 595 596 597 598

// Internal: Filter and find all elements matching the selector.
//
// Where $.fn.find only matches descendants, findAll will test all the
// top level elements in the jQuery object as well.
//
// elems    - jQuery object of Elements
// selector - String selector to match
//
// Returns a jQuery object.
Qiang Xue committed
599 600 601
	function findAll(elems, selector) {
		return elems.filter(selector).add(elems.find(selector));
	}
Qiang Xue committed
602

Qiang Xue committed
603 604 605
	function parseHTML(html) {
		return $.parseHTML(html, document, true)
	}
Qiang Xue committed
606 607 608 609 610 611 612 613 614 615 616 617

// Internal: Extracts container and metadata from response.
//
// 1. Extracts X-PJAX-URL header if set
// 2. Extracts inline <title> tags
// 3. Builds response Element and extracts fragment if set
//
// data    - String response data
// xhr     - XHR response
// options - pjax options Object
//
// Returns an Object with url, title, and contents keys.
Qiang Xue committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
	function extractContainer(data, xhr, options) {
		var obj = {}

		// Prefer X-PJAX-URL header if it was set, otherwise fallback to
		// using the original requested url.
		obj.url = stripPjaxParam(xhr.getResponseHeader('X-PJAX-URL') || options.requestUrl)

		// Attempt to parse response html into elements
		if (/<html/i.test(data)) {
			var $head = $(parseHTML(data.match(/<head[^>]*>([\s\S.]*)<\/head>/i)[0]))
			var $body = $(parseHTML(data.match(/<body[^>]*>([\s\S.]*)<\/body>/i)[0]))
		} else {
			var $head = $body = $(parseHTML(data))
		}

		// If response data is empty, return fast
		if ($body.length === 0)
			return obj

		// If there's a <title> tag in the header, use it as
		// the page's title.
		obj.title = findAll($head, 'title').last().text()

		if (options.fragment) {
			// If they specified a fragment, look for it in the response
			// and pull it out.
			if (options.fragment === 'body') {
				var $fragment = $body
			} else {
				var $fragment = findAll($body, options.fragment).first()
			}

			if ($fragment.length) {
				obj.contents = $fragment.contents()

				// If there's no title, look for data-title and title attributes
				// on the fragment
				if (!obj.title)
					obj.title = $fragment.attr('title') || $fragment.data('title')
			}

		} else if (!/<html/i.test(data)) {
			obj.contents = $body
		}

		// Clean up any <title> tags
		if (obj.contents) {
			// Remove any parent title elements
			obj.contents = obj.contents.not(function() { return $(this).is('title') })

			// Then scrub any titles from their descendants
			obj.contents.find('title').remove()

			// Gather all script[src] elements
			obj.scripts = findAll(obj.contents, 'script[src]').remove()
			obj.contents = obj.contents.not(obj.scripts)
		}

		// Trim any whitespace off the title
		if (obj.title) obj.title = $.trim(obj.title)

		return obj
	}
Qiang Xue committed
681 682 683 684 685 686 687 688 689

// Load an execute scripts using standard script request.
//
// Avoids jQuery's traditional $.getScript which does a XHR request and
// globalEval.
//
// scripts - jQuery object of script Elements
//
// Returns nothing.
Qiang Xue committed
690 691
	function executeScriptTags(scripts) {
		if (!scripts) return
Qiang Xue committed
692

Qiang Xue committed
693
		var existingScripts = $('script[src]')
Qiang Xue committed
694

Qiang Xue committed
695 696 697 698 699 700
		scripts.each(function() {
			var src = this.src
			var matchedScripts = existingScripts.filter(function() {
				return this.src === src
			})
			if (matchedScripts.length) return
Qiang Xue committed
701

Qiang Xue committed
702 703 704 705 706 707
			var script = document.createElement('script')
			script.type = $(this).attr('type')
			script.src = $(this).attr('src')
			document.head.appendChild(script)
		})
	}
Qiang Xue committed
708 709

// Internal: History DOM caching class.
Qiang Xue committed
710 711 712
	var cacheMapping      = {}
	var cacheForwardStack = []
	var cacheBackStack    = []
Qiang Xue committed
713 714 715 716 717 718 719 720 721

// Push previous state id and container contents into the history
// cache. Should be called in conjunction with `pushState` to save the
// previous container contents.
//
// id    - State ID Number
// value - DOM Element to cache
//
// Returns nothing.
Qiang Xue committed
722 723 724
	function cachePush(id, value) {
		cacheMapping[id] = value
		cacheBackStack.push(id)
Qiang Xue committed
725

Qiang Xue committed
726 727 728 729
		// Remove all entires in forward history stack after pushing
		// a new page.
		while (cacheForwardStack.length)
			delete cacheMapping[cacheForwardStack.shift()]
Qiang Xue committed
730

Qiang Xue committed
731 732 733 734
		// Trim back history stack to max cache length.
		while (cacheBackStack.length > pjax.defaults.maxCacheLength)
			delete cacheMapping[cacheBackStack.shift()]
	}
Qiang Xue committed
735 736 737 738 739 740 741 742 743 744

// Shifts cache from directional history cache. Should be
// called on `popstate` with the previous state id and container
// contents.
//
// direction - "forward" or "back" String
// id        - State ID Number
// value     - DOM Element to cache
//
// Returns nothing.
Qiang Xue committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
	function cachePop(direction, id, value) {
		var pushStack, popStack
		cacheMapping[id] = value

		if (direction === 'forward') {
			pushStack = cacheBackStack
			popStack  = cacheForwardStack
		} else {
			pushStack = cacheForwardStack
			popStack  = cacheBackStack
		}

		pushStack.push(id)
		if (id = popStack.pop())
			delete cacheMapping[id]
	}
Qiang Xue committed
761 762 763 764

// Public: Find version identifier for the initial page load.
//
// Returns String version or undefined.
Qiang Xue committed
765 766 767 768 769 770
	function findVersion() {
		return $('meta').filter(function() {
			var name = $(this).attr('http-equiv')
			return name && name.toUpperCase() === 'X-PJAX-VERSION'
		}).attr('content')
	}
Qiang Xue committed
771 772 773 774 775 776 777 778 779 780

// Install pjax functions on $.pjax to enable pushState behavior.
//
// Does nothing if already enabled.
//
// Examples
//
//     $.pjax.enable()
//
// Returns nothing.
Qiang Xue committed
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
	function enable() {
		$.fn.pjax = fnPjax
		$.pjax = pjax
		$.pjax.enable = $.noop
		$.pjax.disable = disable
		$.pjax.click = handleClick
		$.pjax.submit = handleSubmit
		$.pjax.reload = pjaxReload
		$.pjax.defaults = {
			timeout: 650,
			push: true,
			replace: false,
			type: 'GET',
			dataType: 'html',
			scrollTo: 0,
			maxCacheLength: 20,
			version: findVersion
		}
		$(window).on('popstate.pjax', onPjaxPopstate)
	}
Qiang Xue committed
801 802 803 804 805 806 807 808 809 810 811 812

// Disable pushState behavior.
//
// This is the case when a browser doesn't support pushState. It is
// sometimes useful to disable pushState for debugging on a modern
// browser.
//
// Examples
//
//     $.pjax.disable()
//
// Returns nothing.
Qiang Xue committed
813 814 815 816 817 818 819 820
	function disable() {
		$.fn.pjax = function() { return this }
		$.pjax = fallbackPjax
		$.pjax.enable = enable
		$.pjax.disable = $.noop
		$.pjax.click = $.noop
		$.pjax.submit = $.noop
		$.pjax.reload = function() { window.location.reload() }
Qiang Xue committed
821

Qiang Xue committed
822 823
		$(window).off('popstate.pjax', onPjaxPopstate)
	}
Qiang Xue committed
824 825 826 827


// Add the state property to jQuery's event object so we can use it in
// $(window).bind('popstate')
Qiang Xue committed
828 829
	if ( $.inArray('state', $.event.props) < 0 )
		$.event.props.push('state')
Qiang Xue committed
830 831

// Is pjax supported by this browser?
Qiang Xue committed
832 833 834 835
	$.support.pjax =
		window.history && window.history.pushState && window.history.replaceState &&
			// pushState isn't reliable on iOS until 5.
			!navigator.userAgent.match(/((iPod|iPhone|iPad).+\bOS\s+[1-4]|WebApps\/.+CFNetwork)/)
Qiang Xue committed
836

Qiang Xue committed
837
	$.support.pjax ? enable() : disable()
Qiang Xue committed
838 839

})(jQuery);