Skip to content

EspoCRM – Open Source CRM Application

12.9 KB
Raw Blame
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM – Open Source CRM application.
 * Copyright (C) 2014-2026 EspoCRM, Inc.
 * Website: https://www.espocrm.com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://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 Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

import Select from 'ui/select';
import moment from 'moment';
import BaseFieldView from 'views/fields/base';

class MeetingRemindersField extends BaseFieldView {

    detailTemplate = 'crm:meeting/fields/reminders/detail'
    listTemplate = 'crm:meeting/fields/reminders/detail'
    editTemplate = 'crm:meeting/fields/reminders/edit'

    /**
     * @private
     * @type {string}
     */
    dateField = 'dateStart'

    /**
     * @private
     * @type {boolean}
     */
    isDateTimeOptional

    /**
     * @private
     * @type {number}
     */
    minAllDaySeconds = 120 * 60

    getAttributeList() {
        return [this.name];
    }

    setup() {
        this.addActionHandler('addReminder', () => this.actionAddReminder());

        this.addActionHandler('removeReminder', (e, target) => {
            const element = target.closest('.reminder');

            const index = Array.from(element.parentElement.childNodes).indexOf(element);

            this.removeReminder(index);
        });

        this.setupReminderList();

        this.listenTo(this.model, 'change:' + this.name, () => {
            this.reminderList = Espo.Utils
                .cloneDeep(this.model.get(this.name) || []);
        });

        this.typeList = Espo.Utils
            .clone(this.getMetadata().get('entityDefs.Reminder.fields.type.options') || []);
        this.secondsList = Espo.Utils
            .clone(this.getMetadata().get('entityDefs.Reminder.fields.seconds.options') || []);

        this.dateField = this.model.getFieldParam(this.name, 'dateField') || this.dateField;

        this.listenTo(this.model, 'change:' + this.dateField, () => {
            if (this.isEditMode()) {
                this.reRender();
            }
        });

        this.isDateTimeOptional = this.model.getFieldParam(this.dateField, 'type') === 'datetimeOptional';
    }

    /**
     * @private
     */
    setupReminderList() {
        if (this.model.isNew() && !this.model.get(this.name) && this.model.entityType !== 'Preferences') {
            let param = 'defaultReminders';

            if (this.model.entityType === 'Task') {
                param = 'defaultRemindersTask';
            }

            this.reminderList = this.getPreferences().get(param) || [];
        } else {
            this.reminderList = this.model.get(this.name) || [];
        }

        this.reminderList = Espo.Utils.cloneDeep(this.reminderList);
    }

    afterRender() {
        if (this.isEditMode()) {
            this.$container = this.$el.find('.reminders-container');

            this.reminderList.forEach(item => {
                this.addItemHtml(item);
            });
        }
    }

    focusOnButton() {
        // noinspection JSUnresolvedReference
        this.$el.find('button[data-action="addReminder"]')
            .get(0)
            .focus({preventScroll: true});
    }

    /**
     * @private
     * @param {string} type
     * @param {number} index
     */
    updateType(type, index) {
        this.reminderList[index].type = type;
        this.trigger('change');
    }

    /**
     * @private
     * @param {number} seconds
     * @param {number} index
     */
    updateSeconds(seconds, index) {
        this.reminderList[index].seconds = seconds;
        this.trigger('change');
    }

