XForms/StandardValidator.php5

<?php

/* ------------------------------------------------------ */
/* StandardValidator
/* ------------------------------------------------------ */
/* Author: itorres@shodor.org, jwsm@shodor.org
/* Date: 10/06 - updated 5/17/07
/* Description: validates all input received thru XForms
/* via regular expressions.
/* ------------------------------------------------------ */

class StandardValidator {

    private $errorList = array();
    protected $customCodes = array();
    protected $extensions = array(
        'image/jpg' => 'jpg',
        'image/pjpeg' => 'jpg',
        'image/jpeg' => 'jpg',
        'image/gif' => 'gif',
        'image/png' => 'png',
        'application/pdf' =>'pdf',
        'application/msword' =>'doc',
        'application/x-compressed' => 'tgz',
        'application/zip' => 'zip',
        'application/x-zip' => 'zip',
        'application/x-zip-compressed' => 'zip',
        'application/x-gzip' => 'gz',
        'application/xml' =>'xml',
        'text/xml' =>'xml',
        'audio/mpeg' =>'mp3',
        'application/x-latex' => 'tex',
        'text/plain' => 'txt',
        'text/html' => 'html',
        'text/comma-separated-values' => 'csv',
        'text/csv' => 'csv',
        'application/csv' => 'csv',
        'application/excel' => 'csv',
        'application/vnd.ms-excel' => 'csv',
        'application/vnd.msexcel' => 'csv'
    );


    public function validateInput ( $input, $type )
    {
        switch ($type)
        {
            case 'string':
                $pattern = "/^[a-zA-Z\s]+$/";
                $errorCode = 100;
                break;
            case 'numbers':
                $pattern = "/^(\-)?[0-9\.]+(\s)?$/";
                $errorCode = 101;
                break;
            case 'alphanumeric':
                $pattern = "/^[0-9a-zA-Z\s]+$/";
                $errorCode = 102;
                break;
            case 'money':
                $pattern = "/^([0-9\-\.\,\$])$/";
                $errorCode = 137;
            case 'name':
                $pattern = "/^([a-zA-Z][0-9A-Za-z\-\.\,\']*(\s)?)+$/";
                $errorCode = 103;
                break;
            case 'email':
                $pattern = "/^[a-zA-Z0-9\.\_\-]+\@[a-zA-Z0-9\-\_]+\.[a-z0-9\-\_\.]+(\s)?$/";
                $errorCode = 104;
                break;
            case 'address':
                $pattern = "/^[a-zA-Z0-9\s\.\-\,\#]+(\s)?$/";
                $errorCode = 105;
                break;
            case 'city':
                $pattern = "/^[a-zA-Z0-9\s\-\.]+(\s)?$/";
                $errorCode = 106;
                break;
            case 'state':
                $pattern = "/^[a-zA-Z\s\.]+(\s)?$/";
                $errorCode = 107;
                break;
            case 'zip':
                $pattern = "/^[0-9]{5,9}(\-[0-9]{4})?(\s)?$/";
                $errorCode = 108;
                break;
            case 'website':
                # source: http://www.mattfarina.com/2009/01/08/rfc-3986-url-validation
                $pattern = "/^([a-z][a-z0-9\*\-\.]*):\/\/(?:(?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*(?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@)?(?:(?:[a-z0-9\-\.]|%[0-9a-f]{2})+|(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\]))(?::[0-9]+)?(?:[\/|\?](?:[\w#!:\.\?\+=&@!$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})*)?$/i";
                $errorCode = 109;
                break;
            case 'checkbox':
                $pattern = "/^([a-zA-Z0-9\.\_\/\(\)]+(\s)?)+$/";
                $errorCode = 110;
                break;
            case 'pulldown':
                $pattern = "/^[a-zA-Z\s\_]+$/";
                $errorCode = 111;
                break;
            case 'phone':
                $pattern = "/^[0-9a-zA-Z\-\s\(\)\+]{7,20}$/";
                $errorCode = 112;
                break;
            case 'birthday':
                $pattern = "/^[a-zA-Z0-9\s\,\-\/]+$/";
                $errorCode = 113;
                break;
            case 'paragraph':
            case 'textlist':
                $pattern = "//";
                $errorCode = 115;
                break;
            case 'shortname':
            case 'shortName':
                $pattern = "/^[a-zA-Z0-9\_\-\.]+$/";
                $errorCode = 116;
                break;
            case 'organization':
                $pattern = "/^([A-Za-z0-9\-\.\,]*(\s)?)+$/";
                $errorCode = 117;
                break;
            case 'username':
                $pattern = "/^[a-z][a-z0-9\_]{2,13}$/";
                $errorCode = 130;
                break;
            case 'time':
                $pattern = "/^[0-9]{1,2}[hH](\s)?[0-9]{1,2}[mM](\s)?$/";
                $errorCode = 131;
                break;
            case 'date':
                //$pattern = "[0-3][0-9]\/[0-1][0-9]\/[0-2][0-9][0-9][0-9]?$/";
                $explodedPatt = explode("/",$input);
                                if(sizeof($explodedPatt) == 3){
                    $day = $explodedPatt[1];
                    $month = $explodedPatt[0];
                    $year = $explodedPatt[2];

                    $truthiness = (strlen($day) == 2) && ($day <= 31);
                    $truthiness = $truthiness && (strlen($month) == 2) && ($month <= 12);
                    $truthiness = $truthiness && (strlen($year) == 4) && ($year > 0) && ($year < (date("Y") + 20));

                    if($day > 29 && $month == 2){
                        $truthiness = false;
                    } else if (($month == 4 || $month == 6 || $month == 9 || $month == 11) && ($day > 30)){
                        $truthiness = false;
                    }

                    if(!$truthiness){
                        return 132;
                    } else {
                        return 0;
                    }

                } else {
                    return 132;
                }
                break;
            case 'password':
                $pattern = "/^[\S]{6,10}$/";
                $errorCode = 118;
                break;
            case 'fileName':
                $pattern = "/^[a-zA-Z0-9\.\-]+$/";
        $errorCode = 120;
                break;
            case 'xml':
            case 'mixedxml':
                $input = utf8_encode($input);

                $old_error_handler = set_error_handler(array($this, "XMLParseErrorHandler"));
                if ($type == "mixedxml") { $input = "<root> $input </root>"; }
                //print("checking $input");
                $check = simplexml_load_string("\n $input \n");
                restore_error_handler();
                if ($check === false) return 119;
                else return 0;
                break;
            default:
                $pattern = "//";
                $errorCode = 0;
            break;
        }

        $match =  preg_match($pattern, $input, $matches);

        if( ! $match) {

            return($errorCode);

        }
        return  (0);
    }

