// ----------------------------------------------------------------------
// Javascript form validation routines.
// Author: Stephen Poley
// Adapted, heavily, for this site by Joe Casey
//
// Simple routines to quickly pick up obvious typos.
// All validation routines return true if executed by an older browser:
// in this case validation must be left to the server.
//
// Update Jun 2005: discovered that reason IE wasn't setting focus was
// due to an IE timing bug. Added 0.1 sec delay to fix.
//
// Update Oct 2005: minor tidy-up: unused parameter removed
//
// Update Jun 2006: minor improvements to variable names and layout
// ----------------------------------------------------------------------

var nbsp = 160;		// non-breaking space char
var node_text = 3;	// DOM text node-type
var emptyString = /^\s*$/ ;
var global_valfield;	// retain valfield for timer thread

// --------------------------------------------
//                  trim
// Trim leading/trailing whitespace off string
// --------------------------------------------

function trim(str)
{
  return str.replace(/^\s+|\s+$/g, '');
}


// --------------------------------------------
//                  setfocus
// Delayed focus setting to get around IE bug
// --------------------------------------------

function setFocusDelayed()
{
  global_valfield.focus();
}

function setfocus(valfield)
{
  // save valfield in global variable so value retained when routine exits
  global_valfield = valfield;
  setTimeout( 'setFocusDelayed()', 100 );
}


// --------------------------------------------
//                  msg
// Display warn/error message in HTML element.
// commonCheck routine must have previously been called
// --------------------------------------------

function msg(fld,     // id of element to display message in
             msgtype, // class to give element ("warn" or "error")
             message) // string to display
{
  // setting an empty string can give problems if later set to a 
  // non-empty string, so ensure a space present. (For Mozilla and Opera one could 
  // simply use a space, but IE demands something more, like a non-breaking space.)
  var dispmessage;
  if (emptyString.test(message)) 
    dispmessage = String.fromCharCode(nbsp);    
  else  
    dispmessage = message;

  var elem = document.getElementById(fld);
  elem.firstChild.nodeValue = dispmessage;  
  
  elem.className = msgtype;   // set the CSS class to adjust appearance of message
}

// --------------------------------------------
//            commonCheck
// Common code for all validation routines to:
// (a) check for older / less-equipped browsers
// (b) check if empty fields are required
// Returns true (validation passed), 
//         false (validation failed) or 
//         proceed (don't know yet)
// --------------------------------------------

var proceed = 2;  

function commonCheck    (valfield,   // element to be validated
                         infofield,  // id of element to receive info/error msg
                         required)   // true if required
{
  if (!document.getElementById) 
    return true;  // not available on this browser - leave validation to the server
  var elem = document.getElementById(infofield);
  if (!elem.firstChild) return true;  // not available on this browser 
  if (elem.firstChild.nodeType != node_text) return true;  // infofield is wrong type of node  

  if (emptyString.test(valfield.value)) {
    if (required) {
      msg (infofield, "error", "ERROR: required");  
      setfocus(valfield);
      return false;
    }
    else {
      msg (infofield, "warn", "");   // OK
      return true;  
    }
  }
  return proceed;
}

// --------------------------------------------
//            validatePresent
// Validate if something has been entered
// Returns true if so 
// --------------------------------------------

function validatePresent(valfield,   // element to be validated
                         infofield ) // id of element to receive info/error msg
{
  var stat = commonCheck (valfield, infofield, true);
  if (stat != proceed) return stat;

  msg (infofield, "warn", "");  
  return true;
}

// --------------------------------------------
//            validatePrincipal
// Validate principal
// Returns true if so (and also if could not be executed because of old browser)
// Permits leading Dollar sign, commas, decimal point, cents
// --------------------------------------------

