hcuMIRhandler.i

<?php
/*
 * FILE: hcuMIRhandler.i
 * Functions to support examining and validating MIR packet data
 */

/**
 * Check to see if given phone number matches regex
 * @param $phone
 * @return boolean true if $phone matches regex, otherwise false
 */
function Match_Phone_Regex($phone) {
    /*
     * Validate that numbers match the North American Numbering Plan
     * see https://en.wikipedia.org/wiki/North_American_Numbering_Plan
     * Note - includes Carribean but NOT Mexico.
     *
     * This regex is matching against commonly used phone constructs, not checking for bizarre crap. This will match:
     * 223 456 7890
     * (223) 345-5555
     * (323)344-4444
     * 333-333-3333
     * 2234567890
     *
     * also note! regex only matches full 10 digits.
     * Returns false for 7-digit numbers missing area code
     */
    $regexPhone = '/(?:[2-9]\d{2}|\([2-9]\d{2}\))[ -]?[2-9]\d{2}[ -]?\d{4}/';

    if (preg_match($regexPhone, $phone)) {
        return true;
    }
    return false;
}

/**
 * Given phone is sanitized to remove all non-digits
 * If (sanitized) given phone contains exactly 7 or 10 digits,
 * return formatted 123-1234 or 123-123-1234
 *
 * If (sanitized) given phone contains any other digit count,
 * sanitized phone is returned unformatted.
 *
 * @param $phone
 * @return string phone formatted as 123-4567 or 123-456-7890
 *
 */
function Format_Phone_Dashes($phone) {

    $phone = preg_replace("/[^0-9]/", "", $phone);
    $length = strlen($phone);

    switch($length) {
      case 7:
        return preg_replace("/([0-9]{3})([0-9]{4})/", "$1-$2", $phone);

      case 10:
        return preg_replace("/([0-9]{3})([0-9]{3})([0-9]{4})/", "$1-$2-$3", $phone);

      default:
        return $phone;
    }
  }


  /**
   * Check date as
   *   not empty
   *   valid content
   *   within requested range.
   *
   * @param string $datechk date to be checked
   * @param string $datefmt desired display format
   * @param string $mindate earliest acceptable date
   * @param string $maxdate latest acceptable date
   * @return string accepted date in requested format, or empty
   */

  function Date_In_Range($datechk, $datefmt = 'Y-m-d', $mindate = '12/13/1901', $maxdate = '') {

    # set a timezone for strtotime
    # validate chkdate is set, is convertable by strtotime, is within given range
    date_default_timezone_set('UTC');

    $mindate  = (!empty($mindate) && ($st = strtotime($mindate)) ?  $st : strtotime('1901-12-31')); # default 12/31/1901
    $maxdate  = (!empty($maxdate) && ($st = strtotime($maxdate)) ?  $st : time()); # default now
    // $GLOBALS['HB_ENV']["SYSENV"]["logger"]->info( "Date_In_Range datechk $datechk datefmt $datefmt min $mindate max $maxdate st " . strtotime($datechk));

    if (!empty($datechk) && ($st = strtotime($datechk)) && $st > $mindate && $st < $maxdate) {
      return date($datefmt, $st);
    }

    return '';
  }

