view website/issues/html/help_controls.js @ 5548:fea11d05110e

Avoid errors from selecting "no selection" on multilink (issue2550722). As discussed in issue 2550722 there are various cases where selecting "no selection" on a multilink can result in inappropriate errors from Roundup: * If selecting "no selection" produces a null edit (a value was set in the multilink in an edit with an error, then removed again, along with all other changes, in the next form submission), so the page is rendered from the form contents including the "-<id>" value for "no selection" for the multilink. * If creating an item with a nonempty value for a multilink has an error, and the resubmission changes that multilink to "no selection" (and this in turn has subcases, according to whether the creation then succeeds or fails on the resubmission, which need fixes in different places in the Roundup code). All of these cases have in common that it is expected and OK to have a "-<id>" value for a submission for a multilink when <id> is not set in that multilink in the database (because the original attempt to set <id> in that multilink had an error), so the hyperdb.py logic to give an error in that case is thus removed. In the subcase of the second case where the resubmission with "no selection" has an error, the templating code tries to produce a menu entry for the "-<id>" multilink value, which also results in an error, hence the templating.py change to ignore such values in the list for a multilink.
author Joseph Myers <jsm@polyomino.org.uk>
date Thu, 27 Sep 2018 11:33:01 +0000
parents 536344835432
children
line wrap: on
line source

// initial values for either Nosy, Superseder, Topic and Waiting On,
// depending on which has called
original_field = form[field].value;

// Some browsers (ok, IE) don't define the "undefined" variable.
undefined = document.geez_IE_is_really_friggin_annoying;

function trim(value) {
  var temp = value;
  var obj = /^(\s*)([\W\w]*)(\b\s*$)/;
  if (obj.test(temp)) { temp = temp.replace(obj, '$2'); }
  var obj = /  /g;
  while (temp.match(obj)) { temp = temp.replace(obj, " "); }
  return temp;
}

function determineList() {
     // generate a comma-separated list of the checked items
     var list = new String('');

     // either a checkbox object or an array of checkboxes
     var check = document.frm_help.check;

     if ((check.length == undefined) && (check.checked != undefined)) {
         // only one checkbox on page
         if (check.checked) {
             list = check.value;
         }
     } else {
         // array of checkboxes
         for (box=0; box < check.length; box++) {
             if (check[box].checked) {
                 if (list.length == 0) {
                     separator = '';
                 }
                 else {
                     separator = ',';
                 }
                 // we used to use an Array and push / join, but IE5.0 sux
                 list = list + separator + check[box].value;
             }
         }
     }
     return list;
}

/**
 * update the field in the opening window;
 * the text_field variable must be set in the calling page
 */
function updateOpener() {
  // write back to opener window
  if (document.frm_help.check==undefined) { return; }
  form[field].value = text_field.value;

  /* trigger change event on the field we changed */
  if ("createEvent" in document) {
    var evt = document.createEvent("HTMLEvents");
    evt.initEvent("change", true, true);
    form[field].dispatchEvent(evt);
  }
    else
	form[field].fireEvent("onchange");
}

function updateList() {
  // write back to opener window
  if (document.frm_help.check==undefined) { return; }
  form[field].value = determineList();

  /* trigger change event on the field we changed */
  if ("createEvent" in document) {
    var evt = document.createEvent("HTMLEvents");
    evt.initEvent("change", true, true);
    form[field].dispatchEvent(evt);
  }
    else
	form[field].fireEvent("onchange");
}

function updatePreview() {
  // update the preview box
  if (document.frm_help.check==undefined) { return; }
  writePreview(determineList());
}

function clearList() {
  // uncheck all checkboxes
  if (document.frm_help.check==undefined) { return; }
  for (box=0; box < document.frm_help.check.length; box++) {
      document.frm_help.check[box].checked = false;
  }
}

function reviseList_framed(form, textfield) {
  // update the checkboxes based on the preview field
  // alert('reviseList_framed')
  // alert(form)
  if (form.check==undefined)
      return;
  // alert(textfield)
  var to_check;
  var list = textfield.value.split(",");
  if (form.check.length==undefined) {
      check = form.check;
      to_check = false;
      for (val in list) {
          if (check.value==trim(list[val])) {
              to_check = true;
              break;
          }
      }
      check.checked = to_check;
  } else {
    for (box=0; box < form.check.length; box++) {
      check = form.check[box];
      to_check = false;
      for (val in list) {
          if (check.value==trim(list[val])) {
              to_check = true;
              break;
          }
      }
      check.checked = to_check;
    }
  }
}

