lib/editor/tiny/plugins/premium/amd/src/configuration.js

// This file is part of Moodle - http://moodle.org/
//
// Moodle 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.
//
// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
/**
 * Tiny Premium configuration.
 *
 * @module      tiny_premium/configuration
 * @copyright   2023 David Woloszyn <david.woloszyn@moodle.com>
 * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
import {
    addToolbarButton,
    addMenubarItem,
    addToolbarSection,
    addContextmenuItem
} from 'editor_tiny/utils';
import {
    getInitialPluginConfiguration,
    getPluginOptionName
} from 'editor_tiny/options';
const configureToolbar = (toolbar) => {
    // Add premium toolbar sections to house all the plugins with no natural home.
    toolbar = addToolbarSection(toolbar, 'premium_a', 'advanced', true);
    toolbar = addToolbarSection(toolbar, 'premium_b', 'formatting', true);
    return toolbar;
};
export const configure = (instanceConfig, options) => {
    // Get the namespaced options for Tiny Premium before they are officially initialised.
    // Due to the timing the plugin options are available, we need to get at the options in this slightly unconventional way.
    const pluginOptions = getInitialPluginConfiguration(options);
    const enabledPremiumPlugins = pluginOptions[getPluginOptionName('tiny_premium/plugin', 'premiumplugins')].split(',');
    let plugins = instanceConfig.plugins;
    let menu = instanceConfig.menu;
    let toolbar = configureToolbar(instanceConfig.toolbar);
    let contextmenu = instanceConfig.contextmenu;
    let pluginsettings = {};
    // Advanced Table.
    if (enabledPremiumPlugins.indexOf('advtable') !== -1) {
        plugins += ` advtable`;
        menu = addMenubarItem(menu, 'table', '| advtablerownumbering', 'advtablesort');
    }
    // Enhanced Image Editing.
    if (enabledPremiumPlugins.indexOf('editimage') !== -1) {
        plugins += ` editimage`;
        toolbar = addToolbarButton(toolbar, 'content', 'editimage', 'tiny_media_image');
        // Remove the duplicate image button from the quickbar toolbar by redefining the values without 'imageoptions'.
        // eslint-disable-next-line camelcase
        instanceConfig.editimage_toolbar = 'rotateleft rotateright flipv fliph editimage';
    }
    // Export.
    if (enabledPremiumPlugins.indexOf('export') !== -1) {
        plugins += ` export`;
        menu = addMenubarItem(menu, 'tools', '| export');
    }
    // Page Embed.
    if (enabledPremiumPlugins.indexOf('pageembed') !== -1) {
        plugins += ` pageembed`;
        toolbar = addToolbarButton(toolbar, 'content', 'pageembed', 'tiny_media_video');
    }
    // Advanced Typography.
    if (enabledPremiumPlugins.indexOf('typography') !== -1) {
        plugins += ` typography`;
        toolbar = addToolbarButton(toolbar, 'premium_b', 'typography');
    }
    // Case Change.
    if (enabledPremiumPlugins.indexOf('casechange') !== -1) {
        plugins += ` casechange`;
        toolbar = addToolbarButton(toolbar, 'premium_a', 'casechange');
    }
    // Checklist.
    if (enabledPremiumPlugins.indexOf('checklist') !== -1) {
        plugins += ` checklist`;
        toolbar = addToolbarButton(toolbar, 'lists', 'checklist');
    }
    // Spell Checker Pro.
    if (enabledPremiumPlugins.indexOf('tinymcespellchecker') !== -1) {
        plugins += ` tinymcespellchecker`;
        menu = addMenubarItem(menu, 'tools', 'spellcheckdialog', 'spellcheckerlanguage');
        contextmenu = addContextmenuItem(contextmenu, 'spellchecker');
        toolbar = addToolbarButton(toolbar, 'premium_a', 'spellcheckdialog');
    }
    // Spelling Autocorrect.
    if (enabledPremiumPlugins.indexOf('autocorrect') !== -1) {
        plugins += ` autocorrect`;
        menu = addMenubarItem(menu, 'tools', '| autocorrect capitalization', 'spellcheckdialog');
    }
    // Permanent Pen.
    if (enabledPremiumPlugins.indexOf('permanentpen') !== -1) {
        plugins += ` permanentpen`;
        menu = addMenubarItem(menu, 'format', '| permanentpen configurepermanentpen');
        toolbar = addToolbarButton(toolbar, 'premium_a', 'permanentpen');
        contextmenu = addContextmenuItem(contextmenu, 'configurepermanentpen');
    }
    // Format Painter.
    if (enabledPremiumPlugins.indexOf('formatpainter') !== -1) {
        plugins += ` formatpainter`;
        toolbar = addToolbarButton(toolbar, 'premium_a', 'formatpainter');
    }
    // Link Checker.
    if (enabledPremiumPlugins.indexOf('linkchecker') !== -1) {
        plugins += ` linkchecker`;
        contextmenu = addContextmenuItem(contextmenu, 'linkchecker');
    }
    // Table of Contents.
    if (enabledPremiumPlugins.indexOf('tableofcontents') !== -1) {
        plugins += ` tableofcontents`;
        toolbar = addToolbarButton(toolbar, 'premium_a', 'tableofcontents');
    }
    // MathML
    if (enabledPremiumPlugins.indexOf('math') !== -1) {
        plugins += ` math`;
        toolbar = addToolbarButton(toolbar, 'premium_a', 'math');
        menu = addMenubarItem(menu, 'insert', 'math', 'tableofcontents');
    }
    // Footnotes.
    if (enabledPremiumPlugins.indexOf('footnotes') !== -1) {
        plugins += ` footnotes`;
        toolbar = addToolbarButton(toolbar, 'premium_a', 'footnotes');
        menu = addMenubarItem(menu, 'insert', 'footnotes', 'tableofcontents');
    }
    // Powerpaste.
    if (enabledPremiumPlugins.indexOf('powerpaste') !== -1) {
        plugins += ` powerpaste`;
    }
    return {
        plugins,
        toolbar,
        menu,
        contextmenu,
        ...pluginsettings
    };
};