/*
* function FormatMIR inspects a provided mir['data'] packet returned from GetMemberInfo
* Sanitizes MIR data values, stripping whitespace, non-digits, etc
* Sets empty string for  values that fail validation
*      Email prefers HCU email
*          strips whitespace,
*          checks via validateEmail function
*      State checks for ctype_alpha
*      Zip strips space and dash, checks for all digits and length 5 or 9
*      SSN strips space and dash, checks for all digits and length 9
*      DOB via Date_In_Range function w/range 12/31/1901 - current date
*      [HomePhone, WorkPhone, CellPhone, Fax] strips non-digits, checks for length 7 or 10
*          ** Note ** use of Match_Phone_Regex function results in requiring 10 digits.
*
* Returns sanitized, formatted MIR
*
*
* @param array $MIR ['data'] section returned from GetMemberInfo
* @param string $Ml email value defined in HomeCU
* @param array $reqMIR array of values required by caller. Error if missing
* @param $datefmt string default 'Y-m-d' requested format for dates returned
* @param $phones string default 'flat' requested fromat for phone numbers [flat|split|named|shortname]
* @param $noEmpty default false when set will unset any empty $MIR values
* @param $BizFNdot default '' = no change;
                           'dot' will return '.' dot as firstname for business accts;
                           'pass' will remove firstname from reqMIR list of required elements

* @return array sanitized $MIR
*
*/
function FormatMIR($MIR, $Ml, $reqMIR, $datefmt = 'Y-m-d', $phones = 'flat', $noEmpty = false, $BizFNdot = '') {
    try {
/*
        //  $mirFields = Array(
        //    "accountnumber",
        //    "firstname",
        //    "middlename",
        //    "lastname",
        //    "email",
        //    "homephone",
        //    "workphone",
        //    "cellphone",
        //    "fax",
        //    "ssn",
        //    "address1",
        //    "address2",
        //    "city",
        //    "state",
        //    "zip",
        //    "cc",
        //    "dob",
        //    "class"
        //  );
*/

        $rmlist = array("#", "&", "/", "%", ",", ":", "=", "?", "'");

        # prefer HCU email, as it tends to be kept more current than core
        $MIR['email'] = validateEmail($Ml) ? $Ml : HCU_array_key_value('email', $MIR);
        /*
        * Notice this does not reject an email with the $rmlist characters,
        * just scrubs them out and keeps on truckin'
        * Is that really what we want?
        */
        $MIR['email'] = str_replace($rmlist, "", $MIR['email']);

        if (!(HCU_array_key_value("email", $MIR) && ($MIR["email"] = preg_replace('/\s/', '', $MIR["email"])) &&
            validateEmail($MIR["email"]) )) {
            unset($MIR["email"]);
        }

        $scrubs = [
            'firstname',
            'middlename',
            'lastname',
            'address1',
            'address2',
            'city',
            'state',
            'acountnumber',
            'cc',
            'class'
        ];
        foreach ($scrubs as $key) {
            $MIR[$key] = str_replace($rmlist, "", HCU_array_key_value($key, $MIR));
        }
        # default country code to US.  Assume CU will specify for other countries
        if (trim($MIR['cc']) == '') {
            $MIR['cc'] = 'US';
        }

        if (trim($MIR['class']) == '') {
            # Assume business class if lastname w/o firstname
            # Some cores send business name as lastname w/empty firstname
            # but can't (or don't) send class.

            # GetMemberInfo / _RetrieveMemberInfo sets default class
            # to empty string if it is not set by the core.
            if (trim($MIR['firstname']) == '' && trim($MIR['lastname']) <> '') {
                $MIR['class'] = 'B';
            } else {
                $MIR['class'] = 'P'; # default to personal account
            }
        }
        switch (strtolower($BizFNdot)) {
        case 'dot':
            # Some SSO partners require firstname / lastname even for business.
            # If this is a business account with first name empty, lastname present
            # and BizFNdot =='dot', fill firstname with a dot so we can connect
            if (empty($MIR['firstname']) && !empty($MIR['lastname']) &&
                in_array ( $MIR['class'] , array ('B','T') ) ) {
                    $MIR['firstname'] = '.';
            }
            break;
        case 'pass':
            # Some SSO allow empty firstname for business.
            # If this is a business account with first name empty, lastname present
            # and BizFNdot == 'pass', clear firstname from the 'required values' list
            if (empty($MIR['firstname']) && !empty($MIR['lastname']) &&
                in_array ( $MIR['class'] , array ('B','T') ) ) {
                    unset($reqMIR['firstname']);
            }
            break;
        default:
            # no action
        }

        if (! (HCU_array_key_value("state", $MIR) && ctype_alpha($MIR["state"]))) {
            $MIR['state'] = '';
        }

        if (!(HCU_array_key_value("zip", $MIR) && ($MIR["zip"] = str_replace([" ","-"], '', $MIR["zip"])) &&
            ctype_digit($MIR["zip"]) && in_array(strlen($MIR["zip"]),[5,9])) ) {
                $MIR["zip"] = '';
            }

        if (! (HCU_array_key_value("ssn", $MIR) &&
            ($MIR["ssn"] = str_replace([" ","-"], '', $MIR["ssn"])) && ctype_digit($MIR["ssn"]) && strlen($MIR['ssn']) == 9) ){
                $MIR["ssn"] = '';
            }

        if ( ! HCU_array_key_value('dob', $MIR) ) {
            $MIR["dob"] = "";
        } else {
            $MIR['dob'] = Date_In_Range(HCU_array_key_value('dob', $MIR), 'Y-m-d', '12/31/1901', time());
        }
        // $GLOBALS['HB_ENV']["SYSENV"]["logger"]->info( "After block DOB: " . HCU_array_key_value('dob', $MIR) . " .");

        $phoneorder = [
            'homephone' => 'HomePhone',
            'cellphone' => 'CellPhone',
            'workphone' => 'WorkPhone',
            'fax'       => 'FaxNumber'
          ];

        foreach ($phoneorder as $key => $name) {
            # Warning... Match_Phone_Regex requires length 10
            # not sure if this will be a problem or not
            # leaving the length 7 code in place until we determine
            # it is safe to remove
            if (!(HCU_array_key_value($key, $MIR) && ($MIR[$key] = preg_replace('/\D/', '', $MIR[$key])) &&
                in_array(strlen($MIR[$key]),[7,10]) && Match_Phone_Regex($MIR[$key])) ) {
                    unset($MIR[$key]);
                }
        }

        # fax included in the cleansing above,
        # but not formatted or used to set a contact phone below
        unset($phoneorder['fax']);

        if ($phones == 'flat') {
            foreach($phoneorder as $key => $name) {
                $MIR['phone'] = HCU_array_key_value($key, $MIR); # digits only
                if (trim($MIR['phone']) != '') {
                    break;
                }
            }
        } elseif ($phones == 'split') {
            foreach($phoneorder as $key => $name) {
                switch (strlen(HCU_array_key_value($key, $MIR))) {
                    case 10:
                        $MIR[$key] = [
                            'area' => substr($MIR[$key], 0, 3),
                            'pre' => substr($MIR[$key], 3, 3),
                            'num' => substr($MIR[$key], 6, 4)];
                        break;
                    case 7:
                    $MIR[$key] = [
                        'pre' => substr($MIR[$key], 0, 3),
                        'num' => substr($MIR[$key], 3, 4)];
                    break;
                default:
                        unset($MIR[$key]);
                        break;
                }
            }
        } elseif ($phones == 'named') {
            $phoneorder = [
                'homephone' => 'Home',
                'cellphone' => 'Cell',
                'workphone' => 'Work'
            ];
            $MIR['phonenumbers'] = [];

            foreach ($phoneorder as $key => $name) {
              switch (strlen(HCU_array_key_value($key, $MIR))) {
                case 10:
                case 7:
                  $MIR['phonenumbers'][] = [
                    'number' => Format_Phone_Dashes($MIR[$key]),
                    'name' => $name
                  ];
                  break;

                default:
                  unset($MIR[$key]);
                  break;
              }
            }
        } elseif ($phones == 'shortname') {
            # shortname setting is for Allied
            # shorter names, include isTextCapable, unset phonenumbers array if empty
            $phoneorder = [
                'homephone' => ['phname' => 'Home', 'isTextCapable' => false],
                'cellphone' => ['phname' => 'Cell', 'isTextCapable' => true],
                'workphone' => ['phname' => 'Work', 'isTextCapable' => false]
            ];

            $MIR['phonenumbers'] = [];

            foreach ($phoneorder as $key => $settings) {
                switch (strlen(HCU_array_key_value($key, $MIR))) {
                    case 10:
                    case 7:
                      $MIR['phonenumbers'][] = [
                        'number' => $MIR[$key],
                        'name' => $settings['phname'],
                        'isTextCapable' => $settings['isTextCapable']
                      ];
                    break;

                    default:
                        unset($MIR[$key]);
                    break;
                }
            }
              if (!count($MIR['phonenumbers'])) {
                unset($MIR['phonenumbers']);
              }


        }

        if ($noEmpty) {
            foreach(array_keys($MIR) as $key) {
                if ( (is_array($MIR[$key]) && !count($MIR[$key])) ||
                     ( !is_array($MIR[$key]) && trim($MIR[$key]) == false) ) {
                        unset($MIR[$key]);
                }
            }
        }

        $missing = array_diff_key($reqMIR, $MIR);
        if (sizeof($missing)) {
            throw new Exception("Incomplete Member Info (" . join(", ", array_keys($missing)) . ")");
        }
        $return['status']['response'] = true;
        $return['status']['message'] = 'Success';
        $return['data'] = $MIR;
    } catch (Exception $e) {
        $return['status']['response'] = false;
        $return['status']['message'] = $e->getMessage();
        $return['data'] = array();
    }
    return $return;
}

?>