bpCommon.i

<?php
/**
 * File: bpCommon.i
 *
 * Purpose: This file is included in the hcuMobilePay.plugin.
 * It contains the generic functions used by all bill pay vendors.
 *
 * Created By: Erin Robbins, 12/2018
 */

/**
 * Returns eligible accounts list from the subscriber's credit union database.
 *
 * @param dbhandle $dbh   database handle
 * @param array $HB_ENV   uses several items from environmental settings for TX_List
 * @param array $parms    (string Cu, integer Uid, string MBRACCT)
 * @return array          list of eligible accounts
 */
function GetAccts($dbh, $HB_ENV, $parms) {
  $AcctList = array();

  if (!isset($parms['Cu']) || !isset($parms['Uid']) || !isset($parms['MBRACCT'])) {
    $AcctList['status']['response'] = 'false';
    $AcctList['status']['code'] = '910';
    $AcctList['status']['message'] = 'Missing Account Parameters'; # missing Cu/Uid/MBRACCT
    return ($AcctList);
  }
  //calling tx_list first, to take care of most our work for us
  $AcctList = TX_list($dbh, $HB_ENV);
  if (!HCU_array_key_exists('acctlist', $AcctList)) {
    throw new Exception ("Unable to load accounts.");
  }
  try {
    //setting micraccount flag, only required if setup in accountspecs trusted detail
    $micrFlg = false;
    //pulling in vendor account specs, split by |
    $accountspecs = explode("|", $parms['accountspecs']);
    //trimming whitespace
    $accountspecs = array_map('trim', $accountspecs);
    if (in_array('micraccount', $accountspecs)){
      $micrFlg = true;
    }

    //extracting only the data we need into new array
    foreach($AcctList['acctlist'] as $key=>$value){
      $outputElem = array();
      //checking for only deposit accounts, acctclass = D
      //checking for available balances over $0, available: > 0
      //checking for authorization to pay to external accounts, to_ext = Y
      //checking if micr is required from accountspecs, if so then check
      //that micraccount is not empty
      // 10/22 $value['available'] was checking !=0, allowed neg. numbers to get in list
      if ( $value['acctclass'] == 'D' && $value['available'] > 0
          && $value['to_ext'] == 'Y' && ( !$micrFlg || ($micrFlg &&
          $value['micraccount'] != '' && $value['micraccount'] != '0' ))) {
        $outputElem['micraccount'] = $value['micraccount'];
        $outputElem['suffix'] = $value['suffix'];
        $outputElem['name'] = $value['description'];
        $outputElem['class'] = $value['acctclass'];
        //deposittype = Y, N, or S - Yes = Checking, N and S = Savings
        $outputElem['type'] = ($value['deposittype'] == 'Y' ? 'Checking' : 'Savings');
        $outputElem['balance'] = $value['available'];
        $outputElem['toext'] = $value['to_ext'];
        $outputElem['member'] = $value['member'];
        //print_r($accountspecs);
        $account = '';
        //setting account number based on specs
        foreach($accountspecs as $k=>$v){
          $positions = array();
          $start = 0;
          $length = 0;
          $cleanv = trim($v);
          $fieldspec = explode("(", $cleanv);
          $fieldname = trim($fieldspec[0]);
          //print_r($fieldspec);
          // $positions = explode(",", $fieldspec[1]);
          if(isset($fieldspec[1])){
            $positions = explode(",", rtrim($fieldspec[1], ")"));
          }
          if(!empty($positions)){
            if (!empty($positions[0])){
              $start = $positions[0];
              }
            if (!empty($positions[1])){
              $length = $positions[1];
              }
          }

          foreach ($value as $k1=>$v1){
            //if given a substring
            if ($fieldname == $k1 && !empty($start) && !empty($length)){
              $account .= substr($value[$k1], $start-1, $length);
              //if no substring value, take whole field value
            } elseif ($fieldname == $k1) {
              $account .= $value[$k1];
            }
          }
        }
         //appending account type to accountid
         if($outputElem['type'] == 'Checking'){
          $account .= '|D';
        }
        else if ($outputElem['type'] == 'Savings'){
          $account .= '|S';
        }
        //print_r($account);

        $acctIdEncrypted = hcu_encrypturl( $account, $HB_ENV['historyHash'] );

        $outputElem['accountid'] = $acctIdEncrypted;
        //$outputElem['accountid'] = $account;
        $output[] = $outputElem;

      }
    }
    if(empty($output)){
      //no acceptable accounts
      $AcctList['status']['response'] = 'false';
      $AcctList['status']['code'] = '910';
      $AcctList['status']['message'] = 'No elibigle pay from accounts found.';
      return ($AcctList);
    }
    #normalize the name for scalability
    $cleanlist = $output;
    $return["status"]["response"] = 'true';
    $return["status"]["message"] = 'Success';
    $return["data"] = $cleanlist;

  } catch (Exception $e) {
      $return['status']['response'] = 'false';
      $return['status']['message'] = $e->getMessage();
      $return['status']['code'] = $e->getCode();
      $return['data'] = array();
  }
  return $return;
}

