Skip to content

EspoCRM – Open Source CRM Application

3.8 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 {inject} from 'di';
import Settings from 'models/settings';
import User from 'models/user';
import Ui from 'ui';

/**
 * A mass-action helper.
 */
class MassActionHelper {

    /**
     * @private
     * @type {Settings}
     */
    @inject(Settings)
    config

    /**
     * @private
     * @type {User}
     */
    @inject(User)
    user

    /**
     * A view.
     *
     * @private
     * @type {import('view').default}}
     */
    view

    /**
     * @private
     * @type {string}
     */
    entityType

    /**
     * @param {import('view').default} view A view.
     * @param {{entityType?: string}} [options] Options.
     */
    constructor(view, options = {}) {
        this.view = view;

        let entityType = options.entityType;

        if (!entityType) {
            if ('entityType' in view) {
                entityType = view.entityType;
            } else if ('scope' in view) {
                entityType = view.scope;
            }
        }

        this.entityType = entityType;
    }

    /**
     * Check whether an action should be run in idle.
     *
     * @param {number} [totalCount] A total record count.
     * @returns {boolean}
     */
    checkIsIdle(totalCount) {
        if (this.user.isPortal()) {
            return false;
        }

        if (typeof totalCount === 'undefined') {
            totalCount = this.view.options.totalCount;
        }

        if (typeof totalCount === 'undefined' && this.view.collection) {
            totalCount = this.view.collection.total;
        }

        return totalCount === -1 || totalCount > this.config.get('massActionIdleCountThreshold');
    }

    /**
     * Process.
     *
     * @param {string} id An ID.
     * @param {string} action An action.
     * @returns {Promise<import('view').default>} Resolves with a dialog view.
     *   The view emits the 'close:success' event.
     */
    process(id, action) {
        Ui.notify();

        return new Promise(async resolve => {
            const view = await this.view.createView('dialog', 'views/modals/mass-action', {
                id: id,
                action: action,
                scope: this.entityType,
            })

            view.render().then(() => {});

            resolve(view);

            this.view.listenToOnce(view, 'success', data => {
                resolve(data);

                this.view.listenToOnce(view, 'close', () => {
                    view.trigger('close:success', data);
                });
            });
        });
    }
}

export default MassActionHelper;