    public function validateFile($input, $type, $mime) {


        switch($type) {
            case 'jpg':
            if(! ($mime == "image/jpeg" || $mime == "image/pjpeg" || $mime == "image/jpg"))
                return(120);
                break;
            case 'png':
                if(!($mime == "image/png"))
                    return(121);
                break;
            case 'gif':
                if(!($mime == "image/gif"))
                    return(122);
                break;
            case 'pdf':
                if(!($mime == "application/pdf"))
                    return(123);
                break;
            case 'wordDoc':
                if(!($mime == "application/msword"))
                    return(124);
                break;
            case 'compressed':
                if(! ($mime == "application/x-compressed" || $mime == "application/x-zip" || 
                        $mime == "application/zip" || $mime == "application/x-zip-compressed" || $mime == "application/x-gzip"))
                    return (134);
                break;
            case 'image':
                if(! ($mime == "image/jpeg" || $mime == "image/pjpeg" || $mime == "image/jpg" || $mime == "image/png" || $mime == "image/gif"))
                    return (125);
                break;
            case 'xml':
                if(! ($mime == "text/xml" || $mime == "application/xml"))
                    return (126);
                break;
            case 'mp3':
                if(!($mime == "audio/mpeg"))
                    return (127);
                break;
            case 'latex':
                if(!($mime == "application/x-latex"))
                    return (128);
            case "text":
                if(!($mime == "text/plain"))
                    return (129);
                break;
            case "html":
                if(!($mime == "text/html"))
                    return (133);
                break;
            case "csv":
                if(!($mime == "text/comma-separated-values" || $mime == "text/plain" ||
                    $mime == "text/csv" || $mime == "application/csv" || $mime == "application/excel" ||
                    $mime == "application/vnd.ms-excel" || $mime == "application/vnd.msexcel"))
                    return (136);
                break;
            default:
                //THIS IS SPARTA
                return (300);
                break;
        }

        return(0);

    }