/**
 *
 *
 * @param $soapString
 * @param $soapHeaders
 * @param $soapServer
 * @param $soapCertfile
 * @param $soapKeyfile
 * @param $soapCACert
 */
function embcurl($soapString, $soapHeaders, $soapServer, $soapCertfile='', $soapKeyfile='', $soapCACert='') {
  $useEmbedded = true;

  if ($useEmbedded) {
    $curlopts = array(
        CURLOPT_SSL_VERIFYPEER => 0,
        CURLOPT_RETURNTRANSFER => 1,
        CURLOPT_HEADER => 0,
        CURLOPT_POST => 1,
        CURLOPT_POSTFIELDS => "$soapString",
        CURLOPT_URL => "$soapServer");
    if (!empty($soapCertfile)) {
        $curlopts[CURLOPT_SSLCERT] = "$soapCertfile";
    }
    if (!empty($soapKeyfile)) {
        $curlopts[CURLOPT_SSLKEY] = "$soapKeyfile";
    }
    if (!empty($soapCACert)) {
        $curlopts[CURLOPT_CAINFO] = "$soapCACert";
    }

    $ch = @curl_init();
    @curl_setopt_array($ch, $curlopts);
    @curl_setopt($ch, CURLOPT_HTTPHEADER, $soapHeaders);

    $response = @curl_exec($ch);


    if (curl_errno($ch)) {
        $response = '';
    }
    @curl_close($ch);
  } else {
    // * Call to Command-line curl command

    // * build the command line call
    // ** Data value
    $clData = "--data-binary '$soapString' ";

    // * *Build Headers
    if (is_array($soapHeaders)) {
      foreach ($soapHeaders as $hdrLine) {
        $clHeaders .= "-H '$hdrLine' ";
      }
    }
    // * Include Cert File
    if (!empty($soapCertfile)) {
        $clCert = "--cert '$soapCertfile' ";
    }
    // * Include Key File
    if (!empty($soapKeyfile)) {
        $clKey= "--key '$soapKeyfile' ";
    }
    // * Include CA File
    if (!empty($soapCACert)) {
        $clCA = "--cacert $soapCACert";
    }

    // ** Soap Action
    $clAction = "'$soapServer'";

    $curlExec = "/usr/bin/curl $clData $clHeaders $clCert $clKey $clCA $clAction";

    $clCurl = popen($curlExec, "r");
    $response = '';

    if (!$clCurl)  {
      $response = '';
    } else {
      while ($buff = fread ($clCurl, 1500)) {
        $response .= $buff;
      }
      $pipe_err = pclose($clCurl);
    }

  }
    return $response;
}

/**
 * Returns the data response from the service calls
 * to an array
 *
 * @param $object       the data response passed from the service call
 * @return array        list of response messages and data
 */
function objectToArray( $object ) {
  if( !is_object( $object ) && !is_array( $object ) ) {
    return $object;
  }
  if( is_object( $object ) ) {
    $object = get_object_vars( $object );
  }
    return array_map( 'objectToArray', $object );
}

/**
 * Returns an array without duplicate values based
 * on the key
 *
 * @param $array    the array to have duplicates removed
 * @param $key      the key you want to removal based on
 * @return array    list with duplicates removed
 */
