Proyectos de Subversion Moodle

/**

 * Provides interface for users to edit availability settings on the

 * module/section editing form.

 *

 * The system works using this JavaScript plus form.js files inside each

 * condition plugin.

 *

 * The overall concept is that data is held in a textarea in the form in JSON

 * format. This JavaScript converts the textarea into a set of controls

 * generated here and by the relevant plugins.

 *

 * (Almost) all data is held directly by the state of the HTML controls, and

 * can be updated to the form field by calling the 'update' method, which

 * this code and the plugins call if any HTML control changes.

 *

 * @module moodle-core_availability-form

 */

M.core_availability = M.core_availability || {};

/**

 * Core static functions for availability settings in editing form.

 *

 * @class M.core_availability.form

 * @static

 */

M.core_availability.form = {

    /**

     * Object containing installed plugins. They are indexed by plugin name.

     *

     * @property plugins

     * @type Object

     */

    plugins: {},

    /**

     * Availability field (textarea).

     *

     * @property field

     * @type Y.Node

     */

    field: null,

    /**

     * Main div that replaces the availability field.

     *

     * @property mainDiv

     * @type Y.Node

     */

    mainDiv: null,

    /**

     * Object that represents the root of the tree.

     *

     * @property rootList

     * @type M.core_availability.List

     */

    rootList: null,

    /**

     * Counter used when creating anything that needs an id.

     *

     * @property idCounter

     * @type Number

     */

    idCounter: 0,

    /**

     * The 'Restrict by group' button if present.

     *

     * @property restrictByGroup

     * @type Y.Node

     */

    restrictByGroup: null,

    /**

     * Called to initialise the system when the page loads. This method will

     * also call the init method for each plugin.

     *

     * @method init

     */

    init: function(pluginParams) {

        // Init all plugins.

        for (var plugin in pluginParams) {

            var params = pluginParams[plugin];

            var pluginClass = M[params[0]].form;

            pluginClass.init.apply(pluginClass, params);

        }

        // Get the availability field, hide it, and replace with the main div.

        this.field = Y.one('#id_availabilityconditionsjson');

        this.field.setAttribute('aria-hidden', 'true');

        // The fcontainer class here is inappropriate, but is necessary

        // because otherwise it is impossible to make Behat work correctly on

        // these controls as Behat incorrectly decides they're a moodleform

        // textarea. IMO Behat should not know about moodleforms at all and

        // should look purely at HTML elements on the page, but until it is

        // fixed to do this or fixed in some other way to only detect moodleform

        // elements that specifically match what those elements should look like,

        // then there is no good solution.

        this.mainDiv = Y.Node.create('<div class="availability-field fcontainer"></div>');

        this.field.insert(this.mainDiv, 'after');

        // Get top-level tree as JSON.

        var value = this.field.get('value');

        var data = null;

        if (value !== '') {

            try {

                data = Y.JSON.parse(value);

            } catch (x) {

                // If the JSON data is not valid, treat it as empty.

                this.field.set('value', '');

            }

        }

        this.rootList = new M.core_availability.List(data, true);

        this.mainDiv.appendChild(this.rootList.node);

        // Update JSON value after loading (to reflect any changes that need

        // to be made to make it valid).

        this.update();

        this.rootList.renumber();

        // Mark main area as dynamically updated.

        this.mainDiv.setAttribute('aria-live', 'polite');

        // Listen for form submission - to avoid having our made-up fields

        // submitted, we need to disable them all before submit.

        this.field.ancestor('form').on('submit', function() {

            this.mainDiv.all('input,textarea,select').set('disabled', true);

        }, this);

        // If the form has group mode and/or grouping options, there is a

        // 'add restriction' button there.

        this.restrictByGroup = Y.one('#restrictbygroup');

        if (this.restrictByGroup) {

            this.restrictByGroup.on('click', this.addRestrictByGroup, this);

            var groupmode = Y.one('#id_groupmode');

            var groupingid = Y.one('#id_groupingid');

            if (groupmode) {

                groupmode.on('change', this.updateRestrictByGroup, this);

            }

            if (groupingid) {

                groupingid.on('change', this.updateRestrictByGroup, this);

            }

            this.updateRestrictByGroup();

        }

        // Everything is ready. Make sure the div is visible and hide the loading indicator.

        this.parent = Y.one('#fitem_id_availabilityconditionsjson');

        this.parent.removeClass('d-none');

        document.getElementById('availabilityconditions-loading').remove();

    },

    /**

     * Called at any time to update the hidden field value.

     *

     * This should be called whenever any value changes in the form settings.

     *

     * @method update

     */

    update: function() {

        // Convert tree to value.

        var jsValue = this.rootList.getValue();

        // Store any errors (for form reporting) in 'errors' value if present.

        var errors = [];

        this.rootList.fillErrors(errors);

        if (errors.length !== 0) {

            jsValue.errors = errors;

        }

        // Set into hidden form field, JS-encoded.

        this.field.set('value', Y.JSON.stringify(jsValue));

        // Also update the restrict by group button if present.

        this.updateRestrictByGroup();

    },

    /**

     * Updates the status of the 'restrict by group' button (enables or disables

     * it) based on current availability restrictions and group/grouping settings.

     */

    updateRestrictByGroup: function() {

        if (!this.restrictByGroup) {

            return;

        }

        // If the root list is anything other than the default 'and' type, disable.

        if (this.rootList.getValue().op !== '&') {

            this.restrictByGroup.set('disabled', true);

            return;

        }

        // If there's already a group restriction, disable it.

        var alreadyGot = this.rootList.hasItemOfType('group') ||

                this.rootList.hasItemOfType('grouping');

        if (alreadyGot) {

            this.restrictByGroup.set('disabled', true);

            return;

        }

        // If the groupmode and grouping id aren't set, disable it.

        var groupmode = Y.one('#id_groupmode');

        var groupingid = Y.one('#id_groupingid');

        var groupavailability = Number(this.restrictByGroup.getData('groupavailability')) === 1;

        var groupingavailability = Number(this.restrictByGroup.getData('groupingavailability')) === 1;

        if ((!groupmode || Number(groupmode.get('value')) === 0 || !groupavailability) &&

                (!groupingid || Number(groupingid.get('value')) === 0 || !groupingavailability)) {

            this.restrictByGroup.set('disabled', true);

            return;

        }

        this.restrictByGroup.set('disabled', false);

    },

    /**

     * Called when the user clicks on the 'restrict by group' button. This is

     * a special case that adds a group or grouping restriction.

     *

     * By default this restriction is not shown which makes it similar to the

     *

     * @param e Button click event

     */

    addRestrictByGroup: function(e) {

        // If you don't prevent default, it submits the form for some reason.

        e.preventDefault();

        // Add the condition.

        var groupmode = Y.one('#id_groupmode');

        var groupingid = Y.one('#id_groupingid');

        var groupavailability = Number(this.restrictByGroup.getData('groupavailability')) === 1;

        var groupingavailability = Number(this.restrictByGroup.getData('groupingavailability')) === 1;

        var newChild;

        if (groupingid && Number(groupingid.get('value')) !== 0 && groupingavailability) {

            // Add a grouping restriction if one is specified.

            newChild = new M.core_availability.Item(

                    {type: 'grouping', id: Number(groupingid.get('value'))}, true);

        } else if (groupmode && groupavailability) {

            // Otherwise just add a group restriction.

            newChild = new M.core_availability.Item({type: 'group'}, true);

        }

        // Refresh HTML.

        if (newChild !== null) {

            this.rootList.addChild(newChild);

            this.update();

            this.rootList.renumber();

            this.rootList.updateHtml();

        }

    }

};

