espocrm-base/client/src/dynamic-logic.js

/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2015 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
 * Website: http://www.espocrm.com
 *
 * EspoCRM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

Espo.define('dynamic-logic', [], function () {

    var DynamicLogic = function (defs, recordView) {
        this.defs = defs || {};
        this.recordView = recordView;

        this.fieldTypeList = ['visible', 'hidden', 'required', 'notRequired', 'readOnly', 'notReadOnly'];
        this.panelTypeList = ['visible', 'hidden'];

        this.optionsDirtyMap = {};
        this.originalOptions = {};
    }

    _.extend(DynamicLogic.prototype, {

        process: function () {
            var fields = this.defs.fields || {};
            Object.keys(fields).forEach(function (field) {
                var item = (fields[field] || {});
                this.fieldTypeList.forEach(function (type) {
                    if (!(type in item)) return;
                    var conditionGroup = (item[type] || {}).conditionGroup;
                    if (!conditionGroup) return;
                    var methodName;
                    if (this.checkConditionGroup(conditionGroup)) {
                        methodName = 'makeField' + Espo.Utils.upperCaseFirst(type) + 'True';
                    } else {
                        methodName = 'makeField' + Espo.Utils.upperCaseFirst(type) + 'False';
                    }
                    this[methodName](field);
                }, this);
            }, this);

            var panels = this.defs.panels || {};
            Object.keys(panels).forEach(function (panel) {
                var item = (panels[panel] || {});
                this.panelTypeList.forEach(function (type) {
                    if (!(type in item)) return;
                    var conditionGroup = (item[type] || {}).conditionGroup;
                    if (!conditionGroup) return;
                    var methodName;
                    if (this.checkConditionGroup(conditionGroup)) {
                        methodName = 'makePanel' + Espo.Utils.upperCaseFirst(type) + 'True';
                    } else {
                        methodName = 'makePanel' + Espo.Utils.upperCaseFirst(type) + 'False';
                    }
                    this[methodName](panel);
                }, this);
            }, this);

            var options = this.defs.options || {};
            Object.keys(options).forEach(function (field) {
                var itemList = options[field] || [];
                var isMet = false;
                for (var i in itemList) {
                    var item = itemList[i];
                    if (this.checkConditionGroup(item.conditionGroup)) {
                        this.setOptionList(field, item.optionList || []);
                        isMet = true;
                        break;
                    }
                }
                if (!isMet) {
                    this.resetOptionList(field);
                }
            }, this);
        },

        checkConditionGroup: function (list, type) {
            type = type || 'and';

            list = list || [];

            var result = false;
            if (type === 'and') {
                result = true;
                for (var i in list) {
                    if (!this.checkCondition(list[i])) {
                        result = false;
                        break;
                    }
                }
            } else if (type === 'or') {
                for (var i in list) {
                    if (this.checkCondition(list[i])) {
                        result = true;
                        break;
                    }
                }
            } else if (type === 'not') {
                if (list.length) {
                    result = !this.checkCondition(list[0]);
                }
            }
            return result;
        },

        checkCondition: function (defs) {
            defs = defs || {};
            var type = defs.type || 'equals';

            if (~['or', 'and', 'or'].indexOf(type)) {
                return this.checkConditionGroup(defs.value, type);
            }

            if (type === 'equals') {
                var attribute = defs.attribute;
                var value = defs.value;
                if (!attribute) return;
                if (!value) return;
                if (this.recordView.model.get(attribute) === value) {
                    return true;
                }
            }
            return false;
        },

        setOptionList: function (field, optionList) {
            this.recordView.setFieldOptionList(field, optionList);
        },

        resetOptionList: function (field) {
            this.recordView.resetFieldOptionList(field);
        },

        makeFieldVisibleTrue: function (field) {
            this.recordView.showField(field);
        },

        makeFieldVisibleFalse: function (field) {
            this.recordView.hideField(field);
        },

        makeFieldHiddenTrue: function (field) {
            this.recordView.hideField(field);
        },

        makeFieldHiddenFalse: function (field) {
            this.recordView.showField(field);
        },

        makeFieldRequiredTrue: function (field) {
            this.recordView.setFieldRequired(field);
        },

        makeFieldRequiredFalse: function (field) {
            this.recordView.setFieldNotRequired(field);
        },

        makeFieldNotRequiredTrue: function (field) {
            this.recordView.setFieldNotRequired(field);
        },

        makeFieldNotRequiredFalse: function (field) {
            this.recordView.setFieldRequired(field);
        },

        makeFieldReadOnlyTrue: function (field) {
            this.recordView.setFieldReadOnly(field);
        },

        makeFieldReadOnlyFalse: function (field) {
            this.recordView.setFieldNotReadOnly(field);
        },

        makeFieldNotReadOnlyTrue: function (field) {
            this.recordView.setFieldNotReadOnly(field);
        },

        makeFieldNotReadOnlyFalse: function (field) {
            this.recordView.setFieldReadOnly(field);
        },

        makePanelVisibleTrue: function (field) {
            this.recordView.showPanel(field);
        },

        makePanelVisibleFalse: function (field) {
            this.recordView.hidePanel(field);
        },

        makePanelHiddenTrue: function (field) {
            this.recordView.hidePanel(field);
        },

        makePanelHiddenFalse: function (field) {
            this.recordView.showPanel(field);
        }

    });

    return DynamicLogic;
});