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

/**

 * @package    atto_managefiles

 * @copyright  2014 Frédéric Massart

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

 */

/**

 * @module moodle-atto_managefiles-usedfiles

 */

/**

 * Atto text editor managefiles usedfiles plugin.

 *

 * @namespace M.atto_managefiles

 * @class usedfiles

 */

/**

 * CSS constants.

 *

 * @type {Object}

 */

var CSS = {

    HASMISSINGFILES: 'has-missing-files',

    HASUNUSEDFILES: 'has-unused-files'

};

/**

 * Selectors constants.

 *

 * @type {Object}

 */

var SELECTORS = {

    FILEANCESTOR: '.fitem',

    FORM: '#atto_managefiles_manageform',

    MISSINGFILES: '.missing-files'

};

M.atto_managefiles = M.atto_managefiles || {};

M.atto_managefiles.usedfiles = M.atto_managefiles.usedfiles || {

    /**

     * The user context.

     *

     * @property _usercontext

     * @type Number

     * @private

     */

    _usercontext: null,

    /**

     * Area Item ID.

     *

     * @property _itemid

     * @type String

     * @private

     */

    _itemid: null,

    /**

     * The editor elementid

     *

     * @property _elementid

     * @type String

     * @private

     */

    _elementid: null,

    /**

     * Init function.

     *

     * @param {Object} allFiles The keys are the file names, the values are the hashes.

     * @return {Void}

     */

    init: function(config) {

        this._usercontext = config.usercontext;

        this._itemid = config.itemid;

        this._elementid = config.elementid;

        var allFiles = config.files;

        var form = Y.one(SELECTORS.FORM),

            usedFiles,

            unusedFiles,

            missingFiles,

            missingFilesTxt,

            i;

        if (!form || !window.parent) {

            Y.log("Unable to find parent window", 'warn', 'moodle-atto_managemedia-usedfiles');

            return;

        }

        usedFiles = this._getUsedFiles();

        unusedFiles = this.findUnusedFiles(allFiles, usedFiles);

        missingFiles = this.findMissingFiles(allFiles, usedFiles);

        // There are some unused files.

        if (unusedFiles.length > 0) {

            // Loop over all the files in the form.

            form.all('input[type=checkbox][name^="deletefile"]').each(function(node) {

                // If the file is used, remove it.

                if (Y.Array.indexOf(unusedFiles, node.getData('filename')) === -1) {

                    node.ancestor(SELECTORS.FILEANCESTOR).remove();

                }

            });

            form.addClass(CSS.HASUNUSEDFILES);

        } else {

            // This is needed as the init may be called twice due to the double call to $PAGE->requires->yui_module().

            form.removeClass(CSS.HASUNUSEDFILES);

        }

        // There are some files missing.

        if (missingFiles.length > 0) {

            missingFilesTxt = '<ul>';

            for (i = 0; i < missingFiles.length; i++) {

                missingFilesTxt += '<li>' + Y.Escape.html(missingFiles[i]) + '</li>';

            }

            missingFilesTxt += '</ul>';

            form.one(SELECTORS.MISSINGFILES).setHTML('').append(missingFilesTxt);

            form.addClass(CSS.HASMISSINGFILES);

        } else {

            form.removeClass(CSS.HASMISSINGFILES);

        }

    },

    /**

     * Return the list of files used in the area.

     *

     * @method _getUsedFiles

     * @return {Object} List of files used where the keys are the name of the files, the value is true.

     * @private

     */

    _getUsedFiles: function() {

        var content = Y.one(window.parent.document.getElementById(this._elementid + 'editable')),

            baseUrl = M.cfg.wwwroot + '/draftfile.php/' + this._usercontext + '/user/draft/' + this._itemid + '/',

            pattern = new RegExp("[\"']" + baseUrl.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&') + "(.+?)[\\?\"']", 'gm'),

            filename = '',

            match = '',

            usedFiles = {};

        // The pattern matches any draftfile URL contained within quotes, e.g. 'src="<filename>"' or 'href="<filename>"'.

        while ((match = pattern.exec(content.get('innerHTML'))) !== null) {

            filename = decodeURIComponent(match[1]);

            usedFiles[filename] = true;

        }

        return usedFiles;

    },

    /**

     * Return an array of unused files.

     *

     * @param {Object} allFiles Where the keys are the file names.

     * @param {Object} usedFiles Where the keys are the file names.

     * @return {Array} Of file names.

     */

    findUnusedFiles: function(allFiles, usedFiles) {

        var key,

            list = [];

        for (key in allFiles) {

            if (!usedFiles[key]) {

                list.push(key);

            }

        }

        return list;

    },

    /**

     * Return an array of missing files.

     *

     * @param {Object} allFiles Where the keys are the file names.

     * @param {Object} usedFiles Where the keys are the file names.

     * @return {Array} Of file names.

     */

    findMissingFiles: function(allFiles, usedFiles) {

        var key,

            list = [];

        for (key in usedFiles) {

            if (!allFiles[key]) {

                list.push(key);

            }

        }

        return list;

    }

};