bugzilla-4intranet/js/bug-visibility.js

/* Functions used to show/hide dependent bug fields and change their select options
 * License: Dual-license GPL 3.0+ or MPL 1.1+
 * Author(s): Vitaliy Filippov <vitalif@mail.ru>
 */

addListener(window, 'load', initControlledFields);

function initControlledFields()
{
    // Initialise fields in correct order (starting with top-most controller fields)
    var initialised = {};
    var doInit = function(f)
    {
        if (f && !initialised[f])
        {
            initialised[f] = true;
            doInit(field_metadata[f].visibility_field);
            doInit(field_metadata[f].value_field);
            doInit(field_metadata[f].null_field);
            doInit(field_metadata[f].default_field);
            initControlledField(f);
        }
    };
    for (var i in field_metadata)
    {
        doInit(i);
    }
}

function initControlledField(i)
{
    var f = document.getElementById(i);
    if (f)
    {
        if (document.forms['Create'] && field_metadata[i].default_value)
        {
            // Select global default value before selecting dependent ones
            f._oldDefault = setFieldValue(f, field_metadata[i].default_value);
        }
        if (f.nodeName != 'INPUT' || f.type != 'hidden')
        {
            handleControlledField(f.id, !document.forms['Create']);
        }
        addListener(f, 'change', handleControllerField_this);
    }
}

function getSelectedIds(sel)
{
    if (typeof sel == "string")
    {
        sel = document.getElementById(sel);
    }
    var opt = {};
    var lm = sel.id.length+2;
    if (sel.nodeName != 'SELECT')
    {
        if (sel.name == 'product')
        {
            // product is a special case - it is preselected as hidden field on bug creation form
            opt[product_id] = true;
        }
        return opt;
    }
    for (var i = 0; i < sel.options.length; i++)
    {
        if (sel.options[i].selected)
        {
            id = sel.options[i].id;
            opt[id ? id.substr(1, id.length-lm) : 0] = true;
        }
    }
    return opt;
}

function getSelectedNames(sel)
{
    var opt = {};
    if (sel.type != 'select' || !sel.multi)
    {
        opt[sel.value] = true;
        return opt;
    }
    for (var i = 0; i < sel.options.length; i++)
    {
        if (sel.options[i].selected)
        {
            opt[sel.options[i].value] = true;
        }
    }
    return opt;
}

function handleControllerField_this(e)
{
    var m = field_metadata[this.id];
    if (!m)
    {
        return;
    }
    var f = {};
    for (var i in { 'fields': 1, 'values': 1, 'null': 1, 'defaults': 1 })
    {
        for (var j in m[i])
        {
            f[j] = true;
        }
    }
    for (var i in f)
    {
        handleControlledField(i);
    }
}

function checkValueVisibility(selected, visible)
{
    var vis = false;
    if (visible)
    {
        for (var value in visible)
        {
            if (selected[value])
            {
                vis = true;
                break;
            }
        }
    }
    return vis;
}

function setFieldValue(f, v)
{
    if (f.nodeName == 'SELECT')
    {
        f.selectedIndex = -1;
        v = v.split(',');
        for (var i in v)
        {
            i = document.getElementById('v' + v[i] + '_' + f.id);
            if (i)
            {
                i.selected = true;
            }
        }
    }
    else if (f.type != 'hidden')
    {
        f.value = v;
    }
    return v;
}

function handleControlledField(controlled_id, is_initial_editform)
{
    var m = field_metadata[controlled_id];
    var controlled = document.getElementById(controlled_id);
    var vis;
    // Show/hide the field
    if (m.visibility_field)
    {
        vis = checkValueVisibility(getSelectedIds(m.visibility_field), field_metadata[m.visibility_field]['fields'][controlled_id]);
        for (var i in { row: 1, container: 1, label: 1 })
        {
            var field_container = document.getElementById('field_' + i + '_' + controlled_id);
            (vis ? removeClass : addClass)(field_container, 'bz_hidden_field');
        }
    }
    if (is_initial_editform)
    {
        // Skip re-filling of fields on bug edit page load, because
        // the bug may include incorrect values that must not be hidden initially
        return;
    }
    if (!controlled)
    {
        // Maybe the field is not editable.
        return;
    }
    // Change select options
    if (controlled.nodeName == 'SELECT')
    {
        if (m.value_field)
        {
            // It is more correct to match selected values on name, because a
            // target_milestone/version/component with the same name may exist for a different product
            var copt = getSelectedNames(controlled);
            bz_clearOptions(controlled);
            var nullable = m.nullable && !controlled.multiple;
            if (m.null_field && nullable)
            {
                nullable = checkValueVisibility(getSelectedIds(m.null_field), field_metadata[m.null_field]['null'][controlled_id]);
            }
            if (nullable)
            {
                bz_createOptionInSelect(controlled, '---', '');
            }
            var opt = getSelectedIds(m.value_field), controlled_value;
            var vh = field_metadata[m.value_field]['values'][controlled_id];
            for (var i in m.legal)
            {
                controlled_value = m.legal[i];
                vis = checkValueVisibility(opt, vh[controlled_value[0]]);
                if (vis)
                {
                    item = bz_createOptionInSelect(controlled, controlled_value[1], controlled_value[1]);
                    item.id = 'v'+controlled_value[0]+'_'+controlled_id;
                    if (copt[controlled_value[1]])
                    {
                        item.selected = true;
                    }
                }
            }
        }
        else if (m.nullable && !controlled.multiple && m.null_field)
        {
            // Just enable/disable empty value
            var nullable = checkValueVisibility(getSelectedIds(m.null_field), field_metadata[m.null_field]['null'][controlled_id]);
            var has_null = controlled.options[0].value == '';
            if (nullable && !has_null)
            {
                controlled.insertBefore(new Option('---', ''), controlled.options[0]);
            }
            else if (!nullable && has_null)
            {
                controlled.removeChild(controlled.options[0]);
            }
        }
    }
    // Select default value
    if (m.default_field)
    {
        var diff = false;
        if (controlled._oldDefault)
        {
            // Check if the value is different from previous default
            if (controlled.nodeName == 'SELECT')
            {
                var copt = getSelectedIds(controlled);
                for (var i in controlled._oldDefault)
                {
                    if (copt[controlled._oldDefault[i]])
                    {
                        delete copt[controlled._oldDefault[i]];
                    }
                    else
                    {
                        diff = true;
                        break;
                    }
                }
                for (var i in copt)
                {
                    diff = true;
                    break;
                }
            }
            else
            {
                diff = controlled.value != controlled._oldDefault;
            }
        }
        // else means we are on creation form, so also select
        if (!diff)
        {
            var v = m.default_value;
            if (field_metadata[m.default_field]['defaults'][controlled_id])
            {
                for (var i in getSelectedIds(m.default_field))
                {
                    v = field_metadata[m.default_field]['defaults'][controlled_id][i];
                }
            }
            if (v)
            {
                controlled._oldDefault = setFieldValue(controlled, v);
            }
        }
    }
}