function UniqueMultidimArray($array, $key){
  $temp_array = array();
  $i = 0;
  $key_array = array();

  foreach($array as $val) {
      if (!in_array($val[$key], $key_array)) {
          $key_array[$i] = $val[$key];
          $temp_array[$i] = $val;
      }
      $i++;
  }
  return $temp_array;
}

/**
 * Read the cache value for a given list.
 *
 * @param dbhandle $dbh   database handle
 * @param $user           memberId
 * @param $subscriber     subscriberId
 * @param $cu             credit union
 * @param $cacheType      name of cache key
 * @param $session        session token
 * @return array          row of cached data
 */
function ReadCache($dbh, $user, $subscriber, $cu, $cacheType, $session) {

  $sql = "SELECT session, entry, data
  FROM cu_vendorcache
  WHERE cu = '$cu'
  AND username = '$user'
  AND subscriber = '$subscriber'
  AND type = '$cacheType'";

  $rs = db_query( $sql, $dbh );

  // check for mulitple ebpntries in case some error caused multiple entries to exist
  $returnData = "";
  $row = 0;
  while ($cacheRow = db_fetch_array($rs, $row++)) {
    // if already have found data, remove any more
    if ( strlen( $returnData ) > 0 ) {
      DeleteCache($dbh, $user, $subscriber, $cu, $cacheType, $cacheRow["session"], $cacheRow["entry"]);
    } else if ( $cacheRow["session"] == $session ) {
      // valid session, return the data
      $returnData = $cacheRow["data"];
    } else {
      // invalid session, remove this entry
      DeleteCache($dbh, $user, $subscriber, $cu, $cacheType, $cacheRow["session"], "");
    }
  }

  $returnStructure = json_decode( $returnData, true );

  return $returnStructure;
}

/**
 * Delete a given cache entry.
 * This is how the cache is flagged as flushed.
 * Use the $cacheType, $session, and/or $timestamp to refine how much cache to flush.
 *
 * @param dbhandle $dbh   database handle
 * @param $user           memberId
 * @param $subscriber     subscriberId
 * @param $cu             credit union
 * @param $cacheType      name of cache key
 * @param $session        session token
 * @param $timestamp      user timestamp
 */
function DeleteCache($dbh, $user, $subscriber, $cu, $cacheType, $session, $timestamp) {
  $sql = "DELETE FROM cu_vendorcache
  WHERE cu = '$cu'
  AND username = '$user'
  AND subscriber = '$subscriber'";

  if ( strlen( $cacheType ) ) {
    $sql .= " AND type = '$cacheType'";
  }

  if ( strlen( $session ) ) {
    $sql .= " AND session = '$session'";
  }

  if ( strlen( $timestamp ) ) {
    $sql .= " AND entry = '$timestamp'";
  }
  db_query( $sql, $dbh );
}

/**
 * Write the cache value for a given list.
 *
 * @param dbhandle $dbh   database handle
 * @param $user           memberId
 * @param $subscriber     subscriberId
 * @param $cu             credit union
 * @param $cacheType      name of cache key
 * @param $session        session token
 * @param $data           expected as a structure
 * @return                cached values as data structure
 */
function WriteCache($dbh, $user, $subscriber, $cu, $cacheType, $session, $data) {
  // we need every variable
  if ( !$dbh || !$user || !$subscriber || !$cu || !$cacheType || !$session || !$data ) {
    return;
  }

  try {
    // convert to a json object
    $jsonData = json_encode( $data );
  } catch ( Exception $e ) {
    $jsonData = "";
  }
  //print "Here in Write $jsonData";
  if ( strlen( $jsonData ) ) {
    $jsonData = pg_escape_string($jsonData);   // handle quoting, etc

    $sql = "INSERT INTO cu_vendorcache (cu, username, subscriber, session, type, data)
    VALUES ('$cu', '$user', '$subscriber', '$session', '$cacheType', '$jsonData' )";
    //print "About to write: $sql";
    $result = db_query( $sql, $dbh );
  }
}

