sagepay_processor.inc

<?php
define('SAGEPAY_LOG_FILE_PREFIX', 'sagepay_transactions_account_');


class SagePay_Processor
{
    
    
    private static $_URLS = Array(
                                    'Live'      => Array(
                                                            'payment_registration'  => 'https://live.sagepay.com/gateway/service/vspdirect-register.vsp',
                                                            'threeds_callback'      => 'https://live.sagepay.com/gateway/service/direct3dcallback.vsp',
                                                        ),
                                    'Test'      => Array(
                                                            'payment_registration'  => 'https://test.sagepay.com/gateway/service/vspdirect-register.vsp',
                                                            'threeds_callback'      => 'https://test.sagepay.com/gateway/service/direct3dcallback.vsp',
                                                        ),
                                    'Simulator' => Array(
                                                            'payment_registration'  => 'https://test.sagepay.com/simulator/VSPDirectGateway.asp',
                                                            'threeds_callback'      => 'https://test.sagepay.com/simulator/VSPDirectCallback.asp',
                                                        ),
                                 );
    
    private $_post_string;
    
    private $_post_urls;
    
    private $_merchant_ref;
    
    private $_card_number;
    
    private $_card_type;
    
    private $_tx_type;
    
    private $_amount;
    
    private $_currency;
    
    private $_gift_aid = 'no';
    
    private $_timeout;
    
    private $_log_file_name;
    
    private $_response = NULL;
    
    private $_success = FALSE;
    
    private static $_TEST_CARD_NUMBERS = Array(
                        '4929000000006'         => 'Visa',
                        '4462000000000003'      => 'Visa Delta',
                        '4917300000000008'      => 'Visa Electron',
                        '5404000000000001'      => 'MasterCard',
                        '300000000000000004'    => 'Maestro',
                        '5641820000000005'      => 'Switch (UK Maestro)',
                        '6334900000000005'      => 'Solo',
                        '374200000000004'       => 'American Express',
                        '36000000000008'        => 'Diners Club',
                        '3569990000000009'      => 'JCB',
                        '6304990000000000044'   => 'Laser',
                    );
                    
    private static $_CARD_TYPES = Array(
                        'VISA'      => 'Visa',
                        'DELTA'     => 'Visa Delta',
                        'UKE'       => 'Visa Electron',
                        'MC'        => 'MasterCard',
                        'MAESTRO'   => 'Maestro',
                        'SOLO'      => 'Solo',
                        'AMEX'      => 'American Express',
                        'DC'        => 'Diners Club',
                        'JCB'       => 'JCB',
                        'LASER'     => 'Laser',
                    );
    
    
    function __construct($protocol, $vendor, $timeout = 60, $run_mode = 'Simulator')
    {
        $this->_post_string = "VPSProtocol=$protocol&Vendor=$vendor";
        $this->_timeout = $timeout;
        $this->_post_urls = self::$_URLS[$run_mode];
        $this->_log_file_name = SAGEPAY_LOG_FILE_PREFIX.$vendor.'_'.strtolower($run_mode);
        
    }//end constructor
    
    
    public function setCardName($card_name)
    {
        $this->_post_string .= '&CardHolder='.urlencode($card_name);
        
    }//end setCardName()
    
    
    public function setCardNumber($card_no)
    {
        //get the last 4 digits of card numbers for logging later
        $this->_card_number = substr($card_no, -4);
        $this->_post_string .= "&CardNumber=$card_no";
        
    }//end setCardNumber()
    
    
    public function setCardExpiryDate($month, $year)
    {
        $this->_post_string .= "&ExpiryDate=$month$year";
        
    }//end setCardExpiryDate()
    
    
    public function setCardStartDate($month, $year)
    {
        $this->_post_string .= "&StartDate=$month$year";
        
    }//end setCardStartDate()
    
    
    public function setCardIssueNumber($issue_no)
    {
        $this->_post_string .= "&IssueNumber=$issue_no";
        
    }//end setCardIssueNumber()
    
    
    public function setCardCV2($cv2)
    {
        $this->_post_string .= "&CV2=$cv2";
        
    }//end setCardCV2()
    
    
    public function setTransactionTypePayment()
    {
        $this->_tx_type = 'PAYMENT';
        $this->_post_string .= "&TxType=PAYMENT";
        
    }//end setTransactionTypePayment()
    
    
    public function setMerchantReference($merchant_ref)
    {
        $this->_merchant_ref = $this->_getUniqueReferenceNumber($merchant_ref);
        $this->_post_string .= '&VendorTxCode='.$this->_merchant_ref;
        
    }//end setMerchantReference()
    
    
    public function setAmount($amount, $currency)
    {
        $this->_amount = sprintf('%01.2f',$amount);
        $this->_currency = $currency;
        $this->_post_string .= '&Amount='.$this->_amount."&Currency=$currency";
        
    }//end setAmount()
    