/**

 * Base object for plugins. Plugins should use Y.Object to extend this class.

 *

 * @class M.core_availability.plugin

 * @static

 */

M.core_availability.plugin = {

    /**

     * True if users are allowed to add items of this plugin at the moment.

     *

     * @property allowAdd

     * @type Boolean

     */

    allowAdd: false,

    /**

     * Called (from PHP) to initialise the plugin. Should usually not be

     * overridden by child plugin.

     *

     * @method init

     * @param {String} component Component name e.g. 'availability_date'

     */

    init: function(component, allowAdd, params) {

        var name = component.replace(/^availability_/, '');

        this.allowAdd = allowAdd;

        M.core_availability.form.plugins[name] = this;

        this.initInner.apply(this, params);

    },

    /**

     * Init method for plugin to override. (Default does nothing.)

     *

     * This method will receive any parameters defined in frontend.php

     * get_javascript_init_params.

     *

     * @method initInner

     * @protected

     */

    initInner: function() {

        // Can be overriden.

    },

    /**

     * Gets a YUI node representing the controls for this plugin on the form.

     *

     * Must be implemented by sub-object; default throws an exception.

     *

     * @method getNode

     * @return {Y.Node} YUI node

     */

    getNode: function() {

        throw 'getNode not implemented';

    },

    /**

     * Fills in the value from this plugin's controls into a value object,

     * which will later be converted to JSON and stored in the form field.

     *

     * Must be implemented by sub-object; default throws an exception.

     *

     * @method fillValue

     * @param {Object} value Value object (to be written to)

     * @param {Y.Node} node YUI node (same one returned from getNode)

     */

    fillValue: function() {

        throw 'fillValue not implemented';

    },

    /**

     * Fills in any errors from this plugin's controls. If there are any

     * errors, push them into the supplied array.

     *

     * Errors are Moodle language strings in format component:string, e.g.

     * 'availability_date:error_date_past_end_of_world'.

     *

     * The default implementation does nothing.

     *

     * @method fillErrors

     * @param {Array} errors Array of errors (push new errors here)

     * @param {Y.Node} node YUI node (same one returned from getNode)

     */

    fillErrors: function() {

        // Can be overriden.

    },

    /**

     * Focuses the first thing in the plugin after it has been added.

     *

     * The default implementation uses a simple algorithm to identify the

     * first focusable input/select and then focuses it.

     */

    focusAfterAdd: function(node) {

        var target = node.one('input:not([disabled]),select:not([disabled])');

        target.focus();

    }

};

