web-apps/apps/spreadsheeteditor/main/app/controller/Statusbar.js

/*
 *
 * (c) Copyright Ascensio System SIA 2010-2019
 *
 * This program is a free software product. You can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License (AGPL)
 * version 3 as published by the Free Software Foundation. In accordance with
 * Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
 * that Ascensio System SIA expressly excludes the warranty of non-infringement
 * of any third-party rights.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
 * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
 *
 * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
 * street, Riga, Latvia, EU, LV-1050.
 *
 * The  interactive user interfaces in modified source and object code versions
 * of the Program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU AGPL version 3.
 *
 * Pursuant to Section 7(b) of the License you must retain the original Product
 * logo when distributing the program. Pursuant to Section 7(e) we decline to
 * grant you any rights under trademark law for use of our trademarks.
 *
 * All the Product's GUI elements, including illustrations and icon sets, as
 * well as technical writing content are licensed under the terms of the
 * Creative Commons Attribution-ShareAlike 4.0 International. See the License
 * terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
 *
*/
/**
 *  Statusbar.js
 *
 *  Statusbar controller
 *
 *    Created by Maxim Kadushkin on 27 March 2014
 *  Copyright (c) 2018 Ascensio System SIA. All rights reserved.
 *
 */

define([
    'core',
    'spreadsheeteditor/main/app/view/Statusbar'
], function () {
    'use strict';

    SSE.Controllers.Statusbar = Backbone.Controller.extend(_.extend({
        models: [],
        collections: [],
        views: [
            'Statusbar'
        ],

        initialize: function() {
            this.addListeners({
                'Statusbar': {
                    'show:hidden': _.bind(function (obj, index) {
                        this.hideWorksheet(false, index);
                    }, this),
                    'sheet:changename': _.bind(function(){
                        this.api.asc_closeCellEditor();
                        this.renameWorksheet();
                    },this),
                    'sheet:setcolor':       _.bind(this.setWorksheetColor, this),
                    'sheet:updateColors':   _.bind(this.updateTabsColors, this),
                    'sheet:move':           _.bind(this.moveWorksheet, this)
                }
            });
        },

        events: function() {
            return {
                'click #status-btn-zoomdown': _.bind(this.zoomDocument,this,'down'),
                'click #status-btn-zoomup': _.bind(this.zoomDocument,this,'up'),
                'click .cnt-zoom': _.bind(this.onZoomShow, this)
            };
        },

        onLaunch: function() {
            this.statusbar = this.createView('Statusbar').render();
            this.statusbar.$el.css('z-index', 10);
            this.statusbar.labelZoom.css('min-width', 80);
            this.statusbar.zoomMenu.on('item:click', _.bind(this.menuZoomClick, this));

            this.bindViewEvents(this.statusbar, this.events);

            $('#id-tab-menu-new-color', this.statusbar.$el).on('click', _.bind(this.onNewBorderColor, this));
        },

        setApi: function(api) {
            this.api = api;
            this.api.asc_registerCallback('asc_onZoomChanged',   _.bind(this.onZoomChange, this));
            this.api.asc_registerCallback('asc_onSelectionMathChanged',   _.bind(this.onApiMathChanged, this));
            this.api.asc_registerCallback('asc_onCoAuthoringDisconnect', _.bind(this.onApiDisconnect, this));
            Common.NotificationCenter.on('api:disconnect',               _.bind(this.onApiDisconnect, this));
            this.api.asc_registerCallback('asc_onUpdateTabColor', _.bind(this.onApiUpdateTabColor, this));
            this.api.asc_registerCallback('asc_onEditCell', _.bind(this.onApiEditCell, this));
            /** coauthoring begin **/
            this.api.asc_registerCallback('asc_onWorkbookLocked', _.bind(this.onWorkbookLocked, this));
            this.api.asc_registerCallback('asc_onWorksheetLocked', _.bind(this.onWorksheetLocked, this));
            /** coauthoring end **/
            this.api.asc_registerCallback('asc_onError', _.bind(this.onError, this));
            this.api.asc_registerCallback('asc_onFilterInfo',   _.bind(this.onApiFilterInfo , this));
            this.api.asc_registerCallback('asc_onActiveSheetChanged', _.bind(this.onApiActiveSheetChanged, this));

            this.statusbar.setApi(api);
        },

        zoomDocument: function(d,e) {
            switch (d) {
                case 'up':
                    var f = Math.floor(this.api.asc_getZoom() * 10)/10;
                    f += .1;
                    !(f > 2.) && this.api.asc_setZoom(f);
                    break;
                case 'down':
                    f = Math.ceil(this.api.asc_getZoom() * 10)/10;
                    f -= .1;
                    !(f < .5) && this.api.asc_setZoom(f);
                    break;
            }
            Common.NotificationCenter.trigger('edit:complete', this.statusbar);
        },

        menuZoomClick: function(menu, item) {
            this.api.asc_setZoom(item.value/100);
            Common.NotificationCenter.trigger('edit:complete', this.statusbar);
        },

        /*
        *   api events
        * */

        onZoomChange: function(percent, type) {
            this.statusbar.labelZoom.text(Common.Utils.String.format(this.zoomText, Math.floor((percent +.005)*100)));
        },

        onApiDisconnect: function() {
            this.SetDisabled(true);
        },

        SetDisabled: function(state) {
            this.statusbar.setMode({isDisconnected: state});
            this.statusbar.update();
        },

        /** coauthoring begin **/
        onWorkbookLocked: function(locked) {
            this.statusbar.tabbar[locked?'addClass':'removeClass']('coauth-locked');
            this.statusbar.btnAddWorksheet.setDisabled(locked || this.api.isCellEdited || this.statusbar.rangeSelectionMode==Asc.c_oAscSelectionDialogType.Chart ||
                                                                                          this.statusbar.rangeSelectionMode==Asc.c_oAscSelectionDialogType.FormatTable);
            var item, i = this.statusbar.tabbar.getCount();
            while (i-- > 0) {
                item = this.statusbar.tabbar.getAt(i);
                if (item.sheetindex >= 0) {
//                        if (locked) item.reorderable = false;
//                        else item.reorderable = !this.api.asc_isWorksheetLockedOrDeleted(item.sheetindex);
                } else {
                    item.disable(locked);
                }
            }
        },

        onWorksheetLocked: function(index,locked) {
            var count = this.statusbar.tabbar.getCount(), tab;
            for (var i = count; i-- > 0; ) {
                tab = this.statusbar.tabbar.getAt(i);
                if (index == tab.sheetindex) {
                    tab[locked?'addClass':'removeClass']('coauth-locked');
                    tab.isLockTheDrag = locked || (this.statusbar.rangeSelectionMode==Asc.c_oAscSelectionDialogType.FormatTable);
                    break;
                }
            }
        },
        /** coauthoring end **/

        onApiMathChanged: function(info) {
//            info.asc_getCountNumbers();
//            info.asc_getMin();
//            info.asc_getMax();

            this.statusbar.setMathInfo({
                count   : info.asc_getCount(),
                average : info.asc_getAverage(),
                min     : info.asc_getMin(),
                max     : info.asc_getMax(),
                sum     : info.asc_getSum()
            });
            this.statusbar.updateTabbarBorders();
        },

        onApiFilterInfo: function(countFilter, countRecords) {
            this.statusbar.setFilteredInfo(countFilter, countRecords);
            this.statusbar.updateTabbarBorders();
        },

        onApiEditCell: function(state) {
            var disableAdd = (state == Asc.c_oAscCellEditorState.editFormula),
                disable = (state != Asc.c_oAscCellEditorState.editEnd),
                mask = $('.statusbar-mask'),
                statusbar = this.statusbar;

            statusbar.isEditFormula = disableAdd;
            statusbar.btnZoomUp.setDisabled(disable);
            statusbar.btnZoomDown.setDisabled(disable);
            statusbar.labelZoom[disable?'addClass':'removeClass']('disabled');
            statusbar.btnAddWorksheet.setDisabled(disable || this.api.asc_isWorkbookLocked() || statusbar.rangeSelectionMode!=Asc.c_oAscSelectionDialogType.None);

            if (disableAdd && mask.length>0 || !disableAdd && mask.length==0) return;
            statusbar.$el.find('.statusbar').toggleClass('masked', disableAdd);
            if(disableAdd) {
                mask = $("<div class='statusbar-mask'>").appendTo(statusbar.$el);
            } else {
                mask.remove();
            }
        },

        createDelayedElements: function() {
            this.statusbar.$el.css('z-index', '');
            this.statusbar.tabMenu.on('item:click', _.bind(this.onTabMenu, this));
            this.statusbar.btnAddWorksheet.on('click', _.bind(this.onAddWorksheetClick, this));

            Common.NotificationCenter.on('window:resize', _.bind(this.onWindowResize, this));
            Common.NotificationCenter.on('cells:range',   _.bind(this.onRangeDialogMode, this));
        },

        onWindowResize: function(area) {
            this.statusbar.onTabInvisible(undefined, this.statusbar.tabbar.checkInvisible(true));
        },

        onRangeDialogMode: function (mode) {
            var islocked = this.statusbar.tabbar.hasClass('coauth-locked'),
                currentIdx = this.api.asc_getActiveWorksheetIndex();
            this.statusbar.btnAddWorksheet.setDisabled(islocked || this.api.isCellEdited || mode!=Asc.c_oAscSelectionDialogType.None);

            var item, i = this.statusbar.tabbar.getCount();
            while (i-- > 0) {
                item = this.statusbar.tabbar.getAt(i);
                if (item.sheetindex !== currentIdx) {
                    item.disable(mode==Asc.c_oAscSelectionDialogType.FormatTable);
                }
                item.isLockTheDrag = (item.hasClass('coauth-locked') || (mode!=Asc.c_oAscSelectionDialogType.None));
            }
            this.statusbar.rangeSelectionMode = mode;
        },

        onTabMenu: function(obj, item, e) {
            var me = this;
            var selectTabs = this.statusbar.tabbar.selectTabs,
                arrIndex = [];
            selectTabs.forEach(function (item) {
                arrIndex.push(item.sheetindex);
            });
            switch (item.value) {
                case 'ins':
                    var arrNames = [];
                    for(var i = 0; i < arrIndex.length; i++) {
                        arrNames.push(me.createSheetName(arrNames));
                    }
                    setTimeout(function () {
                        me.api.asc_insertWorksheet(arrNames);
                     }, 1);
                    break;
                case 'del':
                    this.deleteWorksheet(arrIndex);
                    break;
                case 'ren':
                    this.renameWorksheet();
                    break;
                case 'copy':
                    this.moveWorksheet(arrIndex, false);
                    break;
                case 'move':
                    this.moveWorksheet(arrIndex, true);
                    break;
                case 'hide':
                    setTimeout(function () {
                        me.hideWorksheet(true, arrIndex);
                    }, 1);
                    break;
            }
        },

        createSheetName: function(curArrNames) {
            var items = [], wc = this.api.asc_getWorksheetsCount();
            while (wc--) {
                items.push(this.api.asc_getWorksheetName(wc).toLowerCase());
            }

            var index = 0, name;
            while(true) {
                index++;
                name = this.strSheet + index;
                if (items.indexOf(name.toLowerCase()) < 0) break;
            }

            if (curArrNames && curArrNames.length > 0) {
                var arr = [];
                curArrNames.forEach(function (item) {
                    arr.push(item.toLowerCase());
                });
                while(arr.indexOf(name.toLowerCase()) !== -1 || items.indexOf(name.toLowerCase()) !== -1) {
                    index++;
                    name = this.strSheet + index;
                }
            }

            return name;
        },

        createCopyName: function(orig, curArrNames) {
            var wc = this.api.asc_getWorksheetsCount(), names = [];
            while (wc--) {
                names.push(this.api.asc_getWorksheetName(wc).toLowerCase());
            }

            var re = /^(.*)\((\d)\)$/.exec(orig);
            var first = re ? re[1] : orig + ' ';

            var index = 1, name;
            while(true) {
                index++;
                name = first + '(' + index + ')';
                if (names.indexOf(name.toLowerCase()) < 0) break;
            }

            if (curArrNames && curArrNames.length > 0) {
                var arr = [];
                curArrNames.forEach(function (item) {
                    arr.push(item.toLowerCase());
                });
                while(arr.indexOf(name.toLowerCase()) !== -1) {
                    index++;
                    name = first + '(' + index + ')';
                }
            }

            return name;
        },

        deleteWorksheet: function(selectTabs) {
            var me = this;

            if (this.statusbar.tabbar.tabs.length == 1 || selectTabs.length === this.statusbar.tabbar.tabs.length) {
                Common.UI.warning({msg: this.errorLastSheet});
            } else {
                Common.UI.warning({
                    msg: this.warnDeleteSheet,
                    buttons: ['ok','cancel'],
                    callback: function(btn) {
                        if (btn == 'ok' && !me.api.asc_deleteWorksheet(selectTabs)) {
                            _.delay(function(){
                                Common.UI.error({msg: me.errorRemoveSheet});
                            },10);
                        }
                    }
                });
            }
        },

        hideWorksheet: function(hide, index) {
            if ( hide ) {
                (this.statusbar.tabbar.tabs.length == 1 || index.length === this.statusbar.tabbar.tabs.length) ?
                    Common.UI.warning({msg: this.errorLastSheet}) :
                    this.api['asc_hideWorksheet'](index);
            } else {
                this.api['asc_showWorksheet'](index);
                this.loadTabColor(index);
                var me = this;
                setTimeout(function(){
                    me.statusbar.tabMenu.hide();
                }, 1);
            }
        },

        renameWorksheet: function() {
            var me = this;
            var wc = me.api.asc_getWorksheetsCount(), items = null;
            if (wc > 0) {
                var sindex = me.api.asc_getActiveWorksheetIndex();
                if (me.api.asc_isWorksheetLockedOrDeleted(sindex)) {
                    return;
                }

                var value = Common.Utils.InternalSettings.get("sse-settings-coauthmode");
                if (!value) {
                    items = [];
                    while (wc--) {
                        if (sindex !== wc) {
                            items.push(me.api.asc_getWorksheetName(wc).toLowerCase());
                        }
                    }
                }

                var tab = me.statusbar.tabbar.tabs[me.statusbar.tabbar.getActive()];
                var top = me.statusbar.$el.position().top - 115,
                    left = tab.$el.offset().left;

                var current = me.api.asc_getWorksheetName(me.api.asc_getActiveWorksheetIndex());
                var win = (new SSE.Views.Statusbar.RenameDialog({
                    current: current,
                    names: items,
                    api: me.api,
                    handler: function (btn, s) {
                        if (btn == 'ok' && s != current) {
                            me.api.asc_renameWorksheet(s);
                        }
                        me.api.asc_enableKeyEvents(true);
                    }
                }));
                if (typeof win.options.width == "number") {
                    var bodywidth = $('body').width();
                    if (left+win.options.width > bodywidth)
                        left = bodywidth - win.options.width - 5;
                }
                win.show(left, top);
            }
        },

        moveWorksheet: function(selectArr, cut, silent, index, destPos) {
            var me = this;
            var wc = me.api.asc_getWorksheetsCount(), items = [], arrIndex = [], i = -1;
            while (++i < wc) {
                if (!this.api.asc_isWorksheetHidden(i)) {
                    items.push({
                        value: me.api.asc_getWorksheetName(i),
                        inindex: i
                    });
                }
            }
            if (!_.isUndefined(selectArr)) {
                items.forEach(function (item) {
                    if (selectArr.indexOf(item.inindex) !== -1) {
                        arrIndex.push(item.inindex);
                    }
                });
            }
            if (!_.isUndefined(silent)) {
                if (_.isUndefined(selectArr)) {
                    me.api.asc_showWorksheet(items[index].inindex);

                    Common.NotificationCenter.trigger('comments:updatefilter', ['doc', 'sheet' + this.api.asc_getActiveWorksheetId()]);

                    if (!_.isUndefined(destPos)) {
                        me.api.asc_moveWorksheet(items.length === destPos ? wc : items[destPos].inindex);
                    }
                } else {
                    if (!_.isUndefined(destPos)) {
                        me.api.asc_moveWorksheet(destPos, arrIndex);
                    }
                }
                return;
            }

            (new SSE.Views.Statusbar.CopyDialog({
                title   : cut ? me.statusbar.itemMove : me.statusbar.itemCopy,
                ismove  : cut,
                names   : items,
                handler : function(btn, i) {
                    if (btn == 'ok') {
                        if (cut) {
                            me.api.asc_moveWorksheet(i == -255 ? wc : i, arrIndex);
                        } else {
                            var arrNames = [];
                            arrIndex.forEach(function (item) {
                                arrNames.push(me.createCopyName(me.api.asc_getWorksheetName(item), arrNames));
                            });
                            me.api.asc_copyWorksheet(i == -255 ? wc : i, arrNames, arrIndex);
                        }
                    }
                    me.api.asc_enableKeyEvents(true);
                }
            })).show();
        },

        onAddWorksheetClick: function(o, index, opts) {
            if (this.api) {
                this.api.asc_closeCellEditor();
                this.api.asc_addWorksheet(this.createSheetName());

                Common.NotificationCenter.trigger('comments:updatefilter', ['doc', 'sheet' + this.api.asc_getActiveWorksheetId()], false);  //  hide popover
            }
            Common.NotificationCenter.trigger('edit:complete', this.statusbar);
        },

        selectTab: function (sheetindex) {
            if (this.api) {
                var hidden = this.api.asc_isWorksheetHidden(sheetindex);
                if (!hidden) {
                    var tab = _.findWhere(this.statusbar.tabbar.tabs, {sheetindex: sheetindex});
                    if (tab) {
                        this.statusbar.tabbar.setActive(tab);
                    }
                }
            }
        },

        moveCurrentTab: function (direction) {
            if (this.api) {
                var indTab = 0,
                    tabBar = this.statusbar.tabbar,
                    index = this.api.asc_getActiveWorksheetIndex(),
                    length = tabBar.tabs.length;

                this.statusbar.tabMenu.hide();
                this.api.asc_closeCellEditor();

                for (var i = 0; i < length; ++i) {
                    if (tabBar.tabs[i].sheetindex === index) {
                        indTab = i;

                        if (direction > 0) {
                            indTab++;
                            if (indTab >= length) {
                                indTab = 0;
                            }
                        } else {
                            indTab--;
                            if (indTab < 0) {
                                indTab = length - 1;
                            }
                        }

                        tabBar.setActive(indTab);
                        this.api.asc_showWorksheet(tabBar.getAt(indTab).sheetindex);

                        break;
                    }
                }
            }
        },

        // colors

        onApiUpdateTabColor: function (index) {
            this.loadTabColor(index);
        },

        setWorksheetColor: function (color) {
            var me = this;
            if (this.api) {
                var selectTabs = this.statusbar.tabbar.selectTabs,
                    arrIndex = [];
                selectTabs.forEach(function (item) {
                    arrIndex.push(item.sheetindex);
                });
                if (arrIndex) {
                    if ('transparent' === color) {
                        this.api.asc_setWorksheetTabColor(null, arrIndex);
                        selectTabs.forEach(function (tab) {
                            tab.$el.find('a').css('box-shadow', '');
                        });
                    } else {
                        var asc_clr = Common.Utils.ThemeColor.getRgbColor(color);
                        if (asc_clr) {
                            this.api.asc_setWorksheetTabColor(asc_clr, arrIndex);
                            selectTabs.forEach(function (tab) {
                                me.setTabLineColor(tab, asc_clr);
                            });
                        }
                    }
                }
            }
        },

        updateThemeColors: function() {
            var updateColors = function(picker, defaultColorIndex) {
                if (picker) {
                    var clr,
                        effectcolors = Common.Utils.ThemeColor.getEffectColors();

                    for (var i = 0; i < effectcolors.length; ++i) {
                        if (typeof(picker.currentColor) == 'object' &&
                            clr === undefined &&
                            picker.currentColor.effectId == effectcolors[i].effectId)
                            clr = effectcolors[i];
                    }

                    picker.updateColors(effectcolors, Common.Utils.ThemeColor.getStandartColors());

                    if (picker.currentColor === undefined) {
                        picker.currentColor = effectcolors[defaultColorIndex];
                    } else if (clr!==undefined) {
                        picker.currentColor = clr;
                    }
                }
            };

            if (this.statusbar) {
                updateColors(this.statusbar.mnuTabColor, 1);
            }
        },

        onNewBorderColor: function() {
            if (this.statusbar && this.statusbar.mnuTabColor) {
                this.statusbar.mnuTabColor.addNewColor();
            }
        },

        updateTabsColors: function (updateCurrentColor) {
            var i = -1,
                tabind = -1,
                color = null,
                clr = null,
                ishidden = false,
                wc = this.api.asc_getWorksheetsCount(),
                sindex = this.api.asc_getActiveWorksheetIndex();

            if (!_.isUndefined(updateCurrentColor)) {
                var toolbarController = this.application.getController('Toolbar');
                if (toolbarController) {

                    this.statusbar.mnuTabColor.updateCustomColors();

                    color = this.api.asc_getWorksheetTabColor(sindex);
                    if (color) {
                        if (color.get_type() == Asc.c_oAscColor.COLOR_TYPE_SCHEME) {
                            clr = {color: Common.Utils.ThemeColor.getHexColor(color.get_r(), color.get_g(), color.get_b()), effectValue: color.get_value() };
                        } else {
                            clr = Common.Utils.ThemeColor.getHexColor(color.get_r(), color.get_g(), color.get_b());
                        }
                    }

                    if (_.isObject(clr)) {
                        var isselected = false;
                        for (i = 0; i < 10; i++) {
                            if (Common.Utils.ThemeColor.ThemeValues[i] === clr.effectValue) {
                                this.statusbar.mnuTabColor.select(clr, true);
                                isselected = true;
                                break;
                            }
                        }
                        if (!isselected) this.statusbar.mnuTabColor.clearSelection();
                    } else {
                        this.statusbar.mnuTabColor.select(clr || 'transparent', true);
                    }
                }
            }

            i = -1;

            while (++i < wc) {
                ++tabind;

                ishidden = this.api.asc_isWorksheetHidden(i);
                if (ishidden) {
                    --tabind;
                }

                if (!ishidden) {
                    this.setTabLineColor(this.statusbar.tabbar.getAt(tabind), this.api.asc_getWorksheetTabColor(i));
                }
            }
        },

        loadTabColor: function (sheetindex) {
            if (this.api) {
                if (!this.api.asc_isWorksheetHidden(sheetindex)) {
                    var tab = _.findWhere(this.statusbar.tabbar.tabs, {sheetindex: sheetindex});
                    if (tab) {
                        this.setTabLineColor(tab, this.api.asc_getWorksheetTabColor(sheetindex));
                    }
                }
            }
        },

        setTabLineColor: function (tab, color) {
            if (tab) {
                 if (null !== color) {
                    color = '#' + Common.Utils.ThemeColor.getHexColor(color.get_r(), color.get_g(), color.get_b());
                } else {
                    color = '';
                }

                if (color.length) {
                    if (!tab.isActive()) {
                        color = '0px 3px 0 ' + Common.Utils.RGBColor(color).toRGBA(0.7) + ' inset';
                    } else {
                        color = '0px 3px 0 ' + color + ' inset';
                    }

                    tab.$el.find('a').css('box-shadow', color);
                } else {
                    tab.$el.find('a').css('box-shadow', '');
                }
            }
        },

        onZoomShow: function(e){
            if (e.target.classList.contains('disabled')) {
                return false;
            }
        },

        onError: function(id, level, errData) {
            if (id == Asc.c_oAscError.ID.LockedWorksheetRename)
                this.statusbar.update();
        },

        onApiActiveSheetChanged: function (index) {
            this.statusbar.tabMenu.hide();
        },

        zoomText        : 'Zoom {0}%',
        errorLastSheet  : 'Workbook must have at least one visible worksheet.',
        errorRemoveSheet: 'Can\'t delete the worksheet.',
        warnDeleteSheet : 'The worksheet maybe has data. Proceed operation?',
        strSheet        : 'Sheet'
    }, SSE.Controllers.Statusbar || {}));
});