    protected function resolveFileExtension($mime) {
        if ($mime == '') return '';
        return($this->extensions[$mime]);
    }

    public function fixExtension($input, $mime) {

        $pattern = "/.([a-zA-Z]+)$/";
        $replacement = "." . $this->resolveFileExtension($mime);
        $input = preg_replace($pattern, $replacement, $input,  1);


        return $input;
    }

    /*
        Function: getErrorCode
        Pre: Eror code (int)
        Post: String definition of error code (string)
        Runtime: O(1)
        Description: Interface to resolving error listings.
                     Provides connections to external listing
                     of errors
     */

    public function getErrorMessage($code) {

        return $this->getErrorCode($code);

    }

    public function getErrorCode($code) {

        if (!ctype_digit((string) $code)) {
            return ("");
        }

        // We also need to resolve a listing of error codes.
        return ($this->getErrorListing($code));

    } // end getErrorCode

    /*
        Function: getErrorListing
        Pre: Eror code (int)
        Post: String definition of error code (string)
        Runtime: O(1)
        Description: Connects to external data source that contains
                     the listing of all error messages.  You can override
                     this function to connect to any datasource that has
                     the error resolutions.

     */

    protected function getErrorListing($code) {

        if (!ctype_digit((string) $code)) {
            return ("");
        }

        // the custom codes trump the database codes -- check first for custom ones
        if (isset($this->customCodes[$code])) return $this->customCodes[$code];

        // We will see if the error code first exists in a predefine variable (faster access)
        // Ok, we only need to only to query a data source for either of these reasons:
        // A: The xml error codes have not been loaded
        // B: The xml error code was not found

        $errorArray = $this->getErrorArray();

        if (count($errorArray) > 0) {

            if (@$errorArray[$code] != "") {
                return ($errorArray[$code]);
            }

        }


        // We need access to the database, we will accomplish this by
//      $DOC_ROOT = $_SERVER['DOCUMENT_ROOT'];
//      include_once("$DOC_ROOT/common/DbResource.php5");

        $xmlData = file_get_contents(dirname(__FILE__) . '/validationErrors.xml');

        if ($xmlData) {

            // Now that we have the xml data, let's parse it for a list of errors
            $xmlData = simplexml_load_string($xmlData);

            $tempErrorArray = array();

            foreach ($xmlData AS $key) {
                $tempErrorArray[(int)$key->code] = (String)$key->mesg;
            }

            $this->setErrorArray($tempErrorArray);


            // Now let's try the same query again with the newly populated dataset

            $errorArray = $this->getErrorArray();

            if (count($errorArray) > 0) {

                if (isset($errorArray[$code]) && $errorArray[$code] != "") {
                    return ($errorArray[$code]);
                } else {
                    return ("Unknown error");
                }

            }
        } else {
            return ("");
        }

    } // End getErrorListing

    /*
        Function: getErrorArray
        Pre: None
        Post: Errors Listing (Array)
        Runtime: O(1)
        Description: Returns an array of all of the error
                     codes for the site

     */

    protected function getErrorArray() {

        if ($this->errorList == "") {
            return (array());
        } else {
            return ($this->errorList);
        }

    } // end getErrorArray


    /*
        Function: setErrorArray
        Pre: Errors Listing (Array)
        Post: None
        Runtime: O(1)
        Description: Saves an array of all of the error
                     codes for the site

     */

    protected function setErrorArray($array) {
        $this->errorList = $array;
    }

    public function setCustomCode ($code, $value)
    {
        if (!ctype_digit((string) $code)) return false;
        $this->customCodes[$code] = $value;
    }


    function XMLParseErrorHandler($errno, $errstr, $errfile, $errline)
    {
      switch ($errno) {
        case 2:
            $this->setCustomCode(120, "Your XML did not parse for the following reasons. " . preg_replace("/\s/", "&nbsp;", $errstr));
            break;
        default:
            break;
      }
    }


}

?>

---