iTop/js/dataTables.pipeline.js

/*
 * @copyright   Copyright (C) 2010-2021 Combodo SARL
 * @license     http://opensource.org/licenses/AGPL-3.0
 */

//
// Pipelining function for DataTables. To be used to the `ajax` option of DataTables
//
var numberCachePages = 5;

$.fn.dataTable.pipeline = function (opts, initJson) {
	// Configuration options
	var conf = $.extend({
		pages: numberCachePages,     // number of pages to cache
		url: '',      // script url
		data: null,   // function or object with parameters to send to the server
	                  // matching how `ajax.data` works in DataTables
		method: 'GET' // Ajax HTTP method
	}, opts);

	// Private variables for storing the cache
	var cacheLower = -1;
	var cacheUpper = null;
	var cacheLastRequest = null;
	var cacheLastJson = null;
	var draw_number = 1;

	return function (request, drawCallback, settings) {
		let message = '<i class="fa fa-sync-alt fa-spin fa-x fa-fw"></i>';
		this.closest('.dataTables_wrapper').block({
			message: message,
			css: {
				border: '0px '
			}
		});

		var ajax = false;
		var requestStart = request.start;
		var drawStart = request.start;
		var requestLength = request.length;
		if (request.start = undefined) {
			requestStart = settings._iDisplayStart;
			drawStart = settings._iDisplayStart;
			requestLength = settings._iDisplayLength;
		}
		var requestEnd = requestStart+requestLength;

		//Manage case requestLength=-1 => all the row are display 
		if (requestLength == -1) {
			requestLength = cacheLastJson.recordsTotal;
			if (cacheLower != 0 || cacheLastJson.recordsTotal > cacheUpper) {
				//new server request is mandatory
				ajax = true;
			}
		}
		if (request.draw == 1 && initJson != null) {
			//do nothing
			cacheLastJson = $.extend(true, {}, initJson);
			cacheLower = 0;
			cacheUpper = initJson.data.length;
		} else if (settings.clearCache) {
			// API requested that the cache be cleared
			ajax = true;
			settings.clearCache = false;
		} else if (cacheLower < 0 || requestStart < cacheLower || requestEnd > cacheUpper) {
			// outside cached data - need to make a request
			ajax = true;
		} else if (JSON.stringify(request.order) !== JSON.stringify(cacheLastRequest.order) ||
			JSON.stringify(request.columns) !== JSON.stringify(cacheLastRequest.columns) ||
			JSON.stringify(request.search) !== JSON.stringify(cacheLastRequest.search)
		) {
			// properties changed (ordering, columns, searching)
			ajax = true;
		} else if (cacheLastJson == undefined || cacheLastJson.length == 0) {
			ajax = true;
		}

		// Store the request for checking next time around
		cacheLastRequest = $.extend( true, {}, request );

		if ( ajax ) {
			// Need data from the server
			if ( requestStart < cacheLower ) {
				requestStart = requestStart - (requestLength*(conf.pages-1));

				if ( requestStart < 0 ) {
					requestStart = 0;
				}
			}

			cacheLower = requestStart;
			cacheUpper = requestStart + (requestLength * conf.pages);

			request.start = requestStart;
			request.length = requestLength*conf.pages;
			request.end = requestStart+ requestLength*conf.pages;

			// Provide the same `data` options as DataTables.
			if ( typeof conf.data === 'function' ) {
				// As a function it is executed with the data object as an arg
				// for manipulation. If an object is returned, it is used as the
				// data object to submit
				var d = conf.data( request );
				if ( d ) {
					$.extend( request, d );
				}
			} else if ( $.isPlainObject( conf.data ) ) {
				// As an object, the data given extends the default
				$.extend( request, conf.data );
			}
			return $.ajax( {
				"type":     conf.method,
				"url":      conf.url,
				"data":     request,
				"dataType": "json",
				"cache":    false,
				"success": function (json) {
					cacheLastJson = $.extend(true, {}, json);

					if (cacheLower != drawStart && requestLength != -1) {
						json.data.splice(0, drawStart-cacheLower);
					}
					if (requestLength >= -1) {
						json.data.splice(requestLength, json.data.length);
					}
					drawCallback(json);
				},
				error: function (data) {
					let oDlg = $('<div></div>');
					$('body').append(oDlg);
					oDlg.html(data.responseText);
					oDlg.dialog({
						title: settings["oLanguage"]["errorMessage"],
						modal: true,
						width: 'auto',
						height: 'auto',
						maxHeight: $(window).height() * 0.7,
						maxWidth: '500',
						position: {my: "center", at: "center", of: window},
						buttons: [
							{
								text: settings["oLanguage"]["buttonOk"],
								class: "ibo-is-primary ibo-is-neutral",
								click: function () {
									$(this).dialog('close');
								}
							}],
					});
				}
			} );
		} else {
			json = $.extend( true, {}, cacheLastJson );
			json.draw = request.draw; // Update the echo for each response
			json.data.splice( 0, requestStart-cacheLower );
			json.data.splice( requestLength, json.data.length );

			drawCallback(json);
		}
	}
};

// Register an API method that will empty the pipelined data, forcing an Ajax
// fetch on the next draw (i.e. `table.clearPipeline().draw()`)
$.fn.dataTable.Api.register( 'clearPipeline()', function () {
	return this.iterator( 'table', function ( settings ) {
		settings.clearCache = true;
	} );
} );