function validatePrincipal  (valfield,   // element to be validated
                             infofield,  // id of element to receive info/error msg
                             required)   // true if required
{
  var stat = commonCheck (valfield, infofield, required);
  if (stat != proceed) return stat;

  var principal = trim(valfield.value);  // value of field with whitespace trimmed off
//  var principalRE = /^[\$]?([0-9]{1,7}|[1-5],[0-9]{3},[0-9]{3})$/  ;
//var principalRE = /^[\$]?([0-9]{1,7}|[1-5],\d\d\d,\d\d\d|[0-9]{1,3},\d\d\d)(.\d\d)?$/  ;
//  if (!principalRE.test(tfld)) {
  principal = principal.replace("$","");
  principal = principal.replace(/,/g,"");
  if (principal != parseInt(principal) && principal != parseFloat(principal)) {  // is it numeric?
//    msg (infofield, "error", "ERROR: not a valid dollar amount.");
    msg (infofield, "error", "ERROR: must be a dollar amount");
    setfocus(valfield);
    return false;
  }
  if (principal < 10000) {  // less than 10000?
    msg (infofield, "error", "ERROR: must be greater than $9,999.");
    setfocus(valfield);
    return false;
  }
  if (principal >= 1000000 ) {  // more than $1,000,000?
    msg (infofield, "error", "ERROR: must be less than $1,000,000.");
    setfocus(valfield);
    return false;
  } 
 
  else {msg (infofield, "notError", "OK"); }
 
  return true;
}

// --------------------------------------------
//               validateRate
// Validate if possible rate
// Returns true if so (and also if could not be executed because of old browser)
// --------------------------------------------

function validateRate   (valfield,   // element to be validated
                         infofield,  // id of element to receive info/error msg
                         required)   // true if required
{
  var stat = commonCheck (valfield, infofield, required);
  if (stat != proceed) return stat;

  var tfld = trim(valfield.value);  // value of field with whitespace trimmed off
  tfld = tfld.replace("%","");
  if (tfld != parseInt(tfld) && tfld != parseFloat(tfld)) { // is it numeric?
    msg (infofield, "error", "ERROR: not a valid interest rate");
    setfocus(valfield);
    return false;
  }

  if (tfld>25) {
    msg (infofield, "error", "ERROR: maximum 25%");
    setfocus(valfield);
    return false;
  }

  if (tfld<1) {
    msg (infofield, "error", "ERROR: minimum 1%");
    setfocus(valfield);
    return false;
  }

  else {msg (infofield, "notError", "OK"); }

  return true;
}

// --------------------------------------------
//             validateTerm
// Validate mortgage Term
// Returns true if OK 
// --------------------------------------------

function validateTerm   (valfield,   // element to be validated
                         infofield,  // id of element to receive info/error msg
                         required)   // true if required
{
  var stat = commonCheck (valfield, infofield, required);
  if (stat != proceed) return stat;

  var tfld = trim(valfield.value);
  if (tfld != parseInt(tfld)) {
    msg (infofield, "error", "ERROR: not a valid term");
    setfocus(valfield);
    return false;
  }

  if (tfld>50) {
    msg (infofield, "error", "ERROR: maximum 50 years");
    setfocus(valfield);
    return false;
  }

  if (tfld<5) {
    msg (infofield, "error", "ERROR: minimum 5 years");
    setfocus(valfield);
    return false;
  }

  else {msg (infofield, "notError", "OK"); }

  return true;
}
// --------------------------------------------
//             validateTitle
// Validate title and subtitle
// Returns true if OK 
// --------------------------------------------

function validateTitle  (valfield,   // element to be validated
                         infofield,  // id of element to receive info/error msg
                         required,  // true if required
                         maxLength) // no minimum, 0 is OK
{
  var stat = commonCheck (valfield, infofield, required);
  if (stat != proceed) return stat;

//  var tfld = trim(valfield.value);
//  var titleRE = /[0-9a-zA-Z!@%-_=+:,./]*$/ ;
//  if (!titleRE.test(tfld)) {
//    msg (infofield, "error", "ERROR: not a valid title. Please use letters, numbers, and any of these: !@%-_=+:,./");
//    setfocus(valfield);
//    return false;
//  }

  if (tfld.length>=maxLength) {
    msg (infofield, "error", "ERROR: maximum "+ maxLength +" characters");
    setfocus(valfield);
    return false;
  }
 
  else {msg (infofield, "notError", "OK"); }
 
  return true;
}