/**
 * Inserts a log entry for each service call.
 * Records both the request and the reply.
 *
 * @param array $logData   (logPoint, token, txnId, request, reply, memberId
 *                          userIP, SSOVendor)
 */
function LogActivity( $logData ) {
  // make sure entry isn't too long
  $logPoint = substr( $logData["logPoint"], 0, 35 );
  $sessionId = substr( $logData["token"], -20 );    // assuming lower characters are more significant
  $txnId = substr( $logData["txnId"], -20 );        // assuming lower characters are more significant
  $request = pg_escape_string(trim($logData["request"]));   // handle quoting, etc
  $reply = pg_escape_string(trim($logData["reply"]));   // handle quoting, etc


  // entry time is added automatically
  $sql = "INSERT INTO cu_vendorlog (cu, user_id, service, sub_service,
  session_id, txn_id, user_ip, request, response)
  VALUES ('{$logData["Cu"]}', '{$logData["memberId"]}', '{$logData["SSOVendor"]}',
          '$logPoint', '$sessionId', '$txnId',
          '{$logData["userIP"]}', '$request', '$reply')";

  db_query($sql, $logData["dbConn"] );

}

/**
 * Creates guid for use as a log tracking id
 * in the soap message headers
 */
function getGUID(){
        mt_srand((double)microtime()*10000);//optional for php 4.2.0 and up.
        $charid = strtoupper(md5(uniqid(rand(), true)));
        $hyphen = chr(45);// "-"
        $uuid = chr(123)// "{"
            .substr($charid, 0, 8).$hyphen
            .substr($charid, 8, 4).$hyphen
            .substr($charid,12, 4).$hyphen
            .substr($charid,16, 4).$hyphen
            .substr($charid,20,12)
            .chr(125);// "}"
        return $uuid;

}

/**
 * Return the list of states to use for a State drop-down list.
 * NOTE: this is formatted for use with a Kendo DropdownList.
 */
function GetBPStateList() {
  $states = array(
    [ "name"=>'Alabama', "value"=>'AL'],
    [ "name"=>'Alaska', "value"=>'AK'],
    [ "name"=>'Arizona', "value"=>'AZ'],
    [ "name"=>'Arkansas', "value"=>'AR'],
    [ "name"=>'California', "value"=>'CA'],
    [ "name"=>'Colorado', "value"=>'CO'],
    [ "name"=>'Connecticut', "value"=>'CT'],
    [ "name"=>'Delaware', "value"=>'DE'],
    [ "name"=>'Florida', "value"=>'FL'],
    [ "name"=>'Georgia', "value"=>'GA'],
    [ "name"=>'Hawaii', "value"=>'HI'],
    [ "name"=>'Idaho', "value"=>'ID'],
    [ "name"=>'Illinois', "value"=>'IL'],
    [ "name"=>'Indiana', "value"=>'IN'],
    [ "name"=>'Iowa', "value"=>'IA'],
    [ "name"=>'Kansas', "value"=>'KS'],
    [ "name"=>'Kentucky', "value"=>'KY'],
    [ "name"=>'Louisiana', "value"=>'LA'],
    [ "name"=>'Maine', "value"=>'ME'],
    [ "name"=>'Maryland', "value"=>'MD'],
    [ "name"=>'Massachusetts', "value"=>'MA'],
    [ "name"=>'Michigan', "value"=>'MI'],
    [ "name"=>'Minnesota', "value"=>'MN'],
    [ "name"=>'Mississippi', "value"=>'MS'],
    [ "name"=>'Missouri', "value"=>'MO'],
    [ "name"=>'Montana', "value"=>'MT'],
    [ "name"=>'Nebraska', "value"=>'NE'],
    [ "name"=>'Nevada', "value"=>'NV'],
    [ "name"=>'New Hampshire', "value"=>'NH'],
    [ "name"=>'New Jersey', "value"=>'NJ'],
    [ "name"=>'New Mexico', "value"=>'NM'],
    [ "name"=>'New York', "value"=>'NY'],
    [ "name"=>'North Carolina', "value"=>'NC'],
    [ "name"=>'North Dakota', "value"=>'ND'],
    [ "name"=>'Ohio', "value"=>'OH'],
    [ "name"=>'Oklahoma', "value"=>'OK'],
    [ "name"=>'Oregon', "value"=>'OR'],
    [ "name"=>'Pennsylvania', "value"=>'PA'],
    [ "name"=>'Rhode Island', "value"=>'RI'],
    [ "name"=>'South Carolina', "value"=>'SC'],
    [ "name"=>'South Dakota', "value"=>'SD'],
    [ "name"=>'Tennessee', "value"=>'TN'],
    [ "name"=>'Texas', "value"=>'TX'],
    [ "name"=>'Utah', "value"=>'UT'],
    [ "name"=>'Vermont', "value"=>'VT'],
    [ "name"=>'Virginia', "value"=>'VA'],
    [ "name"=>'Washington', "value"=>'WA'],
    [ "name"=>'West Virginia', "value"=>'WV'],
    [ "name"=>'Wisconsin', "value"=>'WI'],
    [ "name"=>'Wyoming', "value"=>'WY']
  );

  // $provinces = array(
  //   [ "name"=>'Alberta', "value" => 'AB' ],
  //   [ "name"=>'British Columbia', "value" => 'BC' ],
  //   [ "name"=>'Manitoba', "value" => 'MB' ],
  //   [ "name"=>'New Brunswick', "value" => 'NB' ],
  //   [ "name"=>'Newfoundland and Labrador', "value" => 'NL' ],
  //   [ "name"=>'Nova Scotia', "value" => 'NS' ],
  //   [ "name"=>'Ontario', "value" => 'ON' ],
  //   [ "name"=>'Prince Edward Island', "value" => 'PE' ],
  //   [ "name"=>'Saskatchewan', "value" => 'SK' ],
  //   [ "name"=>'Quebec', "value" => 'QC' ]
  // );

  // $caribbean = array(
  //   [ "name"=>'US Virgin Islands', "value" => 'VI' ],
  //   [ "name"=>'Trinidad and Tobago', "value" => 'TT' ]
  // );
  // put them together and return them
  // $returnData = array_merge( $states, $provinces, $caribbean );
  $returnData = $states;
  return $returnData;
}

