cu_sms.i

<?php

    // ** HOMECU LONG CODE
    $HOMECU_LONGCODE_API_KEY = "2A5625EB08229DA1179F36ED064EF52F9ED14E30";
    $HOMECU_LONGCODE_URL         = 'https://sms.tsgglobal.com/jsonrpc?apiVersion=1.0&key=#key#';        // ** JSON URL
    $HOMECU_LOGFILE                  = "/home/homecu/smslog/transport_longcode.log";


/*
 *  Function: SendLongCodeSMS
 *  Purpose:    This will be used to send messages using the TSG Global
 *                          Long Code API
 *  Parameters: p_hb_api_key             -- This is the HomeBanking API Key, I am passing it in
 *                              to help encapsulate this function AND at this time I don't know if there
 *                              is a separate API Key for each long code
 *                          p_hb_url                     -- This is the URL that the message will be posted to, the API KEY will
 *                              be coded with #key# so I can easily replace
 *                          p_hb_from_nbr        -- This is the Credit Union Long Code that the message is being sent from
 *                          p_hb_to_nbr              -- This is the Member's phone number that is receiving the message
 *                          p_hb_msg                     -- This is the actual message being sent.  It should be limited to 160 chars,
 *                                                                          but I will trim as well to ensure length restriction
 *  Returns:    Will return a true or false.  Will only return false if no response from server.. -- At this time
 *                          I do not know what I want to do with failed requests
*/
function SendLongCodeSMS($p_hb_api_key, $p_hb_url, $p_hb_from_nbr, $p_hb_to_nbr, $p_hb_msg) {
    $retVal = true;

    $debug = 0;


  if ($debug) {WriteTransportLog($GLOBALS['HOMECU_LOGFILE'], "\nStart: " . date('Ymd-H:i:s'));}
    // ** VALIDATE THE INFORMATION BEFORE CONTINUING -- Make sure they appear to be valid numbers
    $pattern = '/^[+]{0,1}[0-9]{1,12}$/';
  if (!preg_match($pattern, $p_hb_from_nbr))  {
        if ($debug) {WriteTransportLog($GLOBALS['HOMECU_LOGFILE'], "Fail: Invalid FROM: {$p_hb_from_nbr}");}
        return false;
  }

  if (!preg_match($pattern, $p_hb_to_nbr))  {
        if ($debug) {WriteTransportLog($GLOBALS['HOMECU_LOGFILE'], "Fail: Invalid To: {$p_hb_to_nbr}");}
        return false;
  }

/*
   * TSG updated their service.  If the destination DID does NOT have a 1 for before the area code, the request fails
   *                             If the length is exactly 10, then assume it does not have the area code and add it there
   */
  if (strlen($p_hb_to_nbr) == 10) {
    $p_hb_to_nbr = "1" . $p_hb_to_nbr;
  }
    // ** SETUP THE API URL
    $api_url = str_replace('#key#', $p_hb_api_key, $p_hb_url);

    // * the api will accept json values. So I will first create the Associative array, then translate to json
    //      * then send to url

    $api_msg_ary = Array(
                                                "method"=>"sms.send",
                                                "params"=>Array($p_hb_from_nbr, $p_hb_to_nbr, $p_hb_msg, 1),
                                                "id"=>""
  );
    $api_msg_json = json_encode($api_msg_ary);

  // ** MWS
  // I had previously preforemd the Escape Cmd prior to the json_encode when I was building the array.  However, when an apostrophe showed up in the
  // message it was causing a syntax error from escaped double quotes. The message was never sent.
  // I believe calling EscapeCmd after encoding json should work. Apostrophes are not created by json_encode.
  $api_msg_json = EscapeCmd($api_msg_json);
  $pipe_err=0;

  $api_response = "";

  $opts = "--connect-timeout 5 --retry 3 --retry-delay 2";

  // ** ALSO pass a -3 on the command. This fixes an error where I was getting an error similar to * error:14077458:SSL routines:SSL23_GET_SERVER_HELLO:reason(1112)
    // ** the error seems to be when the server was expecting SSLv3

    if ($debug) {WriteTransportLog($GLOBALS['HOMECU_LOGFILE'], "PHCMD: " . "/usr/bin/curl -k -N --silent $opts -X POST -H 'Content-Type: application/json' -d '$api_msg_json' '$api_url'");}

    $fd = popen("/usr/bin/curl -k -N --silent $opts -X POST -H 'Content-Type: application/json' -d '$api_msg_json' '$api_url'","r");

    if (!$fd)  {
        // ** CREATE THE ERROR in the same expected format as the JSON-RPC
        $api_response = '{"result":null,"error":{"code":"FAILOPEN","message":"Unable to open open portal.","data":null},"id":null}';
    } else {
        while ($buff = fread ($fd, 1500)) {
         $api_response .= $buff;
        }
        $pipe_err = pclose($fd);
    }

    // ** AT THIS POINT -- I WANT SAVE THE LOG
    if ($debug) {WriteTransportLog($GLOBALS['HOMECU_LOGFILE'], "From:{$p_hb_from_nbr}\tTo:{$p_hb_to_nbr}\tSEND:{$api_msg_json}\tAPI:$api_url\tRESPONSE:{$api_response}");}
    // ** We can now decode the response
    $api_response = json_decode($api_response, true);
    if (!is_array($api_response)) {
        // ** PROBLEM THIS SHOULD BE AN ARRAY
        $retVal = false;
        /*
         * FIRST check to see if an error was returned from the request
         */
    } elseif (HCU_array_key_value('error', $api_response) != '') {
        // ** Error happened
        $retVal = false;
        /*
         *  TSG GLobal SMS API
         *  Returns a value nvs_code with the request
         *     -- S - SMS Request successful
         *     -- I - Invalid Request
         *
         */
    } elseif (HCU_array_key_value('nvs_code', $api_response['result']['status']) != 'S') {
        // ** Invalid Request
        $retVal = false;
    }

    return $retVal;

}