/**

 * Maintains a list of children and settings for how they are combined.

 *

 * @class M.core_availability.List

 * @constructor

 * @param {Object} json Decoded JSON value

 * @param {Boolean} [false] root True if this is root level list

 * @param {Boolean} [false] root True if parent is root level list

 */

M.core_availability.List = function(json, root, parentRoot) {

    // Set default value for children. (You can't do this in the prototype

    // definition, or it ends up sharing the same array between all of them.)

    this.children = [];

    if (root !== undefined) {

        this.root = root;

    }

    // Create DIV structure (without kids).

    this.node = Y.Node.create('<div class="availability-list"><h3 class="accesshide"></h3>' +

            '<div class="availability-inner">' +

            '<div class="availability-header mb-1"><span>' +

            M.util.get_string('listheader_sign_before', 'availability') + '</span>' +

            ' <label><span class="accesshide">' + M.util.get_string('label_sign', 'availability') +

            ' </span><select class="availability-neg custom-select mx-1"' +

            ' title="' + M.util.get_string('label_sign', 'availability') + '">' +

            '<option value="">' + M.util.get_string('listheader_sign_pos', 'availability') + '</option>' +

            '<option value="!">' + M.util.get_string('listheader_sign_neg', 'availability') + '</option></select></label> ' +

            '<span class="availability-single">' + M.util.get_string('listheader_single', 'availability') + '</span>' +

            '<span class="availability-multi">' + M.util.get_string('listheader_multi_before', 'availability') +

            ' <label><span class="accesshide">' + M.util.get_string('label_multi', 'availability') + ' </span>' +

            '<select class="availability-op custom-select mx-1"' +

            ' title="' + M.util.get_string('label_multi', 'availability') + '"><option value="&">' +

            M.util.get_string('listheader_multi_and', 'availability') + '</option>' +

            '<option value="|">' + M.util.get_string('listheader_multi_or', 'availability') + '</option></select></label> ' +

            M.util.get_string('listheader_multi_after', 'availability') + '</span></div>' +

            '<div class="availability-children"></div>' +

            '<div class="availability-none"><span class="px-3">' + M.util.get_string('none', 'moodle') + '</span></div>' +

            '<div class="clearfix mt-1"></div>' +

            '<div class="availability-button"></div></div><div class="clearfix"></div></div>');

    if (!root) {

        this.node.addClass('availability-childlist d-sm-flex align-items-center');

    }

    this.inner = this.node.one('> .availability-inner');

    var shown = true;

    if (root) {

        // If it's the root, add an eye icon as first thing in header.

        if (json && json.show !== undefined) {

            shown = json.show;

        }

        this.eyeIcon = new M.core_availability.EyeIcon(false, shown);

        this.node.one('.availability-header').get('firstChild').insert(

                this.eyeIcon.span, 'before');

        this.node.one('.availability-header').get('firstChild').insert(

            this.eyeIcon.disabledSpan, 'before');

        this.on('availability:privateRuleSet', function(e) {

            e.target.getDOMNode().dataset.private = true;

            this.updatePrivateStatus();

        });

        this.on('availability:privateRuleUnset', function(e) {

            delete e.target.getDOMNode().dataset.private;

            this.updatePrivateStatus();

        });

    } else if (parentRoot) {

        // When the parent is root, add an eye icon before the main list div.

        if (json && json.showc !== undefined) {

            shown = json.showc;

        }

        this.eyeIcon = new M.core_availability.EyeIcon(false, shown);

        this.inner.insert(this.eyeIcon.span, 'before');

        this.inner.insert(this.eyeIcon.disabledSpan, 'before');

    }

    if (!root) {

        // If it's not the root, add a delete button to the 'none' option.

        // You can only delete lists when they have no children so this will

        // automatically appear at the correct time.

        var deleteIcon = new M.core_availability.DeleteIcon(this);

        var noneNode = this.node.one('.availability-none');

        noneNode.appendChild(document.createTextNode(' '));

        noneNode.appendChild(deleteIcon.span);

        // Also if it's not the root, none is actually invalid, so add a label.

        noneNode.appendChild(Y.Node.create('<span class="mt-1 badge bg-warning text-dark">' +

                M.util.get_string('invalid', 'availability') + '</span>'));

    }

    // Create the button and add it.

    var button = Y.Node.create('<button type="button" class="btn btn-secondary mt-1">' +

            M.util.get_string('addrestriction', 'availability') + '</button>');

    button.on("click", function() {

        this.clickAdd();

    }, this);

    this.node.one('div.availability-button').appendChild(button);

    if (json) {

        // Set operator from JSON data.

        switch (json.op) {

            case '&' :

            case '|' :

                this.node.one('.availability-neg').set('value', '');

                break;

            case '!&' :

            case '!|' :

                this.node.one('.availability-neg').set('value', '!');

                break;

        }

        switch (json.op) {

            case '&' :

            case '!&' :

                this.node.one('.availability-op').set('value', '&');

                break;

            case '|' :

            case '!|' :

                this.node.one('.availability-op').set('value', '|');

                break;

        }

        // Construct children.

        for (var i = 0; i < json.c.length; i++) {

            var child = json.c[i];

            if (this.root && json && json.showc !== undefined) {

                child.showc = json.showc[i];

            }

            var newItem;

            if (child.type !== undefined) {

                // Plugin type.

                newItem = new M.core_availability.Item(child, this.root);

            } else {

                // List type.

                newItem = new M.core_availability.List(child, false, this.root);

            }

            this.addChild(newItem);

        }

    }

    // Add update listeners to the dropdowns.

    this.node.one('.availability-neg').on('change', function() {

        // Update hidden field and HTML.

        M.util.js_pending('availability-neg-change');

        M.core_availability.form.update();

        this.updateHtml();

        M.util.js_complete('availability-neg-change');

    }, this);

    this.node.one('.availability-op').on('change', function() {

        // Update hidden field.

        M.util.js_pending('availability-op-change');

        M.core_availability.form.update();

        this.updateHtml();

        M.util.js_complete('availability-op-change');

    }, this);

    // Update HTML to hide unnecessary parts.

    this.updateHtml();

};

