* @version 1.8 * * Examples of use: * * require_once 'codebase/lib/FormValidator.inc.php'; * $fv = new FormValidator(); * * $fv->isEmpty('location_name', _("Location name cannot be blank.")); * $fv->checkRegex('cc_exp', '/^\d{4}$|^$/', true, _("CC exp date must be in MMYY format.")); * $fv->isInteger('client_id', _("Client id must be an integer.")); * $fv->numericRange('client_id', -32768, 32767, _("Client id must be a number between -32768 and 32767.")); * $fv->stringLength('zip', 0, 255, _("Zip must contain less than 256 characters.")); * $fv->validateEmail('invoice_email'); * $fv->validatePhone('phone1'); */ class FormValidator { // Array filling with error messages. var $errors = array(); // Default error marker; var $marker = ' class="sc-msg-error"'; /** * Return the current list of errors. * * @return array an array of errors in the following arrangement: * keys: the name of the variable with an error * vals: the message to display for that error */ function getErrorList() { return $this->errors; } /** * Add an error to the errors stack. * * @param string $form_name The name of the incoming form variable. * @param string $msg The error message for that form. * @param int $type The type of message: MSG_NOTICE, * MSG_SUCCESS, MSG_WARNING, or MSG_ERR. * @param string $file __FILE__. * @param string $line __LINE__. */ function addError($form_name, $msg='', $type=MSG_ERR, $file=null, $line=null) { $this->errors[] = array( 'name' => $form_name, 'message' => $msg, 'type' => $type, 'file' => $file, 'line' => $line ); } /** * Check whether any errors have been triggered. * * @param string $form_name the name of the incoming form variable * * @return bool true if any errors were found, or if found for * a variable of $form_name, false otherwise */ function anyErrors($form_name=null) { if (isset($form_name)) { foreach ($this->errors as $err) { if ($err['name'] == $form_name) { return true; } } return false; } return (sizeof($this->errors) > 0); } /** * Reset the error list. */ function resetErrorList() { $this->errors = array(); } /** * Prints the HTML for displaying error messages. * * @access public * @author Quinn Comendant * @since 15 Jul 2005 01:39:14 */ function printErrorMessages() { if ($this->anyErrors()) { ?>
getErrorList(); foreach ($errors as $err) { if (!empty($err['message']) && is_string($err['message'])) { if (error_reporting() > 0 && isset($err['file']) && isset($err['line'])) { echo "\n'; } switch ($err['type']) { case MSG_ERR: echo '
' . $err['message'] . '
'; break; case MSG_WARNING: echo '
' . $err['message'] . '
'; break; case MSG_SUCCESS: echo '
' . $err['message'] . '
'; break; case MSG_NOTICE: default: echo '
' . $err['message'] . '
'; break; } } } ?>
anyErrors($form_name)) { if (isset($marker)) { echo $marker; } else { echo $this->marker; } } } /** * Check whether input has a value. To be used when a value must be empty * under certain circumstances. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if form is not empty, false otherwise. */ function notEmpty($form_name, $msg='') { $val = trim(getFormData($form_name)); if ($val != '') { $this->addError($form_name, $msg); return true; } else { return false; } } /** * Check whether input is blank. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if form is empty, false otherwise. */ function isEmpty($form_name, $msg='') { $val = trim(getFormData($form_name)); if ($val == '') { $this->addError($form_name, $msg); return true; } else { return false; } } /** * Check whether input is a string. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if form is a string, false otherwise. */ function isString($form_name, $msg='') { $val = getFormData($form_name); if (!is_string($val) && $val != '') { $this->addError($form_name, $msg); return false; } else { return true; } } /** * Check whether input is a number. Allows negative numbers. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if no errors found, false otherwise */ function isNumber($form_name, $msg='') { $val = getFormData($form_name); if (!is_numeric($val) && $val != '') { $this->addError($form_name, $msg); return false; } else { return true; } } /** * addError if input is NOT an integer. Don't just use is_int() because the * data coming from the user is *really* a string. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if value is an integer */ function isInteger($form_name, $msg='', $negative_ok=false) { $val = getFormData($form_name); $pattern = $negative_ok ? '/^-?[[:digit:]]+$/' : '/^[[:digit:]]+$/'; if ((!is_numeric($val) || !preg_match($pattern, $val)) && $val != '') { $this->addError($form_name, $msg); return false; } else { return true; } } /** * Check whether input is a float. Don't just use is_float() because the * data coming from the user is *really* a string. Integers will also * pass this test. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if value is a float */ function isFloat($form_name, $msg='', $negative_ok=false) { $val = getFormData($form_name); $pattern = $negative_ok ? '/^-?[[:digit:]]*(?:\.?[[:digit:]]+)$/' : '/^[[:digit:]]*(?:\.?[[:digit:]]+)$/'; if ((!is_numeric($val) || !preg_match($pattern, $val)) && $val != '') { $this->addError($form_name, $msg); return false; } else { return true; } } /** * Check whether input is an array. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if value is a float */ function isArray($form_name, $msg='') { $val = getFormData($form_name); if (!is_array($val) && !empty($val)) { $this->addError($form_name, $msg); return false; } else { return true; } } /** * Check whether input matches the specified perl regular expression * pattern. * * @param string $form_name the name of the incoming form variable * @param int $regex perl regex that the string must match * @param bool $not set to false to be valid if match, or true * to be valid on no match * @param string $msg the message to display on error * * @return bool true if value passes regex test */ function checkRegex($form_name, $regex, $not, $msg='') { $val = getFormData($form_name); if ($not) { if (!preg_match($regex, $val)) { $this->addError($form_name, $msg); return false; } else { return true; } } else { if (preg_match($regex, $val)) { $this->addError($form_name, $msg); return false; } else { return true; } } } /** * Tests if the string length is between specified values. Whitespace excluded for min. * * @param string $form_name the name of the incoming form variable * @param int $min minimum length of string, inclusive * @param int $max maximum length of string, inclusive * @param string $msg the message to display on error * * @return bool true if string length is within given boundaries */ function stringLength($form_name, $min, $max, $msg='') { $val = getFormData($form_name); if (strlen(trim($val)) < $min || strlen($val) > $max) { $this->addError($form_name, $msg); return false; } else { return true; } } /** * Check whether input is within a valid numeric range. * * @param string $form_name the name of the incoming form variable * @param int $min minimum value of number, inclusive * @param int $max maximum value of number, inclusive * @param string $msg the message to display on error * * @return bool true if no errors found, false otherwise */ function numericRange($form_name, $min, $max, $msg='') { $val = getFormData($form_name); if ($val != '' && is_numeric($val)) { if ($val < $min || $val > $max) { $this->addError($form_name, $msg); return false; } return true; } else { // Not a number! return false; } } /** * Validates an email address based on the recommendations in RFC 3696. * Is more loose than restrictive, to allow the many valid variants of * email addresses while catching the most common mistakes. * http://www.faqs.org/rfcs/rfc822.html * http://www.faqs.org/rfcs/rfc2822.html * http://www.faqs.org/rfcs/rfc3696.html * http://www.faqs.org/rfcs/rfc1035.html * * @access public * @param string $form_name The name of the incoming form variable. * @return bool Validity of address. * @author Quinn Comendant */ function validateEmail($form_name) { $email = getFormData($form_name); if ('' == trim($email)) { return false; } require_once 'codebase/lib/Email.inc.php'; $e = new Email(); // Test email address format. if (!preg_match($e->getParam('regex'), $email, $e_parts)) { $this->addError($form_name, sprintf(_("%s is not a valid email address."), oTxt($email))); App::logMsg(sprintf('The email address %s is not valid.', getFormData($form_name)), LOG_DEBUG, __FILE__, __LINE__); return false; } // We have a match! Here are the captured subpatterns, on which further tests are run. $local = $e_parts[2]; // If domain is an IP [XXX.XXX.XXX.XXX] strip off the brackets. $domain = $e_parts[3]{0} == '[' ? substr($e_parts[3], 1, -1) : $e_parts[3]; // Test length. if (strlen($local) > 64 || strlen($domain) > 191) { $this->addError($form_name, sprintf(_("Email address must contain less than 256 characters."), oTxt($email))); App::logMsg(sprintf('The email address %s must contain less than 256 characters.', getFormData($form_name)), LOG_DEBUG, __FILE__, __LINE__); return false; } // Check domain exists: It's a domain if ip2long fails; Checkdnsrr ensures a MX record exists; Gethostbyname() ensures the domain exists. if (ip2long($domain) == '-1' && function_exists('checkdnsrr') && !checkdnsrr($domain . '.', 'MX') && gethostbyname($domain) == $domain) { $this->addError($form_name, sprintf(_("%s is not a valid email domain name"), oTxt($domain))); App::logMsg(sprintf('The email address %s contains an invalid email domain name (%s).', getFormData($form_name), $domain), LOG_INFO, __FILE__, __LINE__); return false; } return true; } // function validateEmail($form_name, $allow_fullname=false) // { // $email = getFormData($form_name); // if ('' == trim($email)) { // return false; // } // // // Test email address format. // if ($allow_fullname) { // if (!$this->checkRegex($form_name, '/^[^<>@]*()]+\@[A-Za-z0-9.-]+\.[A-Za-z]{2,5}>?$/i', true, sprintf(_("%s is not a valid email address."), $email))) { // App::logMsg(sprintf('The email address %s is not valid.', getFormData($form_name)), LOG_DEBUG, __FILE__, __LINE__); // return false; // } // } else { // if (!$this->checkRegex($form_name, '/^[^\s@\[\]<>()]+\@[A-Za-z0-9.-]+\.[A-Za-z]{2,5}$/i', true, sprintf(_("%s is not a valid email address."), $email))) { // App::logMsg(sprintf('The email address %s is not valid.', getFormData($form_name)), LOG_DEBUG, __FILE__, __LINE__); // return false; // } // } // // // Test length. // if (!$this->stringLength($form_name, 0, 255, sprintf(_("Email address must contain less than 256 characters."), $email))) { // App::logMsg(sprintf('The email address %s must contain less than 256 characters.', getFormData($form_name)), LOG_DEBUG, __FILE__, __LINE__); // return false; // } // // // Check domain exists and has valid MX record. // preg_match('/^[^<>@]*()]+\@([A-Za-z0-9.-]+\.[A-Za-z]{2,5})>?$/i', $email, $matches); // if (!empty($matches[1])) { // if (!checkdnsrr($matches[1] . '.', 'MX') && gethostbyname($matches[1]) == $matches[1]) { // $this->addError($form_name, sprintf(_("%s is not a valid email domain name"), $matches[1])); // App::logMsg(sprintf('The email address %s contains an invalid email domain name (%s).', getFormData($form_name), $matches[1]), LOG_DEBUG, __FILE__, __LINE__); // return false; // } // } // // return true; // } /** * Check whether input is a valid phone number. Notice: it is now set * to allow characters like - or () or + so people can type in a phone * number that looks like: +1 (530) 624-4410 * * @param string $form_name the name of the incoming form variable * * @return bool true if no errors found, false otherwise */ function validatePhone($form_name) { $phone = getFormData($form_name); return $this->checkRegex($form_name, '/^[0-9 +().-]*$/', true, sprintf(_("The phone number %s is not valid."), $phone)) && $this->stringLength($form_name, 0, 25, sprintf(_("The phone number %s is too long"), $phone)); } /** * Verifies that date can be processed by the strtotime function. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if no errors found, false otherwise */ function validateStrDate($form_name, $msg='') { if (($timestamp = strtotime(getFormData($form_name, '0'))) === -1) { $this->addError($form_name, $msg); App::logMsg(sprintf('The string date %s is not valid.', getFormData($form_name)), LOG_DEBUG, __FILE__, __LINE__); return false; } else { return true; } } /** * Verifies credit card number. * * @param string $form_name The name of the incoming form variable. * @param string $cc_num Card number to verify. * @param string $cc_type Optional, card type to do specific checks. * * @return bool true if no errors found, false otherwise */ function validateCCNumber($form_name, $cc_num=null, $cc_type=null) { if (!isset($cc_num)) { $cc_num = getFormData($form_name); } if ('' == $cc_num) { return false; } // Innocent until proven guilty $card_is_valid = true; // Get rid of any non-digits $cc_num = preg_replace('/[^\d]/', '', $cc_num); // Perform card-specific checks, if applicable switch (strtolower($cc_type)) { case 'visa' : $card_is_valid = preg_match('/^4\d{15}$|^4\d{12}$/', $cc_num); break; case 'mastercard' : case 'mc' : $card_is_valid = preg_match('/^5[1-5]\d{14}$/', $cc_num); break; case 'american_express' : case 'american_ex' : case 'americanexpress' : case 'americanex' : case 'am_ex' : case 'amex' : case 'ae' : $card_is_valid = preg_match('/^3[47]\d{13}$/', $cc_num); break; case 'discover' : $card_is_valid = preg_match('/^6011\d{12}$/', $cc_num); break; case 'diners_club' : case 'dinersclub' : case 'diners' : case 'diner' : case 'dc' : $card_is_valid = preg_match('/^30[0-5]\d{11}$|^3[68]\d{12}$/', $cc_num); break; case 'jcb' : $card_is_valid = preg_match('/^3\d{15}$|^2131|1800\d{11}$/', $cc_num); break; } // The Luhn formula works right to left, so reverse the number. $cc_num = strrev($cc_num); $luhn_total = 0; $num = strlen($cc_num); for ($i=0; $i<$num; $i++) { // Get each digit. $digit = substr($cc_num,$i,1); // If it's an odd digit, double it. if ($i / 2 != floor($i / 2)) { $digit *= 2; } // If the result is two digits, add them. if (strlen($digit) == 2) { $digit = substr($digit,0,1) + substr($digit,1,1); } // Add the current digit to the $luhn_total. $luhn_total += $digit; } // If it passed (or bypassed) the card-specific check and the Total is evenly divisible by 10, it's cool! if ($card_is_valid && $luhn_total % 10 == 0) { return true; } else { $this->addError($form_name, _("The credit card number you entered is not valid.")); return false; } } /** * Check whether uploaded file is valid. * * @param string $form_name the name of the incoming form variable * @param string $msg the message to display on error * * @return bool true if no errors found, false otherwise */ function validateFile($form_name, $msg='') { if (isset($_FILES[$form_name]['tmp_name']) && '' == trim($_FILES[$form_name]['tmp_name'])) { $this->addError($form_name, $msg); return false; } else { return true; } } } // THE END ?>