/**
 *  Use the AWS SMS service for sending out the function.
 *  This function will make a shell call to the python script sendAwsSms.py
 *
 *  @param string $pPhoneNbr - The phone number receiving the message
 *  @param string $pSubject  - Subject that will be attached to the message
 *  @param string $pMessage  - The message being sent to user
 *  @param boolean $pTransaction - Treat this message as Critical?  Setting to True will identify the message as Transactional instead of Promotional
 *
 *  @return boolean          - Success or not
 */
function SendAwsSMS($pPhoneNbr, $pSubject, $pMessage, $pTransaction=false) {
    $bolRet = false;

    try {
    /*
     * If any option is empty then send an error
     */

      /* ** Validation ** */
        if ($pPhoneNbr == '' || $pSubject == '' || $pMessage == '') {
            throw new exception ("Empty parameters");
        }

        // ** sanitize phone number and make sure it starts with 1..
          // Presuming 10 digits does not have a 1
        if (strlen($pPhoneNbr) == 10) {
            $pPhoneNbr = "1" . $pPhoneNbr;
    }
    /* ** Configuration ** */
    // Python script name

    $pyFile = dirname(__FILE__) . "/../../shared/scripts/sendAwsSms.py";

      /* ** Options ** */
        $opts = "-p " . escapeshellarg($pPhoneNbr) . " -s " . escapeshellarg($pSubject) . " -m " . escapeshellarg($pMessage) . " ";

        if ($pTransaction) {
            $opts .= " -t ";
        }
        /* ** Create Command ** */
        $command = escapeshellcmd('python3') . " {$pyFile} $opts ";

        /* ** Execute Command ** */
        $smsResponse = exec($command);

        if ($smsResponse != '') {
      // ** Try and decode the json value that is being returned

            $dataResp = json_decode($smsResponse, true);
            switch (json_last_error()) {
                case JSON_ERROR_NONE:
                    // ** ALL IS GOOD
                    break;
                case JSON_ERROR_DEPTH:
                case JSON_ERROR_STATE_MISMATCH:
                case JSON_ERROR_CTRL_CHAR:
                case JSON_ERROR_SYNTAX:
                case JSON_ERROR_UTF8:
                default:
                    throw new Exception ("Invalid Format");
                    break;
            }
            /*
             * Program should normally return the array
             *   [status]
             *   [response]
             *   [error]
             *
             */
            if (is_array($dataResp)) {
                if (array_key_exists('status', $dataResp)) {
                    $respStatus = $dataResp['status'];

                    if ($respStatus == '000') {
                        $bolRet = true;
                    }
                }
            }
        }

    } catch (exception $ex) {
        // ** catch most generic errors --
            // ** When logging gets enabled, would be nice to track the error

        $bolRet = false;
    }


    return $bolRet;
}


/*
    * Function: WriteTransportLog
    * Purpose:  This will be used mainly in testing / developing while we are evaluating this new TXT 2.0 feature
    * Parameters:
                                p_logfile - Name of the logfile
                                p_msg           - Message that will be saved to the file
    * Returns: Nothing returned
    * Purpose: To open the log file p_logfile, and append the message p_msg
*/
function WriteTransportLog($p_logfile, $p_msg) {

  $fh = fopen ($p_logfile, "a");
  fwrite($fh, $p_msg. "\n");
  fclose($fh);

}


/*
 * Function: EscapeCmd
 * Purpose:  I want to try and protect the information being passed to teh command line, however, for the most part
 *                       it is already protected because I am using ' apostrophe, however, I need to make sure they don't exist
 *                          and if they do I need to replace them with a string that will not break the command
 * Parameters:
                            p_str -- The string to be parsed
 * Returns: the altered string
*/
function EscapeCmd ($p_str) {

  $p_str = preg_replace("/'/", "'\"'\"'", $p_str);

    return $p_str;
}

/*
    TSG GLOBAL Reponses can be
Array
(
    [result] => Array
        (
            [sender] => +CU_LONGCODE
            [recipient] => +MBR_NBR
            [location] => Idaho, United States
            [status] => Array
                (
                    [code] => 200
                    [nvs_code] => S
                    [message] => Valid number, SMS delivered
                )

            [carrier] => 999
            [sms_id] =>
        )

    [id] =>
    [error] =>
)


Array
(
    [response] =>
    [error] => Decoding failed: Syntax error
)



*/