// ==============================================================================
//                     JavaScript Form Validation Libarary
// ==============================================================================
// a DentedReality Production 2001,2002,2003
// written by Beau Lebens <beau@dentedreality.com.au>
// See: http://www.dentedreality.com.au/jsvalidation/
// Version 1.3

// Validate the fields on a form using specific, custom attributes
// required="true" => this field must have something in it. Use this
//	in combination with another rule normally.
// validate="true" => validate this field, provided it has a rule
// rule="rule" => use the rule specified to validate this input "value"
//	Options for "rule":
//		"txt"		= Text Only (and spaces)
//		"num"		= Numbers Only (allow decimal)
//		"int"		= Integers only
//		"phone" 	= Phone number, (0-9()-+)
//		"date"		= Date Format (dd/mm/yyyy)
//		"email" 	= Email addresses
//		"alnum" 	= Alpha-Numeric Values
//		"curr"		= Currency ($xxxx..."."xx)
//		"addr"  	= Address characters (a-zA-Z0-9-,#)
//		"name" 		= Most likely characters in a name  (a-zA-Z,.-)
//		"free"		= Freeform text (a-zA-Z0-9+-_()[]/&)
//		"nobadsql"	= Denies harmful SQL syntax
//		"notnull"	= Must enter something
//		RegExp		= Any valid regular expression you may specify
//					ie. "/^[\d]{0,3}.[\d]{0,3}.[\d]{0,3}$/" = an IP number
// error="Extended String" => the error message if validation fails. (without a
//	newline character at the end or a bullet at the start, they are added)
// ==============================================================================


// Default Operational Values, Modify these to change default actions of
// the data validation library.

// This is the rule to use to validate a value if none is specified.
defaultValidationRule	= "notnull";
// Line break code for error message.
lineBreak = "<br/>";
// Class for fields with error
errorFieldClass = "bsError";
// This is the first part of the error message, set to blank to just show a list
// of errors.
defaultErrorPrefix	= "El formulario no puede enviarse con estos errores:";
// [ELEMENT] is replaced with the field name when displayed.
defaultErrorMessage	= "El valor del campo '[ELEMENT]' no es v&aacute;lido.";
// JSon structure for validation rules
validationRules = {	"txt" 	: /^[a-z ]*$/i, 
					"num" 	: /^[\d\.]*$/, 
					"int" 	: /^\d*$/, 
					"phone" : /^[\d \-\(\)\+]*$/, 
					"date" 	: /^(()|(\d{1,2}(\/|-)\d{1,2}(\/|-)\d{2,4}))$/, 
					"email" : /^[a-z\d\.\-_]+@[a-z\d\.\-_]{2,}\.[a-z]{2,10}$/i,
					"alnum" : /^[\w ]*$/i, 
					"curr":  /^\$?\d*,?\.?\d{0,2}$/i, 
					"addr" : /^[\w- \.,#]*$/gi,
					"name" : /^[a-z,\-\. ]*$/gi,
					"free" : /^[\w\-\+\(\)\[\]\\/&, ]*$/i,
					"nobadsql" : /((delete|drop|update|replace|kill|lock) )/gi,
					"notnull" : /.+/ }

// ==============================================================================
//							   ACTUAL VALIDATION CODE
// ==============================================================================

// Actual code for determining and then applying a regular expression
// to the designated form element. Returns true if the pattern matches,
// false if it doesn't.
function validateField(field_name, validation_code) {
	// This is a switch used for reversing the desired regular
	// expression result.
	// Set to "true" if matching a regexp successfully should
	// result in a failure.
	invertResult = false;

	// Check if they supplied a custom RegExp or just a rule name
	if (validation_code.charAt(0) != "/") {
		// These are the pre-defined rules available.
		validation_code = validation_code.toLowerCase();
		re = validationRules[validation_code];		
		// Set the default validation for this field if none applied
		if (re == null) re = validationRules[defaultValidationRule];		
	} else {	
		// This means they specified a RegExp of their own, which should be
		// in the form "/<RegExp>/" and needs to be "eval"ed before using.
		re = eval(validation_code);
	}
	
	// Do the actual regular expression testing against the string
	// and return the result.
	if (re.test(field_name.value)) {
		// If this rule uses result inversion, then return the opposite
		return !invertResult;
	} else {
		// If this rule uses result inversion, then return the opposite
		return invertResult;
	}
}

// This is the mainline function which needs to be called on form submission to
// check required fields
function validateForm(form) {
	masterErrorMsg = defaultErrorPrefix;
	checkedFields = new Array('', '', '');

	// Loop through every element in the form specified.
	for (x=0; x<form.elements.length; x++) {
		rule = "";
		msg  = "";
		form_element = form.elements[x];
		
		// Ensure the form element exists
		if (!form_element) continue;
		// Make sure the field is supposed to be validated.
		if (form_element.getAttribute("validate") && 
			!in_array("+" + form_element.name, checkedFields)) {
			// add this field into the "checkedFields" array to avoid
			// checking it again.
			checkedFields[checkedFields.length] = "+" + form_element.name;
			
			// Set default validation rule if none is specified
			if (!form_element.getAttribute("rule"))
				rule = defaultValidationRule;
			else
				rule = form_element.getAttribute("rule");
			
			// And set the default error message
			// Replaces [ELEMENT] with the field name in the default
			// error message string if it is used.
			if (!form_element.getAttribute("error"))
				error = defaultErrorMessage.replace('\[ELEMENT\]', form_element.name);
			else
				error = form_element.getAttribute("error");
			
			// If the validation fails, add this error message
			// to the running message.
			if (!validateField(form_element, rule) || 
				(form_element.getAttribute("required") && form_element.value == "")) {
				form_element.className = errorFieldClass;
				masterErrorMsg += lineBreak + " - " + error;
			} else {
				form_element.className = "";
			}
		}	
	}
	
	// This checks the current error message against the default,
	// if it has been changed (which means an error occurred) then
	// it displays the error and then returns false to prevent the
	// form from being submitted.
	if (masterErrorMsg != defaultErrorPrefix) {
		// Consider implementing customisable pop-up window
		// here rather than basic alert.
		// Customise window title, colours
		showValidationError(masterErrorMsg, form);		
		return false;
	}
	// If the current error message is the same as the default,
	// then that means nothing has gone wrong, so just return
	// true and allow the form to be submitted and be processed
	// as per normal.
	else {
		return true;
	}
}

function showValidationError(errorMessage, form)
{
	obj = document.getElementById(form.name + "Msg");
	obj.innerHTML = errorMessage;
	obj.style.display = "";
}

function debug(text)
{
	cont = document.getElementById("ddebug").innerHTML;
	cont += "<br/>" + text;
	document.getElementById("ddebug").innerHTML = cont;	
}

// Returns true or false based on whether the specified string is found
// in the array.
// This is based on the PHP function of the same name.
function in_array(stringToSearch, arrayToSearch) {
	for (s = 0; s < arrayToSearch.length; s++) {
		thisEntry = arrayToSearch[s];
		if (thisEntry.indexOf(stringToSearch) != -1) {
			return true;
		}
	}
	return false;
}

// ==============================================================================