function reviseList(vals) {
  // update the checkboxes based on the preview field
  if (document.frm_help.check==undefined) { return; }
  var to_check;
  var list = vals.split(",");
  if (document.frm_help.check.length==undefined) {
      check = document.frm_help.check;
      to_check = false;
      for (val in list) {
          if (check.value==trim(list[val])) {
              to_check = true;
              break;
          }
      }
      check.checked = to_check;
  } else {
    for (box=0; box < document.frm_help.check.length; box++) {
      check = document.frm_help.check[box];
      to_check = false;
      for (val in list) {
          if (check.value==trim(list[val])) {
              to_check = true;
              break;
          }
      }
      check.checked = to_check;
    }
  }
}

function resetList() {
  // reset preview and check boxes to initial values
  if (document.frm_help.check==undefined) { return; }
  writePreview(original_field);
  reviseList(original_field);
}

function writePreview(val) {
   // writes a value to the text_preview
   document.frm_help.text_preview.value = val;
}

function focusField(name) {
    for(i=0; i < document.forms.length; ++i) {
      var obj = document.forms[i].elements[name];
      if (obj && obj.focus) {obj.focus();}
    }
}

function selectField(name) {
    for(i=0; i < document.forms.length; ++i) {
      var obj = document.forms[i].elements[name];
      if (obj && obj.focus){obj.focus();}
      if (obj && obj.select){obj.select();}
    }
}

function checkRequiredFields(fields)
{
    var bonk='';
    var res='';
    var argv = checkRequiredFields.arguments;
    var argc = argv.length;
    var input = '';
    var val='';

    for (var i=0; i < argc; i++) {
        fi = argv[i];
        input = document.getElementById(fi);
        if (input) {
            val = input.value
            if (val == '' || val == '-1' || val == -1) {
                if (res == '') {
                    res = fi;
                    bonk = input;
                } else {
                    res += ', '+fi;
                }
            }
        } else {
            alert('Field with id='+fi+' not found!')
        }
    }
    if (res == '') {
        return submit_once();
    } else {
        alert('Missing value here ('+res+')!');
        if (window.event && window.event.returnvalue) {
            event.returnValue = 0;    // work-around for IE
        }
        bonk.focus();
        return false;
    }
}

/**
 * seeks the given value (2nd argument)
 * in the value of the given input element (1st argument),
 * which is considered a list of values, separated by commas
 */
function has_value(input, val)
{
    var actval = input.value
    var arr = feld.value.split(',');
    var max = arr.length;
    for (i=0;i<max;i++) {
        if (trim(arr[i]) == val) {
            return true
        }
    }
    return false
}

/**
 * Switch Value:
 * change the value of the given input field (might be of type text or hidden),
 * adding or removing the value of the given checkbox field (might be a radio
 * button as well)
 *
 * This function doesn't care whether or not the checkboxes of all values of
 * interest are present; but of course it doesn't have total control of the
 * text field.
 */
function switch_val(text, check)
{
    var switched_val = check.value
    var arr = text.value.split(',')
    var max = arr.length
    if (check.checked) {
        for (i=0; i<max; i++) {
            if (trim(arr[i]) == switched_val) {
                return
            }
        }
	if (text.value)
            text.value = text.value+','+switched_val
	else
            text.value = switched_val
    } else {
        var neu = ''
	var changed = false
        for (i=0; i<max; i++) {
            if (trim(arr[i]) == switched_val) {
                changed=true
            } else {
                neu = neu+','+trim(arr[i])
            }
        }
        if (changed) {
            text.value = neu.substr(1)
        }
    }
}

/**
 * append the given value (2nd argument) to an input field
 * (1st argument) which contains comma-separated values;
 * see --> remove_val()
 *
 * This will work nicely even for batched lists
 */
function append_val(name, val)
{
    var feld = document.itemSynopsis[name];
    var actval = feld.value;
    if (actval == '') {
        feld.value = val
    } else {
        var arr = feld.value.split(',');
        var max = arr.length;
        for (i=0;i<max;i++) {
            if (trim(arr[i]) == val) {
                return
            }
        }
        feld.value = actval+','+val
    }
}

/**
 * remove the given value (2nd argument) from the comma-separated values
 * of the given input element (1st argument); see --> append_val()
 */
function remove_val(name, val)
{
    var feld = document.itemSynopsis[name];
    var actval = feld.value;
    var changed=false;
    if (actval == '') {
	return
    } else {
        var arr = feld.value.split(',');
        var max = arr.length;
        var neu = ''
        for (i=0;i<max;i++) {
            if (trim(arr[i]) == val) {
                changed=true
            } else {
                neu = neu+','+trim(arr[i])
            }
        }
        if (changed) {
            feld.value = neu.substr(1)
        }
    }
}

/**
 * give the focus to the element given by id
 */
function focus2id(name)
{
    document.getElementById(name).focus();
}

Roundup Issue Tracker: http://roundup-tracker.org/