    /**
     * @private
     * @param {{type: string, seconds: number}} item
     */
    addItemHtml(item) {
        const $item = $('<div>').addClass('input-group').addClass('reminder');

        const $type = $('<select>')
            .attr('name', 'type')
            .attr('data-name', 'type')
            .addClass('form-control');

        this.typeList.forEach(type => {
            const $o = $('<option>')
                .attr('value', type)
                .text(this.getLanguage().translateOption(type, 'reminderTypes'));

            $type.append($o);
        });

        $type.val(item.type)
            .addClass('radius-left');

        $type.on('change', () => {
            this.updateType($type.val(), $type.closest('.reminder').index());
        });

        const $seconds = $('<select>')
            .attr('name', 'seconds')
            .attr('data-name', 'seconds')
            .addClass('form-control radius-right');

        const limitDate = this.model.get(this.dateField) ?
            this.getDateTime().toMoment(this.model.get(this.dateField)) : null;

        /** @var {number[]} secondsList */
        let secondsList = Espo.Utils.clone(this.secondsList);

        if (this.isDateTimeOptional && this.model.attributes[this.dateField + 'Date']) {
            secondsList = secondsList.filter(seconds => !seconds || seconds >= this.minAllDaySeconds);
        }

        if (!secondsList.includes(item.seconds)) {
            secondsList.push(item.seconds);
        }

        secondsList
            .filter(seconds => {
                return seconds === item.seconds || !limitDate ||
                    this.isBefore(seconds, limitDate);
            })
            .sort((a, b) => a - b)
            .forEach(seconds => {
                const $o = $('<option>')
                    .attr('value', seconds)
                    .text(this.stringifySeconds(seconds));

                $seconds.append($o);
            });

        $seconds.val(item.seconds);

        $seconds.on('change', () => {
            const seconds = parseInt($seconds.val());
            const index = $seconds.closest('.reminder').index();

            this.updateSeconds(seconds, index);
        });

        const $remove = $('<button>')
            .addClass('btn')
            .addClass('btn-link')
            .css('margin-left', '5px')
            .attr('type', 'button')
            .attr('data-action', 'removeReminder')
            .html('<span class="fas fa-times"></span>');

        $item
            .append($('<div class="input-group-item">').append($type))
            .append($('<div class="input-group-item">').append($seconds))
            .append($('<div class="input-group-btn">').append($remove));

        this.$container.append($item);

        Select.init($type, {});
        Select.init($seconds, {
            sortBy: '$score',
            sortDirection: 'desc',
            /**
             * @param {string} search
             * @param {{value: string, text: string}} item
             * @return {number}
             */
            score: (search, item) => {
                const num = parseInt(item.value);
                const searchNum = parseInt(search);

                if (isNaN(searchNum)) {
                    return 0;
                }

                const boost = item.value.startsWith(search) ? 1 : 0;

                const numOpposite = Number.MAX_SAFE_INTEGER - num + boost;

                if (/[a-z]/i.test(search) && item.text) {
                    return item.text.startsWith(search) ? 1 : 0;
                }

                if (searchNum === 0 && num === 0) {
                    return numOpposite;
                }

                if (searchNum * 60 === num) {
                    return numOpposite;
                }

                if (searchNum * 60 * 60 === num) {
                    return numOpposite;
                }

                if (searchNum * 60 * 60 * 24 === num) {
                    return numOpposite;
                }

                return 0;
            },
            load: (item, callback) => {
                const num = parseInt(item);

                if (isNaN(num) || num < 0) {
                    return;
                }

                if (num > 59) {
                    return;
                }

                const list = [];

                const mSeconds = num * 60;

                if (!this.isBefore(mSeconds, limitDate)) {
                    return;
                }

                list.push({
                    value: mSeconds.toString(),
                    text: this.stringifySeconds(mSeconds),
                });

                if (num <= 24) {
                    const hSeconds = num * 3600;

                    if (this.isBefore(hSeconds, limitDate)) {
                        list.push({
                            value: hSeconds.toString(),
                            text: this.stringifySeconds(hSeconds),
                        });
                    }
                }

                if (num <= 30) {
                    const dSeconds = num * 3600 * 24;

                    if (this.isBefore(dSeconds, limitDate)) {
                        list.push({
                            value: dSeconds.toString(),
                            text: this.stringifySeconds(dSeconds),
                        });
                    }
                }

                callback(list);
            }
        });
    }

    /**
     * @private
     * @param {number} seconds
     * @param {moment.Moment} limitDate
     * @return {boolean}
     */
    isBefore(seconds, limitDate) {
        return moment.utc().add(seconds, 'seconds').isBefore(limitDate);
    }

    /**
     * @private
     * @param {number} totalSeconds
     * @return {string}
     */
    stringifySeconds(totalSeconds) {
        if (!totalSeconds) {
            return this.translate('on time', 'labels', 'Meeting');
        }

        let d = totalSeconds;
        const days = Math.floor(d / 86400);
        d = d % 86400;
        const hours = Math.floor(d / 3600);
        d = d % 3600;
        const minutes = Math.floor(d / 60);
        const seconds = d % 60;

        const parts = [];

        if (days) {
            parts.push(days + '' + this.getLanguage().translate('d', 'durationUnits'));
        }

        if (hours) {
            parts.push(hours + '' + this.getLanguage().translate('h', 'durationUnits'));
        }

        if (minutes) {
            parts.push(minutes + '' + this.getLanguage().translate('m', 'durationUnits'));
        }

        if (seconds) {
            parts.push(seconds + '' + this.getLanguage().translate('s', 'durationUnits'));
        }

        return parts.join(' ') + ' ' + this.translate('before', 'labels', 'Meeting');
    }

    /**
     * @private
     * @param {{type: string, seconds: number}} item
     * @return {string}
     */
    getDetailItemHtml(item) {
        return $('<div>')
            .append(
                $('<span>').text(this.getLanguage().translateOption(item.type, 'reminderTypes')),
                ' ',
                $('<span>').text(this.stringifySeconds(item.seconds))
            )
            .get(0).outerHTML;
    }

    getValueForDisplay() {
        if (this.isDetailMode() || this.isListMode()) {
            let html = '';

            this.reminderList.forEach(item => {
                html += this.getDetailItemHtml(item);
            });

            return html;
        }
    }

    fetch() {
        const data = {};

        data[this.name] = Espo.Utils.cloneDeep(this.reminderList);

        return data;
    }

    /**
     * @private
     */
    actionAddReminder() {
        const type = this.getMetadata().get('entityDefs.Reminder.fields.type.default');
        const seconds = this.getMetadata().get('entityDefs.Reminder.fields.seconds.default') || 0;

        const item = {
            type: type,
            seconds: seconds,
        };

        this.reminderList.push(item);

        this.addItemHtml(item);
        this.trigger('change');

        this.focusOnButton();
    }

    /**
     * @private
     * @param {number} index
     */
    removeReminder(index) {
        const element = this.element.querySelectorAll('.reminder')[index] ?? null;

        if (!element) {
            return;
        }

        element.parentElement.removeChild(element);

        this.reminderList.splice(index, 1);

        this.focusOnButton();
    }
}

export default MeetingRemindersField;