Y.augment(M.core_availability.List, Y.EventTarget, true, null, {emitFacade: true});

/**

 * Adds a child to the end of the list (in HTML and stored data).

 *

 * @method addChild

 * @private

 * @param {M.core_availability.Item|M.core_availability.List} newItem Child to add

 */

M.core_availability.List.prototype.addChild = function(newItem) {

    if (this.children.length > 0) {

        // Create connecting label (text will be filled in later by updateHtml).

        this.inner.one('.availability-children').appendChild(Y.Node.create(

                '<div class="availability-connector">' +

                '<span class="label"></span>' +

                '</div>'));

    }

    // Add item to array and to HTML.

    this.children.push(newItem);

    // Allow events from child Items and Lists to bubble up to this list.

    newItem.addTarget(this);

    this.inner.one('.availability-children').appendChild(newItem.node);

};

/**

 * Focuses something after a new list is added.

 *

 * @method focusAfterAdd

 */

M.core_availability.List.prototype.focusAfterAdd = function() {

    this.inner.one('button').focus();

};

/**

 * Checks whether this list uses the individual show icons or the single one.

 *

 * (Basically, AND and the equivalent NOT OR list can have individual show icons

 * so that you hide the activity entirely if a user fails one condition, but

 * may display it with information about the condition if they fail a different

 * one. That isn't possible with OR and NOT AND because for those types, there

 * is not really a concept of which single condition caused the user to fail

 * it.)

 *

 * Method can only be called on the root list.

 *

 * @method isIndividualShowIcons

 * @return {Boolean} True if using the individual icons

 */

