Proyectos de Subversion Moodle

// 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/>.

/**

 * Course index cm component.

 *

 * This component is used to control specific course modules interactions like drag and drop.

 *

 * @module     core_courseformat/local/courseindex/cm

 * @class      core_courseformat/local/courseindex/cm

 * @copyright  2021 Ferran Recio <ferran@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

import DndCmItem from 'core_courseformat/local/courseeditor/dndcmitem';

import Templates from 'core/templates';

import Prefetch from 'core/prefetch';

import Config from 'core/config';

import Pending from "core/pending";

import log from "core/log";

// Prefetch the completion icons template.

const completionTemplate = 'core_courseformat/local/courseindex/cmcompletion';

Prefetch.prefetchTemplate(completionTemplate);

export default class Component extends DndCmItem {

    /**

     * Constructor hook.

     */

    create() {

        // Optional component name for debugging.

        this.name = 'courseindex_cm';

        // Default query selectors.

        this.selectors = {

            CM_NAME: `[data-for='cm_name']`,

            CM_COMPLETION: `[data-for='cm_completion']`,

            DND_ALLOWED: `[data-courseindexdndallowed='true']`,

        };

        // Default classes to toggle on refresh.

        this.classes = {

            CMHIDDEN: 'dimmed',

            LOCKED: 'editinprogress',

            RESTRICTIONS: 'restrictions',

            PAGEITEM: 'pageitem',

            INDENTED: 'indented',

        };

        // We need our id to watch specific events.

        this.id = this.element.dataset.id;

    }

    /**

     * Static method to create a component instance form the mustache template.

     *

     * @param {element|string} target the DOM main element or its ID

     * @param {object} selectors optional css selector overrides

     * @return {Component}

     */

    static init(target, selectors) {

        let element = document.querySelector(target);

        // TODO Remove this if condition as part of MDL-83851.

        if (!element) {

            log.debug('Init component with id is deprecated, use a query selector instead.');

            element = document.getElementById(target);

        }

        return new this({

            element,

            selectors,

        });

    }

    /**

     * Initial state ready method.

     *

     * @param {Object} state the course state.

     */

    stateReady(state) {

        if (document.querySelector(this.selectors.DND_ALLOWED)) {

            this.configDragDrop(this.id);

        }

        const cm = state.cm.get(this.id);

        const course = state.course;

        // Refresh completion icon.

        this._refreshCompletion({

            state,

            element: cm,

        });

        const url = new URL(window.location.href);

        const anchor = url.hash.replace('#', '');

        // Check if the current url is the cm url.

        if (window.location.href == cm.url

            || (window.location.href.includes(course.baseurl) && anchor == cm.anchor)

        ) {

            this.element.scrollIntoView({block: "center"});

        }

        // Check if this we are displaying this activity page.

        if (Config.contextid != Config.courseContextId && Config.contextInstanceId == this.id) {

            this.reactive.dispatch('setPageItem', 'cm', this.id, true);

            this.element.scrollIntoView({block: "center"});

        }

        // Add anchor logic if the element is not user visible or the element hasn't URL.

        if (!cm.uservisible || !cm.url) {

            const element = this.getElement(this.selectors.CM_NAME);

            this.addEventListener(

                element,

                'click',

                this._activityAnchor,

            );

            // If the element is not user visible we also need to update the anchor link including the section page.

            if (!document.getElementById(cm.anchor)) {

                element.setAttribute('href', this._getActivitySectionURL(cm));

            }

        }

    }

    /**

     * Component watchers.

     *

     * @returns {Array} of watchers

     */

    getWatchers() {

        return [

            {watch: `cm[${this.id}]:deleted`, handler: this.remove},

            {watch: `cm[${this.id}]:updated`, handler: this._refreshCm},

            {watch: `cm[${this.id}].completionstate:updated`, handler: this._refreshCompletion},

            {watch: `course.pageItem:updated`, handler: this._refreshPageItem},

        ];

    }

    /**

     * Update a course index cm using the state information.

     *

     * @param {object} param

     * @param {Object} param.element details the update details.

     */

    _refreshCm({element}) {

        // Update classes.

        this.element.classList.toggle(this.classes.CMHIDDEN, !element.visible);

        this.getElement(this.selectors.CM_NAME).innerHTML = element.name;

        this.element.classList.toggle(this.classes.DRAGGING, element.dragging ?? false);

        this.element.classList.toggle(this.classes.LOCKED, element.locked ?? false);

        this.element.classList.toggle(this.classes.RESTRICTIONS, element.hascmrestrictions ?? false);

        this.element.classList.toggle(this.classes.INDENTED, element.indent);

        this.locked = element.locked;

    }

    /**

     * Handle a page item update.

     *

     * @param {Object} details the update details

     * @param {Object} details.element the course state data.

     */

    _refreshPageItem({element}) {

        if (!element.pageItem) {

            return;

        }

        const isPageId = (element.pageItem.type == 'cm' && element.pageItem.id == this.id);

        this.element.classList.toggle(this.classes.PAGEITEM, isPageId);

        if (isPageId && !this.reactive.isEditing) {

            this.element.scrollIntoView({block: "nearest"});

        }

    }

    /**

     * Update the activity completion icon.

     *

     * @param {Object} details the update details

     * @param {Object} details.state the state data

     * @param {Object} details.element the element data

     */

    async _refreshCompletion({state, element}) {

        // No completion icons are displayed in edit mode.

        if (this.reactive.isEditing || !element.istrackeduser) {

            return;

        }

        // Check if the completion value has changed.

        const completionElement = this.getElement(this.selectors.CM_COMPLETION);

        if (!completionElement || completionElement.dataset.value == element.completionstate) {

            return;

        }

        // Collect section information from the state.

        const exporter = this.reactive.getExporter();

        const data = exporter.cmCompletion(state, element);

        const {html, js} = await Templates.renderForPromise(completionTemplate, data);

        Templates.replaceNode(completionElement, html, js);

    }

    /**

     * The activity anchor event.

     *

     * @param {Event} event

     */

    _activityAnchor(event) {

        const cm = this.reactive.get('cm', this.id);

        // If the user cannot access the element but the element is present in the page

        // the new url should be an anchor link.

        const element = document.getElementById(cm.anchor);

        if (element) {

            // Make sure the section is expanded.

            this.reactive.dispatch('sectionContentCollapsed', [cm.sectionid], false);

            // Marc the element as page item once the event is handled.

            const pendingAnchor = new Pending(`courseformat/activity:openAnchor`);

            setTimeout(() => {

                this.reactive.dispatch('setPageItem', 'cm', cm.id);

                pendingAnchor.resolve();

            }, 50);

            return;

        }

        // If the element is not present in the page we need to go to the specific section.

        event.preventDefault();

        window.location = this._getActivitySectionURL(cm);

    }

    /**

     * Get the anchor link in section page for the cm.

     *

     * @param {Object} cm the course module data.

     * @return {String} the anchor link.

     */

    _getActivitySectionURL(cm) {

        let section = this.reactive.get('section', cm.sectionid);

        // If the section is delegated get its parent section if it has one.

        if (section.component && section.parentsectionid) {

            section = this.reactive.get('section', section.parentsectionid);

        }

        if (!section) {

            return '#';

        }

        const sectionurl = section.sectionurl.split("#")[0];

        return `${sectionurl}#${cm.anchor}`;

    }

}