    public function setDescription($desc)
    {
        $this->_post_string .= '&Description='.urlencode($desc);
        
    }//end setDescription()
    
    
    public function setCardType($card_type)
    {
        $this->_card_type = $card_type;
        $this->_post_string .= "&CardType=$card_type";
        
    }//end setCardType()
    
    
    public function setBillingFirstnames($first_names)
    {
        $this->_post_string .= '&BillingFirstnames='.urlencode($first_names);
        
    }//end setBillingFirstnames()
    

    public function setBillingSurname($surname)
    {
        $this->_post_string .= '&BillingSurname='.urlencode($surname);
        
    }//end setBillingSurname()
    

    public function setBillingAddress1($address)
    {
        $this->_post_string .= '&BillingAddress1='.urlencode($address);
        
    }//end setBillingAddress1()

    
    public function setBillingAddress2($address)
    {
        $this->_post_string .= '&BillingAddress2='.urlencode($address);
        
    }//end setBillingAddress2()

    
    public function setBillingCity($city)
    {
        $this->_post_string .= '&BillingCity='.urlencode($city);
        
    }//end setBillingCity()
    

    public function setBillingPostcode($postcode)
    {
        $this->_post_string .= '&BillingPostCode='.urlencode($postcode);
        
    }//end setBillingPostcode()

    
    public function setBillingCountry($country)
    {
        $this->_post_string .= '&BillingCountry='.urlencode($country);
        
    }//end setBillingCountry()

    
    public function setBillingState($state)
    {
        $this->_post_string .= '&BillingState='.urlencode($state);
        
    }//end setBillingState()
    
    
    public function setBillingPhone($phone_no)
    {
        $this->_post_string .= '&BillingPhone='.urlencode($phone_no);
        
    }//end setBillingPhone()

    
    public function setDeliveryFirstnames($first_names)
    {
        $this->_post_string .= '&DeliveryFirstnames='.urlencode($first_names);
        
    }//end setDeliveryFirstnames()
    

    public function setDeliverySurname($surname)
    {
        $this->_post_string .= '&DeliverySurname='.urlencode($surname);
        
    }//end setDeliverySurname()
    

    public function setDeliveryAddress1($address)
    {
        $this->_post_string .= '&DeliveryAddress1='.urlencode($address);
        
    }//end setDeliveryAddress1()

    
    public function setDeliveryAddress2($address)
    {
        $this->_post_string .= '&DeliveryAddress2='.urlencode($address);
        
    }//end setDeliveryAddress2()

    
    public function setDeliveryCity($city)
    {
        $this->_post_string .= '&DeliveryCity='.urlencode($city);
        
    }//end setDeliveryCity()
    

    public function setDeliveryPostcode($postcode)
    {
        $this->_post_string .= '&DeliveryPostCode='.urlencode($postcode);
        
    }//end setDeliveryPostcode()

    
    public function setDeliveryCountry($country)
    {
        $this->_post_string .= '&DeliveryCountry='.urlencode($country);
        
    }//end setDeliveryCountry()


    public function setDeliveryState($state)
    {
        $this->_post_string .= '&DeliveryState='.urlencode($state);
        
    }//end setDeliveryState()
    
    
    public function setDeliveryPhone($phone_no)
    {
        $this->_post_string .= '&DeliveryPhone='.urlencode($phone_no);
        
    }//end setDeliveryPhone()
    
    
    public function setThreeDSecure()
    {
        $this->_post_string .= '&Apply3DSecure=0';
        
    }//end setThreeDSecure()
    