/**
 * Return the list of phone types to use for a phone type drop-down list.
 * NOTE: this is formatted for use with a Kendo DropdownList.
 * NOTE: this is not currently used, but may be needed for future use
 */
function GetPhoneTypes(){
  $types = array(
    [ "name"=>'Home', "code"=>'Home'],
    [ "name"=>'Cell', "code"=>'Cell'],
    [ "name"=>'Work', "code"=>'Work'],
  );
  $returnData = $types;
  return $returnData;

}

/**
 * Return the list of account types to use for a account type drop-down list.
 * NOTE: this is formatted for use with a Kendo DropdownList.
 */
function GetBPAccountTypes($MC){
  $types = array(
    [ "name"=>$MC->msg('Checking'), "value"=>'D'],
    [ "name"=>$MC->msg('Savings'), "value"=>'S'],
  );
  $returnData = $types;
  return $returnData;

}

/**
 * Return the list of p2p types to use for a p2p type drop-down list.
 * NOTE: this is formatted for use with a Kendo DropdownList.
 */
function GetBPP2PTypes($MC){
  $types = array(
    [ "name"=>$MC->msg('Text'), "value"=>'SMS'],
    [ "name"=>$MC->msg('Email'), "value"=>'Email'],
  );
  $returnData = $types;
  return $returnData;

}

/**
 * Return the list of billing frequencies to use for a drop-down list.
 * Should be used for new payments and transfers
 * NOTE: this is formatted for use with a Kendo DropdownList.
 */
function GetBillingFreq($MC){
  $types = array(
    [ "name"=>$MC->msg('Once'), "value"=>'Once', "isDeleted"=>false],
    [ "name"=>$MC->msg('Weekly'), "value"=>'Weekly', "isDeleted"=>false],
    [ "name"=>$MC->msg('Monthly'), "value"=>'Monthly', "isDeleted"=>false],
    [ "name"=>$MC->msg('Annually'), "value"=>'Annual', "isDeleted"=>false],
  );
  $returnData = $types;
  return $returnData;
}