M.core_availability.List.prototype.isIndividualShowIcons = function() {

    if (!this.root) {

        throw 'Can only call this on root list';

    }

    var neg = this.node.one('.availability-neg').get('value') === '!';

    var isor = this.node.one('.availability-op').get('value') === '|';

    return (!neg && !isor) || (neg && isor);

};

/**

 * Renumbers the list and all children.

 *

 * @method renumber

 * @param {String} parentNumber Number to use in heading for this list

 */

M.core_availability.List.prototype.renumber = function(parentNumber) {

    // Update heading for list.

    var headingParams = {count: this.children.length};

    var prefix;

    if (parentNumber === undefined) {

        headingParams.number = '';

        prefix = '';

    } else {

        headingParams.number = parentNumber + ':';

        prefix = parentNumber + '.';

    }

    var heading = M.util.get_string('setheading', 'availability', headingParams);

    this.node.one('> h3').set('innerHTML', heading);

    this.node.one('> h3').getDOMNode().dataset.restrictionOrder = parentNumber ? parentNumber : 'root';

    // Do children.

    for (var i = 0; i < this.children.length; i++) {

        var child = this.children[i];

        child.renumber(prefix + (i + 1));

    }

};

/**

 * Updates HTML for the list based on the current values, for example showing

 * the 'None' text if there are no children.

 *

 * @method updateHtml

 */

