/* this whole js file is used for web user form validation on email fields- I don't know if the function checkUsername() is used anywhere */ 
/* PW: not totally true... this is to be a general formUtils js file now...  */

function emailCheck (emailStr) {

/* The following variable tells the rest of the function whether or not
to verify that the address ends in a two-letter country or well-known
TLD.  1 means check it, 0 means don't. */

var checkTLD=0;

/* The following is the list of known TLDs that an e-mail address must end with. */

var knownDomsPat=/^(com|net|org|edu|int|mil|gov|arpa|biz|aero|name|coop|info|pro|museum)$/;

/* The following pattern is used to check if the entered e-mail address
fits the user@domain format.  It also is used to separate the username
from the domain. */

var emailPat=/^(.+)@(.+)$/;

/* The following string represents the pattern for matching all special
characters.  We don't want to allow special characters in the address. 
These characters include ( ) < > @ , ; : \ " . [ ] */

var specialChars="\\(\\)><@,;:\\\\\\\"\\.\\[\\]";

/* The following string represents the range of characters allowed in a 
username or domainname.  It really states which chars aren't allowed.*/

var validChars="\[^\\s" + specialChars + "\]";

/* The following pattern applies if the "user" is a quoted string (in
which case, there are no rules about which characters are allowed
and which aren't; anything goes).  E.g. "jiminy cricket"@disney.com
is a legal e-mail address. */

var quotedUser="(\"[^\"]*\")";

/* The following pattern applies for domains that are IP addresses,
rather than symbolic names.  E.g. joe@[123.124.233.4] is a legal
e-mail address. NOTE: The square brackets are required. */

var ipDomainPat=/^\[(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\]$/;

/* The following string represents an atom (basically a series of non-special characters.) */

var atom=validChars + '+';

/* The following string represents one word in the typical username.
For example, in john.doe@somewhere.com, john and doe are words.
Basically, a word is either an atom or quoted string. */

var word="(" + atom + "|" + quotedUser + ")";

// The following pattern describes the structure of the user

var userPat=new RegExp("^" + word + "(\\." + word + ")*$");

/* The following pattern describes the structure of a normal symbolic
domain, as opposed to ipDomainPat, shown above. */

var domainPat=new RegExp("^" + atom + "(\\." + atom +")*$");

/* Finally, let's start trying to figure out if the supplied address is valid. */

/* Begin with the coarse pattern to simply break up user@domain into
different pieces that are easy to analyze. */

var matchArray=emailStr.match(emailPat);

if (matchArray==null) {

/* Too many/few @'s or something; basically, this address doesn't
even fit the general mould of a valid e-mail address. */

alert("Email address seems incorrect (check @ and .'s)");
return false;
}
var user=matchArray[1];
var domain=matchArray[2];

// Start by checking that only basic ASCII characters are in the strings (0-127).

for (i=0; i<user.length; i++) {
if (user.charCodeAt(i)>127) {
alert("Ths username in the email address contains invalid characters.");
return false;
   }
}
for (i=0; i<domain.length; i++) {
if (domain.charCodeAt(i)>127) {
alert("Ths domain name in the email address contains invalid characters.");
return false;
   }
}

// See if "user" is valid 

if (user.match(userPat)==null) {

// user is not valid

alert("The username in the email address doesn't seem to be valid.");
return false;
}

/* if the e-mail address is at an IP address (as opposed to a symbolic
host name) make sure the IP address is valid. */

var IPArray=domain.match(ipDomainPat);
if (IPArray!=null) {

// this is an IP address

for (var i=1;i<=4;i++) {
if (IPArray[i]>255) {
alert("Destination IP address in email is invalid!");
return false;
   }
}
return true;
}

// Domain is symbolic name.  Check if it's valid.
 
var atomPat=new RegExp("^" + atom + "$");
var domArr=domain.split(".");
var len=domArr.length;
for (i=0;i<len;i++) {
if (domArr[i].search(atomPat)==-1) {
alert("The domain name does not seem to be valid in the email address.");
return false;
   }
}

/* domain name seems valid, but now make sure that it ends in a
known top-level domain (like com, edu, gov) or a two-letter word,
representing country (uk, nl), and that there's a hostname preceding 
the domain or country. */

if (checkTLD && domArr[domArr.length-1].length!=2 && 
domArr[domArr.length-1].search(knownDomsPat)==-1) {
alert("The email address must end in a well-known domain or two letter " + "country.");
return false;
}

// Make sure there's a host name preceding the domain.

if (len<2) {
alert("This address is missing a hostname!");
return false;
}

// If we've gotten this far, everything's valid!
return true;
}



function checkUsername(usernameStr)
{
  var specialChars="\\(\\)><,\\'&;:\\\\\\\"\\[\\] ";
  var validChars="\[^\\s" + specialChars + "\]";
  var atom=validChars + '+';
  var usernamePat=new RegExp("^" + atom + "$");
  if (usernameStr.match(usernamePat)==null) {
    alert("The username must not be empty and cannot contain spaces or the following special characters: ()<>,'&:;[]\\\"");
    return false;
  }
  else {
    return true;
  }
}


/* Form Validation (previously in cmscore.js) */

var requiredFields = new Array();
function addRequiredField(field)
{
  requiredFields.push(field);
}
function checkRequiredFields(form)
{
  for (i=0; i<requiredFields.length; i++) {
    if (requiredFields[i]) { //PW: new temp safety check to stop Moz errors
      var count = 0;
      
      if (requiredFields[i].getAttribute) field = requiredFields[i];
      else if (!form) field = document.all(requiredFields[i]);
      else {
        var fields = new Array();
        for (var j = 0; j < form.elements.length; j++) {
          if (form.elements[j].name == requiredFields[i]) { 
            fields.push(form.elements[j]);
            if (count == 0) {
              // take the first one
              field = form.elements[j];
            }
            count++;
          }
        }
      }
      if (count > 1) {
        // multi-checkbox or radio
        missing = checkArray(fields);
      }
      else {
        missing = field == null || field.value == "" || checkArray(field);
      }
      
      if (missing) {
        message = "Missing Required Field: Please supply values for all required fields" + 
                  " (ie those marked with an *)";
        if (field && field.getAttribute) {
          if (field.getAttribute('displayName'))
            message += '\n\n' + field.getAttribute('displayName');
          else if (field.getAttribute('name')) {
            if (field.getAttribute('name').indexOf('cmf') == 0)
              message += '\n\n' + field.getAttribute('name').substring(3);
            else
              message += '\n\n' + field.getAttribute('name');
          }
        }  
        alert(message);
        return false;
      }
    }
  }
  return true;
}

function checkArray(list) {
  if (!list.length) return false;
  for (j=0; j < list.length; j++) {
    if (list[j].checked || list[j].selected) return false;
  }
  return true;
}