    public function setAVSCV2()
    {
        $this->_post_string .= '&ApplyAVSCV2=0';
        
    }//end setAVSCV2()
    
    
    public function setGiftAidPayment()
    {
        $this->_gift_aid = 'yes';
        $this->_post_string .= '&GiftAidPayment=1';
        
    }//end setGiftAidPayment()
    
    
    public function process()
    {
        //send POST request to the Payment Registration URL
        $this->_success = $this->_sendRequest($this->_post_urls['payment_registration']);
        
        if ($this->_success) {
            switch ($this->_response['Status']) {
                case 'OK':
                    $this->_success = 1;
                    break;
                case '3DAUTH':
                    $this->_success = 2;
                    break;
                default: //the transaction is denied
                    $this->_success = FALSE;
            }
        }
        
        return $this->_success;
        
    }//end process()
    
    
    public function authorize($merchant_ref, $md, $pares)
    {
        //set up parameters for logging
        $this->_merchant_ref = $merchant_ref;
        $this->_tx_type = '3-D Secure Authorization Callback';
        
        //set authorization parameters
        $this->_post_string = "MD=$md&PARes=".urlencode($pares);
        
        //send POST request to the 3-D Secure Callback URL
        $this->_success = $this->_sendRequest($this->_post_urls['threeds_callback']);
        
        if ($this->_success) {
            $this->_success = $this->_response['Status'] == 'OK'? 1 : FALSE;
        }
        
        return $this->_success;
        
    }//end authorize()
    
    
    private function _sendRequest($url)
    {
        $success = TRUE;
        
        //log the request of the transaction
        $this->_logRequest();

        $options = array(
                 'POST'           => 1,
                 'POSTFIELDS'     => $this->_post_string,
                 'RETURNTRANSFER' => 1,
                 'TIMEOUT'        => $this->_timeout,
                 'SSL_VERIFYPEER' => 1,
                 'SSL_VERIFYHOST' => 2,
                );
        $details  = fetch_url($url, $options);
        $response = $details['response'];
        
        if ($response === FALSE) {
            $success = FALSE;
            $response = Array('CURL_ERROR' => TRUE, 'Status' => 'CURL_ERROR_'.$details['errornumber'], 'StatusDetail' => $details['errorstring']);
        } else {
            $lines = explode("\r\n", $response);
            $response = Array();
            foreach ($lines as $line) {
                if (!empty($line)) {
                    $key_val_pairs = explode('=', $line, 2);
                    $response[$key_val_pairs[0]] = $key_val_pairs[1];
                }
            }
        }
        
        $this->_response = $response;
        
        //log the transaction response
        $this->_logResponse();
            
        return $success;
        
    }//end _sendRequest()
    
    
    function getResponse()
    {
        $response = Array();
        
        switch ($this->_success) {
            case 1: //payment is accepted
                $response['TRANSACTION']    = $this->_response['VPSTxId'];
                $response['TIME']           = time();
            case FALSE: //error
                $response['STATUS']         = $this->_response['StatusDetail'];
                break;
            case 2: //redirect user to the Access Control Server (ACS) for card holder verification
                $response['ACS_URL']        = $this->_response['ACSURL'];
                $response['PAREQ_MESSAGE']  = $this->_response['PAReq'];
                $response['MD']             = $this->_response['MD'];
                break;
        }
        
        return $response;

    }//end getResponse()
    
    
    public function getMerchantReference()
    {
        return $this->_merchant_ref;
        
    }//end getMerchantReference()
    
    
    public static function getTestCardNumbers()
    {
        return self::$_TEST_CARD_NUMBERS;
        
    }//end getTestCardNumbers()
    

    public static function getCardTypes()
    {
        return self::$_CARD_TYPES;
        
    }//end getCardTypes()
    
    
    private function _logRequest()
    {
        $message = "Request\n";
        if (empty($this->_card_number)) { //a historic (3-D Secure Callback) request
            $message .= "Historic reference: {$this->getMerchantReference()}\n";
            
        } else { //a non-historic (PAYMENT) request
            //log 4 last digits of card number
            $message .= "Card number: {$this->_card_number}\n";
            
            //log card type
            $message .= "Card type: {$this->_card_type}\n";
            
            //log merchant reference
            $message .= "Merchant reference: {$this->getMerchantReference()}\n";
            
            //log amount
            $message .= "Amount: {$this->_amount} {$this->_currency}\n";
            
            //gift aid
            $message .= "Gift Aid Payment: {$this->_gift_aid}\n";
            
        }
            
        //log trasaction type 
        $message .= "Transaction type: {$this->_tx_type}\n";
        
        $this->_log($message);
        
    }//end _logRequest()
    
    
    private function _logResponse()
    {
        $message = "Response\n";
        if (array_get_index($this->_response, 'CURL_ERROR', FALSE)) {
            $message .= 'CURL Error: '.$this->_response['StatusDetail'].' (status = '.$this->_response['Status'].")\n";
            
        } else {
            //log the status
            $message .= 'Transaction result: '.$this->_response['Status']."\n";
            
            //log the status details
            if (isset($this->_response['StatusDetail'])) {
                $message .= 'Status details: '.$this->_response['StatusDetail']."\n";
            }
            
            //log the merchant reference so that we can match this response with its request in the log file
            $message .= "Merchant reference: {$this->getMerchantReference()}\n";
            
            //log Sage Pay transaction ID
            if (isset($this->_response['VPSTxId'])) {
                $message .= 'Transaction ID: '.$this->_response['VPSTxId']."\n";
            }
            
            //log security key
            if (isset($this->_response['SecurityKey'])) {
                $message .= 'Security Key: '.$this->_response['SecurityKey']."\n";
            }
            
            //log authorization code
            if (isset($this->_response['TxAuthNo'])) {
                $message .= 'Authorization code: '.$this->_response['TxAuthNo']."\n";
            }
            
            //log 3DS Status
            if (isset($this->_response['3DSecureStatus'])) {
                $message .= '3-D Secure Status: '.$this->_response['3DSecureStatus']."\n";
            }
            
            //log CAVV result code
            if (isset($this->_response['CAVV'])) {
                $message .= '3-D Secure Result Code: '.$this->_response['CAVV']."\n";
            }
            
        }
        
        $this->_log($message);
        
    }//end _logResponse()
    
    
    private function _log($message, $level = E_USER_NOTICE, $encode=FALSE)
    {
        log_write($message, $this->_log_file_name, $level, $encode);
        
    }//end log()
    
    
    private function _getUniqueReferenceNumber($ref_no)
    {
        if (strlen($ref_no) > 40) {
            $ref_no = md5($ref_no);
        }
        
        return $ref_no;
        
    }//end _getUniqueReferenceNumber()
    
    
}//end class

?>