M.core_availability.List.prototype.updateHtml = function() {

    // Control children appearing or not appearing.

    if (this.children.length > 0) {

        this.inner.one('> .availability-children').removeAttribute('aria-hidden');

        this.inner.one('> .availability-none').setAttribute('aria-hidden', 'true');

        this.inner.one('> .availability-header').removeAttribute('aria-hidden');

        if (this.children.length > 1) {

            this.inner.one('.availability-single').setAttribute('aria-hidden', 'true');

            this.inner.one('.availability-multi').removeAttribute('aria-hidden');

        } else {

            this.inner.one('.availability-single').removeAttribute('aria-hidden');

            this.inner.one('.availability-multi').setAttribute('aria-hidden', 'true');

        }

    } else {

        this.inner.one('> .availability-children').setAttribute('aria-hidden', 'true');

        this.inner.one('> .availability-none').removeAttribute('aria-hidden');

        this.inner.one('> .availability-header').setAttribute('aria-hidden', 'true');

    }

    // For root list, control eye icons.

    if (this.root) {

        var showEyes = this.isIndividualShowIcons();

        // Individual icons.

        for (var i = 0; i < this.children.length; i++) {

            var child = this.children[i];

            if (showEyes) {

                child.eyeIcon.span.removeAttribute('aria-hidden');

                child.eyeIcon.disabledSpan.removeAttribute('aria-hidden');

            } else {

                child.eyeIcon.span.setAttribute('aria-hidden', 'true');

                child.eyeIcon.disabledSpan.setAttribute('aria-hidden', 'true');

            }

        }

        // Single icon is the inverse.

        if (showEyes) {

            this.eyeIcon.span.setAttribute('aria-hidden', 'true');

            this.eyeIcon.disabledSpan.setAttribute('aria-hidden', 'true');

        } else {

            this.eyeIcon.span.removeAttribute('aria-hidden');

            this.eyeIcon.disabledSpan.removeAttribute('aria-hidden');

        }

        this.updatePrivateStatus();

    }

    // Update connector text.

    var connectorText;

    if (this.inner.one('.availability-op').get('value') === '&') {

        connectorText = M.util.get_string('and', 'availability');

    } else {

        connectorText = M.util.get_string('or', 'availability');

    }

    this.inner.all('> .availability-children > .availability-connector span.label').each(function(span) {

        span.set('innerHTML', connectorText);

    });

};

/**

 * Deletes a descendant item (Item or List). Called when the user clicks a

 * delete icon.

 *

 * This is a recursive function.

 *

 * @method deleteDescendant

 * @param {M.core_availability.Item|M.core_availability.List} descendant Item to delete

 * @return {Boolean} True if it was deleted

 */

M.core_availability.List.prototype.deleteDescendant = function(descendant) {

    // Loop through children.

    for (var i = 0; i < this.children.length; i++) {

        var child = this.children[i];

        if (child === descendant) {

            // Remove from internal array.

            this.children.splice(i, 1);

            var target = child.node;

            // Remove one of the connector nodes around target (if any left).

            if (this.children.length > 0) {

                if (target.previous('.availability-connector')) {

                    target.previous('.availability-connector').remove();

                } else {

                    target.next('.availability-connector').remove();

                }

            }

            // Remove target itself.

            this.inner.one('> .availability-children').removeChild(target);

            // Update the form and the list HTML.

            M.core_availability.form.update();

            this.updateHtml();

            // Focus add button for this list.

            this.inner.one('> .availability-button').one('button').focus();

            return true;

        } else if (child instanceof M.core_availability.List) {

            // Recursive call.

            var found = child.deleteDescendant(descendant);

            if (found) {

                return true;

            }

        }

    }

    return false;

};

/**

 * Shows the 'add restriction' dialogue box.

 *

 * @method clickAdd

 */

