web-apps/apps/spreadsheeteditor/mobile/app/controller/DocumentHolder.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
 *
 */

/**
 *  DocumentHolder.js
 *
 *  Created by Maxim Kadushkin on 11/15/16
 *  Copyright (c) 2018 Ascensio System SIA. All rights reserved.
 *
 */


define([
    'core',
    'jquery',
    'underscore',
    'backbone',
    'spreadsheeteditor/mobile/app/view/DocumentHolder'
], function (core, $, _, Backbone) {
    'use strict';

    SSE.Controllers.DocumentHolder = Backbone.Controller.extend(_.extend((function() {
        // private
        var _actionSheets = [],
            _isEdit = false,
            _canViewComments = true,
            _isComments = false;

        function openLink(url) {
            var newDocumentPage = window.open(url, '_blank');

            if (newDocumentPage) {
                newDocumentPage.focus();
            }
        }

        return {
            models: [],
            collections: [],
            views: [
                'DocumentHolder'
            ],

            initialize: function() {
                this.addListeners({
                    'DocumentHolder': {
                        'contextmenu:click' : this.onContextMenuClick
                    }
                });
            },

            setApi: function(api) {
                this.api = api;

                this.api.asc_registerCallback('asc_onShowPopMenu',      _.bind(this.onApiShowPopMenu, this));
                this.api.asc_registerCallback('asc_onHidePopMenu',      _.bind(this.onApiHidePopMenu, this));
                this.api.asc_registerCallback('asc_onHyperlinkClick',   _.bind(this.onApiHyperlinkClick, this));
                Common.NotificationCenter.on('api:disconnect',          _.bind(this.onCoAuthoringDisconnect, this));
                this.api.asc_registerCallback('asc_onCoAuthoringDisconnect', _.bind(this.onCoAuthoringDisconnect,this));
            },

            setMode: function (mode) {
                _isEdit = mode.isEdit;
                if (_isEdit) {
                    this.api.asc_registerCallback('asc_onSetAFDialog',          _.bind(this.onApiFilterOptions, this));
                }
                _canViewComments = mode.canViewComments;
            },

            // When our application is ready, lets get started
            onLaunch: function() {
                var me = this;

                me.view = me.createView('DocumentHolder').render();

                $$(window).on('resize', _.bind(me.onEditorResize, me));
            },

            // Handlers

            onContextMenuClick: function (view, event) {
                var me = this;
                var info = me.api.asc_getCellInfo();

                switch (event) {
                case 'cut':
                    var res = me.api.asc_Cut();
                    if (!res) {
                        me.view.hideMenu();
                        if (!Common.localStorage.getBool("sse-hide-copy-cut-paste-warning")) {
                            uiApp.modal({
                                title: me.textCopyCutPasteActions,
                                text: me.errorCopyCutPaste,
                                afterText: '<label class="label-checkbox item-content no-ripple">' +
                                    '<input type="checkbox" name="checkbox-show-cut">' +
                                    '<div class="item-media" style="margin-top: 10px; display: flex; align-items: center;">' +
                                    '<i class="icon icon-form-checkbox"></i><span style="margin-left: 10px;">' + me.textDoNotShowAgain + '</span>' +
                                    '</div>' +
                                    '</label>',
                                buttons: [{
                                    text: 'OK',
                                    onClick: function () {
                                        var dontshow = $('input[name="checkbox-show-cut"]').prop('checked');
                                        if (dontshow) Common.localStorage.setItem("sse-hide-copy-cut-paste-warning", 1);
                                    }
                                }]
                            });
                        }
                    }
                    break;
                case 'copy':
                    var res = me.api.asc_Copy();
                    if (!res) {
                        me.view.hideMenu();
                        if (!Common.localStorage.getBool("sse-hide-copy-cut-paste-warning")) {
                            uiApp.modal({
                                title: me.textCopyCutPasteActions,
                                afterText: '<label class="label-checkbox item-content no-ripple">' +
                                    '<input type="checkbox" name="checkbox-show-copy">' +
                                    '<div class="item-media" style="margin-top: 10px; display: flex; align-items: center;">' +
                                    '<i class="icon icon-form-checkbox"></i><span style="margin-left: 10px;">' + me.textDoNotShowAgain + '</span>' +
                                    '</div>' +
                                    '</label>',
                                buttons: [{
                                    text: 'OK',
                                    onClick: function () {
                                        var dontshow = $('input[name="checkbox-show-copy"]').prop('checked');
                                        if (dontshow) Common.localStorage.setItem("sse-hide-copy-cut-paste-warning", 1);
                                    }
                                }]
                            });
                        }
                    }
                    break;
                case 'paste':
                    var res = me.api.asc_Paste();
                    if (!res) {
                        me.view.hideMenu();
                        if (!Common.localStorage.getBool("sse-hide-copy-cut-paste-warning")) {
                            uiApp.modal({
                                title: me.textCopyCutPasteActions,
                                text: me.errorCopyCutPaste,
                                afterText: '<label class="label-checkbox item-content no-ripple">' +
                                    '<input type="checkbox" name="checkbox-show-paste">' +
                                    '<div class="item-media" style="margin-top: 10px; display: flex; align-items: center;">' +
                                    '<i class="icon icon-form-checkbox"></i><span style="margin-left: 10px;">' + me.textDoNotShowAgain + '</span>' +
                                    '</div>' +
                                    '</label>',
                                buttons: [{
                                    text: 'OK',
                                    onClick: function () {
                                        var dontshow = $('input[name="checkbox-show-paste"]').prop('checked');
                                        if (dontshow) Common.localStorage.setItem("sse-hide-copy-cut-paste-warning", 1);
                                    }
                                }]
                            });
                        }
                    }
                    break;
                case 'del': me.api.asc_emptyCells(Asc.c_oAscCleanOptions.All); break;
                case 'wrap': me.api.asc_setCellTextWrap(true); break;
                case 'unwrap': me.api.asc_setCellTextWrap(false); break;
                case 'edit':
                    me.view.hideMenu();
                    SSE.getController('EditContainer').showModal();
                    // SSE.getController('EditCell').getView('EditCell');
                    break;
                case 'merge':
                    if (me.api.asc_mergeCellsDataLost(Asc.c_oAscMergeOptions.Merge)) {
                        _.defer(function () {
                            uiApp.confirm(me.warnMergeLostData, me.notcriticalErrorTitle, function(){
                                me.api.asc_mergeCells(Asc.c_oAscMergeOptions.Merge);
                            });
                        });
                    } else {
                        me.api.asc_mergeCells(Asc.c_oAscMergeOptions.Merge);
                    }
                    break;
                case 'unmerge':
                    me.api.asc_mergeCells(Asc.c_oAscMergeOptions.None);
                    break;
                case 'hide':
                    me.api[info.asc_getSelectionType() == Asc.c_oAscSelectionType.RangeRow ? 'asc_hideRows' : 'asc_hideColumns']();
                    break;
                case 'show':
                    me.api[info.asc_getSelectionType() == Asc.c_oAscSelectionType.RangeRow ? 'asc_showRows' : 'asc_showColumns']();
                    break;
                case 'addlink':
                    me.view.hideMenu();
                    SSE.getController('AddContainer').showModal({
                        panel: 'hyperlink'
                    });
                    break;
                case 'openlink':
                    var linkinfo = info.asc_getHyperlink();
                    if ( linkinfo.asc_getType() == Asc.c_oAscHyperlinkType.RangeLink ) {
                        var nameSheet = linkinfo.asc_getSheet();
                        var curActiveSheet = this.api.asc_getActiveWorksheetIndex();
                        me.api.asc_setWorksheetRange(linkinfo);
                        SSE.getController('Statusbar').onLinkWorksheetRange(nameSheet, curActiveSheet);
                    } else {
                        var url = linkinfo.asc_getHyperlinkUrl().replace(/\s/g, "%20");
                        me.api.asc_getUrlType(url) > 0 && openLink(url);
                    }
                    break;
                case 'freezePanes':
                    me.api.asc_freezePane();
                    break;
                case 'viewcomment':
                    me.view.hideMenu();
                    var cellinfo = this.api.asc_getCellInfo(),
                        comments = cellinfo.asc_getComments();
                    if (comments.length) {
                        SSE.getController('Common.Controllers.Collaboration').apiShowComments(comments[0].asc_getId());
                        SSE.getController('Common.Controllers.Collaboration').showCommentModal();
                    }
                    break;
                case 'addcomment':
                    me.view.hideMenu();
                    SSE.getController('AddContainer').showModal();
                    SSE.getController('AddOther').getView('AddOther').showPageComment(false);
                }

                if ('showActionSheet' == event && _actionSheets.length > 0) {
                    _.delay(function () {
                        _.each(_actionSheets, function (action) {
                            action.text = action.caption;
                            action.onClick = function () {
                                me.onContextMenuClick(null, action.event)
                            }
                        });

                        uiApp.actions([_actionSheets, [
                            {
                                text: me.sheetCancel,
                                bold: true
                            }
                        ]]);
                    }, 100);
                }

                me.view.hideMenu();
            },

            // API Handlers

            onEditorResize: function(cmp) {
                // Hide context menu
            },

            onApiShowPopMenu: function(posX, posY) {
                if (this.isDisconnected) return;

                if ($('.popover.settings, .popup.settings, .picker-modal.settings, .modal-in, .actions-modal').length > 0) {
                    return;
                }

                var me = this,
                    items;

                items = me._initMenu(me.api.asc_getCellInfo());

                me.view.showMenu(items, posX, posY);
            },

            onApiHidePopMenu: function() {
                this.view.hideMenu();
            },

            onApiHyperlinkClick: function(url) {
                if (!url) {
                    var me = this;
                    _.defer(function () {
                        uiApp.modal({
                            title: me.notcriticalErrorTitle,
                            text : me.errorInvalidLink,
                            buttons: [{text: 'OK'}]
                        });
                    });
                }
            },

            // Internal

            _initMenu: function (cellinfo) {
                var me = this,
                    arrItems = [],
                    arrItemsIcon = [];
                _actionSheets.length = 0;

                var iscellmenu, isrowmenu, iscolmenu, isallmenu, ischartmenu, isimagemenu, istextshapemenu, isshapemenu, istextchartmenu;
                var iscelllocked    = cellinfo.asc_getLocked(),
                    seltype         = cellinfo.asc_getSelectionType(),
                    xfs             = cellinfo.asc_getXfs();
                _isComments      = cellinfo.asc_getComments().length>0; //prohibit adding multiple comments in one cell;

                switch (seltype) {
                    case Asc.c_oAscSelectionType.RangeCells:     iscellmenu  = true;     break;
                    case Asc.c_oAscSelectionType.RangeRow:       isrowmenu   = true;     break;
                    case Asc.c_oAscSelectionType.RangeCol:       iscolmenu   = true;     break;
                    case Asc.c_oAscSelectionType.RangeMax:       isallmenu   = true;     break;
                    case Asc.c_oAscSelectionType.RangeImage:     isimagemenu = true;     break;
                    case Asc.c_oAscSelectionType.RangeShape:     isshapemenu = true;     break;
                    case Asc.c_oAscSelectionType.RangeChart:     ischartmenu = true;     break;
                    case Asc.c_oAscSelectionType.RangeChartText: istextchartmenu = true; break;
                    case Asc.c_oAscSelectionType.RangeShapeText: istextshapemenu = true; break;
                }

                if (!_isEdit) {
                    if (iscellmenu || istextchartmenu || istextshapemenu) {
                        arrItemsIcon = [{
                            caption: me.menuCopy,
                            event: 'copy',
                            icon: 'icon-copy'
                        }];
                    }
                    if (iscellmenu && cellinfo.asc_getHyperlink()) {
                        arrItems.push({
                            caption: me.menuOpenLink,
                            event: 'openlink'
                        });
                    }
                    if (_canViewComments && _isComments) {
                        arrItems.push({
                            caption: me.menuViewComment,
                            event: 'viewcomment'
                        });
                    }
                } else {

                    if (!iscelllocked && (isimagemenu || isshapemenu || ischartmenu || istextshapemenu || istextchartmenu)) {
                        this.api.asc_getGraphicObjectProps().every(function (object) {
                            if (object.asc_getObjectType() == Asc.c_oAscTypeSelectElement.Image) {
                                iscelllocked = object.asc_getObjectValue().asc_getLocked();
                            }

                            return !iscelllocked;
                        });
                    }

                    if (iscelllocked || this.api.isCellEdited) {
                        arrItemsIcon = [{
                            caption: me.menuCopy,
                            event: 'copy',
                            icon: 'icon-copy'
                        }];

                    } else {
                        var arrItemsIcon = [{
                            caption: me.menuCut,
                            event: 'cut',
                            icon: 'icon-cut'
                        }, {
                            caption: me.menuCopy,
                            event: 'copy',
                            icon: 'icon-copy'
                        }, {
                            caption: me.menuPaste,
                            event: 'paste',
                            icon: 'icon-paste'
                        }];
                        arrItems.push({
                            caption: me.menuDelete,
                            event: 'del'
                        });

                        // isTableLocked       = cellinfo.asc_getLockedTable()===true;

                        if (isimagemenu || isshapemenu || ischartmenu ||
                            istextshapemenu || istextchartmenu) {
                            arrItems.push({
                                caption: me.menuEdit,
                                event: 'edit'
                            });
                        } else {
                            if (iscolmenu || isrowmenu) {
                                arrItems.push({
                                    caption: me.menuHide,
                                    event: 'hide'
                                }, {
                                    caption: me.menuShow,
                                    event: 'show'
                                });
                            } else if (iscellmenu) {
                                !iscelllocked &&
                                arrItems.push({
                                    caption: me.menuCell,
                                    event: 'edit'
                                });

                                (cellinfo.asc_getMerge() == Asc.c_oAscMergeOptions.None) &&
                                arrItems.push({
                                    caption: me.menuMerge,
                                    event: 'merge'
                                });

                                (cellinfo.asc_getMerge() == Asc.c_oAscMergeOptions.Merge) &&
                                arrItems.push({
                                    caption: me.menuUnmerge,
                                    event: 'unmerge'
                                });

                                arrItems.push(
                                    xfs.asc_getWrapText() ?
                                        {
                                            caption: me.menuUnwrap,
                                            event: 'unwrap'
                                        } :
                                        {
                                            caption: me.menuWrap,
                                            event: 'wrap'
                                        });

                                if (cellinfo.asc_getHyperlink() && !cellinfo.asc_getMultiselect()) {
                                    arrItems.push({
                                        caption: me.menuOpenLink,
                                        event: 'openlink'
                                    });
                                } else if (!cellinfo.asc_getHyperlink() && !cellinfo.asc_getMultiselect() &&
                                    !cellinfo.asc_getLockText() && !!cellinfo.asc_getText()) {
                                    arrItems.push({
                                        caption: me.menuAddLink,
                                        event: 'addlink'
                                    });
                                }
                            }

                            arrItems.push({
                                caption: this.api.asc_getSheetViewSettings().asc_getIsFreezePane() ? me.menuUnfreezePanes : me.menuFreezePanes,
                                event: 'freezePanes'
                            });

                        }

                        if (_canViewComments) {
                            if (_isComments) {
                                arrItems.push({
                                    caption: me.menuViewComment,
                                    event: 'viewcomment'
                                });
                            } else if (iscellmenu) {
                                arrItems.push({
                                    caption: me.menuAddComment,
                                    event: 'addcomment'
                                });
                            }
                        }
                    }


                    if (Common.SharedSettings.get('phone') && arrItems.length > 2) {
                        _actionSheets = arrItems.slice(2);

                        arrItems = arrItems.slice(0, 2);
                        arrItems.push({
                            caption: me.menuMore,
                            event: 'showActionSheet'
                        });
                    }
                }

                var menuItems = {itemsIcon: arrItemsIcon, items: arrItems};

                return menuItems;
            },

            onCoAuthoringDisconnect: function() {
                this.isDisconnected = true;
            },

            onApiFilterOptions: function(config) {
                if(_isEdit) {
                    var rect = config.asc_getCellCoord(),
                        posX = rect.asc_getX() + rect.asc_getWidth() - 9,
                        posY = rect.asc_getY() + rect.asc_getHeight() - 9;
                    SSE.getController('FilterOptions').showModal(posX,posY);
                }
            },


            warnMergeLostData: 'Operation can destroy data in the selected cells.<br>Continue?',
            menuCopy:       'Copy',
            menuCut:        'Cut',
            menuPaste:      'Paste',
            menuDelete:     'Delete',
            menuAddLink:    'Add Link',
            menuOpenLink:   'Open Link',
            menuWrap:       'Wrap',
            menuUnwrap:     'Unwrap',
            menuMerge:      'Merge',
            menuUnmerge:    'Unmerge',
            menuShow:       'Show',
            menuHide:       'Hide',
            menuEdit:       'Edit',
            menuCell:       'Cell',
            menuMore:       'More',
            sheetCancel:    'Cancel',
            menuFreezePanes: 'Freeze Panes',
            menuUnfreezePanes: 'Unfreeze Panes',
            menuViewComment: 'View Comment',
            menuAddComment: 'Add Comment',
            textCopyCutPasteActions: 'Copy, Cut and Paste Actions',
            errorCopyCutPaste: 'Copy, cut and paste actions using the context menu will be performed within the current file only.',
            textDoNotShowAgain: 'Don\'t show again',
            notcriticalErrorTitle: 'Warning',
            errorInvalidLink: 'The link reference does not exist. Please correct the link or delete it.'
        }
    })(), SSE.Controllers.DocumentHolder || {}))
});