bootstrap-table/dist/extensions/cookie/bootstrap-table-cookie.js

(function (global, factory) {
    if (typeof define === "function" && define.amd) {
        define([], factory);
    } else if (typeof exports !== "undefined") {
        factory();
    } else {
        var mod = {
            exports: {}
        };
        factory();
        global.bootstrapTableCookie = mod.exports;
    }
})(this, function () {
    'use strict';

    /**
     * @author: Dennis Hernández
     * @webSite: http://djhvscf.github.io/Blog
     * @version: v1.2.3
     *
     * @update zhixin wen <wenzhixin2010@gmail.com>
     */

    (function ($) {
        'use strict';

        var cookieIds = {
            sortOrder: 'bs.table.sortOrder',
            sortName: 'bs.table.sortName',
            pageNumber: 'bs.table.pageNumber',
            pageList: 'bs.table.pageList',
            columns: 'bs.table.columns',
            searchText: 'bs.table.searchText',
            filterControl: 'bs.table.filterControl'
        };

        var getCurrentHeader = function getCurrentHeader(that) {
            var header = that.$header;
            if (that.options.height) {
                header = that.$tableHeader;
            }

            return header;
        };

        var getCurrentSearchControls = function getCurrentSearchControls(that) {
            var searchControls = 'select, input';
            if (that.options.height) {
                searchControls = 'table select, table input';
            }

            return searchControls;
        };

        var cookieEnabled = function cookieEnabled() {
            return !!navigator.cookieEnabled;
        };

        var inArrayCookiesEnabled = function inArrayCookiesEnabled(cookieName, cookiesEnabled) {
            var index = -1;

            for (var i = 0; i < cookiesEnabled.length; i++) {
                if (cookieName.toLowerCase() === cookiesEnabled[i].toLowerCase()) {
                    index = i;
                    break;
                }
            }

            return index;
        };

        var setCookie = function setCookie(that, cookieName, cookieValue) {
            if (!that.options.cookie || !cookieEnabled() || that.options.cookieIdTable === '') {
                return;
            }

            if (inArrayCookiesEnabled(cookieName, that.options.cookiesEnabled) === -1) {
                return;
            }

            cookieName = that.options.cookieIdTable + '.' + cookieName;

            switch (that.options.cookieStorage) {
                case 'cookieStorage':
                    document.cookie = [cookieName, '=', cookieValue, '; expires=' + calculateExpiration(that.options.cookieExpire), that.options.cookiePath ? '; path=' + that.options.cookiePath : '', that.options.cookieDomain ? '; domain=' + that.options.cookieDomain : '', that.options.cookieSecure ? '; secure' : ''].join('');
                case 'localStorage':
                    localStorage.setItem(cookieName, cookieValue);
                    break;
                case 'sessionStorage':
                    sessionStorage.setItem(cookieName, cookieValue);
                    break;
                default:
                    return false;
            }

            return true;
        };

        var getCookie = function getCookie(that, tableName, cookieName) {
            if (!cookieName) {
                return null;
            }

            if (inArrayCookiesEnabled(cookieName, that.options.cookiesEnabled) === -1) {
                return null;
            }

            cookieName = tableName + '.' + cookieName;

            switch (that.options.cookieStorage) {
                case 'cookieStorage':
                    var value = '; ' + document.cookie;
                    var parts = value.split('; ' + cookieName + '=');
                    return parts.length === 2 ? parts.pop().split(';').shift() : null;
                case 'localStorage':
                    return localStorage.getItem(cookieName);
                case 'sessionStorage':
                    return sessionStorage.getItem(cookieName);
                default:
                    return null;
            }
        };

        var deleteCookie = function deleteCookie(that, tableName, cookieName) {
            cookieName = tableName + '.' + cookieName;

            switch (that.options.cookieStorage) {
                case 'cookieStorage':
                    document.cookie = [encodeURIComponent(cookieName), '=', '; expires=Thu, 01 Jan 1970 00:00:00 GMT', that.options.cookiePath ? '; path=' + that.options.cookiePath : '', that.options.cookieDomain ? '; domain=' + that.options.cookieDomain : ''].join('');
                    break;
                case 'localStorage':
                    localStorage.removeItem(cookieName);
                    break;
                case 'sessionStorage':
                    sessionStorage.removeItem(cookieName);
                    break;

            }
            return true;
        };

        var calculateExpiration = function calculateExpiration(cookieExpire) {
            var time = cookieExpire.replace(/[0-9]*/, ''); //s,mi,h,d,m,y
            cookieExpire = cookieExpire.replace(/[A-Za-z]{1,2}/, ''); //number

            switch (time.toLowerCase()) {
                case 's':
                    cookieExpire = +cookieExpire;
                    break;
                case 'mi':
                    cookieExpire = cookieExpire * 60;
                    break;
                case 'h':
                    cookieExpire = cookieExpire * 60 * 60;
                    break;
                case 'd':
                    cookieExpire = cookieExpire * 24 * 60 * 60;
                    break;
                case 'm':
                    cookieExpire = cookieExpire * 30 * 24 * 60 * 60;
                    break;
                case 'y':
                    cookieExpire = cookieExpire * 365 * 24 * 60 * 60;
                    break;
                default:
                    cookieExpire = undefined;
                    break;
            }
            if (!cookieExpire) {
                return '';
            }
            var d = new Date();
            d.setTime(d.getTime() + cookieExpire * 1000);
            return d.toGMTString();
        };

        var initCookieFilters = function initCookieFilters(bootstrapTable) {
            setTimeout(function () {
                var parsedCookieFilters = JSON.parse(getCookie(bootstrapTable, bootstrapTable.options.cookieIdTable, cookieIds.filterControl));

                if (!bootstrapTable.options.filterControlValuesLoaded && parsedCookieFilters) {

                    var cachedFilters = {},
                        header = getCurrentHeader(bootstrapTable),
                        searchControls = getCurrentSearchControls(bootstrapTable),
                        applyCookieFilters = function applyCookieFilters(element, filteredCookies) {
                        $(filteredCookies).each(function (i, cookie) {
                            if (cookie.text !== '') {
                                $(element).val(cookie.text);
                                cachedFilters[cookie.field] = cookie.text;
                            }
                        });
                    };

                    header.find(searchControls).each(function () {
                        var field = $(this).closest('[data-field]').data('field'),
                            filteredCookies = $.grep(parsedCookieFilters, function (cookie) {
                            return cookie.field === field;
                        });

                        applyCookieFilters(this, filteredCookies);
                    });

                    bootstrapTable.initColumnSearch(cachedFilters);
                    bootstrapTable.options.filterControlValuesLoaded = true;
                    bootstrapTable.initServer();
                }
            }, 250);
        };

        $.extend($.fn.bootstrapTable.defaults, {
            cookie: false,
            cookieExpire: '2h',
            cookiePath: null,
            cookieDomain: null,
            cookieSecure: null,
            cookieIdTable: '',
            cookiesEnabled: ['bs.table.sortOrder', 'bs.table.sortName', 'bs.table.pageNumber', 'bs.table.pageList', 'bs.table.columns', 'bs.table.searchText', 'bs.table.filterControl'],
            cookieStorage: 'cookieStorage', //localStorage, sessionStorage
            //internal variable
            filterControls: [],
            filterControlValuesLoaded: false
        });

        $.fn.bootstrapTable.methods.push('getCookies');
        $.fn.bootstrapTable.methods.push('deleteCookie');

        $.extend($.fn.bootstrapTable.utils, {
            setCookie: setCookie,
            getCookie: getCookie
        });

        var BootstrapTable = $.fn.bootstrapTable.Constructor,
            _init = BootstrapTable.prototype.init,
            _initTable = BootstrapTable.prototype.initTable,
            _initServer = BootstrapTable.prototype.initServer,
            _onSort = BootstrapTable.prototype.onSort,
            _onPageNumber = BootstrapTable.prototype.onPageNumber,
            _onPageListChange = BootstrapTable.prototype.onPageListChange,
            _onPagePre = BootstrapTable.prototype.onPagePre,
            _onPageNext = BootstrapTable.prototype.onPageNext,
            _toggleColumn = BootstrapTable.prototype.toggleColumn,
            _selectPage = BootstrapTable.prototype.selectPage,
            _onSearch = BootstrapTable.prototype.onSearch;

        BootstrapTable.prototype.init = function () {
            this.options.filterControls = [];
            this.options.filterControlValuesLoaded = false;

            this.options.cookiesEnabled = typeof this.options.cookiesEnabled === 'string' ? this.options.cookiesEnabled.replace('[', '').replace(']', '').replace(/ /g, '').toLowerCase().split(',') : this.options.cookiesEnabled;

            if (this.options.filterControl) {
                var that = this;
                this.$el.on('column-search.bs.table', function (e, field, text) {
                    var isNewField = true;

                    for (var i = 0; i < that.options.filterControls.length; i++) {
                        if (that.options.filterControls[i].field === field) {
                            that.options.filterControls[i].text = text;
                            isNewField = false;
                            break;
                        }
                    }
                    if (isNewField) {
                        that.options.filterControls.push({
                            field: field,
                            text: text
                        });
                    }

                    setCookie(that, cookieIds.filterControl, JSON.stringify(that.options.filterControls));
                }).on('created-controls.bs.table', initCookieFilters(that));
            }
            _init.apply(this, Array.prototype.slice.apply(arguments));
        };

        BootstrapTable.prototype.initServer = function () {
            var bootstrapTable = this;
            if (bootstrapTable.options.cookie && bootstrapTable.options.filterControl && !bootstrapTable.options.filterControlValuesLoaded) {
                var cookie = JSON.parse(getCookie(bootstrapTable, bootstrapTable.options.cookieIdTable, cookieIds.filterControl));
                if (cookie) return;
            }
            _initServer.apply(this, Array.prototype.slice.apply(arguments));
        };

        BootstrapTable.prototype.initTable = function () {
            _initTable.apply(this, Array.prototype.slice.apply(arguments));
            this.initCookie();
        };

        BootstrapTable.prototype.initCookie = function () {
            if (!this.options.cookie) {
                return;
            }

            if (this.options.cookieIdTable === '' || this.options.cookieExpire === '' || !cookieEnabled()) {
                console.error("Configuration error. Please review the cookieIdTable, cookieExpire properties, if those properties are ok, then this browser does not support the cookies");
                this.options.cookie = false; //Make sure that the cookie extension is disabled
                return;
            }

            var sortOrderCookie = getCookie(this, this.options.cookieIdTable, cookieIds.sortOrder),
                sortOrderNameCookie = getCookie(this, this.options.cookieIdTable, cookieIds.sortName),
                pageNumberCookie = getCookie(this, this.options.cookieIdTable, cookieIds.pageNumber),
                pageListCookie = getCookie(this, this.options.cookieIdTable, cookieIds.pageList),
                columnsCookie = JSON.parse(getCookie(this, this.options.cookieIdTable, cookieIds.columns)),
                searchTextCookie = getCookie(this, this.options.cookieIdTable, cookieIds.searchText);

            //sortOrder
            this.options.sortOrder = sortOrderCookie ? sortOrderCookie : this.options.sortOrder;
            //sortName
            this.options.sortName = sortOrderNameCookie ? sortOrderNameCookie : this.options.sortName;
            //pageNumber
            this.options.pageNumber = pageNumberCookie ? +pageNumberCookie : this.options.pageNumber;
            //pageSize
            this.options.pageSize = pageListCookie ? pageListCookie === this.options.formatAllRows() ? pageListCookie : +pageListCookie : this.options.pageSize;
            //searchText
            this.options.searchText = searchTextCookie ? searchTextCookie : '';

            if (columnsCookie) {
                $.each(this.columns, function (i, column) {
                    column.visible = $.inArray(column.field, columnsCookie) !== -1;
                });
            }
        };

        BootstrapTable.prototype.onSort = function () {
            _onSort.apply(this, Array.prototype.slice.apply(arguments));
            setCookie(this, cookieIds.sortOrder, this.options.sortOrder);
            setCookie(this, cookieIds.sortName, this.options.sortName);
        };

        BootstrapTable.prototype.onPageNumber = function () {
            _onPageNumber.apply(this, Array.prototype.slice.apply(arguments));
            setCookie(this, cookieIds.pageNumber, this.options.pageNumber);
            return false;
        };

        BootstrapTable.prototype.onPageListChange = function () {
            _onPageListChange.apply(this, Array.prototype.slice.apply(arguments));
            setCookie(this, cookieIds.pageList, this.options.pageSize);
            setCookie(this, cookieIds.pageNumber, this.options.pageNumber);
            return false;
        };

        BootstrapTable.prototype.onPagePre = function () {
            _onPagePre.apply(this, Array.prototype.slice.apply(arguments));
            setCookie(this, cookieIds.pageNumber, this.options.pageNumber);
            return false;
        };

        BootstrapTable.prototype.onPageNext = function () {
            _onPageNext.apply(this, Array.prototype.slice.apply(arguments));
            setCookie(this, cookieIds.pageNumber, this.options.pageNumber);
            return false;
        };

        BootstrapTable.prototype.toggleColumn = function () {
            _toggleColumn.apply(this, Array.prototype.slice.apply(arguments));

            var visibleColumns = [];

            $.each(this.columns, function (i, column) {
                if (column.visible) {
                    visibleColumns.push(column.field);
                }
            });

            setCookie(this, cookieIds.columns, JSON.stringify(visibleColumns));
        };

        BootstrapTable.prototype.selectPage = function (page) {
            _selectPage.apply(this, Array.prototype.slice.apply(arguments));
            setCookie(this, cookieIds.pageNumber, page);
        };

        BootstrapTable.prototype.onSearch = function () {
            var target = Array.prototype.slice.apply(arguments);
            _onSearch.apply(this, target);

            if ($(target[0].currentTarget).parent().hasClass('search')) {
                setCookie(this, cookieIds.searchText, this.searchText);
            }
            setCookie(this, cookieIds.pageNumber, this.options.pageNumber);
        };

        BootstrapTable.prototype.getCookies = function () {
            var bootstrapTable = this;
            var cookies = {};
            $.each(cookieIds, function (key, value) {
                cookies[key] = getCookie(bootstrapTable, bootstrapTable.options.cookieIdTable, value);
                if (key === 'columns') {
                    cookies[key] = JSON.parse(cookies[key]);
                }
            });
            return cookies;
        };

        BootstrapTable.prototype.deleteCookie = function (cookieName) {
            if (cookieName === '' || !cookieEnabled()) {
                return;
            }

            deleteCookie(this, this.options.cookieIdTable, cookieIds[cookieName]);
        };
    })(jQuery);
});