M.core_availability.List.prototype.clickAdd = function() {

    var content = Y.Node.create('<div>' +

            '<ul class="list-unstyled container-fluid"></ul>' +

            '<div class="availability-buttons mdl-align">' +

            '<button type="button" class="btn btn-secondary">' + M.util.get_string('cancel', 'moodle') +

            '</button></div></div>');

    var cancel = content.one('button');

    // Make a list of all the dialog options.

    var dialogRef = {dialog: null};

    var ul = content.one('ul');

    var li, id, button, label;

    for (var type in M.core_availability.form.plugins) {

        // Plugins might decide not to display their add button.

        if (!M.core_availability.form.plugins[type].allowAdd) {

            continue;

        }

        // Add entry for plugin.

        li = Y.Node.create('<li class="clearfix row"></li>');

        id = 'availability_addrestriction_' + type;

        button = Y.Node.create('<div class="col-6"><button type="button" class="btn btn-secondary w-100"' +

                'id="' + id + '">' + M.util.get_string('title', 'availability_' + type) + '</button></div>');

        button.on('click', this.getAddHandler(type, dialogRef), this);

        li.appendChild(button);

        label = Y.Node.create('<div class="col-6"><label for="' + id + '">' +

                M.util.get_string('description', 'availability_' + type) + '</label></div>');

        li.appendChild(label);

        ul.appendChild(li);

    }

    // Extra entry for lists.

    li = Y.Node.create('<li class="clearfix row"></li>');

    id = 'availability_addrestriction_list_';

    button = Y.Node.create('<div class="col-6"><button type="button" class="btn btn-secondary w-100"' +

            'id="' + id + '">' + M.util.get_string('condition_group', 'availability') + '</button></div>');

    button.on('click', this.getAddHandler(null, dialogRef), this);

    li.appendChild(button);

    label = Y.Node.create('<div class="col-6"><label for="' + id + '">' +

            M.util.get_string('condition_group_info', 'availability') + '</label></div>');

    li.appendChild(label);

    ul.appendChild(li);

    var config = {

        headerContent: M.util.get_string('addrestriction', 'availability'),

        bodyContent: content,

        additionalBaseClass: 'availability-dialogue',

        draggable: true,

        modal: true,

        closeButton: false,

        width: '450px'

    };

    dialogRef.dialog = new M.core.dialogue(config);

    dialogRef.dialog.show();

    cancel.on('click', function() {

        dialogRef.dialog.destroy();

        // Focus the button they clicked originally.

        this.inner.one('> .availability-button').one('button').focus();

    }, this);

};

/**

 * Gets an add handler function used by the dialogue to add a particular item.

 *

 * @method getAddHandler

 * @param {String|Null} type Type name of plugin or null to add lists

 * @param {Object} dialogRef Reference to object that contains dialog

 * @param {M.core.dialogue} dialogRef.dialog Dialog object

 * @return {Function} Add handler function to call when adding that thing

 */

M.core_availability.List.prototype.getAddHandler = function(type, dialogRef) {

    return function() {

        var newItem;

        if (type) {

            // Create an Item object to represent the child.

            newItem = new M.core_availability.Item({type: type, creating: true}, this.root);

        } else {

            // Create a new List object to represent the child.

            newItem = new M.core_availability.List({c: [], showc: true}, false, this.root);

        }

        // Add to list.

        this.addChild(newItem);

        // Update the form and list HTML.

        M.core_availability.form.update();

        M.core_availability.form.rootList.renumber();

        this.updateHtml();

        // Hide dialog.

        dialogRef.dialog.destroy();

        newItem.focusAfterAdd();

    };

};

/**

 * Gets the value of the list ready to convert to JSON and fill form field.

 *

 * @method getValue

 * @return {Object} Value of list suitable for use in JSON

 */

M.core_availability.List.prototype.getValue = function() {

    // Work out operator from selects.

    var value = {};

    value.op = this.node.one('.availability-neg').get('value') +

            this.node.one('.availability-op').get('value');

    // Work out children from list.

    value.c = [];

    var i;

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

        value.c.push(this.children[i].getValue());

    }

    // Work out show/showc for root level.

    if (this.root) {

        if (this.isIndividualShowIcons()) {

            value.showc = [];

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

                var eyeIcon = this.children[i].eyeIcon;

                value.showc.push(!eyeIcon.isHidden() && !eyeIcon.isDisabled());

            }

        } else {

            value.show = !this.eyeIcon.isHidden() && !this.eyeIcon.isDisabled();

        }

    }

    return value;

};

/**

 * Checks whether this list has any errors (incorrect user input). If so,

 * an error string identifier in the form langfile:langstring should be pushed

 * into the errors array.

 *

 * @method fillErrors

 * @param {Array} errors Array of errors so far

 */

M.core_availability.List.prototype.fillErrors = function(errors) {

    // List with no items is an error (except root).

    if (this.children.length === 0 && !this.root) {

        errors.push('availability:error_list_nochildren');

    }

    // Pass to children.

    for (var i = 0; i < this.children.length; i++) {

        this.children[i].fillErrors(errors);

    }

};

/**

 * Checks whether the list contains any items of the given type name.

 *

 * @method hasItemOfType

 * @param {String} pluginType Required plugin type (name)

 * @return {Boolean} True if there is one

 */

M.core_availability.List.prototype.hasItemOfType = function(pluginType) {

    // Check each item.

    for (var i = 0; i < this.children.length; i++) {

        var child = this.children[i];

        if (child instanceof M.core_availability.List) {

            // Recursive call.

            if (child.hasItemOfType(pluginType)) {

                return true;

            }

        } else {

            if (child.pluginType === pluginType) {

                return true;

            }

        }

    }

    return false;

};

M.core_availability.List.prototype.getEyeIcons = function() {

    // Check each item.

    var eyeIcons = [];

    eyeIcons.push(this.eyeIcon);

    for (var i = 0; i < this.children.length; i++) {

        var child = this.children[i];

        if (child.eyeIcon !== null) {

            eyeIcons.push(child.eyeIcon);

        }

        if (child instanceof M.core_availability.List) {

            eyeIcons.concat(child.getEyeIcons());

        }

    }

    return eyeIcons;

};

/**

 * Find all eye icons in the list and children, and disable or enable them if needed.

 */

M.core_availability.List.prototype.updatePrivateStatus = function() {

    if (!this.root) {

        throw new Error('Can only call this on root list');

    }

    var shouldDisable = !this.node.all('[data-private]').isEmpty();

    var eyeIcons = this.getEyeIcons();

    for (var i = 0, j = eyeIcons.length; i < j; i++) {

        if (shouldDisable) {

            eyeIcons[i].setDisabled();

        } else {

            eyeIcons[i].setEnabled();

        }

    }

};

/**

 * Eye icon for this list (null if none).

 *

 * @property eyeIcon

 * @type M.core_availability.EyeIcon

 */

M.core_availability.List.prototype.eyeIcon = null;

/**

 * True if list is special root level list.

 *

 * @property root

 * @type Boolean

 */

M.core_availability.List.prototype.root = false;

/**

 * Array containing children (Lists or Items).

 *

 * @property children

 * @type M.core_availability.List[]|M.core_availability.Item[]

 */

M.core_availability.List.prototype.children = null;

/**

 * HTML outer node for list.

 *

 * @property node

 * @type Y.Node

 */

M.core_availability.List.prototype.node = null;

/**

 * HTML node for inner div that actually is the displayed list.

 *

 * @property node

 * @type Y.Node

 */

M.core_availability.List.prototype.inner = null;

/**

 * Represents a single condition.

 *

 * @class M.core_availability.Item

 * @constructor

 * @param {Object} json Decoded JSON value

 * @param {Boolean} root True if this item is a child of the root list.

 */

M.core_availability.Item = function(json, root) {

    this.pluginType = json.type;

    if (M.core_availability.form.plugins[json.type] === undefined) {

        // Handle undefined plugins.

        this.plugin = null;

        this.pluginNode = Y.Node.create('<div class="availability-warning">' +

                M.util.get_string('missingplugin', 'availability') + '</div>');

    } else {

        // Plugin is known.

        this.plugin = M.core_availability.form.plugins[json.type];

        this.pluginNode = this.plugin.getNode(json);

        // Add a class with the plugin Frankenstyle name to make CSS easier in plugin.

        this.pluginNode.addClass('availability_' + json.type);

    }

    // Allow events from pluginNode to bubble up to the Item.

    Y.augment(this.pluginNode, Y.EventTarget, true, null, {emitFacade: true});

    this.pluginNode.addTarget(this);

    this.node = Y.Node.create('<div class="availability-item d-sm-flex align-items-center"><h3 class="accesshide"></h3></div>');

    // Add eye icon if required. This icon is added for root items, but may be

    // hidden depending on the selected list operator.

    if (root) {

        var shown = true;

        if (json.showc !== undefined) {

            shown = json.showc;

        }

        this.eyeIcon = new M.core_availability.EyeIcon(true, shown);

        this.node.appendChild(this.eyeIcon.span);

        this.node.appendChild(this.eyeIcon.disabledSpan);

    }

    // Add plugin controls.

    this.pluginNode.addClass('availability-plugincontrols');

    this.node.appendChild(this.pluginNode);

    // Add delete button for node.