PageRenderTime 71ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 1ms

/includes/modules/payment/paypaldp.php

https://bitbucket.org/gcooksey3/zencart
PHP | 2606 lines | 1900 code | 190 blank | 516 comment | 767 complexity | 993152fe9bc182ed12590a61686aa3ec MD5 | raw file
Possible License(s): AGPL-1.0 
    

  1. <?php
    2. 

  2. /**
    3. 

  3.  * paypaldp.php payment module class for Paypal Payments Pro (aka Website Payments Pro)
    4. 

  4.  *
    5. 

  5.  * @package paymentMethod
    6. 

  6.  * @copyright Copyright 2003-2012 Zen Cart Development Team
    7. 

  7.  * @copyright Portions Copyright 2005 CardinalCommerce
    8. 

  8.  * @copyright Portions Copyright 2003 osCommerce
    9. 

  9.  * @license http://www.zen-cart.com/license/2_0.txt GNU Public License V2.0
    10. 

  10.  * @version GIT: $Id: Author: DrByte  Tue Aug 28 14:21:34 2012 -0400 Modified in v1.5.1 $
    11. 

  11.  */
    12. 

  12. /**
    13. 

  13.  * The transaction URL for the Cardinal Centinel 3D-Secure service.
    14. 

  14.  */
    15. 

  15. define('MODULE_PAYMENT_PAYPALDP_CARDINAL_TXN_URL', 'https://paypal.cardinalcommerce.com/maps/processormodule.asp');
    16. 

  16. //define('MODULE_PAYMENT_PAYPALDP_CARDINAL_TXN_URL', 'https://centineltest.cardinalcommerce.com/maps/processormodule.asp');
    17. 

  17. /**
    18. 

  18.  * debug flag for developer use only:
    19. 

  19.  */
    20. 

  20. if (!defined('MODULE_PAYMENT_CARDINAL_CENTINEL_DEBUGGING')) define('MODULE_PAYMENT_CARDINAL_CENTINEL_DEBUGGING', FALSE);
    21. 

  21. /**
    22. 

  22.  * load the communications layer code
    23. 

  23.  */
    24. 

  24. require_once(DIR_FS_CATALOG . DIR_WS_MODULES . 'payment/paypal/paypal_curl.php');
    25. 

  25. /**
    26. 

  26.  * the PayPal payment module for PayPal Payments Pro (Direct Payment API)
    27. 

  27.  */
    28. 

  28. class paypaldp extends base {
    29. 

  29.   /**
    30. 

  30.    * name of this module
    31. 

  31.    *
    32. 

  32.    * @var string
    33. 

  33.    */
    34. 

  34.   var $code;
    35. 

  35.   /**
    36. 

  36.    * displayed module title
    37. 

  37.    *
    38. 

  38.    * @var string
    39. 

  39.    */
    40. 

  40.   var $title;
    41. 

  41.   /**
    42. 

  42.    * displayed module description
    43. 

  43.    *
    44. 

  44.    * @var string
    45. 

  45.    */
    46. 

  46.   var $description;
    47. 

  47.   /**
    48. 

  48.    * module status - set based on various config and zone criteria
    49. 

  49.    *
    50. 

  50.    * @var string
    51. 

  51.    */
    52. 

  52.   var $enabled;
    53. 

  53.   /**
    54. 

  54.    * the zone to which this module is restricted for use
    55. 

  55.    *
    56. 

  56.    * @var string
    57. 

  57.    */
    58. 

  58.   var $zone;
    59. 

  59.   /**
    60. 

  60.    * array holding accepted DP/gateway card types
    61. 

  61.    *
    62. 

  62.    * @var array
    63. 

  63.    */
    64. 

  64.   var $cards = array();
    65. 

  65.   /**
    66. 

  66.    * JS code used for gateway/DP mode
    67. 

  67.    *
    68. 

  68.    * @var string
    69. 

  69.    */
    70. 

  70.   var $cc_type_javascript = '';
    71. 

  71.   /**
    72. 

  72.    * JS code used for gateway/DP mode
    73. 

  73.    *
    74. 

  74.    * @var string
    75. 

  75.    */
    76. 

  76.   var $cc_type_check = '';
    77. 

  77.   /**
    78. 

  78.    * debugging flag
    79. 

  79.    *
    80. 

  80.    * @var boolean
    81. 

  81.    */
    82. 

  82.   var $enableDebugging = false;
    83. 

  83.   /**
    84. 

  84.    * is DP enabled ?
    85. 

  85.    *
    86. 

  86.    * @var boolean
    87. 

  87.    */
    88. 

  88.   var $enableDirectPayment = true;
    89. 

  89.   /**
    90. 

  90.    * sort order of display
    91. 

  91.    *
    92. 

  92.    * @var int
    93. 

  93.    */
    94. 

  94.   var $sort_order = 0;
    95. 

  95.   /**
    96. 

  96.    * Button Source / BN code -- enables the module to work for Zen Cart sites
    97. 

  97.    *
    98. 

  98.    * @var string
    99. 

  99.    */
    100. 

  100.   var $buttonSource = 'ZenCart-DP_us';
    101. 

  101.   /**
    102. 

  102.    * order status setting for pending orders
    103. 

  103.    *
    104. 

  104.    * @var int
    105. 

  105.    */
    106. 

  106.   var $order_pending_status = 1;
    107. 

  107.   /**
    108. 

  108.    * order status setting for completed orders
    109. 

  109.    *
    110. 

  110.    * @var int
    111. 

  111.    */
    112. 

  112.   var $order_status = DEFAULT_ORDERS_STATUS_ID;
    113. 

  113.   /**
    114. 

  114.    * Debug tools
    115. 

  115.    */
    116. 

  116.   var $_logDir = 'includes/modules/payment/paypal/logs/';
    117. 

  117.   var $_logLevel = 0;
    118. 

  118.   /**
    119. 

  119.    * FMF
    120. 

  120.    */
    121. 

  121.   var $fmfResponse = '';
    122. 

  122.   var $fmfErrors = array();
    123. 

  123.   /**
    124. 

  124.    * class constructor
    125. 

  125.    */
    126. 

  126.   function paypaldp() {
    127. 

  127.     include_once(zen_get_file_directory(DIR_FS_CATALOG . DIR_WS_LANGUAGES . $_SESSION['language'] . '/modules/payment/', 'paypaldp.php', 'false'));
    128. 

  128.     global $order;
    129. 

  129.     $this->code = 'paypaldp';
    130. 

  130.     $this->codeTitle = MODULE_PAYMENT_PAYPALDP_TEXT_ADMIN_TITLE_WPP;
    131. 

  131.     $this->codeVersion = '1.5.1';
    132. 

  132.     $this->enableDirectPayment = true;
    133. 

  133.     $this->enabled = (MODULE_PAYMENT_PAYPALDP_STATUS == 'True');
    134. 

  134.     // Set the title & description text based on the mode we're in
    135. 

  135.     if (IS_ADMIN_FLAG === true) {
    136. 

  136.       $this->description = sprintf(MODULE_PAYMENT_PAYPALDP_TEXT_ADMIN_DESCRIPTION, ' (rev' . $this->codeVersion . ')');
    137. 

  137.       $country = (defined('MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY')) ? MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY : STORE_COUNTRY;
    138. 

  138.       $this->title = $country == '223' || $country == 'USA' ? MODULE_PAYMENT_PAYPALDP_TEXT_ADMIN_TITLE_WPP : MODULE_PAYMENT_PAYPALDP_TEXT_ADMIN_TITLE_NONUSA;
    139. 

  139.       $this->title .= (defined('MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY') ? ' (' . MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY . ')' : '');
    140. 

  140.       if ($this->enabled) {
    141. 

  141.         if ( ((MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'US' || MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'Canada') && (MODULE_PAYMENT_PAYPALWPP_APISIGNATURE == '' || MODULE_PAYMENT_PAYPALWPP_APIUSERNAME == '' || MODULE_PAYMENT_PAYPALWPP_APIPASSWORD == ''))
    142. 

  142.               || (!defined('MODULE_PAYMENT_PAYPALWPP_STATUS') || MODULE_PAYMENT_PAYPALWPP_STATUS != 'True')
    143. 

  143.           ) $this->title .= '<span class="alert"><strong> NOT CONFIGURED YET</strong></span>';
    144. 

  144.         if (MODULE_PAYMENT_PAYPALDP_SERVER =='sandbox') $this->title .= '<strong><span class="alert"> (sandbox active)</span></strong>';
    145. 

  145.         if (MODULE_PAYMENT_PAYPALDP_DEBUGGING =='Log File' || MODULE_PAYMENT_PAYPALDP_DEBUGGING =='Log and Email') $this->title .= '<strong> (Debug)</strong>';
    146. 

  146.         if (!function_exists('curl_init')) $this->title .= '<strong><span class="alert"> CURL NOT FOUND. Cannot Use.</span></strong>';
    147. 

  147.       }
    148. 

  148.     } else {
    149. 

  149.       $this->description = MODULE_PAYMENT_PAYPALDP_TEXT_DESCRIPTION;
    150. 

  150.       $this->title = MODULE_PAYMENT_PAYPALDP_TEXT_TITLE; //cc
    151. 

  151.     }
    152. 

  152. 

  153.     if ((!defined('PAYPAL_OVERRIDE_CURL_WARNING') || (defined('PAYPAL_OVERRIDE_CURL_WARNING') && PAYPAL_OVERRIDE_CURL_WARNING != 'True')) && !function_exists('curl_init')) $this->enabled = false;
    154. 

  154. 

  155.     $this->enableDebugging = (MODULE_PAYMENT_PAYPALDP_DEBUGGING == 'Log File' || MODULE_PAYMENT_PAYPALDP_DEBUGGING =='Log and Email');
    156. 

  156.     $this->emailAlerts = (MODULE_PAYMENT_PAYPALDP_DEBUGGING == 'Log File' || MODULE_PAYMENT_PAYPALDP_DEBUGGING =='Log and Email' || MODULE_PAYMENT_PAYPALDP_DEBUGGING == 'Alerts Only');
    157. 

  157.     $this->sort_order = MODULE_PAYMENT_PAYPALDP_SORT_ORDER;
    158. 

  158. 

  159.     $this->buttonSource = (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK') ? 'ZenCart-DP_uk' : 'ZenCart-DP_us';
    160. 

  160. 

  161.     $this->order_pending_status = MODULE_PAYMENT_PAYPALDP_ORDER_PENDING_STATUS_ID;
    162. 

  162.     if ((int)MODULE_PAYMENT_PAYPALDP_ORDER_STATUS_ID > 0) {
    163. 

  163.       $this->order_status = MODULE_PAYMENT_PAYPALDP_ORDER_STATUS_ID;
    164. 

  164.     }
    165. 

  165. //    $this->new_acct_notify = MODULE_PAYMENT_PAYPALDP_NEW_ACCT_NOTIFY;
    166. 

  166.     $this->zone = (int)MODULE_PAYMENT_PAYPALDP_ZONE;
    167. 

  167.     if (is_object($order)) $this->update_status();
    168. 

  168. 

  169.     if (PROJECT_VERSION_MAJOR != '1' && substr(PROJECT_VERSION_MINOR, 0, 3) != '5.0') $this->enabled = false;
    170. 

  170. 

  171.     // offer credit card choices for pull-down menu -- only needed for UK version
    172. 

  172.     $this->cards = array();
    173. 

  173.     if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK') {
    174. 

  174.       if (CC_ENABLED_VISA=='1')    $this->cards[] = array('id' => 'Visa', 'text' => 'Visa');
    175. 

  175.       if (CC_ENABLED_MC=='1')      $this->cards[] = array('id' => 'MasterCard', 'text' => 'MasterCard');
    176. 

  176.       if (CC_ENABLED_MAESTRO=='1') $this->cards[] = array('id' => 'Maestro', 'text' => 'Maestro');
    177. 

  177.       if (CC_ENABLED_SWITCH=='1')  $this->cards[] = array('id' => 'Switch', 'text' => 'Switch');
    178. 

  178.       if (CC_ENABLED_SOLO=='1')    $this->cards[] = array('id' => 'Solo', 'text' => 'Solo');
    179. 

  179.     }
    180. 

  180. 

  181.     // debug setup
    182. 

  182.     if (!@is_writable($this->_logDir)) $this->_logDir = DIR_FS_CATALOG . $this->_logDir;
    183. 

  183.     if (!@is_writable($this->_logDir)) $this->_logDir = DIR_FS_SQL_CACHE;
    184. 

  184.     // Regular mode:
    185. 

  185.     if ($this->enableDebugging) $this->_logLevel = 2;
    186. 

  186.     // DEV MODE:
    187. 

  187.     if (defined('PAYPAL_DEV_MODE') && PAYPAL_DEV_MODE == 'true') $this->_logLevel = 3;
    188. 

  188. 

  189.     if (IS_ADMIN_FLAG === true) $this->tableCheckup();
    190. 

  190. 

  191.   }
    192. 

  192.   /**
    193. 

  193.    *  Sets payment module status based on zone restrictions etc
    194. 

  194.    */
    195. 

  195.   function update_status() {
    196. 

  196.     global $order, $db;
    197. 

  197. //    $this->zcLog('update_status', 'Checking whether module should be enabled or not.');
    198. 

  198.     // if store is not running in SSL, cannot offer credit card module, for PCI reasons
    199. 

  199.     if (!defined('ENABLE_SSL') || ENABLE_SSL != 'true') {
    200. 

  200.       $this->enabled = FALSE;
    201. 

  201.       $this->zcLog('update_status', 'Module disabled because SSL is not enabled on this site.');
    202. 

  202.     }
    203. 

  203.     // check other reasons for the module to be deactivated:
    204. 

  204.     if ($this->enabled && (int)$this->zone > 0) {
    205. 

  205.       $check_flag = false;
    206. 

  206.       $sql = "SELECT zone_id
    207. 

  207.               FROM " . TABLE_ZONES_TO_GEO_ZONES . "
    208. 

  208.               WHERE geo_zone_id = :zoneId
    209. 

  209.               AND zone_country_id = :countryId
    210. 

  210.               ORDER BY zone_id";
    211. 

  211.       $sql = $db->bindVars($sql, ':zoneId', $this->zone, 'integer');
    212. 

  212.       $sql = $db->bindVars($sql, ':countryId', $order->billing['country']['id'], 'integer');
    213. 

  213.       $check = $db->Execute($sql);
    214. 

  214.       while (!$check->EOF) {
    215. 

  215.         if ($check->fields['zone_id'] < 1) {
    216. 

  216.           $check_flag = true;
    217. 

  217.           break;
    218. 

  218.         } elseif ($check->fields['zone_id'] == $order->billing['zone_id']) {
    219. 

  219.           $check_flag = true;
    220. 

  220.           break;
    221. 

  221.         }
    222. 

  222.         $check->MoveNext();
    223. 

  223.       }
    224. 

  224. 

  225.       if (!$check_flag) {
    226. 

  226.         $this->enabled = false;
    227. 

  227.         $this->zcLog('update_status', 'Module disabled due to zone restriction. Billing address is not within the Payment Zone selected in the module settings.');
    228. 

  228.       }
    229. 

  229. 

  230.       // module cannot be used for purchase > $10,000 USD
    231. 

  231.       $order_amount = $this->calc_order_amount($order->info['total'], 'USD');
    232. 

  232.       if ($order_amount > 10000) {
    233. 

  233.         $this->enabled = false;
    234. 

  234.         $this->zcLog('update_status', 'Module disabled because purchase price (' . $order_amount . ') exceeds PayPal-imposed maximum limit of 10,000 USD.');
    235. 

  235.       }
    236. 

  236.       if ($order->info['total'] == 0) {
    237. 

  237.         $this->enabled = false;
    238. 

  238.         $this->zcLog('update_status', 'Module disabled because purchase amount is set to 0.00.' . "\n" . print_r($order, true));
    239. 

  239.       }
    240. 

  240.     }
    241. 

  241.   }
    242. 

  242.   /**
    243. 

  243.    *  Validate the credit card information via javascript (Number, Owner, and CVV Lengths)
    244. 

  244.    */
    245. 

  245.   function javascript_validation() {
    246. 

  246.     return '  if (payment_value == "' . $this->code . '") {' . "\n" .
    247. 

  247.            '    var cc_firstname = document.checkout_payment.paypalwpp_cc_firstname.value;' . "\n" .
    248. 

  248.            '    var cc_lastname = document.checkout_payment.paypalwpp_cc_lastname.value;' . "\n" .
    249. 

  249.            '    var cc_number = document.checkout_payment.paypalwpp_cc_number.value;' . "\n" .
    250. 

  250.            '    var cc_checkcode = document.checkout_payment.paypalwpp_cc_checkcode.value;' . "\n" .
    251. 

  251.            '    if (cc_firstname == "" || cc_lastname == "" || eval(cc_firstname.length) + eval(cc_lastname.length) < ' . CC_OWNER_MIN_LENGTH . ') {' . "\n" .
    252. 

  252.            '      error_message = error_message + "' . MODULE_PAYMENT_PAYPALDP_TEXT_JS_CC_OWNER . '";' . "\n" .
    253. 

  253.            '      error = 1;' . "\n" .
    254. 

  254.            '    }' . "\n" .
    255. 

  255.            '    if (cc_number == "" || cc_number.length < ' . CC_NUMBER_MIN_LENGTH . ') {' . "\n" .
    256. 

  256.            '      error_message = error_message + "' . MODULE_PAYMENT_PAYPALDP_TEXT_JS_CC_NUMBER . '";' . "\n" .
    257. 

  257.            '      error = 1;' . "\n" .
    258. 

  258.            '    }' . "\n" .
    259. 

  259.            '    if (document.checkout_payment.paypalwpp_cc_checkcode.disabled == false && (cc_checkcode == "" || cc_checkcode.length < 3 || cc_checkcode.length > 4)) {' . "\n".
    260. 

  260.            '      error_message = error_message + "' . MODULE_PAYMENT_PAYPALDP_TEXT_JS_CC_CVV . '";' . "\n" .
    261. 

  261.            '      error = 1;' . "\n" .
    262. 

  262.            '    }' . "\n" .
    263. 

  263.            '  }' . "\n";
    264. 

  264.   }
    265. 

  265.   /**
    266. 

  266.    * Display Credit Card Information Submission Fields on the Checkout Payment Page
    267. 

  267.    */
    268. 

  268.   function selection() {
    269. 

  269.     global $order;
    270. 

  270.     $this->cc_type_check =
    271. 

  271.             'var value = document.checkout_payment.paypalwpp_cc_type.value;' .
    272. 

  272.             'if (value == "Solo" || value == "Maestro" || value == "Switch") {' .
    273. 

  273.             '    document.checkout_payment.paypalwpp_cc_issue_month.disabled = false;' .
    274. 

  274.             '    document.checkout_payment.paypalwpp_cc_issue_year.disabled = false;' .
    275. 

  275.             '    document.checkout_payment.paypalwpp_cc_checkcode.disabled = false;' .
    276. 

  276.             '    if (document.checkout_payment.paypalwpp_cc_issuenumber) document.checkout_payment.paypalwpp_cc_issuenumber.disabled = false;' .
    277. 

  277.             '} else {' .
    278. 

  278.             '    if (document.checkout_payment.paypalwpp_cc_issuenumber) document.checkout_payment.paypalwpp_cc_issuenumber.disabled = true;' .
    279. 

  279.             '    if (document.checkout_payment.paypalwpp_cc_issue_month) document.checkout_payment.paypalwpp_cc_issue_month.disabled = true;' .
    280. 

  280.             '    if (document.checkout_payment.paypalwpp_cc_issue_year) document.checkout_payment.paypalwpp_cc_issue_year.disabled = true;' .
    281. 

  281.             '    document.checkout_payment.paypalwpp_cc_checkcode.disabled = false;' .
    282. 

  282.             '}';
    283. 

  283.     if (sizeof($this->cards) == 0) $this->cc_type_check = '';
    284. 

  284. 

  285.     /**
    286. 

  286.      * since we are processing via the gateway, prepare and display the CC fields
    287. 

  287.      */
    288. 

  288.     $expires_month = array();
    289. 

  289.     $expires_year = array();
    290. 

  290.     $issue_year = array();
    291. 

  291.     for ($i = 1; $i < 13; $i++) {
    292. 

  292.       $expires_month[] = array('id' => sprintf('%02d', $i), 'text' => strftime('%B - (%m)',mktime(0,0,0,$i,1,2000)));
    293. 

  293.     }
    294. 

  294. 

  295.     $today = getdate();
    296. 

  296.     for ($i = $today['year']; $i < $today['year'] + 15; $i++) {
    297. 

  297.       $expires_year[] = array('id' => strftime('%y', mktime(0,0,0,1,1,$i)), 'text' => strftime('%Y',mktime(0,0,0,1,1,$i)));
    298. 

  298.     }
    299. 

  299. 

  300.     $onFocus = ' onfocus="methodSelect(\'pmt-' . $this->code . '\')"';
    301. 

  301. 

  302.     $fieldsArray = array();
    303. 

  303.     $fieldsArray[] = array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_FIRSTNAME,
    304. 

  304.                            'field' => zen_draw_input_field('paypalwpp_cc_firstname', $order->billing['firstname'], 'id="'.$this->code.'-cc-ownerf"'. $onFocus . ' autocomplete="off"') .
    305. 

  305.                            '<script type="text/javascript">function paypalwpp_cc_type_check() { ' . $this->cc_type_check . ' } </script>',
    306. 

  306.                            'tag' => $this->code.'-cc-ownerf');
    307. 

  307.     $fieldsArray[] = array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_LASTNAME,
    308. 

  308.                            'field' => zen_draw_input_field('paypalwpp_cc_lastname', $order->billing['lastname'], 'id="'.$this->code.'-cc-ownerl"'. $onFocus . ' autocomplete="off"'),
    309. 

  309.                            'tag' => $this->code.'-cc-ownerl');
    310. 

  310.     if (sizeof($this->cards)>0) $fieldsArray[] = array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_TYPE,
    311. 

  311.                             'field' => zen_draw_pull_down_menu('paypalwpp_cc_type', $this->cards, '', 'onchange="paypalwpp_cc_type_check();" onblur="paypalwpp_cc_type_check();"' . 'id="'.$this->code.'-cc-type"'. $onFocus),
    312. 

  312.                            'tag' => $this->code.'-cc-type');
    313. 

  313.     $fieldsArray[] = array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_NUMBER,
    314. 

  314.                            'field' => zen_draw_input_field('paypalwpp_cc_number', $ccnum, 'id="'.$this->code.'-cc-number"' . $onFocus . ' autocomplete="off"'),
    315. 

  315.                            'tag' => $this->code.'-cc-number');
    316. 

  316.     $fieldsArray[] = array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_EXPIRES,
    317. 

  317.                            'field' => zen_draw_pull_down_menu('paypalwpp_cc_expires_month', $expires_month, strftime('%m'), 'id="'.$this->code.'-cc-expires-month"' . $onFocus) . '&nbsp;' . zen_draw_pull_down_menu('paypalwpp_cc_expires_year', $expires_year, '', 'id="'.$this->code.'-cc-expires-year"' . $onFocus),
    318. 

  318.                            'tag' => $this->code.'-cc-expires-month');
    319. 

  319.     $fieldsArray[] = array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_CHECKNUMBER,
    320. 

  320.                            'field' => zen_draw_input_field('paypalwpp_cc_checkcode', '', 'size="4" maxlength="4"' . ' id="'.$this->code.'-cc-cvv"' . $onFocus . ' autocomplete="off"') . '&nbsp;<small>' . MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_CHECKNUMBER_LOCATION . '</small><script type="text/javascript">paypalwpp_cc_type_check();</script>',
    321. 

  321.                            'tag' => $this->code.'-cc-cvv');
    322. 

  322. 

  323.     $selection = array('id' => $this->code,
    324. 

  324.                        'module' => MODULE_PAYMENT_PAYPALDP_TEXT_TITLE,
    325. 

  325.                        'fields' => $fieldsArray);
    326. 

  326. 

  327.     if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK' && (CC_ENABLED_MAESTRO=='1' || CC_ENABLED_SWITCH=='1' || CC_ENABLED_SOLO=='1')) {
    328. 

  328.       // add extra fields for Switch/Solo cards
    329. 

  329.       for ($i = $today['year'] - 10; $i <= $today['year']; $i++) {
    330. 

  330.         $issue_year[] = array('id' => strftime('%y',mktime(0,0,0,1,1,$i)), 'text' => strftime('%Y',mktime(0,0,0,1,1,$i)));
    331. 

  331.       }
    332. 

  332.       array_splice($selection['fields'], 4, 0,
    333. 

  333.                    array(array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_ISSUE,
    334. 

  334.                                'field' => zen_draw_pull_down_menu('paypalwpp_cc_issue_month', $expires_month, '', 'id="'.$this->code.'-cc-issue-month"' . $onFocus ) . '&nbsp;' . zen_draw_pull_down_menu('paypalwpp_cc_issue_year', $issue_year, '', 'id="'.$this->code.'-cc-issue-year"' . $onFocus),
    335. 

  335.                                'tag' => $this->code.'-cc-issue-month')));
    336. 

  336.       // add extra field for Maestro cards
    337. 

  337.       array_splice($selection['fields'], 4, 0,
    338. 

  338.                    array(array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_MAESTRO_ISSUENUMBER,
    339. 

  339.                                'field' => zen_draw_input_field('paypalwpp_cc_issuenumber', $maestronum, 'size="4" maxlength="4"' . ' id="'.$this->code.'-cc-issuenumber"' . $onFocus . ' autocomplete="off"'),
    340. 

  340.                                'tag' => $this->code.'-cc-issuenumber')));
    341. 

  341.       // 3D-Secure
    342. 

  342.       $selection['fields'][] = array('title' => '',
    343. 

  343.                                'field' => '<div id="' . $this->code.'-cc-securetext"><p>' .
    344. 

  344.                                      '<a href="javascript:void window.open(\'vbv_learn_more.html\',\'vbv_service\',\'width=550,height=450\')">' .
    345. 

  345.                                      zen_image(DIR_WS_IMAGES.'3ds/vbv_learn_more.gif') . '</a>' .
    346. 

  346.                                      '<a href="javascript:void window.open(\'mcs_learn_more.html\',\'mcsc_service\',\'width=550,height=450\')">' .
    347. 

  347.                                      zen_image(DIR_WS_IMAGES.'3ds/mcsc_learn_more.gif') . '</a>' .
    348. 

  348.                                      '</p>' .
    349. 

  349.                                      '<p>' . TEXT_3DS_CARD_MAY_BE_ENROLLED . '</p></div>',
    350. 

  350.                                'tag' => $this->code.'-cc-securetext');
    351. 

  351.     }
    352. 

  352.     return $selection;
    353. 

  353.   }
    354. 

  354.   /**
    355. 

  355.    * This is the credit card check done between checkout_payment and
    356. 

  356.    * checkout_confirmation (called from checkout_confirmation).
    357. 

  357.    * Evaluates the Credit Card Type for acceptance and the validity of the Credit Card Number & Expiration Date
    358. 

  358.    */
    359. 

  359.   function pre_confirmation_check() {
    360. 

  360.     global $messageStack, $order;
    361. 

  361.     include(DIR_WS_CLASSES . 'cc_validation.php');
    362. 

  362.     $cc_validation = new cc_validation();
    363. 

  363.     $result = $cc_validation->validate($_POST['paypalwpp_cc_number'],
    364. 

  364.                                        $_POST['paypalwpp_cc_expires_month'], $_POST['paypalwpp_cc_expires_year'],
    365. 

  365.                                        (isset($_POST['paypalwpp_cc_issue_month']) ? $_POST['paypalwpp_cc_issue_month'] : ''), (isset($_POST['paypalwpp_cc_issue_year']) ? $_POST['paypalwpp_cc_issue_year'] : ''));
    366. 

  366.     $error = '';
    367. 

  367.     switch ($result) {
    368. 

  368.       case 1:
    369. 

  369.         break;
    370. 

  370.       case -1:
    371. 

  371.       $error = MODULE_PAYMENT_PAYPALDP_TEXT_BAD_CARD;//sprintf(TEXT_CCVAL_ERROR_UNKNOWN_CARD, substr($cc_validation->cc_number, 0, 4));
    372. 

  372.       if ($_POST['paypalwpp_cc_number'] == '') $error = str_replace('\n', '', MODULE_PAYMENT_PAYPALDP_TEXT_JS_CC_NUMBER); // yes, those are supposed to be single-quotes.
    373. 

  373.       break;
    374. 

  374.       case -2:
    375. 

  375.       case -3:
    376. 

  376.       case -4:
    377. 

  377.       $error = TEXT_CCVAL_ERROR_INVALID_DATE;
    378. 

  378.       break;
    379. 

  379.       case false:
    380. 

  380.       $error = TEXT_CCVAL_ERROR_INVALID_NUMBER;
    381. 

  381.       break;
    382. 

  382.     }
    383. 

  383. 

  384.     $_POST['paypalwpp_cc_checkcode'] = preg_replace('/[^0-9]/i', '', $_POST['paypalwpp_cc_checkcode']);
    385. 

  385.     if (isset($_POST['paypalwpp_cc_issuenumber'])) $_POST['paypalwpp_cc_issuenumber'] = preg_replace('/[^0-9]/i', '', $_POST['paypalwpp_cc_issuenumber']);
    386. 

  386. 

  387.     if (($result === false) || ($result < 1) ) {
    388. 

  388.       $messageStack->add_session('checkout_payment', $error . '<!-- ['.$this->code.'] -->' . '<!-- result: ' . $result . ' -->', 'error');
    389. 

  389.       zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
    390. 

  390.     }
    391. 

  391. 

  392.     $this->cc_card_type = $cc_validation->cc_type;
    393. 

  393.     $this->cc_card_number = $cc_validation->cc_number;
    394. 

  394.     $this->cc_expiry_month = $cc_validation->cc_expiry_month;
    395. 

  395.     $this->cc_expiry_year = $cc_validation->cc_expiry_year;
    396. 

  396.     $this->cc_checkcode = $_POST['paypalwpp_cc_checkcode'];
    397. 

  397. 

  398. 

  399.     // In the case of UK cards, hook 3D-Secure if appropriate
    400. 

  400.     // 3D-Secure
    401. 

  401.     /**
    402. 

  402.      * Checks if the card is enrolled in an authentication program and
    403. 

  403.      * launches the start-authentication process if it is enrolled.
    404. 

  404.      * The order may continue to authorization if a card is not enrolled
    405. 

  405.      * or an error occurs.
    406. 

  406.      *
    407. 

  407.      * Under the Verified by Visa, MasterCard SecureCode and JCB J/Secure
    408. 

  408.      * program guidelines, not all credit cards are eligible for
    409. 

  409.      * participation in the payer authentication programs. Certain types of
    410. 

  410.      * credit and debit cards, such as commercial and prepaid cards,
    411. 

  411.      * are simply not able to participate in the programs. For this reason,
    412. 

  412.      * this configuration is available to provide the option to allow
    413. 

  413.      * transactions using credit and debit cards that are unable to be
    414. 

  414.      * authenticated to complete and proceed with authorization.
    415. 

  415.      */
    416. 

  416.     if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK' && (!isset($_POST['MD']))) {
    417. 

  417.       if (isset($_SESSION['3Dsecure_auth_status']) && isset($_SESSION['3Dsecure_auth_xid']) && isset($_SESSION['3Dsecure_auth_cavv']) && isset($_SESSION['3Dsecure_auth_eci'])) {
    418. 

  418.         // at this point we have 3d-secure auth data
    419. 

  419.       } else {
    420. 

  420.         // at this stage we need to prepare for checking whether 3d-secure is needed
    421. 

  421.         $this->clear_3DSecure_session_vars(TRUE);
    422. 

  422.         $_SESSION['3Dsecure_requires_lookup'] = $this->requiresLookup($_POST['paypalwpp_cc_number']);
    423. 

  423.         $_SESSION['3Dsecure_card_type'] = $this->determineCardType($_POST['paypalwpp_cc_number']);
    424. 

  424.       }
    425. 

  425.       if (isset($_SESSION['3Dsecure_requires_lookup']) && $_SESSION['3Dsecure_requires_lookup'] == TRUE) {
    426. 

  426.         $_SESSION['3Dsecure_merchantData'] = serialize(array('im'=>$_POST['paypalwpp_cc_issue_month'], 'iy'=>$_POST['paypalwpp_cc_issue_year'], 'in'=>$_POST['paypalwpp_cc_issuenumber'], 'fn'=>$_POST['paypalwpp_cc_firstname'], 'ln'=>$_POST['paypalwpp_cc_lastname']));
    427. 

  427.         global $order_total_modules;
    428. 

  428.         $calculatedOrderTotal = $order_total_modules->pre_confirmation_check(TRUE);
    429. 

  429.         $lookup_data_array = array('currency' => $order->info['currency'],
    430. 

  430.                                    'txn_amount' => $calculatedOrderTotal,
    431. 

  431.                                    'order_desc' => 'Zen Cart(R) ' . MODULE_PAYMENT_PAYPALDP_TEXT_TRANSACTION_FOR . ' ' . $_POST['paypalwpp_cc_firstname'] . ' ' . $_POST['paypalwpp_cc_lastname'],
    432. 

  432.                                    'cc3d_card_number' => $_POST['paypalwpp_cc_number'],
    433. 

  433.                                    'cc3d_checkcode' => $_POST['paypalwpp_cc_checkcode'],
    434. 

  434.                                    'cc3d_exp_month' => $_POST['paypalwpp_cc_expires_month'],
    435. 

  435.                                    'cc3d_exp_year' => $_POST['paypalwpp_cc_expires_year']  );
    436. 

  436.         ////////////////////////////////////////////////////////////////////////////
    437. 

  437.         // Process the enrollment lookup
    438. 

  438.         ////////////////////////////////////////////////////////////////////////////
    439. 

  439.         $lookup_response = $this->get3DSecureLookupResponse($lookup_data_array);
    440. 

  440. 

  441.         $shouldContinue = $lookup_response['continue_flag'];
    442. 

  442.         $errorNo = $lookup_response['error_no'];
    443. 

  443.         $errorDesc = $lookup_response['error_desc'];
    444. 

  444.         $_SESSION['3Dsecure_enrolled'] = $lookup_response['enrolled'];
    445. 

  445.         $_SESSION['3Dsecure_transactionId'] = $lookup_response['transaction_id'];
    446. 

  446.         $requestXML = $lookup_response['requestXML'];
    447. 

  447.         $rawXML = $lookup_response['rawXML'];
    448. 

  448.         if (isset($lookup_response['EciFlag'])) $_SESSION['3Dsecure_auth_eci'] = $lookup_response['EciFlag'];
    449. 

  449. 

  450.         ////////////////////////////////////////////////////////////////////////////
    451. 

  451.         // Assert that there was no error code returned and the Cardholder is
    452. 

  452.         // enrolled in the authentication program prior to starting the
    453. 

  453.         // Authentication process.
    454. 

  454.         //
    455. 

  455.         // If the card is not enrolled or an error was returned, check the business
    456. 

  456.         // rules to determine if the order should continue.
    457. 

  457.         ////////////////////////////////////////////////////////////////////////////
    458. 

  458. 

  459.         if (strcasecmp('0', $errorNo) == 0 && strcasecmp('Y', $_SESSION['3Dsecure_enrolled']) == 0) {
    460. 

  460. 

  461.           ////////////////////////////////////////////////////////////////////////
    462. 

  462.           // Card is enrolled, continue to payer authentication
    463. 

  463.           ////////////////////////////////////////////////////////////////////////
    464. 

  464.           $_SESSION['3Dsecure_acsURL'] = $lookup_response['acs_url'];
    465. 

  465.           $_SESSION['3Dsecure_payload'] = $lookup_response['payload'];
    466. 

  466.           $this->form_action_url = zen_href_link(FILENAME_PAYER_AUTH_FRAME, '', 'SSL', true, false);
    467. 

  467. 

  468.         } else {
    469. 

  469. 

  470.           if ($shouldContinue != 'Y') {
    471. 

  471.             ////////////////////////////////////////////////////////////////////
    472. 

  472.             // Business rules are set to prompt for another form of payment
    473. 

  473.             ////////////////////////////////////////////////////////////////////
    474. 

  474.             $error= $this->get_authentication_error();
    475. 

  475.             if (in_array($errorNo, array('8000', '8010', '8020', '8030'))) $error = CENTINEL_PROCESSING_ERROR;
    476. 

  476.             $reason = $errorNo . ' - ' . $errorDesc;
    477. 

  477.             $messageStack->add_session('checkout_payment', $error . '<!-- ['.$this->code.'] -->' . '<!-- result: ' . $reason . ' -->', 'error');
    478. 

  478.             $errorText = $error . "\n\n" . $reason . "\n(" . $this->code . ")\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    479. 

  479.             zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_SUBJECT . ' ' . $reason, $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    480. 

  480.             zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
    481. 

  481. 

  482.           } else {
    483. 

  483.             ////////////////////////////////////////////////////////////////////
    484. 

  484.             // Business rules are set to continue to authorization
    485. 

  485.             ////////////////////////////////////////////////////////////////////
    486. 

  486.             if (!isset($_SESSION['3Dsecure_auth_eci']) || $_SESSION['3Dsecure_auth_eci'] == '') {
    487. 

  487.               // Not enrolled or error, determine the ECI value for the card number, and make it available to the payment module.
    488. 

  488.               if ($_SESSION['3Dsecure_enrolled'] == 'N') {
    489. 

  489.                 switch($_SESSION['3Dsecure_card_type']) {
    490. 

  490.                   case 'VISA':
    491. 

  491.                     $_SESSION['3Dsecure_auth_eci'] = "06";
    492. 

  492.                     break;
    493. 

  493.                   case 'MASTERCARD':
    494. 

  494.                     $_SESSION['3Dsecure_auth_eci'] = "01";
    495. 

  495.                     break;
    496. 

  496.                   case 'JCB':
    497. 

  497.                     $_SESSION['3Dsecure_auth_eci'] = "06";
    498. 

  498.                     break;
    499. 

  499.                 }
    500. 

  500.               } else if ('U' == $_SESSION['3Dsecure_enrolled'] || '0' != $errorNo) {
    501. 

  501.                 switch($_SESSION['3Dsecure_card_type']) {
    502. 

  502.                   case 'VISA':
    503. 

  503.                     $_SESSION['3Dsecure_auth_eci'] = "07";
    504. 

  504.                     break;
    505. 

  505.                   case 'MASTERCARD':
    506. 

  506.                     $_SESSION['3Dsecure_auth_eci'] = "01";
    507. 

  507.                     break;
    508. 

  508.                   case 'JCB':
    509. 

  509.                     $_SESSION['3Dsecure_auth_eci'] = "07";
    510. 

  510.                     break;
    511. 

  511.                 }
    512. 

  512.               }
    513. 

  513.             }
    514. 

  514.           }
    515. 

  515.         }
    516. 

  516.       }
    517. 

  517.     }
    518. 

  518.     // end uk/3d-secure check
    519. 

  519.   }
    520. 

  520.   /**
    521. 

  521.    * Display Credit Card Information for review on the Checkout Confirmation Page
    522. 

  522.    */
    523. 

  523.   function confirmation() {
    524. 

  524.     $confirmation = array('title' => '',
    525. 

  525.                           'fields' => array(array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_FIRSTNAME,
    526. 

  526.                                                   'field' => $_POST['paypalwpp_cc_firstname']),
    527. 

  527.                                             array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_LASTNAME,
    528. 

  528.                                                   'field' => $_POST['paypalwpp_cc_lastname']),
    529. 

  529.                                             array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_TYPE,
    530. 

  530.                                                   'field' => $this->cc_card_type),
    531. 

  531.                                             array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_NUMBER,
    532. 

  532.                                                   'field' => substr($_POST['paypalwpp_cc_number'], 0, 4) . str_repeat('X', (strlen($_POST['paypalwpp_cc_number']) - 8)) . substr($_POST['paypalwpp_cc_number'], -4)),
    533. 

  533.                                             array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_CREDIT_CARD_EXPIRES,
    534. 

  534.                                                   'field' => strftime('%B, %Y', mktime(0,0,0,$_POST['paypalwpp_cc_expires_month'], 1, '20' . $_POST['paypalwpp_cc_expires_year'])),
    535. 

  535.                                             (isset($_POST['paypalwpp_cc_issuenumber']) ? array('title' => MODULE_PAYMENT_PAYPALDP_TEXT_ISSUE_NUMBER,
    536. 

  536.                                                   'field' => $_POST['paypalwpp_cc_issuenumber']) : '')
    537. 

  537.                                             )));
    538. 

  538.     // 3D-Secure
    539. 

  539.     if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK' && $this->requiresLookup($_POST['paypalwpp_cc_number']) == true) {
    540. 

  540.           $confirmation['fields'][count($confirmation['fields'])] = array(
    541. 

  541.               'title' => '',
    542. 

  542.               'field' => '<div id="' . $this->code.'-cc-securetext"><p>' .
    543. 

  543.                          '<a href="javascript:void window.open(\'vbv_learn_more.html\',\'vbv_service\',\'width=550,height=450\')">' .
    544. 

  544.                          zen_image(DIR_WS_IMAGES.'3ds/vbv_learn_more.gif') . '</a>' .
    545. 

  545.                          '<a href="javascript:void window.open(\'mcs_learn_more.html\',\'mcsc_service\',\'width=550,height=450\')">' .
    546. 

  546.                          zen_image(DIR_WS_IMAGES.'3ds/mcsc_learn_more.gif') . '</a></p>' .
    547. 

  547.                          '<p>' . TEXT_3DS_CARD_MAY_BE_ENROLLED . '</p></div>');
    548. 

  548.     }
    549. 

  549.     return $confirmation;
    550. 

  550.   }
    551. 

  551.   /**
    552. 

  552.    * Prepare the hidden fields comprising the parameters for the Submit button on the checkout confirmation page
    553. 

  553.    */
    554. 

  554.   function process_button() {
    555. 

  555.     global $order;
    556. 

  556.     $_SESSION['paypal_ec_markflow'] = 1;
    557. 

  557.     $process_button_string = '';
    558. 

  558.     $process_button_string .= "\n" . zen_draw_hidden_field('wpp_cc_type', $_POST['paypalwpp_cc_type']) . "\n" .
    559. 

  559.         zen_draw_hidden_field('wpp_cc_expdate_month', $_POST['paypalwpp_cc_expires_month']) . "\n" .
    560. 

  560.         zen_draw_hidden_field('wpp_cc_expdate_year', $_POST['paypalwpp_cc_expires_year']) . "\n" .
    561. 

  561.         zen_draw_hidden_field('wpp_cc_issuedate_month', $_POST['paypalwpp_cc_issue_month']) . "\n" .
    562. 

  562.         zen_draw_hidden_field('wpp_cc_issuedate_year', $_POST['paypalwpp_cc_issue_year']) . "\n" .
    563. 

  563.         zen_draw_hidden_field('wpp_cc_issuenumber', $_POST['paypalwpp_cc_issuenumber']) . "\n" .
    564. 

  564.         zen_draw_hidden_field('wpp_cc_number', $_POST['paypalwpp_cc_number']) . "\n" .
    565. 

  565.         zen_draw_hidden_field('wpp_cc_checkcode', $_POST['paypalwpp_cc_checkcode']) . "\n" .
    566. 

  566.         zen_draw_hidden_field('wpp_payer_firstname', $_POST['paypalwpp_cc_firstname']) . "\n" .
    567. 

  567.         zen_draw_hidden_field('wpp_payer_lastname', $_POST['paypalwpp_cc_lastname']) . "\n";
    568. 

  568.     $process_button_string .= zen_draw_hidden_field(zen_session_name(), zen_session_id());
    569. 

  569.     return $process_button_string;
    570. 

  570.   }
    571. 

  571.   /**
    572. 

  572.    * Prepare and submit the final authorization to PayPal via the appropriate means as configured
    573. 

  573.    */
    574. 

  574.   function before_process() {
    575. 

  575.     global $order, $doPayPal, $messageStack;
    576. 

  576.     $options = array();
    577. 

  577.     $optionsShip = array();
    578. 

  578.     $optionsNVP = array();
    579. 

  579. 

  580.     $options = $this->getLineItemDetails($this->selectCurrency($order->info['currency']));
    581. 

  581. 

  582.     //$this->zcLog('before_process - 1', 'Have line-item details:' . "\n" . print_r($options, true));
    583. 

  583. 

  584.     // Initializing DESC field: using for comments related to tax-included pricing, populated by getLineItemDetails()
    585. 

  585.     $options['DESC'] = '';
    586. 

  586. 

  587.     $doPayPal = $this->paypal_init();
    588. 

  588.       /****************************************
    589. 

  589.        * Do DP checkout
    590. 

  590.        ****************************************/
    591. 

  591.       $this->zcLog('before_process - DP-1', 'Beginning DP mode' /* . print_r($_POST, TRUE)*/);
    592. 

  592.       // Set state fields depending on what PayPal wants to see for that country
    593. 

  593.       $this->setStateAndCountry($order->billing);
    594. 

  594.       if (zen_not_null($order->delivery['street_address'])) {
    595. 

  595.         $this->setStateAndCountry($order->delivery);
    596. 

  596.       }
    597. 

  597. 

  598.       // Validate credit card data
    599. 

  599.       include(DIR_WS_CLASSES . 'cc_validation.php');
    600. 

  600.       $cc_validation = new cc_validation();
    601. 

  601.       $response = $cc_validation->validate($_POST['wpp_cc_number'], $_POST['wpp_cc_expdate_month'], $_POST['wpp_cc_expdate_year'],
    602. 

  602.                                            $_POST['wpp_cc_issuedate_month'], $_POST['wpp_cc_issuedate_year']);
    603. 

  603.       $error = '';
    604. 

  604.       switch ($response) {
    605. 

  605.         case -1:
    606. 

  606.           $error = sprintf(TEXT_CCVAL_ERROR_UNKNOWN_CARD, substr($cc_validation->cc_number, 0, 4));
    607. 

  607.           break;
    608. 

  608.         case -2:
    609. 

  609.         case -3:
    610. 

  610.         case -4:
    611. 

  611.           $error = TEXT_CCVAL_ERROR_INVALID_DATE;
    612. 

  612.           break;
    613. 

  613.         case false:
    614. 

  614.           $error = TEXT_CCVAL_ERROR_INVALID_NUMBER;
    615. 

  615.           break;
    616. 

  616.       }
    617. 

  617. 

  618.       if (($response === false) || ($response < 1) ) {
    619. 

  619.         $this->zcLog('before_process - DP-2', 'CC validation results: ' . $error . '(' . $response . ')');
    620. 

  620.         $messageStack->add_session('checkout_payment', $error . '<!-- ['.$this->code.'] -->' . '<!-- result: ' . $response . ' -->', 'error');
    621. 

  621.         zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
    622. 

  622.       }
    623. 

  623.       if (!in_array($cc_validation->cc_type, array('Visa', 'MasterCard', 'Switch', 'Solo', 'Discover', 'American Express', 'Maestro'))) {
    624. 

  624. //        $this->zcLog('before_process - DP-3', 'CC info: ' . $cc_validation->cc_type . ' ' . substr($cc_validation->cc_number, 0, 4) . str_repeat('X', (strlen($cc_validation->cc_number) - 8)) . substr($cc_validation->cc_number, -4) . ' ' . $error);
    625. 

  625.         $messageStack->add_session('checkout_payment', MODULE_PAYMENT_PAYPALDP_TEXT_BAD_CARD . '<!-- [' . $this->code . ' ' . $cc_validation->cc_type . '] -->', 'error');
    626. 

  626.         zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
    627. 

  627.       }
    628. 

  628. 

  629.       // if CC validation passed, continue using the validated data
    630. 

  630.       $cc_type = $cc_validation->cc_type;
    631. 

  631.       $cc_number = $cc_validation->cc_number;
    632. 

  632.       $cc_first_name = ($_POST['wpp_payer_firstname'] != '' ? $_POST['wpp_payer_firstname'] : $_SESSION['customer_first_name']);
    633. 

  633.       $cc_last_name = ($_POST['wpp_payer_lastname'] != '' ? $_POST['wpp_payer_lastname'] : $_SESSION['customer_last_name']);
    634. 

  634.       $cc_checkcode = $_POST['wpp_cc_checkcode'];
    635. 

  635.       $cc_expdate_month = $cc_validation->cc_expiry_month;
    636. 

  636.       $cc_expdate_year = $cc_validation->cc_expiry_year;
    637. 

  637.       $cc_issuedate_month = $_POST['wpp_cc_issuedate_month'];
    638. 

  638.       $cc_issuedate_year = $_POST['wpp_cc_issuedate_year'];
    639. 

  639.       $cc_issuenumber = $_POST['wpp_cc_issuenumber'];
    640. 

  640.       $cc_owner_ip = current(explode(':', str_replace(',', ':', zen_get_ip_address())));
    641. 

  641. 

  642.       // If they're still here, set some of the order object's variables.
    643. 

  643.       $order->info['cc_type'] = $cc_type;
    644. 

  644.       $order->info['cc_number'] = substr($cc_number, 0, 4) . str_repeat('X', (strlen($cc_number) - 8)) . substr($cc_number, -4);
    645. 

  645.       $order->info['cc_owner'] = $cc_first_name . ' ' . $cc_last_name;
    646. 

  646.       $order->info['cc_expires'] = ''; //$cc_expdate_month . substr($cc_expdate_year, -2);
    647. 

  647.       $order->info['ip_address'] = $cc_owner_ip;
    648. 

  648. 

  649.       // Set currency
    650. 

  650.       $my_currency = $this->selectCurrency($order->info['currency'], 'DP');
    651. 

  651. 

  652.       // if CC is switch or solo, must be GBP
    653. 

  653.       if (in_array($cc_type, array('Switch', 'Solo', 'Maestro'))) {
    654. 

  654.         $my_currency = 'GBP';
    655. 

  655.       }
    656. 

  656. 

  657. //      $order->info['total'] = zen_round($order->info['total'], 2);
    658. 

  658.       $order_amount = $this->calc_order_amount($order->info['total'], $my_currency);
    659. 

  659.       $display_order_amount = $this->calc_order_amount($order->info['total'], $my_currency, TRUE);
    660. 

  660. 

  661. 

  662.       // 3D-Secure
    663. 

  663.       if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK') {
    664. 

  664.         // determine the card type and validate that authentication was attempted and completed if applicable
    665. 

  665.         if (($_SESSION['3Dsecure_requires_lookup'] || $this->requiresLookup($_POST['wpp_cc_number']) == true)) {  // authentication attempt required?
    666. 

  666.           // validate an acceptable lookup result
    667. 

  667.           if (isset($_SESSION['3Dsecure_enroll_lookup_attempted']) == false || strcasecmp($_SESSION['3Dsecure_enroll_lookup_attempted'], 'Y') != 0) {
    668. 

  668.             // lookup never attempted for required card, so need to redirect to payment-selection page
    669. 

  669.             $reason = 'Customer arrived on the order process page without attempting authentication lookup.';
    670. 

  670.             $error = MODULE_PAYMENT_PAYPALDP_CANNOT_BE_COMPLETED;
    671. 

  671.             $messageStack->add_session('checkout_payment', $error . '<!-- ['.$this->code.'] -->' . '<!-- result: ' . $reason . ' -->', 'error');
    672. 

  672.             $errorText = $reason ."\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    673. 

  673.             $errorText .= $this->code;
    674. 

  674.             zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_SUBJECT, $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    675. 

  675.             zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
    676. 

  676.           }
    677. 

  677.           // if enrolled, validate an acceptable authentication result
    678. 

  678.           if (strcasecmp('Y', $_SESSION['3Dsecure_enrolled']) == 0) {
    679. 

  679.             if (isset($_SESSION['3Dsecure_authentication_attempted']) == false || strcasecmp($_SESSION['3Dsecure_authentication_attempted'], 'Y') != 0) {
    680. 

  680.               $reason = 'Customer arrived on the order process page without completing required authentication.';
    681. 

  681.               $error = MODULE_PAYMENT_PAYPALDP_CANNOT_BE_COMPLETED;
    682. 

  682.               $messageStack->add_session('checkout_payment', $error . '<!-- ['.$this->code.'] -->' . '<!-- result: ' . $reason . ' -->', 'error');
    683. 

  683.               $errorText = $reason ."\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    684. 

  684.               $errorText .= $this->code;
    685. 

  685.               zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_SUBJECT, $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    686. 

  686. 

  687.               // remove the lookup/auth attempted status
    688. 

  688.               unset($_SESSION['3Dsecure_enroll_lookup_attempted']);
    689. 

  689.               unset($_SESSION['3Dsecure_authentication_attempted']);
    690. 

  690. 

  691.               // authentication result was not acceptable, redirect
    692. 

  692.               zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
    693. 

  693.             }
    694. 

  694.           }
    695. 

  695.         }
    696. 

  696.         if ($cc_type != 'Solo') {  // PayPal doesn't support 3d-secure on Solo cards
    697. 

  697.           if (isset($_SESSION['3Dsecure_enrolled'])) {
    698. 

  698.             $options['MPIVENDOR3DS'] = $_SESSION['3Dsecure_enrolled'];
    699. 

  699.           }
    700. 

  700.           if ($_SESSION['3Dsecure_auth_eci'] != '') {
    701. 

  701.             $options['ECI'] = $_SESSION['3Dsecure_auth_eci'];
    702. 

  702.           }
    703. 

  703.           if (isset($_SESSION['3Dsecure_auth_xid']) and strlen($_SESSION['3Dsecure_auth_xid']) > 0) {
    704. 

  704.             $options['XID'] = $_SESSION['3Dsecure_auth_xid'];
    705. 

  705.             $options['CAVV'] = $_SESSION['3Dsecure_auth_cavv'];
    706. 

  706.             $options['AUTHSTATUS3DS'] = $_SESSION['3Dsecure_auth_status'];
    707. 

  707.           }
    708. 

  708.         }
    709. 

  709.       }
    710. 

  710. ///////////////////////////
    711. 

  711. 

  712. 

  713.       // Initialize the paypal caller object.
    714. 

  714.       $doPayPal = $this->paypal_init();
    715. 

  715.       $optionsAll = array_merge($options,
    716. 

  716.                     array('STREET'      => $order->billing['street_address'],
    717. 

  717.                           'ZIP'         => $order->billing['postcode'],
    718. 

  718.                           'CITY'        => $order->billing['city'],
    719. 

  719.                           'STATE'       => $order->billing['state'],
    720. 

  720.                           'STREET2'     => $order->billing['suburb'],
    721. 

  721.                           'COUNTRYCODE' => $order->billing['country']['iso_code_2'],
    722. 

  722.                           'EXPDATE'     => $cc_expdate_month . $cc_expdate_year,
    723. 

  723.                           'EMAIL'       => $order->customer['email_address'],
    724. 

  724.                           'PHONENUM'    => $order->customer['telephone']));
    725. 

  725. 

  726.       $optionsShip = array();
    727. 

  727.       if (isset($order->delivery) && $order->delivery['street_address'] != '') {
    728. 

  728.         $optionsShip= array('SHIPTONAME'   => ($order->delivery['name'] == '' ? $order->delivery['firstname'] . ' ' . $order->delivery['lastname'] : $order->delivery['name']),
    729. 

  729.                             'SHIPTOSTREET' => $order->delivery['street_address'],
    730. 

  730.                             'SHIPTOSTREET2' => $order->delivery['suburb'],
    731. 

  731.                             'SHIPTOCITY'   => $order->delivery['city'],
    732. 

  732.                             'SHIPTOZIP'    => $order->delivery['postcode'],
    733. 

  733.                             'SHIPTOSTATE'  => $order->delivery['state'],
    734. 

  734.                             'SHIPTOCOUNTRYCODE'=> $order->delivery['country']['iso_code_2']);
    735. 

  735.       }
    736. 

  736.       // if these optional parameters are blank, remove them from transaction
    737. 

  737.       if (isset($optionsShip['SHIPTOSTREET2']) && trim($optionsShip['SHIPTOSTREET2']) == '') unset($optionsShip['SHIPTOSTREET2']);
    738. 

  738.       if ($optionsAll['STREET2'] == '') unset($optionsAll['STREET2']);
    739. 

  739.       if (isset($optionsShip['SHIPTOPHONE']) && trim($optionsShip['SHIPTOPHONE']) == '') unset($optionsShip['SHIPTOPHONE']);
    740. 

  740. 

  741.       // if State is not supplied, repeat the city so that it's not blank, otherwise PayPal croaks
    742. 

  742.       if ((!isset($optionsShip['SHIPTOSTATE']) || trim($optionsShip['SHIPTOSTATE']) == '') && isset($optionsShip['SHIPTOCITY'])) $optionsShip['SHIPTOSTATE'] = $optionsShip['SHIPTOCITY'];
    743. 

  743. 

  744.       // Payment Transaction/Authorization Mode
    745. 

  745.       $optionsNVP['PAYMENTACTION'] = (MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE == 'Auth Only') ? 'Authorization' : 'Sale';
    746. 

  746.       if (MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE == 'Auth Only') $this->order_status = $this->order_pending_status;
    747. 

  747. 

  748. //      if (in_array($cc_type, array('Switch', 'Solo'))) {
    749. 

  749. //        $optionsNVP['PAYMENTACTION'] = 'Authorization';
    750. 

  750. //      }
    751. 

  751.       $optionsAll['BUTTONSOURCE'] = $this->buttonSource;
    752. 

  752.       $optionsAll['CURRENCY']     = $my_currency;
    753. 

  753.       if (strlen($cc_owner_ip) > 7) {
    754. 

  754.         $optionsAll['IPADDRESS']    = $cc_owner_ip;
    755. 

  755.       }
    756. 

  756.       if ($cc_issuedate_month && $cc_issuedate_year) {
    757. 

  757.         $optionsAll['CARDSTART'] = $cc_issuedate_month . substr($cc_issuedate_year, -2);
    758. 

  758.       }
    759. 

  759.       if (isset($_POST['wpp_cc_issuenumber'])) $optionsAll['CARDISSUE'] = $_POST['wpp_cc_issuenumber'];
    760. 

  760. 

  761.       // Add note to track that this was an API WPP transaction:
    762. 

  762.       $optionsAll['CUSTOM'] = 'DP-' . (int)$_SESSION['customer_id'] . '-' . time();
    763. 

  763. 

  764.       // send the store name as transaction identifier, to help distinguish payments between multiple stores:
    765. 

  765.       $optionsAll['INVNUM'] = (int)$_SESSION['customer_id'] . '-' . time() . '-[' . substr(preg_replace('/[^a-zA-Z0-9_]/', '', STORE_NAME), 0, 30) . ']';  // (cannot send actual invoice number because it's not assigned until after payment is completed)
    766. 

  766. 

  767.       if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK' || (MODULE_PAYMENT_PAYPALWPP_PFVENDOR != '' && MODULE_PAYMENT_PAYPALWPP_PFPASSWORD != '')) { // Payflow params required
    768. 

  768.         if (isset($optionsAll['COUNTRYCODE'])) {
    769. 

  769.           $optionsAll['COUNTRY'] = $optionsAll['COUNTRYCODE'];
    770. 

  770.           unset($optionsAll['COUNTRYCODE']);
    771. 

  771.         }
    772. 

  772.         if (isset($optionsShip['SHIPTOCOUNTRYCODE'])) {
    773. 

  773.           $optionsShip['SHIPTOCOUNTRY'] = $optionsShip['SHIPTOCOUNTRYCODE'];
    774. 

  774.           unset($optionsShip['SHIPTOCOUNTRYCODE']);
    775. 

  775.         }
    776. 

  776.         if (isset($optionsShip['SHIPTOSTREET2'])) unset($optionsShip['SHIPTOSTREET2']);
    777. 

  777.         if (isset($optionsAll['STREET2'])) unset($optionsAll['STREET2']);
    778. 

  778.       }
    779. 

  779.       if (isset($optionsAll['DESC']) && $optionsAll['DESC'] == '') unset($optionsAll['DESC']);
    780. 

  780.       $this->zcLog('before_process - DP-4', 'options: ' . print_r(array_merge($optionsAll, $optionsNVP, $optionsShip), true) . "\n" . 'Rest of data: ' . "\n" . number_format($order_amount, 2) . ' ' . $cc_expdate_month . ' ' . substr($cc_expdate_year, -2) . ' ' . $cc_first_name . ' ' . $cc_last_name . ' ' . $cc_type);
    781. 

  781. 

  782.       if (!isset($optionsAll['AMT'])) $optionsAll['AMT'] = number_format($order_amount, 2, '.', '');
    783. 

  783.       $response = $doPayPal->DoDirectPayment($cc_number,
    784. 

  784.                                            $cc_checkcode,
    785. 

  785.                                            $cc_expdate_month . substr($cc_expdate_year, -2),
    786. 

  786.                                            $cc_first_name, $cc_last_name,
    787. 

  787.                                            $cc_type,
    788. 

  788.                                            $optionsAll, array_merge($optionsNVP, $optionsShip));
    789. 

  789. 

  790.       $this->zcLog('before_process - DP-5', 'resultset:' . "\n" . urldecode(print_r($response, true)));
    791. 

  791. 

  792.       // CHECK RESPONSE
    793. 

  793.       $error = $this->_errorHandler($response, 'DoDirectPayment');
    794. 

  794. 

  795.       if ($this->fmfResponse != '') {
    796. 

  796.         $this->order_status = $this->order_pending_status;
    797. 

  797.       }
    798. 

  798. 

  799.       $this->feeamt = '';
    800. 

  800.       $this->taxamt = '';
    801. 

  801.       $this->pendingreason = '';
    802. 

  802.       $this->reasoncode = '';
    803. 

  803.       $this->numitems = sizeof($order->products);
    804. 

  804.       $this->responsedata = $response;
    805. 

  805. 

  806.       if ($response['PNREF']) {
    807. 

  807.       // PNREF only comes from payflow mode
    808. 

  808.         $this->payment_type = MODULE_PAYMENT_PAYPALDP_PF_TEXT_TYPE;
    809. 

  809.         $this->transaction_id = $response['PNREF'];
    810. 

  810.         $this->payment_status = (MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE == 'Auth Only') ? 'Authorization' : 'Completed';
    811. 

  811.         $this->avs = 'AVSADDR: ' . $response['AVSADDR'] . ', AVSZIP: ' . $response['AVSZIP'] . ', IAVS: ' . $response['IAVS'];
    812. 

  812.         $this->cvv2 = $response['CVV2MATCH'];
    813. 

  813.         $this->amt = $display_order_amount . ' ' . $my_currency;
    814. 

  814.         $this->payment_time = date('Y-m-d h:i:s');
    815. 

  815.         $this->responsedata['CURRENCYCODE'] = $my_currency;
    816. 

  816.         $this->responsedata['EXCHANGERATE'] = $order->info['currency_value'];
    817. 

  817.         $this->auth_code = $this->response['AUTHCODE'];
    818. 

  818.       } else {
    819. 

  819.         // here we're in NVP mode
    820. 

  820.         $this->transaction_id = $response['TRANSACTIONID'];
    821. 

  821.         $this->payment_type = MODULE_PAYMENT_PAYPALDP_DP_TEXT_TYPE;
    822. 

  822.         $this->payment_status = (MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE == 'Auth Only') ? 'Authorization' : 'Completed';
    823. 

  823.         $this->pendingreason = (MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE == 'Auth Only') ? 'authorization' : '';
    824. 

  824.         $this->avs = $response['AVSCODE'];
    825. 

  825.         $this->cvv2 = $response['CVV2MATCH'];
    826. 

  826.         $this->correlationid = $response['CORRELATIONID'];
    827. 

  827.         $this->payment_time = urldecode($response['TIMESTAMP']);
    828. 

  828.         $this->amt = urldecode($response['AMT'] . ' ' . $response['CURRENCYCODE']);
    829. 

  829.         $this->auth_code = (isset($this->response['AUTHCODE'])) ? $this->response['AUTHCODE'] : $this->response['TOKEN'];
    830. 

  830.         $this->transactiontype = 'cart';
    831. 

  831.       }
    832. 

  832.   }
    833. 

  833.   /**
    834. 

  834.    * When the order returns from the processor, this stores the results in order-status-history and logs data for subsequent use
    835. 

  835.    */
    836. 

  836.   function after_process() {
    837. 

  837.     global $insert_id, $db, $order;
    838. 

  838.     // FMF
    839. 

  839.     if ($this->fmfResponse != '') {
    840. 

  840.       $detailedMessage = $insert_id . "\n" . $this->fmfResponse . "\n" . MODULES_PAYMENT_PAYPALDP_TEXT_EMAIL_FMF_INTRO . "\n" . print_r($this->fmfErrors, TRUE);
    841. 

  841.       zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, MODULES_PAYMENT_PAYPALDP_TEXT_EMAIL_FMF_SUBJECT . ' (' . $insert_id . ')', $detailedMessage, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($detailedMessage)), 'paymentalert');
    842. 

  842.     }
    843. 

  843. 

  844.     // add a new OSH record for this order's PP details
    845. 

  845.     $commentString = "Transaction ID: :transID: " .
    846. 

  846.                      (isset($this->responsedata['PPREF']) ? "\nPPRef: " . $this->responsedata['PPREF'] : "") .
    847. 

  847.                      (isset($this->responsedata['AUTHCODE'])? "\nAuthCode: " . $this->responsedata['AUTHCODE'] : "") .
    848. 

  848.                                  "\nPayment Type: :pmtType: " .
    849. 

  849.                      ($this->payment_time != '' ? "\nTimestamp: :pmtTime: " : "") .
    850. 

  850.                                  "\nPayment Status: :pmtStatus: " .
    851. 

  851.                      (isset($this->responsedata['auth_exp']) ? "\nAuth-Exp: " . $this->responsedata['auth_exp'] : "") .
    852. 

  852.                      ($this->avs != 'N/A' ? "\nAVS Code: ".$this->avs."\nCVV2 Code: ".$this->cvv2 : '') .
    853. 

  853.                      (trim($this->amt) != '' ? "\nAmount: :orderAmt: " : "");
    854. 

  854.     $commentString = $db->bindVars($commentString, ':transID:', $this->transaction_id, 'noquotestring');
    855. 

  855.     $commentString = $db->bindVars($commentString, ':pmtType:', $this->payment_type, 'noquotestring');
    856. 

  856.     $commentString = $db->bindVars($commentString, ':pmtTime:', $this->payment_time, 'noquotestring');
    857. 

  857.     $commentString = $db->bindVars($commentString, ':pmtStatus:', $this->payment_status, 'noquotestring');
    858. 

  858.     $commentString = $db->bindVars($commentString, ':orderAmt:', $this->amt, 'noquotestring');
    859. 

  859. 

  860.     $sql_data_array= array(array('fieldName'=>'orders_id', 'value'=>$insert_id, 'type'=>'integer'),
    861. 

  861.                            array('fieldName'=>'orders_status_id', 'value'=>$order->info['order_status'], 'type'=>'integer'),
    862. 

  862.                            array('fieldName'=>'date_added', 'value'=>'now()', 'type'=>'noquotestring'),
    863. 

  863.                            array('fieldName'=>'customer_notified', 'value'=>0, 'type'=>'integer'),
    864. 

  864.                            array('fieldName'=>'comments', 'value'=>$commentString, 'type'=>'string'));
    865. 

  865.     $db->perform(TABLE_ORDERS_STATUS_HISTORY, $sql_data_array);
    866. 

  866. 

  867.     // 3D-Secure
    868. 

  868.     if ($this->requiresLookup($order->info['cc_type']) == true) {
    869. 

  869.       // CardinalCommerce Liability Protection Status
    870. 

  870.       // Inserts 'PROTECTED' or 'NOT PROTECTED' status, ECI, CAVV values in the order status history comments
    871. 

  871.       $auth_proc_status = $this->determine3DSecureProtection($order->info['cc_type'], $_SESSION['3Dsecure_auth_eci']);
    872. 

  872.       $commentString = "3D-Secure: " . $auth_proc_status . "\n" . 'ECI Value = ' . $_SESSION['3Dsecure_auth_eci'] . "\n" . 'CAVV Value = ' . $_SESSION['3Dsecure_auth_cavv'];
    873. 

  873.       $sql_data_array= array(array('fieldName'=>'orders_id', 'value'=> $insert_id, 'type'=>'integer'),
    874. 

  874.                              array('fieldName'=>'orders_status_id', 'value'=> $order->info['order_status'], 'type'=>'integer'),
    875. 

  875.                              array('fieldName'=>'date_added', 'value'=>'now()', 'type'=>'noquotestring'),
    876. 

  876.                              array('fieldName'=>'customer_notified', 'value'=> -1, 'type'=>'integer'),
    877. 

  877.                              array('fieldName'=>'comments', 'value'=> $commentString, 'type'=>'string'));
    878. 

  878.       $db->perform(TABLE_ORDERS_STATUS_HISTORY, $sql_data_array);
    879. 

  879.     }
    880. 

  880. 

  881.     // store the PayPal order meta data -- used for later matching and back-end processing activities
    882. 

  882.     $paypal_order = array('order_id' => $insert_id,
    883. 

  883.                           'txn_type' => $this->transactiontype,
    884. 

  884.                           'module_name' => $this->code,
    885. 

  885.                           'module_mode' => MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY,
    886. 

  886.                           'reason_code' => $this->reasoncode,
    887. 

  887.                           'payment_type' => $this->payment_type,
    888. 

  888.                           'payment_status' => $this->payment_status,
    889. 

  889.                           'pending_reason' => $this->pendingreason,
    890. 

  890.                           'invoice' => urldecode($_SESSION['paypal_ec_token'] . $this->responsedata['PPREF']),
    891. 

  891.                           'first_name' => $_SESSION['paypal_ec_payer_info']['payer_firstname'],
    892. 

  892.                           'last_name' => $_SESSION['paypal_ec_payer_info']['payer_lastname'],
    893. 

  893.                           'payer_business_name' => $_SESSION['paypal_ec_payer_info']['payer_business'],
    894. 

  894.                           'address_name' => $_SESSION['paypal_ec_payer_info']['ship_name'],
    895. 

  895.                           'address_street' => $_SESSION['paypal_ec_payer_info']['ship_street_1'],
    896. 

  896.                           'address_city' => $_SESSION['paypal_ec_payer_info']['ship_city'],
    897. 

  897.                           'address_state' => $_SESSION['paypal_ec_payer_info']['ship_state'],
    898. 

  898.                           'address_zip' => $_SESSION['paypal_ec_payer_info']['ship_postal_code'],
    899. 

  899.                           'address_country' => $_SESSION['paypal_ec_payer_info']['ship_country'],
    900. 

  900.                           'address_status' => $_SESSION['paypal_ec_payer_info']['ship_address_status'],
    901. 

  901.                           'payer_email' => $_SESSION['paypal_ec_payer_info']['payer_email'],
    902. 

  902.                           'payer_id' => $_SESSION['paypal_ec_payer_id'],
    903. 

  903.                           'payer_status' => $_SESSION['paypal_ec_payer_info']['payer_status'],
    904. 

  904.                           'payment_date' => trim(preg_replace('/[^0-9-:]/', ' ', $this->payment_time)),
    905. 

  905.                           'business' => '',
    906. 

  906.                           'receiver_email' => (MODULE_PAYMENT_PAYPALWPP_PFVENDOR != '' ? MODULE_PAYMENT_PAYPALWPP_PFVENDOR : str_replace('_api1', '', MODULE_PAYMENT_PAYPALWPP_APIUSERNAME)),
    907. 

  907.                           'receiver_id' => '',
    908. 

  908.                           'txn_id' => $this->transaction_id,
    909. 

  909.                           'parent_txn_id' => '',
    910. 

  910.                           'num_cart_items' => (float)$this->numitems,
    911. 

  911.                           'mc_gross' => (float)$this->amt,
    912. 

  912.                           'mc_fee' => (float)urldecode($this->feeamt),
    913. 

  913.                           'mc_currency' => $this->responsedata['CURRENCYCODE'],
    914. 

  914.                           'settle_amount' => (float)urldecode($this->responsedata['SETTLEAMT']),
    915. 

  915.                           'settle_currency' => $this->responsedata['CURRENCYCODE'],
    916. 

  916.                           'exchange_rate' => (urldecode($this->responsedata['EXCHANGERATE']) > 0 ? urldecode($this->responsedata['EXCHANGERATE']) : 1.0),
    917. 

  917.                           'notify_version' => '0',
    918. 

  918.                           'verify_sign' =>'',
    919. 

  919.                           'date_added' => 'now()',
    920. 

  920.                           'memo' => (sizeof($this->fmfErrors) > 0 ? 'FMF Details ' . print_r($this->fmfErrors, TRUE) : '{Record generated by payment module}'),
    921. 

  921.                          );
    922. 

  922.     zen_db_perform(TABLE_PAYPAL, $paypal_order);
    923. 

  923. 

  924.     // Unregister the paypal session variables, making it necessary to start again for another purchase
    925. 

  925.     unset($_SESSION['paypal_ec_temp']);
    926. 

  926.     unset($_SESSION['paypal_ec_token']);
    927. 

  927.     unset($_SESSION['paypal_ec_payer_id']);
    928. 

  928.     unset($_SESSION['paypal_ec_payer_info']);
    929. 

  929.     unset($_SESSION['paypal_ec_final']);
    930. 

  930.     unset($_SESSION['paypal_ec_markflow']);
    931. 

  931.     $this->clear_3DSecure_session_vars(TRUE);
    932. 

  932.   }
    933. 

  933.   /**
    934. 

  934.     * Build admin-page components
    935. 

  935.     *
    936. 

  936.     * @param int $zf_order_id
    937. 

  937.     * @return string
    938. 

  938.     */
    939. 

  939.   function admin_notification($zf_order_id) {
    940. 

  940.     if (!defined('MODULE_PAYMENT_PAYPALDP_STATUS')) return '';
    941. 

  941.     global $db;
    942. 

  942.     $module = $this->code;
    943. 

  943.     $output = '';
    944. 

  944.     $response = $this->_GetTransactionDetails($zf_order_id);
    945. 

  945.     //$response = $this->_TransactionSearch('2006-12-01T00:00:00Z', $zf_order_id);
    946. 

  946.     $sql = "SELECT * from " . TABLE_PAYPAL . " WHERE order_id = :orderID
    947. 

  947.             AND parent_txn_id = '' AND order_id > 0
    948. 

  948.             ORDER BY paypal_ipn_id DESC LIMIT 1";
    949. 

  949.     $sql = $db->bindVars($sql, ':orderID', $zf_order_id, 'integer');
    950. 

  950.     $ipn = $db->Execute($sql);
    951. 

  951.     if ($ipn->RecordCount() == 0) $ipn->fields = array();
    952. 

  952.     if (file_exists(DIR_FS_CATALOG . DIR_WS_MODULES . 'payment/paypal/paypalwpp_admin_notification.php')) require(DIR_FS_CATALOG . DIR_WS_MODULES . 'payment/paypal/paypalwpp_admin_notification.php');
    953. 

  953.     return $output;
    954. 

  954.   }
    955. 

  955.   /**
    956. 

  956.    * Used to read details of an existing transaction.  FOR FUTURE USE.
    957. 

  957.    */
    958. 

  958.   function _GetTransactionDetails($oID) {
    959. 

  959.     if ($oID == '' || $oID < 1) return FALSE;
    960. 

  960.     global $db, $messageStack, $doPayPal;
    961. 

  961.     $doPayPal = $this->paypal_init();
    962. 

  962.     // look up history on this order from PayPal table
    963. 

  963.     $sql = "select * from " . TABLE_PAYPAL . " where order_id = :orderID order by last_modified DESC, date_added DESC, parent_txn_id DESC, paypal_ipn_id DESC LIMIT 2";
    964. 

  964.     $sql = $db->bindVars($sql, ':orderID', $oID, 'integer');
    965. 

  965.     $zc_ppHist = $db->Execute($sql);
    966. 

  966.     if ($zc_ppHist->RecordCount() == 0) return false;
    967. 

  967.     $txnID = $zc_ppHist->fields['txn_id'];
    968. 

  968.     if ($txnID == '' || $txnID === 0) return FALSE;
    969. 

  969.     /**
    970. 

  970.      * Read data from PayPal
    971. 

  971.      */
    972. 

  972.     $response = $doPayPal->GetTransactionDetails($txnID);
    973. 

  973.     if (isset($response['RESULT']) && $response['RESULT'] == '7' && $zc_ppHist->RecordCount() > 1) {
    974. 

  974.       $sql = "select * from " . TABLE_PAYPAL . " where order_id = :orderID and txn_id != :condition: order by last_modified ASC, date_added ASC, paypal_ipn_id ASC LIMIT 1";
    975. 

  975.       $sql = $db->bindVars($sql, ':orderID', $oID, 'integer');
    976. 

  976.       $sql = $db->bindVars($sql, ':condition:', $zc_ppHist->fields['txn_id'], 'integer');
    977. 

  977.       $zc_ppHist = $db->Execute($sql);
    978. 

  978.       if ($zc_ppHist->RecordCount() == 0) return false;
    979. 

  979.       $txnID = $zc_ppHist->fields['txn_id'];
    980. 

  980.       if ($txnID == '' || $txnID === 0) return FALSE;
    981. 

  981.       $response = $doPayPal->GetTransactionDetails($txnID);
    982. 

  982.     }
    983. 

  983. 

  984.     $error = $this->_errorHandler($response, 'GetTransactionDetails', 10007);
    985. 

  985.     if ($error === true) {
    986. 

  986.       return false;
    987. 

  987.     } else {
    988. 

  988.       return $response;
    989. 

  989.     }
    990. 

  990.   }
    991. 

  991.   /**
    992. 

  992.    * Used to read details of existing transactions.  FOR FUTURE USE.
    993. 

  993.    */
    994. 

  994.   function _TransactionSearch($startDate = '', $oID = '', $criteria = '') {
    995. 

  995.     global $db, $messageStack, $doPayPal;
    996. 

  996.     $doPayPal = $this->paypal_init();
    997. 

  997.     // look up history on this order from PayPal table
    998. 

  998.     $sql = "select * from " . TABLE_PAYPAL . " where order_id = :orderID  AND parent_txn_id = '' ";
    999. 

  999.     $sql = $db->bindVars($sql, ':orderID', $oID, 'integer');
    1000. 

  1000.     $zc_ppHist = $db->Execute($sql);
    1001. 

  1001.     if ($zc_ppHist->RecordCount() == 0) return false;
    1002. 

  1002.     $txnID = $zc_ppHist->fields['txn_id'];
    1003. 

  1003.     $startDate = $zc_ppHist->fields['payment_date'];
    1004. 

  1004.     $timeval = time();
    1005. 

  1005.     if ($startDate == '') $startDate = date('Y-m-d', $timeval) . 'T' . date('h:i:s', $timeval) . 'Z';
    1006. 

  1006.     /**
    1007. 

  1007.      * Read data from PayPal
    1008. 

  1008.      */
    1009. 

  1009.     $response = $doPayPal->TransactionSearch($startDate, $txnID, $email, $criteria);
    1010. 

  1010. 

  1011.     $error = $this->_errorHandler($response, 'TransactionSearch');
    1012. 

  1012.     if ($error === false) {
    1013. 

  1013.       return false;
    1014. 

  1014.     } else {
    1015. 

  1015.       return $response;
    1016. 

  1016.     }
    1017. 

  1017.   }
    1018. 

  1018.   /**
    1019. 

  1019.    * Evaluate installation status of this module. Returns true if the status key is found.
    1020. 

  1020.    */
    1021. 

  1021.   function check() {
    1022. 

  1022.     global $db;
    1023. 

  1023.     if (!isset($this->_check)) {
    1024. 

  1024.       $check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_PAYMENT_PAYPALDP_STATUS'");
    1025. 

  1025.       $this->_check = !$check_query->EOF;
    1026. 

  1026.     }
    1027. 

  1027.     return $this->_check;
    1028. 

  1028.   }
    1029. 

  1029.   /**
    1030. 

  1030.    * Installs all the configuration keys for this module
    1031. 

  1031.    */
    1032. 

  1032.   function install() {
    1033. 

  1033.     global $db, $messageStack;
    1034. 

  1034.     if (defined('MODULE_PAYMENT_PAYPALDP_STATUS')) {
    1035. 

  1035.       $messageStack->add_session('Website Payments Pro module already installed.', 'error');
    1036. 

  1036.       zen_redirect(zen_href_link(FILENAME_MODULES, 'set=payment&module=paypaldp', 'NONSSL'));
    1037. 

  1037.       return 'failed';
    1038. 

  1038.     }
    1039. 

  1039.     // cannot install DP if EC not already enabled:
    1040. 

  1040.     if (!defined('MODULE_PAYMENT_PAYPALWPP_STATUS') || MODULE_PAYMENT_PAYPALWPP_STATUS != 'True') {
    1041. 

  1041.       $messageStack->add_session('<strong>Sorry, you must install and configure PayPal Express Checkout first.</strong> PayPal Website Payments Pro requires that you offer Express Checkout to your customers.<br /><a href="' . zen_href_link('modules.php?set=payment&module=paypalwpp', '', 'NONSSL') . '">Click here to set up Express Checkout.</a>' , 'error');
    1042. 

  1042.       zen_redirect(zen_href_link(FILENAME_MODULES, 'set=payment&module=paypaldp', 'NONSSL'));
    1043. 

  1043.       return 'failed';
    1044. 

  1044.     }
    1045. 

  1045.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Enable this Payment Module', 'MODULE_PAYMENT_PAYPALDP_STATUS', 'True', 'Do you want to enable this payment module?', '6', '25', 'zen_cfg_select_option(array(\'True\', \'False\'), ', now())");
    1046. 

  1046.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Live or Sandbox', 'MODULE_PAYMENT_PAYPALDP_SERVER', 'live', '<strong>Live: </strong> Used to process Live transactions<br><strong>Sandbox: </strong>For developers and testing', '6', '25', 'zen_cfg_select_option(array(\'live\', \'sandbox\'), ', now())");
    1047. 

  1047.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Sort order of display.', 'MODULE_PAYMENT_PAYPALDP_SORT_ORDER', '0', 'Sort order of display. Lowest is displayed first.', '6', '25', now())");
    1048. 

  1048.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, use_function, set_function, date_added) values ('Payment Zone', 'MODULE_PAYMENT_PAYPALDP_ZONE', '0', 'If a zone is selected, only enable this payment method for that zone.', '6', '25', 'zen_get_zone_class_title', 'zen_cfg_pull_down_zone_classes(', now())");
    1049. 

  1049.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, use_function, date_added) values ('Set Order Status', 'MODULE_PAYMENT_PAYPALDP_ORDER_STATUS_ID', '2', 'Set the status of orders paid with this payment module to this value. <br /><strong>Recommended: Processing[2]</strong>', '6', '25', 'zen_cfg_pull_down_order_statuses(', 'zen_get_order_status_name', now())");
    1050. 

  1050.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, use_function, date_added) values ('Set Unpaid Order Status', 'MODULE_PAYMENT_PAYPALDP_ORDER_PENDING_STATUS_ID', '1', 'Set the status of unpaid orders made with this payment module to this value. <br /><strong>Recommended: Pending[1]</strong>', '6', '25', 'zen_cfg_pull_down_order_statuses(', 'zen_get_order_status_name', now())");
    1051. 

  1051.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, use_function, date_added) values ('Set Refund Order Status', 'MODULE_PAYMENT_PAYPALDP_REFUNDED_STATUS_ID', '1', 'Set the status of refunded orders to this value. <br /><strong>Recommended: Pending[1]</strong>', '6', '25', 'zen_cfg_pull_down_order_statuses(', 'zen_get_order_status_name', now())");
    1052. 

  1052.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Payment Action', 'MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE', 'Final Sale', 'How do you want to obtain payment?<br /><strong>Default: Final Sale</strong>', '6', '25', 'zen_cfg_select_option(array(\'Auth Only\', \'Final Sale\'), ',  now())");
    1053. 

  1053.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Transaction Currency', 'MODULE_PAYMENT_PAYPALDP_CURRENCY',  'Selected Currency', 'Which currency should the order be sent to PayPal as? <br />NOTE: if an unsupported currency is sent to PayPal, it will be auto-converted to USD (or GBP if using UK account)<br /><strong>Default: Selected Currency</strong>', '6', '25', 'zen_cfg_select_option(array(\'Selected Currency\', \'Only USD\', \'Only AUD\', \'Only CAD\', \'Only EUR\', \'Only GBP\', \'Only CHF\', \'Only CZK\', \'Only DKK\', \'Only HKD\', \'Only HUF\', \'Only JPY\', \'Only NOK\', \'Only NZD\', \'Only PLN\', \'Only SEK\', \'Only SGD\'), ', now())");
    1054. 

  1054.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Fraud Mgmt Filters - FMF', 'MODULE_PAYMENT_PAYPALDP_EC_RETURN_FMF_DETAILS', 'No', 'If you have enabled FMF support in your PayPal account and wish to utilize it in your transactions, set this to yes. Otherwise, leave it at No.', '6', '25','zen_cfg_select_option(array(\'No\', \'Yes\'), ', now())");
    1055. 

  1055. 

  1056.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Merchant Country', 'MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY', 'USA', 'Which country is your PayPal Account registered to? <br /><u>Choices:</u><br /><font color=green>You will need to supply <strong>API Settings</strong> in the Express Checkout module.</font><br /><strong>USA and Canada merchants</strong> need PayPal API credentials and a PayPal Payments Pro account.<br /><strong>UK merchants</strong> need to supply <strong>PAYFLOW settings</strong> (and have a Payflow account)', '6', '25',  'zen_cfg_select_option(array(\'USA\', \'UK\', \'Canada\'), ', now())");
    1057. 

  1057.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Debug Mode', 'MODULE_PAYMENT_PAYPALDP_DEBUGGING', 'Off', 'Would you like to enable debug mode?  A complete detailed log of failed transactions will be emailed to the store owner.', '6', '25', 'zen_cfg_select_option(array(\'Off\', \'Alerts Only\', \'Log File\', \'Log and Email\'), ', now())");
    1058. 

  1058. 

  1059.     // 3D-Secure
    1060. 

  1060.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Cardinal Processor ID', 'MODULE_PAYMENT_PAYPALDP_CARDINAL_PROCESSOR', '134-01', 'The processor ID for the Cardinal Centinel service. ', '6', '25', now())");
    1061. 

  1061.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Cardinal Merchant ID', 'MODULE_PAYMENT_PAYPALDP_CARDINAL_MERCHANT', 'enter value', 'The merchant ID for the Cardinal Centinel service. ', '6', '25', now())");
    1062. 

  1062.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added, set_function, use_function) values ('Cardinal Transaction Password', 'MODULE_PAYMENT_PAYPALDP_CARDINAL_PASSWORD', '', 'Enter your Cardinal Transaction Password from your Cardinal Merchant Admin console. This is used to secure and verify that the transaction originated from your store legitimately.', '6', '25', now(), 'zen_cfg_password_input(', 'zen_cfg_password_display')");
    1063. 

  1063.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Only Accept Chargeback-Protected Orders via Cardinal?', 'MODULE_PAYMENT_PAYPALDP_CARDINAL_AUTHENTICATE_REQ', 'No', 'Only proceed with authorization when the Cardinal authentication result provides chargeback protection? ', '6', '25', 'zen_cfg_select_option(array(\'Yes\', \'No\'), ', now())");
    1064. 

  1064. 

  1065.     $this->notify('NOTIFY_PAYMENT_PAYPALDP_INSTALLED');
    1066. 

  1066.   }
    1067. 

  1067. 

  1068.   function keys() {
    1069. 

  1069.     $keys_list = array('MODULE_PAYMENT_PAYPALDP_STATUS', 'MODULE_PAYMENT_PAYPALDP_SORT_ORDER', 'MODULE_PAYMENT_PAYPALDP_ZONE', 'MODULE_PAYMENT_PAYPALDP_ORDER_STATUS_ID', 'MODULE_PAYMENT_PAYPALDP_ORDER_PENDING_STATUS_ID', 'MODULE_PAYMENT_PAYPALDP_REFUNDED_STATUS_ID', 'MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE', 'MODULE_PAYMENT_PAYPALDP_CURRENCY', 'MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY', 'MODULE_PAYMENT_PAYPALDP_EC_RETURN_FMF_DETAILS', 'MODULE_PAYMENT_PAYPALDP_SERVER', 'MODULE_PAYMENT_PAYPALDP_DEBUGGING');
    1070. 

  1070.     if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK') {
    1071. 

  1071.       $keys_list = array_merge($keys_list, array('MODULE_PAYMENT_PAYPALDP_CARDINAL_PROCESSOR','MODULE_PAYMENT_PAYPALDP_CARDINAL_MERCHANT','MODULE_PAYMENT_PAYPALDP_CARDINAL_PASSWORD','MODULE_PAYMENT_PAYPALDP_CARDINAL_AUTHENTICATE_REQ'));
    1072. 

  1072.     }
    1073. 

  1073.     return $keys_list;
    1074. 

  1074.   }
    1075. 

  1075.   /**
    1076. 

  1076.    * De-install this module
    1077. 

  1077.    */
    1078. 

  1078.   function remove() {
    1079. 

  1079.     global $db;
    1080. 

  1080.     $db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key LIKE 'MODULE\_PAYMENT\_PAYPALDP\_%'");
    1081. 

  1081.     $this->notify('NOTIFY_PAYMENT_PAYPALDP_UNINSTALLED');
    1082. 

  1082.   }
    1083. 

  1083.   /**
    1084. 

  1084.    * Check settings and conditions to determine whether we are in an Express Checkout phase or not
    1085. 

  1085.    */
    1086. 

  1086.   function in_special_checkout() {
    1087. 

  1087.     if ((defined('MODULE_PAYMENT_PAYPALDP_STATUS') && MODULE_PAYMENT_PAYPALDP_STATUS == 'True') &&
    1088. 

  1088.              !empty($_SESSION['paypal_ec_token']) &&
    1089. 

  1089.              !empty($_SESSION['paypal_ec_payer_id']) &&
    1090. 

  1090.              !empty($_SESSION['paypal_ec_payer_info'])) {
    1091. 

  1091.       return true;
    1092. 

  1092.     }
    1093. 

  1093.   }
    1094. 

  1094.   /**
    1095. 

  1095.    * Debug Logging support
    1096. 

  1096.    */
    1097. 

  1097.   function zcLog($stage, $message) {
    1098. 

  1098.     static $tokenHash;
    1099. 

  1099.     if ($tokenHash == '') $tokenHash = '_' . zen_create_random_value(4);
    1100. 

  1100.     if (MODULE_PAYMENT_PAYPALDP_DEBUGGING == 'Log and Email' || MODULE_PAYMENT_PAYPALDP_DEBUGGING == 'Log File') {
    1101. 

  1101.       $token = (isset($_SESSION['paypal_ec_token'])) ? $_SESSION['paypal_ec_token'] : preg_replace('/[^0-9.A-Z\-]/', '', $_GET['token']);
    1102. 

  1102.       $token = ($token == '') ? date('m-d-Y-H-i') : $token; // or time()
    1103. 

  1103.       $token .= $tokenHash;
    1104. 

  1104.       $file = $this->_logDir . '/' . $this->code . '_Paypal_Action_' . $token . '.log';
    1105. 

  1105.       if (defined('PAYPAL_DEV_MODE') && PAYPAL_DEV_MODE == 'true') $file = $this->_logDir . '/' . $this->code . '_Paypal_Debug_' . $token . '.log';
    1106. 

  1106.       $fp = @fopen($file, 'a');
    1107. 

  1107.       @fwrite($fp, date('M-d-Y H:i:s') . ' (' . time() . ')' . "\n" . $stage . "\n" . $message . "\n=================================\n\n");
    1108. 

  1108.       @fclose($fp);
    1109. 

  1109.     }
    1110. 

  1110.     $this->_doDebug($stage, $message, false);
    1111. 

  1111.   }
    1112. 

  1112.   /**
    1113. 

  1113.    * Debug Emailing support
    1114. 

  1114.    */
    1115. 

  1115.   function _doDebug($subject = 'PayPal debug data', $data, $useSession = true) {
    1116. 

  1116.     if (MODULE_PAYMENT_PAYPALDP_DEBUGGING == 'Log and Email') {
    1117. 

  1117.       $data =  urldecode($data) . "\n\n";
    1118. 

  1118.       if ($useSession) $data .= "\nSession data: " . print_r($_SESSION, true);
    1119. 

  1119.       zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, $subject, $this->code . "\n" . $data, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($this->code . "\n" . $data)), 'debug');
    1120. 

  1120.     }
    1121. 

  1121.   }
    1122. 

  1122.   /**
    1123. 

  1123.    * Initialize the PayPal/PayflowPro object for communication to the processing gateways
    1124. 

  1124.    */
    1125. 

  1125.   function paypal_init() {
    1126. 

  1126.     $nvp = (MODULE_PAYMENT_PAYPALWPP_APIPASSWORD != '' && MODULE_PAYMENT_PAYPALWPP_APISIGNATURE != '') ? true : false;
    1127. 

  1127.     $ec = ($nvp && $_GET['type'] == 'ec') ? true : false;
    1128. 

  1128.     if (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK' && !$ec) {
    1129. 

  1129.       $doPayPal = new paypal_curl(array('mode' => 'payflow',
    1130. 

  1130.                                         'user' =>   trim(MODULE_PAYMENT_PAYPALWPP_PFUSER),
    1131. 

  1131.                                         'vendor' => trim(MODULE_PAYMENT_PAYPALWPP_PFVENDOR),
    1132. 

  1132.                                         'partner'=> trim(MODULE_PAYMENT_PAYPALWPP_PFPARTNER),
    1133. 

  1133.                                         'pwd' =>    trim(MODULE_PAYMENT_PAYPALWPP_PFPASSWORD),
    1134. 

  1134.                                         'server' => MODULE_PAYMENT_PAYPALDP_SERVER));
    1135. 

  1135.       $doPayPal->_endpoints = array('live'    => 'https://payflowpro.paypal.com/transaction',
    1136. 

  1136.                                     'sandbox' => 'https://pilot-payflowpro.paypal.com/transaction');
    1137. 

  1137.     } else {
    1138. 

  1138.       $doPayPal = new paypal_curl(array('mode' => 'nvp',
    1139. 

  1139.                                         'user' => trim(MODULE_PAYMENT_PAYPALWPP_APIUSERNAME),
    1140. 

  1140.                                         'pwd' =>  trim(MODULE_PAYMENT_PAYPALWPP_APIPASSWORD),
    1141. 

  1141.                                         'signature' => trim(MODULE_PAYMENT_PAYPALWPP_APISIGNATURE),
    1142. 

  1142.                                         'version' => '61.0',
    1143. 

  1143.                                         'server' => MODULE_PAYMENT_PAYPALDP_SERVER));
    1144. 

  1144.       $doPayPal->_endpoints = array('live'    => 'https://api-3t.paypal.com/nvp',
    1145. 

  1145.                                     'sandbox' => 'https://api-3t.sandbox.paypal.com/nvp');
    1146. 

  1146.     }
    1147. 

  1147. 

  1148.     // set logging options
    1149. 

  1149.     $doPayPal->_logDir = $this->_logDir;
    1150. 

  1150.     $doPayPal->_logLevel = $this->_logLevel;
    1151. 

  1151. 

  1152.     // set proxy options if configured
    1153. 

  1153.     if (CURL_PROXY_REQUIRED == 'True' && CURL_PROXY_SERVER_DETAILS != '') {
    1154. 

  1154.       $proxy_tunnel_flag = (defined('CURL_PROXY_TUNNEL_FLAG') && strtoupper(CURL_PROXY_TUNNEL_FLAG) == 'FALSE') ? false : true;
    1155. 

  1155.       $doPayPal->setCurlOption(CURLOPT_HTTPPROXYTUNNEL, $proxy_tunnel_flag);
    1156. 

  1156.       $doPayPal->setCurlOption(CURLOPT_PROXYTYPE, CURLPROXY_HTTP);
    1157. 

  1157.       $doPayPal->setCurlOption(CURLOPT_PROXY, CURL_PROXY_SERVER_DETAILS);
    1158. 

  1158.     }
    1159. 

  1159. 

  1160.     // transaction processing mode
    1161. 

  1161.     $doPayPal->_trxtype = (MODULE_PAYMENT_PAYPALDP_TRANSACTION_MODE == 'Auth Only') ? 'A' : 'S';
    1162. 

  1162. 

  1163.     return $doPayPal;
    1164. 

  1164.   }
    1165. 

  1165.   /**
    1166. 

  1166.    * Determine which PayPal URL to direct the customer's browser to when needed
    1167. 

  1167.    */
    1168. 

  1168.   function getPayPalLoginServer() {
    1169. 

  1169.     if (MODULE_PAYMENT_PAYPALDP_SERVER == 'live') {
    1170. 

  1170.       // live url
    1171. 

  1171.       $paypal_url = 'https://www.paypal.com/cgi-bin/webscr';
    1172. 

  1172.     } else {
    1173. 

  1173.       // sandbox url
    1174. 

  1174.       $paypal_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr';
    1175. 

  1175.     }
    1176. 

  1176.     return $paypal_url;
    1177. 

  1177.   }
    1178. 

  1178.   /**
    1179. 

  1179.    * Used to submit a refund for a given transaction.  FOR FUTURE USE.
    1180. 

  1180.    */
    1181. 

  1181.   function _doRefund($oID, $amount = 'Full', $note = '') {
    1182. 

  1182.     global $db, $doPayPal, $messageStack;
    1183. 

  1183.     $new_order_status = (int)MODULE_PAYMENT_PAYPALDP_REFUNDED_STATUS_ID;
    1184. 

  1184.     $orig_order_amount = 0;
    1185. 

  1185.     $doPayPal = $this->paypal_init();
    1186. 

  1186.     $proceedToRefund = false;
    1187. 

  1187.     $refundNote = strip_tags(zen_db_input($_POST['refnote']));
    1188. 

  1188.     if (isset($_POST['fullrefund']) && $_POST['fullrefund'] == MODULE_PAYMENT_PAYPAL_ENTRY_REFUND_BUTTON_TEXT_FULL) {
    1189. 

  1189.       $refundAmt = 'Full';
    1190. 

  1190.       if (isset($_POST['reffullconfirm']) && $_POST['reffullconfirm'] == 'on') {
    1191. 

  1191.         $proceedToRefund = true;
    1192. 

  1192.       } else {
    1193. 

  1193.         $messageStack->add_session(MODULE_PAYMENT_PAYPALDP_TEXT_REFUND_FULL_CONFIRM_ERROR, 'error');
    1194. 

  1194.       }
    1195. 

  1195.     }
    1196. 

  1196.     if (isset($_POST['partialrefund']) && $_POST['partialrefund'] == MODULE_PAYMENT_PAYPAL_ENTRY_REFUND_BUTTON_TEXT_PARTIAL) {
    1197. 

  1197.       $refundAmt = (float)$_POST['refamt'];
    1198. 

  1198.       $proceedToRefund = true;
    1199. 

  1199.       if ($refundAmt == 0) {
    1200. 

  1200.         $messageStack->add_session(MODULE_PAYMENT_PAYPALDP_TEXT_INVALID_REFUND_AMOUNT, 'error');
    1201. 

  1201.         $proceedToRefund = false;
    1202. 

  1202.       }
    1203. 

  1203.     }
    1204. 

  1204. 

  1205.     // look up history on this order from PayPal table
    1206. 

  1206.     $sql = "select * from " . TABLE_PAYPAL . " where order_id = :orderID  AND parent_txn_id = '' ";
    1207. 

  1207.     $sql = $db->bindVars($sql, ':orderID', $oID, 'integer');
    1208. 

  1208.     $zc_ppHist = $db->Execute($sql);
    1209. 

  1209.     if ($zc_ppHist->RecordCount() == 0) return false;
    1210. 

  1210.     $txnID = $zc_ppHist->fields['txn_id'];
    1211. 

  1211.     $curCode = $zc_ppHist->fields['mc_currency'];
    1212. 

  1212.     $PFamt = $zc_ppHist->fields['mc_gross'];
    1213. 

  1213.     if ($doPayPal->_mode == 'payflow' && $refundAmt == 'Full') $refundAmt = $PFamt;
    1214. 

  1214. 

  1215.     /**
    1216. 

  1216.      * Submit refund request to PayPal
    1217. 

  1217.      */
    1218. 

  1218.     if ($proceedToRefund) {
    1219. 

  1219.        $response = $doPayPal->RefundTransaction($oID, $txnID, $refundAmt, $refundNote, $curCode);
    1220. 

  1220.       $error = $this->_errorHandler($response, 'DoRefund');
    1221. 

  1221.       $new_order_status = ($new_order_status > 0 ? $new_order_status : 1);
    1222. 

  1222.       if (!$error) {
    1223. 

  1223.         if (!isset($response['GROSSREFUNDAMT'])) $response['GROSSREFUNDAMT'] = $refundAmt;
    1224. 

  1224.         // Success, so save the results
    1225. 

  1225.         $sql_data_array = array('orders_id' => $oID,
    1226. 

  1226.                                 'orders_status_id' => (int)$new_order_status,
    1227. 

  1227.                                 'date_added' => 'now()',
    1228. 

  1228.                                 'comments' => 'REFUND INITIATED. Trans ID:' . $response['REFUNDTRANSACTIONID'] . $response['PNREF']. "\n" . /*' Net Refund Amt:' . urldecode($response['NETREFUNDAMT']) . "\n" . ' Fee Refund Amt: ' . urldecode($response['FEEREFUNDAMT']) . "\n" . */' Gross Refund Amt: ' . urldecode($response['GROSSREFUNDAMT']) . (isset($response['PPREF']) ? "\nPPRef: " . $response['PPREF'] : '') . "\n" . $refundNote,
    1229. 

  1229.                                 'customer_notified' => 0
    1230. 

  1230.                              );
    1231. 

  1231.         zen_db_perform(TABLE_ORDERS_STATUS_HISTORY, $sql_data_array);
    1232. 

  1232.         $db->Execute("update " . TABLE_ORDERS  . "
    1233. 

  1233.                       set orders_status = '" . (int)$new_order_status . "'
    1234. 

  1234.                       where orders_id = '" . (int)$oID . "'");
    1235. 

  1235.         $messageStack->add_session(sprintf(MODULE_PAYMENT_PAYPALDP_TEXT_REFUND_INITIATED, urldecode($response['GROSSREFUNDAMT']), urldecode($response['REFUNDTRANSACTIONID']). $response['PNREF']), 'success');
    1236. 

  1236.         return true;
    1237. 

  1237.       }
    1238. 

  1238.     }
    1239. 

  1239.   }
    1240. 

  1240.   /**
    1241. 

  1241.    * Used to capture part or all of a given previously-authorized transaction.  FOR FUTURE USE.
    1242. 

  1242.    * (alt value for $captureType = 'NotComplete')
    1243. 

  1243.    */
    1244. 

  1244.   function _doCapt($oID, $captureType = 'Complete', $amt = 0, $currency = 'USD', $note = '') {
    1245. 

  1245.     global $db, $doPayPal, $messageStack;
    1246. 

  1246.     $doPayPal = $this->paypal_init();
    1247. 

  1247. 

  1248.     //@TODO: Read current order status and determine best status to set this to
    1249. 

  1249.     $new_order_status = (int)MODULE_PAYMENT_PAYPALDP_ORDER_STATUS_ID;
    1250. 

  1250. 

  1251.     $orig_order_amount = 0;
    1252. 

  1252.     $doPayPal = $this->paypal_init();
    1253. 

  1253.     $proceedToCapture = false;
    1254. 

  1254.     $captureNote = strip_tags(zen_db_input($_POST['captnote']));
    1255. 

  1255.     if (isset($_POST['captfullconfirm']) && $_POST['captfullconfirm'] == 'on') {
    1256. 

  1256.       $proceedToCapture = true;
    1257. 

  1257.     } else {
    1258. 

  1258.       $messageStack->add_session(MODULE_PAYMENT_PAYPALDP_TEXT_CAPTURE_FULL_CONFIRM_ERROR, 'error');
    1259. 

  1259.     }
    1260. 

  1260.     if (isset($_POST['captfinal']) && $_POST['captfinal'] == 'on') {
    1261. 

  1261.       $captureType = 'Complete';
    1262. 

  1262.     } else {
    1263. 

  1263.       $captureType = 'NotComplete';
    1264. 

  1264.     }
    1265. 

  1265.     if (isset($_POST['btndocapture']) && $_POST['btndocapture'] == MODULE_PAYMENT_PAYPAL_ENTRY_CAPTURE_BUTTON_TEXT_FULL) {
    1266. 

  1266.       $captureAmt = (float)$_POST['captamt'];
    1267. 

  1267.       if ($captureAmt == 0) {
    1268. 

  1268.         $messageStack->add_session(MODULE_PAYMENT_PAYPALDP_TEXT_INVALID_CAPTURE_AMOUNT, 'error');
    1269. 

  1269.         $proceedToCapture = false;
    1270. 

  1270.       }
    1271. 

  1271.     }
    1272. 

  1272.     // look up history on this order from PayPal table
    1273. 

  1273.     $sql = "select * from " . TABLE_PAYPAL . " where order_id = :orderID  AND parent_txn_id = '' ";
    1274. 

  1274.     $sql = $db->bindVars($sql, ':orderID', $oID, 'integer');
    1275. 

  1275.     $zc_ppHist = $db->Execute($sql);
    1276. 

  1276.     if ($zc_ppHist->RecordCount() == 0) return false;
    1277. 

  1277.     $txnID = $zc_ppHist->fields['txn_id'];
    1278. 

  1278.     /**
    1279. 

  1279.      * Submit capture request to PayPal
    1280. 

  1280.      */
    1281. 

  1281.     if ($proceedToCapture) {
    1282. 

  1282.       $response = $doPayPal->DoCapture($txnID, $captureAmt, $currency, $captureType, '', $captureNote);
    1283. 

  1283.       $error = $this->_errorHandler($response, 'DoCapture');
    1284. 

  1284.       $new_order_status = ($new_order_status > 0 ? $new_order_status : 1);
    1285. 

  1285.       if (!$error) {
    1286. 

  1286.         if (isset($response['PNREF'])) {
    1287. 

  1287.           if (!isset($response['AMT'])) $response['AMT'] = $captureAmt;
    1288. 

  1288.           if (!isset($response['ORDERTIME'])) $response['ORDERTIME'] = date("M-d-Y h:i:s");
    1289. 

  1289.         }
    1290. 

  1290.         // Success, so save the results
    1291. 

  1291.         $sql_data_array = array('orders_id' => (int)$oID,
    1292. 

  1292.                                 'orders_status_id' => (int)$new_order_status,
    1293. 

  1293.                                 'date_added' => 'now()',
    1294. 

  1294.                                 'comments' => 'FUNDS COLLECTED. Trans ID: ' . urldecode($response['TRANSACTIONID']) . $response['PNREF']. "\n" . ' Amount: ' . urldecode($response['AMT']) . ' ' . $currency . "\n" . 'Time: ' . urldecode($response['ORDERTIME']) . "\n" . (isset($response['RECEIPTID']) ? 'Receipt ID: ' . urldecode($response['RECEIPTID']) : 'Auth Code: ' . $response['AUTHCODE']) . (isset($response['PPREF']) ? "\nPPRef: " . $response['PPREF'] : '') . "\n" . $captureNote,
    1295. 

  1295.                                 'customer_notified' => 0
    1296. 

  1296.                              );
    1297. 

  1297.         zen_db_perform(TABLE_ORDERS_STATUS_HISTORY, $sql_data_array);
    1298. 

  1298.         $db->Execute("update " . TABLE_ORDERS  . "
    1299. 

  1299.                       set orders_status = '" . (int)$new_order_status . "'
    1300. 

  1300.                       where orders_id = '" . (int)$oID . "'");
    1301. 

  1301.         $messageStack->add_session(sprintf(MODULE_PAYMENT_PAYPALDP_TEXT_CAPT_INITIATED, urldecode($response['AMT']), urldecode($response['RECEIPTID'] . $response['AUTHCODE']). $response['PNREF']), 'success');
    1302. 

  1302.         return true;
    1303. 

  1303.       }
    1304. 

  1304.     }
    1305. 

  1305.   }
    1306. 

  1306.   /**
    1307. 

  1307.    * Used to void a given previously-authorized transaction.  FOR FUTURE USE.
    1308. 

  1308.    */
    1309. 

  1309.   function _doVoid($oID, $note = '') {
    1310. 

  1310.     global $db, $doPayPal, $messageStack;
    1311. 

  1311.     $new_order_status = (int)MODULE_PAYMENT_PAYPALDP_REFUNDED_STATUS_ID;
    1312. 

  1312.     $doPayPal = $this->paypal_init();
    1313. 

  1313.     $voidNote = strip_tags(zen_db_input($_POST['voidnote']));
    1314. 

  1314.     $voidAuthID = trim(strip_tags(zen_db_input($_POST['voidauthid'])));
    1315. 

  1315.     if (isset($_POST['ordervoid']) && $_POST['ordervoid'] == MODULE_PAYMENT_PAYPAL_ENTRY_VOID_BUTTON_TEXT_FULL) {
    1316. 

  1316.       if (isset($_POST['voidconfirm']) && $_POST['voidconfirm'] == 'on') {
    1317. 

  1317.         $proceedToVoid = true;
    1318. 

  1318.       } else {
    1319. 

  1319.         $messageStack->add_session(MODULE_PAYMENT_PAYPALDP_TEXT_VOID_CONFIRM_ERROR, 'error');
    1320. 

  1320.       }
    1321. 

  1321.     }
    1322. 

  1322.     // look up history on this order from PayPal table
    1323. 

  1323.     $sql = "select * from " . TABLE_PAYPAL . " where order_id = :orderID  AND parent_txn_id = '' ";
    1324. 

  1324.     $sql = $db->bindVars($sql, ':orderID', $oID, 'integer');
    1325. 

  1325.     $sql = $db->bindVars($sql, ':transID', $voidAuthID, 'string');
    1326. 

  1326.     $zc_ppHist = $db->Execute($sql);
    1327. 

  1327.     if ($zc_ppHist->RecordCount() == 0) return false;
    1328. 

  1328.     $txnID = $zc_ppHist->fields['txn_id'];
    1329. 

  1329.     /**
    1330. 

  1330.      * Submit void request to PayPal
    1331. 

  1331.      */
    1332. 

  1332.     if ($proceedToVoid) {
    1333. 

  1333.       $response = $doPayPal->DoVoid($voidAuthID, $voidNote);
    1334. 

  1334.       $error = $this->_errorHandler($response, 'DoVoid');
    1335. 

  1335.       $new_order_status = ($new_order_status > 0 ? $new_order_status : 1);
    1336. 

  1336.       if (!$error) {
    1337. 

  1337.         // Success, so save the results
    1338. 

  1338.         $sql_data_array = array('orders_id' => (int)$oID,
    1339. 

  1339.                                 'orders_status_id' => (int)$new_order_status,
    1340. 

  1340.                                 'date_added' => 'now()',
    1341. 

  1341.                                 'comments' => 'VOIDED. Trans ID: ' . urldecode($response['AUTHORIZATIONID']). $response['PNREF'] . (isset($response['PPREF']) ? "\nPPRef: " . $response['PPREF'] : '') . "\n" . $voidNote,
    1342. 

  1342.                                 'customer_notified' => 0
    1343. 

  1343.                              );
    1344. 

  1344.         zen_db_perform(TABLE_ORDERS_STATUS_HISTORY, $sql_data_array);
    1345. 

  1345.         $db->Execute("update " . TABLE_ORDERS  . "
    1346. 

  1346.                       set orders_status = '" . (int)$new_order_status . "'
    1347. 

  1347.                       where orders_id = '" . (int)$oID . "'");
    1348. 

  1348.         $messageStack->add_session(sprintf(MODULE_PAYMENT_PAYPALDP_TEXT_VOID_INITIATED, urldecode($response['AUTHORIZATIONID']) . $response['PNREF']), 'success');
    1349. 

  1349.         return true;
    1350. 

  1350.       }
    1351. 

  1351.     }
    1352. 

  1352.   }
    1353. 

  1353. 

  1354.   /**
    1355. 

  1355.    * Set the currency code -- use defaults if active currency is not a currency accepted by PayPal
    1356. 

  1356.    */
    1357. 

  1357.   function selectCurrency($val = '') {
    1358. 

  1358.     $ec_currencies = array('CAD', 'EUR', 'GBP', 'JPY', 'USD', 'AUD', 'CHF', 'CZK', 'DKK', 'HKD', 'HUF', 'NOK', 'NZD', 'PLN', 'SEK', 'SGD', 'THB', 'MXN', 'ILS', 'PHP', 'TWD', 'BRL', 'MYR', 'TKD');
    1359. 

  1359.     $dp_currencies = array('CAD', 'EUR', 'GBP', 'JPY', 'USD', 'AUD', 'CHF', 'CZK', 'DKK', 'HKD', 'HUF', 'NOK', 'NZD', 'PLN', 'SEK', 'SGD');
    1360. 

  1360.     $dpus_currencies = array('CAD', 'EUR', 'GBP', 'JPY', 'USD', 'AUD');
    1361. 

  1361. 

  1362.     // in USA, only 6 currencies are supported. But UK and Canada support 16 currencies (as of Jan 2011):
    1363. 

  1363.     $paypalSupportedCurrencies = (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK' || MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'Canada') ? $dp_currencies : $dpus_currencies;
    1364. 

  1364. 

  1365.     $my_currency = substr(MODULE_PAYMENT_PAYPALDP_CURRENCY, 5);
    1366. 

  1366.     if (MODULE_PAYMENT_PAYPALDP_CURRENCY == 'Selected Currency') {
    1367. 

  1367.       $my_currency = ($val == '') ? $_SESSION['currency'] : $val;
    1368. 

  1368.     }
    1369. 

  1369. 

  1370.     if (!in_array($my_currency, $paypalSupportedCurrencies)) {
    1371. 

  1371.       $my_currency = (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'UK') ? 'GBP' : (MODULE_PAYMENT_PAYPALDP_MERCHANT_COUNTRY == 'Canada' ? 'CAD' : 'USD');
    1372. 

  1372.     }
    1373. 

  1373.     return $my_currency;
    1374. 

  1374.   }
    1375. 

  1375.   /**
    1376. 

  1376.    * Calculate the amount based on acceptable currencies
    1377. 

  1377.    */
    1378. 

  1378.   function calc_order_amount($amount, $paypalCurrency, $applyFormatting = false) {
    1379. 

  1379.     global $currencies;
    1380. 

  1380.     $amount = ($amount * $currencies->get_value($paypalCurrency));
    1381. 

  1381.     if ($paypalCurrency == 'JPY' || (int)$currencies->get_decimal_places($paypalCurrency) == 0) {
    1382. 

  1382.       $amount = (int)$amount;
    1383. 

  1383.       $applyFormatting = FALSE;
    1384. 

  1384.     }
    1385. 

  1385.     return ($applyFormatting ? number_format($amount, $currencies->get_decimal_places($paypalCurrency)) : $amount);
    1386. 

  1386.   }
    1387. 

  1387.   /**
    1388. 

  1388.    * Set the state field depending on what PayPal requires for that country.
    1389. 

  1389.    */
    1390. 

  1390.   function setStateAndCountry(&$info) {
    1391. 

  1391.     global $db, $messageStack;
    1392. 

  1392.     switch ($info['country']['iso_code_2']) {
    1393. 

  1393.       case 'AU':
    1394. 

  1394.       case 'US':
    1395. 

  1395.       case 'CA':
    1396. 

  1396.       // Paypal only accepts two character state/province codes for some countries.
    1397. 

  1397.       if (strlen($info['state']) > 2) {
    1398. 

  1398.         $sql = "SELECT zone_code FROM " . TABLE_ZONES . " WHERE zone_name = :zoneName";
    1399. 

  1399.         $sql = $db->bindVars($sql, ':zoneName', $info['state'], 'string');
    1400. 

  1400.         $state = $db->Execute($sql);
    1401. 

  1401.         if (!$state->EOF) {
    1402. 

  1402.           $info['state'] = $state->fields['zone_code'];
    1403. 

  1403.         } else {
    1404. 

  1404.           $messageStack->add_session('header', MODULE_PAYMENT_PAYPALDP_TEXT_STATE_ERROR, 'error');
    1405. 

  1405.         }
    1406. 

  1406.       }
    1407. 

  1407.       break;
    1408. 

  1408.       case 'AT':
    1409. 

  1409.       case 'BE':
    1410. 

  1410.       case 'FR':
    1411. 

  1411.       case 'DE':
    1412. 

  1412.       case 'CH':
    1413. 

  1413.       $info['state'] = '';
    1414. 

  1414.       break;
    1415. 

  1415.       case 'GB':
    1416. 

  1416.       break;
    1417. 

  1417.       default:
    1418. 

  1418.       $info['state'] = '';
    1419. 

  1419.     }
    1420. 

  1420.   }
    1421. 

  1421.   /**
    1422. 

  1422.    * Prepare subtotal and line-item detail content to send to PayPal
    1423. 

  1423.    */
    1424. 

  1424.   function getLineItemDetails($restrictedCurrency) {
    1425. 

  1425.     global $order, $currencies, $order_totals, $order_total_modules;
    1426. 

  1426. 

  1427.     // if not default currency, do not send subtotals or line-item details
    1428. 

  1428.     if (DEFAULT_CURRENCY != $order->info['currency'] || $restrictedCurrency != DEFAULT_CURRENCY) {
    1429. 

  1429.       $this->zcLog('getLineItemDetails 1', 'Not using default currency. Thus, no line-item details can be submitted.');
    1430. 

  1430.       return array();
    1431. 

  1431.     }
    1432. 

  1432.     if ($currencies->currencies[$_SESSION['currency']]['value'] != 1 || $currencies->currencies[$order->info['currency']]['value'] != 1) {
    1433. 

  1433.       $this->zcLog('getLineItemDetails 2', 'currency val not equal to 1.0000 - cannot proceed without coping with currency conversions. Aborting line-item details.');
    1434. 

  1434.       return array();
    1435. 

  1435.     }
    1436. 

  1436. 

  1437.     $optionsST = array();
    1438. 

  1438.     $optionsLI = array();
    1439. 

  1439.     $optionsNB = array();
    1440. 

  1440.     $numberOfLineItemsProcessed = 0;
    1441. 

  1441.     $creditsApplied = 0;
    1442. 

  1442.     $surcharges = 0;
    1443. 

  1443.     $sumOfLineItems = 0;
    1444. 

  1444.     $sumOfLineTax = 0;
    1445. 

  1445.     $optionsST['AMT'] = 0;
    1446. 

  1446.     $optionsST['ITEMAMT'] = 0;
    1447. 

  1447.     $optionsST['TAXAMT'] = 0;
    1448. 

  1448.     $optionsST['SHIPPINGAMT'] = 0;
    1449. 

  1449.     $optionsST['SHIPDISCAMT'] = 0;
    1450. 

  1450.     $optionsST['HANDLINGAMT'] = 0;
    1451. 

  1451.     $optionsST['INSURANCEAMT'] = 0;
    1452. 

  1452.     $flagSubtotalsUnknownYet = true;
    1453. 

  1453.     $subTotalLI = 0;
    1454. 

  1454.     $subTotalTax = 0;
    1455. 

  1455.     $subTotalShipping = 0;
    1456. 

  1456.     $subtotalPRE = array('no data');
    1457. 

  1457.     $discountProblemsFlag = FALSE;
    1458. 

  1458.     $flag_treat_as_partial = FALSE;
    1459. 

  1459. 

  1460.     if (sizeof($order_totals)) {
    1461. 

  1461.       // prepare subtotals
    1462. 

  1462.       for ($i=0, $n=sizeof($order_totals); $i<$n; $i++) {
    1463. 

  1463.         if ($order_totals[$i]['code'] == '') continue;
    1464. 

  1464.         if (in_array($order_totals[$i]['code'], array('ot_total','ot_subtotal','ot_tax','ot_shipping')) || strstr($order_totals[$i]['code'], 'insurance')) {
    1465. 

  1465.           if ($order_totals[$i]['code'] == 'ot_shipping') $optionsST['SHIPPINGAMT'] = round($order_totals[$i]['value'],2);
    1466. 

  1466.           if ($order_totals[$i]['code'] == 'ot_total')    $optionsST['AMT']         = round($order_totals[$i]['value'],2);
    1467. 

  1467.           if ($order_totals[$i]['code'] == 'ot_tax')      $optionsST['TAXAMT']     += strval(round($order_totals[$i]['value'],2));
    1468. 

  1468.           if ($order_totals[$i]['code'] == 'ot_subtotal') $optionsST['ITEMAMT']     = round($order_totals[$i]['value'],2);
    1469. 

  1469.           if (strstr($order_totals[$i]['code'], 'insurance')) $optionsST['INSURANCEAMT'] += round($order_totals[$i]['value'],2);
    1470. 

  1470.           //$optionsST['SHIPDISCAMT'] = '';  // Not applicable
    1471. 

  1471.         } else {
    1472. 

  1472.           // handle other order totals:
    1473. 

  1473.           global $$order_totals[$i]['code'];
    1474. 

  1474.           if ((substr($order_totals[$i]['text'], 0, 1) == '-') || (isset($$order_totals[$i]['code']->credit_class) && $$order_totals[$i]['code']->credit_class == true)) {
    1475. 

  1475.             // handle credits
    1476. 

  1476.             $creditsApplied += round($order_totals[$i]['value'], 2);
    1477. 

  1477.           } else {
    1478. 

  1478.             // treat all other OT's as if they're related to handling fees or other extra charges to be added/included
    1479. 

  1479.             $surcharges += $order_totals[$i]['value'];
    1480. 

  1480.           }
    1481. 

  1481.         }
    1482. 

  1482.       }
    1483. 

  1483. 

  1484.       if ($creditsApplied > 0) $optionsST['ITEMAMT'] -= $creditsApplied;
    1485. 

  1485.       if ($surcharges > 0) $optionsST['ITEMAMT'] += $surcharges;
    1486. 

  1486. 

  1487.       // Handle tax-included scenario
    1488. 

  1488.       if (DISPLAY_PRICE_WITH_TAX == 'true') $optionsST['TAXAMT'] = 0;
    1489. 

  1489. 

  1490.       $subtotalPRE = $optionsST;
    1491. 

  1491.       // Move shipping tax amount from Tax subtotal into Shipping subtotal for submission to PayPal, since PayPal applies tax to each line-item individually
    1492. 

  1492.       $module = substr($_SESSION['shipping']['id'], 0, strpos($_SESSION['shipping']['id'], '_'));
    1493. 

  1493.       if (zen_not_null($order->info['shipping_method']) && DISPLAY_PRICE_WITH_TAX != 'true') {
    1494. 

  1494.         if ($GLOBALS[$module]->tax_class > 0) {
    1495. 

  1495.           $shipping_tax_basis = (!isset($GLOBALS[$module]->tax_basis)) ? STORE_SHIPPING_TAX_BASIS : $GLOBALS[$module]->tax_basis;
    1496. 

  1496.           $shippingOnBilling = zen_get_tax_rate($GLOBALS[$module]->tax_class, $order->billing['country']['id'], $order->billing['zone_id']);
    1497. 

  1497.           $shippingOnDelivery = zen_get_tax_rate($GLOBALS[$module]->tax_class, $order->delivery['country']['id'], $order->delivery['zone_id']);
    1498. 

  1498.           if ($shipping_tax_basis == 'Billing') {
    1499. 

  1499.             $shipping_tax = $shippingOnBilling;
    1500. 

  1500.           } elseif ($shipping_tax_basis == 'Shipping') {
    1501. 

  1501.             $shipping_tax = $shippingOnDelivery;
    1502. 

  1502.           } else {
    1503. 

  1503.             if (STORE_ZONE == $order->billing['zone_id']) {
    1504. 

  1504.               $shipping_tax = $shippingOnBilling;
    1505. 

  1505.             } elseif (STORE_ZONE == $order->delivery['zone_id']) {
    1506. 

  1506.               $shipping_tax = $shippingOnDelivery;
    1507. 

  1507.             } else {
    1508. 

  1508.               $shipping_tax = 0;
    1509. 

  1509.             }
    1510. 

  1510.           }
    1511. 

  1511.           $taxAdjustmentForShipping = zen_round(zen_calculate_tax($order->info['shipping_cost'], $shipping_tax), $currencies->currencies[$_SESSION['currency']]['decimal_places']);
    1512. 

  1512.           $optionsST['SHIPPINGAMT'] += $taxAdjustmentForShipping;
    1513. 

  1513.           $optionsST['TAXAMT'] -= $taxAdjustmentForShipping;
    1514. 

  1514.         }
    1515. 

  1515.       }
    1516. 

  1516.       $flagSubtotalsUnknownYet = (($optionsST['SHIPPINGAMT'] + $optionsST['SHIPDISCAMT'] + $optionsST['AMT'] + $optionsST['TAXAMT'] + $optionsST['ITEMAMT'] + $optionsST['INSURANCEAMT']) == 0);
    1517. 

  1517.     } else {
    1518. 

  1518.       // if we get here, we don't have any order-total information yet because the customer has clicked Express before starting normal checkout flow
    1519. 

  1519.       // thus, we must make a note to manually calculate subtotals, rather than relying on the more robust order-total infrastructure
    1520. 

  1520.       $flagSubtotalsUnknownYet = TRUE;
    1521. 

  1521.     }
    1522. 

  1522. 

  1523.     $decimals = $currencies->get_decimal_places($_SESSION['currency']);
    1524. 

  1524. 

  1525.     // loop thru all products to prepare details of quantity and price.
    1526. 

  1526.     for ($i=0, $n=sizeof($order->products), $k=-1; $i<$n; $i++) {
    1527. 

  1527.       // PayPal is inconsistent in how it handles zero-value line-items, so skip this entry if price is zero
    1528. 

  1528.       if ($order->products[$i]['final_price'] == 0) {
    1529. 

  1529.         continue;
    1530. 

  1530.       } else {
    1531. 

  1531.         $k++;
    1532. 

  1532.       }
    1533. 

  1533. 

  1534.       $optionsLI["L_NUMBER$k"] = $order->products[$i]['model'];
    1535. 

  1535.       $optionsLI["L_NAME$k"]   = $order->products[$i]['name'] . ' [' . (int)$order->products[$i]['id'] . ']';
    1536. 

  1536.       // Append *** if out-of-stock.
    1537. 

  1537.       $optionsLI["L_NAME$k"]  .= ((zen_get_products_stock($order->products[$i]['id']) - $order->products[$i]['qty']) < 0 ? STOCK_MARK_PRODUCT_OUT_OF_STOCK : '');
    1538. 

  1538.       // if there are attributes, loop thru them and add to description
    1539. 

  1539.       if (isset($order->products[$i]['attributes']) && sizeof($order->products[$i]['attributes']) > 0 ) {
    1540. 

  1540.         for ($j=0, $n2=sizeof($order->products[$i]['attributes']); $j<$n2; $j++) {
    1541. 

  1541.           $optionsLI["L_NAME$k"] .= "\n " . $order->products[$i]['attributes'][$j]['option'] .
    1542. 

  1542.                                         ': ' . $order->products[$i]['attributes'][$j]['value'];
    1543. 

  1543.         } // end loop
    1544. 

  1544.       } // endif attribute-info
    1545. 

  1545. 

  1546.       // PayPal can't handle fractional-quantity values, so convert it to qty 1 here
    1547. 

  1547.       if ($order->products[$i]['qty'] > 1 && ($order->products[$i]['qty'] != (int)$order->products[$i]['qty'] || $flag_treat_as_partial)) {
    1548. 

  1548.         $optionsLI["L_NAME$k"] = '('.$order->products[$i]['qty'].' x ) ' . $optionsLI["L_NAME$k"];
    1549. 

  1549.         // zen_add_tax already handles whether DISPLAY_PRICES_WITH_TAX is set
    1550. 

  1550.         $optionsLI["L_AMT$k"] = zen_round(zen_round(zen_add_tax($order->products[$i]['final_price'], $order->products[$i]['tax']), $decimals) * $order->products[$i]['qty'], $decimals);
    1551. 

  1551.         $optionsLI["L_QTY$k"] = 1;
    1552. 

  1552.         // no line-item tax component
    1553. 

  1553.       } else {
    1554. 

  1554.         $optionsLI["L_QTY$k"] = $order->products[$i]['qty'];
    1555. 

  1555.         $optionsLI["L_AMT$k"] = zen_round(zen_add_tax($order->products[$i]['final_price'], $order->products[$i]['tax']), $decimals);
    1556. 

  1556.       }
    1557. 

  1557. 

  1558.       $subTotalLI += ($optionsLI["L_QTY$k"] * $optionsLI["L_AMT$k"]);
    1559. 

  1559. //      $subTotalTax += ($optionsLI["L_QTY$k"] * $optionsLI["L_TAXAMT$k"]);
    1560. 

  1560. 

  1561.       // add line-item for one-time charges on this product
    1562. 

  1562.       if ($order->products[$i]['onetime_charges'] != 0 ) {
    1563. 

  1563.         $k++;
    1564. 

  1564.         $optionsLI["L_NAME$k"]   = MODULES_PAYMENT_PAYPALWPP_LINEITEM_TEXT_ONETIME_CHARGES_PREFIX . substr(htmlentities($order->products[$i]['name'], ENT_QUOTES, 'UTF-8'), 0, 120);
    1565. 

  1565.         $optionsLI["L_AMT$k"]    = zen_round(zen_add_tax($order->products[$i]['onetime_charges'], $order->products[$i]['tax']), $decimals);
    1566. 

  1566.         $optionsLI["L_QTY$k"]    = 1;
    1567. 

  1567. //        $optionsLI["L_TAXAMT$k"] = zen_round(zen_calculate_tax($order->products[$i]['onetime_charges'], $order->products[$i]['tax']), $decimals);
    1568. 

  1568.         $subTotalLI += $optionsLI["L_AMT$k"];
    1569. 

  1569. //        $subTotalTax += $optionsLI["L_TAXAMT$k"];
    1570. 

  1570.       }
    1571. 

  1571.       $numberOfLineItemsProcessed = $k;
    1572. 

  1572.     }  // end for loopthru all products
    1573. 

  1573. 

  1574.     // add line items for any surcharges added by order-total modules
    1575. 

  1575.     if ($surcharges > 0) {
    1576. 

  1576.       $numberOfLineItemsProcessed++;
    1577. 

  1577.       $k = $numberOfLineItemsProcessed;
    1578. 

  1578.       $optionsLI["L_NAME$k"] = MODULES_PAYMENT_PAYPALWPP_LINEITEM_TEXT_SURCHARGES_LONG;
    1579. 

  1579.       $optionsLI["L_AMT$k"]  = $surcharges;
    1580. 

  1580.       $optionsLI["L_QTY$k"]  = 1;
    1581. 

  1581.       $subTotalLI += $surcharges;
    1582. 

  1582.     }
    1583. 

  1583. 

  1584.     // add line items for discounts such as gift certificates and coupons
    1585. 

  1585.     if ($creditsApplied > 0) {
    1586. 

  1586.       $numberOfLineItemsProcessed++;
    1587. 

  1587.       $k = $numberOfLineItemsProcessed;
    1588. 

  1588.       $optionsLI["L_NAME$k"]   = MODULES_PAYMENT_PAYPALWPP_LINEITEM_TEXT_DISCOUNTS_LONG;
    1589. 

  1589.       $optionsLI["L_AMT$k"]    = (-1 * $creditsApplied);
    1590. 

  1590.       $optionsLI["L_QTY$k"]    = 1;
    1591. 

  1591.       $subTotalLI -= $creditsApplied;
    1592. 

  1592.     }
    1593. 

  1593. 

  1594.     // Reformat properly
    1595. 

  1595.     // Replace & and = and % with * if found.
    1596. 

  1596.     // reformat properly according to API specs
    1597. 

  1597.     // Remove HTML markup from name if found
    1598. 

  1598.     for ($k=0, $n=$numberOfLineItemsProcessed+1; $k<$n; $k++) {
    1599. 

  1599.       $optionsLI["L_NAME$k"] = str_replace(array('&','=','%'), '*', $optionsLI["L_NAME$k"]);
    1600. 

  1600.       $optionsLI["L_NAME$k"] = zen_clean_html($optionsLI["L_NAME$k"], 'strong');
    1601. 

  1601.       $optionsLI["L_NAME$k"]   = substr($optionsLI["L_NAME$k"], 0, 127);
    1602. 

  1602.       $optionsLI["L_AMT$k"] = round($optionsLI["L_AMT$k"], 2);
    1603. 

  1603. 

  1604.       if (isset($optionsLI["L_NUMBER$k"])) {
    1605. 

  1605.         if ($optionsLI["L_NUMBER$k"] == '') {
    1606. 

  1606.           unset($optionsLI["L_NUMBER$k"]);
    1607. 

  1607.         } else {
    1608. 

  1608.           $optionsLI["L_NUMBER$k"] = str_replace(array('&','=','%'), '*', $optionsLI["L_NUMBER$k"]);
    1609. 

  1609.           $optionsLI["L_NUMBER$k"] = substr($optionsLI["L_NUMBER$k"], 0, 127);
    1610. 

  1610.         }
    1611. 

  1611.       }
    1612. 

  1612. 

  1613. //      if (isset($optionsLI["L_TAXAMT$k"]) && ($optionsLI["L_TAXAMT$k"] != '' || $optionsLI["L_TAXAMT$k"] > 0)) {
    1614. 

  1614. //        $optionsLI["L_TAXAMT$k"] = round($optionsLI["L_TAXAMT$k"], 2);
    1615. 

  1615. //      }
    1616. 

  1616.     }
    1617. 

  1617. 

  1618.     // Sanity Check of line-item subtotals
    1619. 

  1619.     for ($j=0; $j<$k; $j++) {
    1620. 

  1620.       $itemAMT = $optionsLI["L_AMT$j"];
    1621. 

  1621.       $itemQTY = $optionsLI["L_QTY$j"];
    1622. 

  1622.       $itemTAX = (isset($optionsLI["L_TAXAMT$j"]) ? $optionsLI["L_TAXAMT$j"] : 0);
    1623. 

  1623.       $sumOfLineItems += ($itemQTY * $itemAMT);
    1624. 

  1624.       $sumOfLineTax += ($itemQTY * $itemTAX);
    1625. 

  1625.     }
    1626. 

  1626.     $sumOfLineItems = round($sumOfLineItems, 2);
    1627. 

  1627.     $sumOfLineTax = round($sumOfLineTax, 2);
    1628. 

  1628. 

  1629.     if ($sumOfLineItems == 0) {
    1630. 

  1630.       $sumOfLineTax = 0;
    1631. 

  1631.       $optionsLI = array();
    1632. 

  1632.       $discountProblemsFlag = TRUE;
    1633. 

  1633.       if ($optionsST['SHIPPINGAMT'] == $optionsST['AMT']) {
    1634. 

  1634.         $optionsST['SHIPPINGAMT'] = 0;
    1635. 

  1635.       }
    1636. 

  1636.     }
    1637. 

  1637. 

  1638. //    // Sanity check -- if tax-included pricing is causing problems, remove the numbers and put them in a comment instead:
    1639. 

  1639. //    $stDiffTaxOnly = (strval($sumOfLineItems - $sumOfLineTax - round($optionsST['AMT'], 2)) + 0);
    1640. 

  1640. //    $this->zcLog('tax sanity check', 'stDiffTaxOnly: ' . $stDiffTaxOnly . "\nsumOfLineItems: " . $sumOfLineItems . "\nsumOfLineTax: " . $sumOfLineTax . ' ' . $subTotalTax . ' ' . print_r(array_merge($optionsST, $optionsLI), true));
    1641. 

  1641. //    if (DISPLAY_PRICE_WITH_TAX == 'true' && $stDiffTaxOnly == 0 && ($optionsST['TAXAMT'] != 0 && $sumOfLineTax != 0)) {
    1642. 

  1642. //      $optionsNB['DESC'] = 'Tax included in prices: ' . $sumOfLineTax . ' (' . $optionsST['TAXAMT'] . ') ';
    1643. 

  1643. //      $optionsST['TAXAMT'] = 0;
    1644. 

  1644. //      for ($k=0, $n=$numberOfLineItemsProcessed+1; $k<$n; $k++) {
    1645. 

  1645. //        if (isset($optionsLI["L_TAXAMT$k"])) unset($optionsLI["L_TAXAMT$k"]);
    1646. 

  1646. //      }
    1647. 

  1647. //    }
    1648. 

  1648. 

  1649. //    // Do sanity check -- if any of the line-item subtotal math doesn't add up properly, skip line-item details,
    1650. 

  1650. //    // so that the order can go through even though PayPal isn't being flexible to handle Zen Cart's diversity
    1651. 

  1651. //    if ((strval($subTotalTax) - strval($sumOfLineTax)) > 0.02) {
    1652. 

  1652. //      $this->zcLog('getLineItemDetails 3', 'Tax Subtotal does not match sum of taxes for line-items. Tax details are being removed from line-item submission data.' . "\n" . $sumOfLineTax . ' ' . $subTotalTax . print_r(array_merge($optionsST, $optionsLI), true));
    1653. 

  1653. //      for ($k=0, $n=$numberOfLineItemsProcessed+1; $k<$n; $k++) {
    1654. 

  1654. //        if (isset($optionsLI["L_TAXAMT$k"])) unset($optionsLI["L_TAXAMT$k"]);
    1655. 

  1655. //      }
    1656. 

  1656. //      $subTotalTax = 0;
    1657. 

  1657. //      $sumOfLineTax = 0;
    1658. 

  1658. //    }
    1659. 

  1659. 

  1660. //    // If coupons exist and there's a calculation problem, then it's likely that taxes are incorrect, so reset L_TAXAMTn values
    1661. 

  1661. //    if ($creditsApplied > 0 && (strval($optionsST['TAXAMT']) != strval($sumOfLineTax))) {
    1662. 

  1662. //      $pre = $optionsLI;
    1663. 

  1663. //      for ($k=0, $n=$numberOfLineItemsProcessed+1; $k<$n; $k++) {
    1664. 

  1664. //        if (isset($optionsLI["L_TAXAMT$k"])) unset($optionsLI["L_TAXAMT$k"]);
    1665. 

  1665. //      }
    1666. 

  1666. //      $this->zcLog('getLineItemDetails 4', 'Coupons/Discounts have affected tax calculations, so tax details are being removed from line-item submission data.' . "\n" . $sumOfLineTax . ' ' . $optionsST['TAXAMT'] . "\n" . print_r(array_merge($optionsST, $pre, $optionsNB), true) . "\nAFTER:" . print_r(array_merge($optionsST, $optionsLI, $optionsNB), TRUE));
    1667. 

  1667. //      $subTotalTax = 0;
    1668. 

  1668. //      $sumOfLineTax = 0;
    1669. 

  1669. //    }
    1670. 

  1670. 

  1671.     // disable line-item tax details, leaving only TAXAMT subtotal as tax indicator
    1672. 

  1672.     for ($k=0, $n=$numberOfLineItemsProcessed+1; $k<$n; $k++) {
    1673. 

  1673.       if (isset($optionsLI["L_TAXAMT$k"])) unset($optionsLI["L_TAXAMT$k"]);
    1674. 

  1674.     }
    1675. 

  1675.     // if ITEMAMT >0 and subTotalLI > 0 and they're not equal ... OR subTotalLI minus sumOfLineItems isn't 0
    1676. 

  1676.     // check subtotals
    1677. 

  1677.     if ((strval($optionsST['ITEMAMT']) > 0 && strval($subTotalLI) > 0 && strval($subTotalLI) != strval($optionsST['ITEMAMT'])) || strval($subTotalLI) - strval($sumOfLineItems) != 0) {
    1678. 

  1678.       $this->zcLog('getLineItemDetails 5', 'Line-item subtotals do not add up properly. Line-item-details skipped.' . "\n" . strval($sumOfLineItems) . ' ' . strval($subTotalLI) . ' ' . print_r(array_merge($optionsST, $optionsLI), true));
    1679. 

  1679.       $optionsLI = array();
    1680. 

  1680.       $optionsLI["L_NAME0"] = MODULES_PAYMENT_PAYPALWPP_AGGREGATE_CART_CONTENTS;
    1681. 

  1681.       $optionsLI["L_AMT0"]  = $sumOfLineItems = $subTotalLI = $optionsST['ITEMAMT'];
    1682. 

  1682.     }
    1683. 

  1683. 

  1684.     // check whether discounts are causing a problem
    1685. 

  1685.     if (strval($optionsST['ITEMAMT']) < 0) {
    1686. 

  1686.       $pre = (array_merge($optionsST, $optionsLI));
    1687. 

  1687.       $optionsST['ITEMAMT'] = $optionsST['AMT'];
    1688. 

  1688.       $optionsLI = array();
    1689. 

  1689.       $optionsLI["L_NAME0"] = MODULES_PAYMENT_PAYPALWPP_AGGREGATE_CART_CONTENTS;
    1690. 

  1690.       $optionsLI["L_AMT0"]  = $sumOfLineItems = $subTotalLI = $optionsST['ITEMAMT'];
    1691. 

  1691.       if ($optionsST['AMT'] < $optionsST['TAXAMT']) $optionsST['TAXAMT'] = 0;
    1692. 

  1692.       if ($optionsST['AMT'] < $optionsST['SHIPPINGAMT']) $optionsST['SHIPPINGAMT'] = 0;
    1693. 

  1693.       $discountProblemsFlag = TRUE;
    1694. 

  1694.       $this->zcLog('getLineItemDetails 6', 'Discounts have caused the subtotal to calculate incorrectly. Line-item-details cannot be submitted.' . "\nBefore:" . print_r($pre, TRUE) . "\nAfter:" . print_r(array_merge($optionsST, $optionsLI), true));
    1695. 

  1695.     }
    1696. 

  1696. 

  1697.     // if AMT or ITEMAMT values are 0 (ie: certain OT modules disabled) or we've started express checkout without going through normal checkout flow, we have to get subtotals manually
    1698. 

  1698.     if ((!isset($optionsST['AMT']) || $optionsST['AMT'] == 0 || $flagSubtotalsUnknownYet == TRUE || $optionsST['ITEMAMT'] == 0) && $discountProblemsFlag != TRUE) {
    1699. 

  1699.       $optionsST['ITEMAMT'] = $sumOfLineItems;
    1700. 

  1700.       $optionsST['TAXAMT'] = $sumOfLineTax;
    1701. 

  1701.       if ($subTotalShipping > 0) $optionsST['SHIPPINGAMT'] = $subTotalShipping;
    1702. 

  1702.       $optionsST['AMT'] = $sumOfLineItems + $optionsST['TAXAMT'] + $optionsST['SHIPPINGAMT'];
    1703. 

  1703.     }
    1704. 

  1704.     $this->zcLog('getLineItemDetails 7 - subtotal comparisons', 'BEFORE line-item calcs: ' . print_r($subtotalPRE, true) . ($flagSubtotalsUnknownYet == TRUE ? 'Subtotals Unknown Yet - ' : '') . 'AFTER doing line-item calcs: ' . print_r(array_merge($optionsST, $optionsLI, $optionsNB), true));
    1705. 

  1705. 

  1706.     // if subtotals are not adding up correctly, then skip sending any line-item or subtotal details to PayPal
    1707. 

  1707.     $stAll = round(strval($optionsST['ITEMAMT']) + strval($optionsST['TAXAMT']) + strval($optionsST['SHIPPINGAMT']) + strval($optionsST['SHIPDISCAMT']) + strval($optionsST['HANDLINGAMT']) + strval($optionsST['INSURANCEAMT']), 2);
    1708. 

  1708.     $stDiff = strval($optionsST['AMT'] - $stAll);
    1709. 

  1709.     $stDiffRounded = (strval($stAll - round($optionsST['AMT'], 2)) + 0);
    1710. 

  1710. 

  1711.     // unset any subtotal values that are zero
    1712. 

  1712.     if (isset($optionsST['ITEMAMT']) && $optionsST['ITEMAMT'] == 0) unset($optionsST['ITEMAMT']);
    1713. 

  1713.     if (isset($optionsST['TAXAMT']) && $optionsST['TAXAMT'] == 0) unset($optionsST['TAXAMT']);
    1714. 

  1714.     if (isset($optionsST['SHIPPINGAMT']) && $optionsST['SHIPPINGAMT'] == 0) unset($optionsST['SHIPPINGAMT']);
    1715. 

  1715.     if (isset($optionsST['SHIPDISCAMT']) && $optionsST['SHIPDISCAMT'] == 0) unset($optionsST['SHIPDISCAMT']);
    1716. 

  1716.     if (isset($optionsST['HANDLINGAMT']) && $optionsST['HANDLINGAMT'] == 0) unset($optionsST['HANDLINGAMT']);
    1717. 

  1717.     if (isset($optionsST['INSURANCEAMT']) && $optionsST['INSURANCEAMT'] == 0) unset($optionsST['INSURANCEAMT']);
    1718. 

  1718. 

  1719.     // tidy up all values so that they comply with proper format (number_format(xxxx,2) for PayPal US use )
    1720. 

  1720.     if (!defined('PAYPALWPP_SKIP_LINE_ITEM_DETAIL_FORMATTING') || PAYPALWPP_SKIP_LINE_ITEM_DETAIL_FORMATTING != 'true' || in_array($order->info['currency'], array('JPY', 'NOK', 'HUF'))) {
    1721. 

  1721.       if (is_array($optionsST)) foreach ($optionsST as $key=>$value) {
    1722. 

  1722.         $optionsST[$key] = number_format($value, ((int)$currencies->get_decimal_places($restrictedCurrency) == 0 ? 0 : 2));
    1723. 

  1723.       }
    1724. 

  1724.       if (is_array($optionsLI)) foreach ($optionsLI as $key=>$value) {
    1725. 

  1725.         if (substr($key, 0, 8) == 'L_TAXAMT' && ($optionsLI[$key] == '' || $optionsLI[$key] == 0)) {
    1726. 

  1726.           unset($optionsLI[$key]);
    1727. 

  1727.         } else {
    1728. 

  1728.           if (strstr($key, 'AMT')) $optionsLI[$key] = number_format($value, ((int)$currencies->get_decimal_places($restrictedCurrency) == 0 ? 0 : 2));
    1729. 

  1729.         }
    1730. 

  1730.       }
    1731. 

  1731.     }
    1732. 

  1732. 

  1733.     $this->zcLog('getLineItemDetails 8', 'checking subtotals... ' . "\n" . print_r(array_merge(array('calculated total'=>number_format($stAll, ((int)$currencies->get_decimal_places($restrictedCurrency) == 0 ? 0 : 2))), $optionsST), true) . "\n-------------------\ndifference: " . ($stDiff + 0) . '  (abs+rounded: ' . ($stDiffRounded + 0) . ')');
    1734. 

  1734. 

  1735.     if ( $stDiffRounded != 0) {
    1736. 

  1736.       $this->zcLog('getLineItemDetails 9', 'Subtotals Bad. Skipping line-item/subtotal details');
    1737. 

  1737.       return array();
    1738. 

  1738.     }
    1739. 

  1739. 

  1740.     $this->zcLog('getLineItemDetails 10', 'subtotals balance - okay');
    1741. 

  1741. 

  1742.     // Send Subtotal and LineItem results back to be submitted to PayPal
    1743. 

  1743.     return array_merge($optionsST, $optionsLI, $optionsNB);
    1744. 

  1744.   }
    1745. 

  1745.   /**
    1746. 

  1746.    * If the account was created only for temporary purposes to place the PayPal order, delete it.
    1747. 

  1747.    */
    1748. 

  1748.   function ec_delete_user($cid) {
    1749. 

  1749.     global $db;
    1750. 

  1750.     unset($_SESSION['customer_id']);
    1751. 

  1751.     unset($_SESSION['customer_default_address_id']);
    1752. 

  1752.     unset($_SESSION['customer_first_name']);
    1753. 

  1753.     unset($_SESSION['customer_country_id']);
    1754. 

  1754.     unset($_SESSION['customer_zone_id']);
    1755. 

  1755.     unset($_SESSION['comments']);
    1756. 

  1756.     unset($_SESSION['customer_guest_id']);
    1757. 

  1757.   }
    1758. 

  1758.   /**
    1759. 

  1759.    * If the EC flow has to be interrupted for any reason, this does the appropriate cleanup and displays status/error messages.
    1760. 

  1760.    */
    1761. 

  1761.   function terminateEC($error_msg = '', $kill_sess_vars = false, $goto_page = '') {
    1762. 

  1762.     global $messageStack, $order, $order_total_modules;
    1763. 

  1763.     $error_msg = trim($error_msg);
    1764. 

  1764.     if (substr($error_msg, -1) == '-') $error_msg = trim(substr($error_msg, 0, strlen($error_msg) - 1));
    1765. 

  1765.     $stackAlert = 'checkout_payment';
    1766. 

  1766. 

  1767.     // debug
    1768. 

  1768.     $this->_doDebug('PayPal test Log - terminateEC-A', "goto page: " . $goto_page . "\nerror_msg: " . $error_msg . "\n\nSession data: " . print_r($_SESSION, true));
    1769. 

  1769. 

  1770.     if ($kill_sess_vars) {
    1771. 

  1771.       if (!empty($_SESSION['paypal_ec_temp'])) {
    1772. 

  1772.         $this->ec_delete_user($_SESSION['customer_id']);
    1773. 

  1773.       }
    1774. 

  1774.       // Unregister the paypal session variables, making the user start over.
    1775. 

  1775.       unset($_SESSION['paypal_ec_temp']);
    1776. 

  1776.       unset($_SESSION['paypal_ec_token']);
    1777. 

  1777.       unset($_SESSION['paypal_ec_payer_id']);
    1778. 

  1778.       unset($_SESSION['paypal_ec_payer_info']);
    1779. 

  1779.       unset($_SESSION['paypal_ec_final']);
    1780. 

  1780.       unset($_SESSION['paypal_ec_markflow']);
    1781. 

  1781.       // debug
    1782. 

  1782.       $this->zcLog('termEC-1', 'Killed the session vars as requested');
    1783. 

  1783.     }
    1784. 

  1784. 

  1785.     $this->zcLog('termEC-2', 'BEFORE: Token Data:' . $_SESSION['paypal_ec_token']);
    1786. 

  1786. 

  1787.     if ($error_msg) {
    1788. 

  1788.       $messageStack->add_session($stackAlert, $error_msg, 'error');
    1789. 

  1789.     }
    1790. 

  1790.     // debug
    1791. 

  1791.     $this->zcLog('termEC-10', 'Redirecting to ' . $goto_page . ' - Stack: ' . $stackAlert . "\n" . 'Message: ' . $error_msg . "\nSession Data: " . print_r($_SESSION, true));
    1792. 

  1792.     zen_redirect(zen_href_link($goto_page, '', 'SSL', true, false));
    1793. 

  1793.   }
    1794. 

  1794.   /**
    1795. 

  1795.    * Error / exception handling
    1796. 

  1796.    */
    1797. 

  1797.   function _errorHandler($response, $operation = '', $ignore_codes = '') {
    1798. 

  1798.     global $messageStack, $doPayPal;
    1799. 

  1799.     $gateway_mode = (isset($response['PNREF']) && $response['PNREF'] != '');
    1800. 

  1800.     $basicError = (!$response || (isset($response['RESULT']) && $response['RESULT'] != 0) || (isset($response['ACK']) && !strstr($response['ACK'], 'Success')) || (!isset($response['RESULT']) && !isset($response['ACK'])));
    1801. 

  1801.     $ignoreList = explode(',', str_replace(' ', '', $ignore_codes));
    1802. 

  1802.     foreach($ignoreList as $key=>$value) {
    1803. 

  1803.       if ($value != '' && $response['L_ERRORCODE0'] == $value) $basicError = false;
    1804. 

  1804.     }
    1805. 

  1805.     /** Handle FMF Scenarios **/
    1806. 

  1806.     if (in_array($operation, array('DoExpressCheckoutPayment', 'DoDirectPayment')) && $response['PAYMENTSTATUS'] == 'Pending' && $response['L_ERRORCODE0'] == 11610) {
    1807. 

  1807.       $this->fmfResponse = urldecode($response['L_SHORTMESSAGE0']);
    1808. 

  1808.       $this->fmfErrors = array();
    1809. 

  1809.       if ($response['ACK'] == 'SuccessWithWarning' && isset($response['L_FMFPENDINGID0'])) {
    1810. 

  1810.         for ($i=0; $i<20; $i++) {
    1811. 

  1811.           $this->fmfErrors[] = array('key' => $response['L_FMFPENDINGID' . $i], 'status' => $response['L_FMFPENDINGID' . $i], 'desc' => $response['L_FMFPENDINGDESCRIPTION' . $i]);
    1812. 

  1812.         }
    1813. 

  1813.       }
    1814. 

  1814.       return (sizeof($this->fmfErrors)>0) ? $this->fmfErrors : FALSE;
    1815. 

  1815.     }
    1816. 

  1816.     //echo '<br />basicError='.$basicError.'<br />' . urldecode(print_r($response,true)); die('halted');
    1817. 

  1817.     if (!isset($response['L_SHORTMESSAGE0']) && isset($response['RESPMSG']) && $response['RESPMSG'] != '') $response['L_SHORTMESSAGE0'] = $response['RESPMSG'];
    1818. 

  1818.     $errorInfo = "\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with PayPal Website Payments Pro.';
    1819. 

  1819. 

  1820.     switch($operation) {
    1821. 

  1821.       case 'DoDirectPayment':
    1822. 

  1822.         if ($basicError ||
    1823. 

  1823.            ((isset($_SESSION['paypal_ec_token']) && isset($response['TOKEN'])) && $_SESSION['paypal_ec_token'] != urldecode($response['TOKEN'])) ) {
    1824. 

  1824.             // Error, so send the store owner a complete dump of the transaction.
    1825. 

  1825.           if ($this->enableDebugging) {
    1826. 

  1826.             $this->_doDebug('PayPal Error Log - before_process() - DP', "In function: before_process() - Direct Payment \r\nDid first contact attempt return error? " . ($error_occurred ? "Yes" : "No") . " \r\n\r\nValue List:\r\n" . str_replace('&',"\r\n", urldecode($doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList)))) . "\r\n\r\nResponse:\r\n" . urldecode(print_r($response, true)));
    1827. 

  1827.           }
    1828. 

  1828.           $errorText = MODULE_PAYMENT_PAYPALDP_INVALID_RESPONSE;
    1829. 

  1829.           $errorNum = urldecode($response['L_ERRORCODE0'] . ' ' . $response['RESULT'] . ' <!-- ' . $response['RESPMSG'] . ' -->');
    1830. 

  1830.           if ($response['RESULT'] == 25) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_NOT_WPP_ACCOUNT_ERROR;
    1831. 

  1831.           if ($response['L_ERRORCODE0'] == 10500 || $response['L_ERRORCODE0'] == 10501) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_NOT_US_WPP_ACCOUNT_ERROR;
    1832. 

  1832.           if ($response['HOSTCODE'] == 10500 || $response['HOSTCODE'] == 10501) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_NOT_UKWPP_ACCOUNT_ERROR;
    1833. 

  1833.           if ($response['HOSTCODE'] == 10558) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_CANNOT_USE_THIS_CURRENCY_ERROR;
    1834. 

  1834.           if ($response['L_ERRORCODE0'] == 10002) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_SANDBOX_VS_LIVE_ERROR;
    1835. 

  1835.           if ($response['L_ERRORCODE0'] == 10565) {
    1836. 

  1836.             $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_WPP_BAD_COUNTRY_ERROR;
    1837. 

  1837.             $_SESSION['payment'] = '';
    1838. 

  1838.           }
    1839. 

  1839.           if ($response['L_ERRORCODE0'] == 10566) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_CARD_TYPE_NOT_SUPPORTED;
    1840. 

  1840.           if ($response['L_ERRORCODE0'] == 10736) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_ADDR_ERROR;
    1841. 

  1841.           if ($response['L_ERRORCODE0'] == 10752) {
    1842. 

  1842.             $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_DECLINED;
    1843. 

  1843.             $errorNum = '10752';
    1844. 

  1844.           }
    1845. 

  1845.           if ($response['L_ERRORCODE0'] == 15012) { // Mastercard CE agreement not signed between merchant and PayPal. Thus cannot accept mastercard.
    1846. 

  1846.             $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_CARD_TYPE_NOT_SUPPORTED;
    1847. 

  1847.             $errorNum = '15012';
    1848. 

  1848.           }
    1849. 

  1849.           if ($response['L_ERRORCODE0'] == 15005) {
    1850. 

  1850.             $errorText = 'Card rejected by the bank. Your IP address has been recorded.';
    1851. 

  1851.             $errorNum = '15005';
    1852. 

  1852.           }
    1853. 

  1853.           if ($response['RESPMSG'] != '') $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_DECLINED . ' ' . $errorText;
    1854. 

  1854. 

  1855.           $detailedMessage = ($errorText == MODULE_PAYMENT_PAYPALDP_INVALID_RESPONSE || $errorText == MODULE_PAYMENT_PAYPALDP_TEXT_DECLINED || (int)trim($errorNum) > 0 || $this->enableDebugging || $response['CURL_ERRORS'] != '' || $this->emailAlerts) ? (isset($response['RESULT']) && $response['RESULT'] != 0 ? MODULE_PAYMENT_PAYPALDP_CANNOT_BE_COMPLETED . ' (' . $errorNum . ')' : $errorNum) . ' ' . urldecode(' ' . $response['L_SHORTMESSAGE0'] . ' - ' . $response['L_LONGMESSAGE0'] . ' ' . $response['CURL_ERRORS']) : '';
    1856. 

  1856.           $explain = "\n\nProblem occurred while customer #" . $_SESSION['customer_id'] . ' -- ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' -- was attempting checkout.' . "\n";
    1857. 

  1857.           $detailedEmailMessage = MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_MESSAGE . urldecode($response['L_ERRORCODE0']  . ' ' . $response['RESPMSG']. "\n" . $response['L_SHORTMESSAGE0'] . "\n" . $response['L_LONGMESSAGE0'] . $response['L_ERRORCODE1'] . "\n" . $response['L_SHORTMESSAGE1'] . "\n" . $response['L_LONGMESSAGE1'] . $response['L_ERRORCODE2'] . "\n" . $response['L_SHORTMESSAGE2'] . "\n" . $response['L_LONGMESSAGE2'] . ($response['CURL_ERRORS'] != '' ? "\n" . $response['CURL_ERRORS'] : '') . "\n\n" . 'Zen Cart message: ' . $detailedMessage . "\n\n" . $errorInfo . "\n\n" . 'Transaction Response Details: ' . print_r($response, true) . "\n\n" . 'Transaction Submission: ' . urldecode($doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList), true)));
    1858. 

  1858.           $detailedEmailMessage .= $explain;
    1859. 

  1859.           if (!isset($response['L_ERRORCODE0']) && isset($response['RESULT'])) $detailedEmailMessage .= "\n\n" . print_r($response, TRUE);
    1860. 

  1860.           zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_SUBJECT . ' (' . zen_uncomment($errorNum) . ')', zen_uncomment($detailedEmailMessage), STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br(zen_uncomment($detailedEmailMessage))), 'paymentalert');
    1861. 

  1861.           if ($response['L_ERRORCODE0'] == 15012) $detailedEmailMessage = '';
    1862. 

  1862.           $this->terminateEC(($detailedEmailMessage == '' ? $errorText . ' (' . $errorNum . ') ' : $detailedMessage), ($gateway_mode ? true : false), FILENAME_CHECKOUT_PAYMENT);
    1863. 

  1863.           return true;
    1864. 

  1864.         }
    1865. 

  1865.         break;
    1866. 

  1866.       case 'DoRefund':
    1867. 

  1867.         if ($basicError || (!isset($response['RESPMSG']) && !isset($response['REFUNDTRANSACTIONID']))) {
    1868. 

  1868.           // if error, display error message. If debug options enabled, email dump to store owner
    1869. 

  1869.           if ($this->enableDebugging) {
    1870. 

  1870.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1871. 

  1871.           }
    1872. 

  1872.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_REFUND_ERROR;
    1873. 

  1873.           if ($response['L_ERRORCODE0'] == 10009) $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_REFUNDFULL_ERROR;
    1874. 

  1874.           if ($response['RESULT'] == 105 || isset($response['RESPMSG'])) $response['L_SHORTMESSAGE0'] = $response['RESULT'] . ' ' . $response['RESPMSG'];
    1875. 

  1875.           if (urldecode($response['L_LONGMESSAGE0']) == 'This transaction has already been fully refunded') $response['L_SHORTMESSAGE0'] = urldecode($response['L_LONGMESSAGE0']);
    1876. 

  1876.           if (urldecode($response['L_LONGMESSAGE0']) == 'Can not do a full refund after a partial refund') $response['L_SHORTMESSAGE0'] = urldecode($response['L_LONGMESSAGE0']);
    1877. 

  1877.           if (urldecode($response['L_LONGMESSAGE0']) == 'The partial refund amount must be less than or equal to the remaining amount') $response['L_SHORTMESSAGE0'] = urldecode($response['L_LONGMESSAGE0']);
    1878. 

  1878.           if (urldecode($response['L_LONGMESSAGE0']) == 'You can not refund this type of transaction') $response['L_SHORTMESSAGE0'] = urldecode($response['L_LONGMESSAGE0']);
    1879. 

  1879.           $errorText .= ' (' . urldecode($response['L_SHORTMESSAGE0']) . ') ' . $response['L_ERRORCODE0'];
    1880. 

  1880.           $messageStack->add_session($errorText, 'error');
    1881. 

  1881.           return true;
    1882. 

  1882.         }
    1883. 

  1883.         break;
    1884. 

  1884.       case 'DoAuthorization':
    1885. 

  1885.       case 'DoReauthorization':
    1886. 

  1886.         if ($basicError) {
    1887. 

  1887.           // if error, display error message. If debug options enabled, email dump to store owner
    1888. 

  1888.           if ($this->enableDebugging) {
    1889. 

  1889.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1890. 

  1890.           }
    1891. 

  1891.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_AUTH_ERROR;
    1892. 

  1892.           $errorText .= ' (' . urldecode($response['L_SHORTMESSAGE0']) . ') ' . $response['L_ERRORCODE0'];
    1893. 

  1893.           $messageStack->add_session($errorText, 'error');
    1894. 

  1894.           return true;
    1895. 

  1895.         }
    1896. 

  1896.         break;
    1897. 

  1897.       case 'DoCapture':
    1898. 

  1898.         if ($basicError) {
    1899. 

  1899.           // if error, display error message. If debug options enabled, email dump to store owner
    1900. 

  1900.           if ($this->enableDebugging) {
    1901. 

  1901.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1902. 

  1902.           }
    1903. 

  1903.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_CAPT_ERROR;
    1904. 

  1904.           if ($response['RESULT'] == 111) $response['L_SHORTMESSAGE0'] = $response['RESULT'] . ' ' . $response['RESPMSG'];
    1905. 

  1905.           $errorText .= ' (' . urldecode($response['L_SHORTMESSAGE0']) . ') ' . $response['L_ERRORCODE0'];
    1906. 

  1906.           $messageStack->add_session($errorText, 'error');
    1907. 

  1907.           return true;
    1908. 

  1908.         }
    1909. 

  1909.         break;
    1910. 

  1910.       case 'DoVoid':
    1911. 

  1911.         if ($basicError) {
    1912. 

  1912.           // if error, display error message. If debug options enabled, email dump to store owner
    1913. 

  1913.           if ($this->enableDebugging) {
    1914. 

  1914.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1915. 

  1915.           }
    1916. 

  1916.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_VOID_ERROR;
    1917. 

  1917.           if ($response['RESULT'] == 12) $response['L_SHORTMESSAGE0'] = $response['RESULT'] . ' ' . $response['RESPMSG'];
    1918. 

  1918.           if ($response['RESULT'] == 108) $response['L_SHORTMESSAGE0'] = $response['RESULT'] . ' ' . $response['RESPMSG'];
    1919. 

  1919.           $errorText .= ' (' . urldecode($response['L_SHORTMESSAGE0']) . ') ' . $response['L_ERRORCODE0'];
    1920. 

  1920.           $messageStack->add_session($errorText, 'error');
    1921. 

  1921.           return true;
    1922. 

  1922.         }
    1923. 

  1923.         break;
    1924. 

  1924.       case 'GetTransactionDetails':
    1925. 

  1925.         if ($basicError) {
    1926. 

  1926.           if (isset($response['RESPMSG']) && $response['RESPMSG'] == 'Field format error: ORIGID missing') {
    1927. 

  1927.             return FALSE;
    1928. 

  1928.           }
    1929. 

  1929.           // if error, display error message. If debug options enabled, email dump to store owner
    1930. 

  1930.           if ($this->enableDebugging) {
    1931. 

  1931.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1932. 

  1932.           }
    1933. 

  1933.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_GETDETAILS_ERROR;
    1934. 

  1934.           $errorText .= ' (' . urldecode($response['L_SHORTMESSAGE0']) . ') ' . $response['L_ERRORCODE0'];
    1935. 

  1935.           $messageStack->add_session($errorText, 'error');
    1936. 

  1936.           return true;
    1937. 

  1937.         }
    1938. 

  1938.         break;
    1939. 

  1939.       case 'TransactionSearch':
    1940. 

  1940.         if ($basicError) {
    1941. 

  1941.           // if error, display error message. If debug options enabled, email dump to store owner
    1942. 

  1942.           if ($this->enableDebugging) {
    1943. 

  1943.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1944. 

  1944.           }
    1945. 

  1945.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_TRANSSEARCH_ERROR;
    1946. 

  1946.           $errorText .= ' (' . urldecode($response['L_SHORTMESSAGE0']) . ') ' . $response['L_ERRORCODE0'];
    1947. 

  1947.           $messageStack->add_session($errorText, 'error');
    1948. 

  1948.           return true;
    1949. 

  1949.         }
    1950. 

  1950.         break;
    1951. 

  1951. 

  1952.       default:
    1953. 

  1953.         if ($basicError) {
    1954. 

  1954.           // if error, display error message. If debug options enabled, email dump to store owner
    1955. 

  1955.           if ($this->enableDebugging) {
    1956. 

  1956.             $this->_doDebug('PayPal Error Log - ' . $operation, "Value List:\r\n" . str_replace('&',"\r\n", $doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList))) . "\r\n\r\nResponse:\r\n" . print_r($response, true));
    1957. 

  1957.           }
    1958. 

  1958.           $errorText = MODULE_PAYMENT_PAYPALDP_TEXT_GEN_API_ERROR;
    1959. 

  1959.           $errorNum .= ' (' . urldecode($response['L_SHORTMESSAGE0'] . ' <!-- ' . $response['RESPMSG']) . ' -->) ' . $response['L_ERRORCODE0'];
    1960. 

  1960.           $detailedMessage = ($errorText == MODULE_PAYMENT_PAYPALDP_TEXT_GEN_API_ERROR || $errorText == MODULE_PAYMENT_PAYPALDP_TEXT_DECLINED || $this->enableDebugging || $response['CURL_ERRORS'] != '' || $this->emailAlerts) ? urldecode(' ' . $response['L_SHORTMESSAGE0'] . ' - ' . $response['L_LONGMESSAGE0'] . ' ' . $response['CURL_ERRORS']) : '';
    1961. 

  1961.           $explain = "\n\nProblem occurred while customer #" . $_SESSION['customer_id'] . ' -- ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' -- was attempting checkout.' . "\n";
    1962. 

  1962.           $detailedEmailMessage = ($detailedMessage == '') ? '' : MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_MESSAGE . ' ' . $response['RESPMSG'] . urldecode($response['L_ERRORCODE0'] . "\n" . $response['L_SHORTMESSAGE0'] . "\n" . $response['L_LONGMESSAGE0'] . $response['L_ERRORCODE1'] . "\n" . $response['L_SHORTMESSAGE1'] . "\n" . $response['L_LONGMESSAGE1'] . $response['L_ERRORCODE2'] . "\n" . $response['L_SHORTMESSAGE2'] . "\n" . $response['L_LONGMESSAGE2'] . ($response['CURL_ERRORS'] != '' ? "\n" . $response['CURL_ERRORS'] : '') . "\n\n" . 'Zen Cart message: ' . $detailedMessage . "\n\n" . $errorInfo . "\n\n" . 'Transaction Response Details: ' . print_r($response, true) . "\n\n" . 'Transaction Submission: ' . urldecode($doPayPal->_sanitizeLog($doPayPal->_parseNameValueList($doPayPal->lastParamList), true)));
    1963. 

  1963.           if ($detailedEmailMessage != '') $detailedEmailMessage .= $explain;
    1964. 

  1964.           if ($detailedEmailMessage != '') zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, MODULE_PAYMENT_PAYPALDP_TEXT_EMAIL_ERROR_SUBJECT . ' (' . zen_uncomment($errorNum) . ')', zen_uncomment($detailedMessage . $explain), STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br(zen_uncomment($detailedEmailMessage))), 'paymentalert');
    1965. 

  1965.           $messageStack->add_session($errorText . $errorNum . $detailedMessage, 'error');
    1966. 

  1966.           return true;
    1967. 

  1967.         }
    1968. 

  1968.         break;
    1969. 

  1969.     }
    1970. 

  1970.   }
    1971. 

  1971. 

  1972.   function tableCheckup() {
    1973. 

  1973.     global $db, $sniffer;
    1974. 

  1974.     $fieldOkay1 = (method_exists($sniffer, 'field_type')) ? $sniffer->field_type(TABLE_PAYPAL, 'txn_id', 'varchar(20)', true) : -1;
    1975. 

  1975.     $fieldOkay2 = ($sniffer->field_exists(TABLE_PAYPAL, 'module_name')) ? true : -1;
    1976. 

  1976.     $fieldOkay3 = ($sniffer->field_exists(TABLE_PAYPAL, 'order_id')) ? true : -1;
    1977. 

  1977. 

  1978.     if ($fieldOkay1 == -1) {
    1979. 

  1979.       $sql = "show fields from " . TABLE_PAYPAL;
    1980. 

  1980.       $result = $db->Execute($sql);
    1981. 

  1981.       while (!$result->EOF) {
    1982. 

  1982.         if  ($result->fields['Field'] == 'txn_id') {
    1983. 

  1983.           if  ($result->fields['Type'] == 'varchar(20)') {
    1984. 

  1984.             $fieldOkay1 = true; // exists and matches required type, so skip to other checkup
    1985. 

  1985.           } else {
    1986. 

  1986.             $fieldOkay1 = $result->fields['Type']; // doesn't match, so return what it "is"
    1987. 

  1987.             break;
    1988. 

  1988.           }
    1989. 

  1989.         }
    1990. 

  1990.         $result->MoveNext();
    1991. 

  1991.       }
    1992. 

  1992.     }
    1993. 

  1993. 

  1994.     if ($fieldOkay1 !== true) {
    1995. 

  1995.       // temporary fix to table structure for v1.3.7.x -- may remove in later release
    1996. 

  1996.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE payment_type payment_type varchar(40) NOT NULL default ''");
    1997. 

  1997.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE txn_type txn_type varchar(40) NOT NULL default ''");
    1998. 

  1998.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE payment_status payment_status varchar(32) NOT NULL default ''");
    1999. 

  1999.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE reason_code reason_code varchar(40) default NULL");
    2000. 

  2000.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE pending_reason pending_reason varchar(32) default NULL");
    2001. 

  2001.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE invoice invoice varchar(128) default NULL");
    2002. 

  2002.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE payer_business_name payer_business_name varchar(128) default NULL");
    2003. 

  2003.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE address_name address_name varchar(64) default NULL");
    2004. 

  2004.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE address_street address_street varchar(254) default NULL");
    2005. 

  2005.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE address_city address_city varchar(120) default NULL");
    2006. 

  2006.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE address_state address_state varchar(120) default NULL");
    2007. 

  2007.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE payer_email payer_email varchar(128) NOT NULL default ''");
    2008. 

  2008.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE business business varchar(128) NOT NULL default ''");
    2009. 

  2009.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE receiver_email receiver_email varchar(128) NOT NULL default ''");
    2010. 

  2010.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE txn_id txn_id varchar(20) NOT NULL default ''");
    2011. 

  2011.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE parent_txn_id parent_txn_id varchar(20) default NULL");
    2012. 

  2012.     }
    2013. 

  2013.     if ($fieldOkay2 !== true) {
    2014. 

  2014.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " ADD COLUMN module_name varchar(40) NOT NULL default '' after txn_type");
    2015. 

  2015.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " ADD COLUMN module_mode varchar(40) NOT NULL default '' after module_name");
    2016. 

  2016.     }
    2017. 

  2017.     if ($fieldOkay3 !== true) {
    2018. 

  2018.       $db->Execute("ALTER TABLE " . TABLE_PAYPAL . " CHANGE zen_order_id order_id int(11) NOT NULL default '0'");
    2019. 

  2019.     }
    2020. 

  2020. 

  2021.   }
    2022. 

  2022. 

  2023.   /****************************************************************************************************************************
    2024. 

  2024.    * ADDED CODE FOR 3D-SECURE SUPPORT PROVIDED BY CARDINALCOMMERCE FOR PAYPAL-UK
    2025. 

  2025.    */
    2026. 

  2026. 

  2027.   /**
    2028. 

  2028.    * reset session vars related to 3D-Secure processing
    2029. 

  2029.    */
    2030. 

  2030.   function clear_3DSecure_session_vars($thorough = FALSE) {
    2031. 

  2031.     if ($thorough) {
    2032. 

  2032.       if (isset($_SESSION['3Dsecure_requires_lookup'])) unset($_SESSION['3Dsecure_requires_lookup']);
    2033. 

  2033.       if (isset($_SESSION['3Dsecure_card_type'])) unset($_SESSION['3Dsecure_card_type']);
    2034. 

  2034.     }
    2035. 

  2035.     if (isset($_SESSION['3Dsecure_merchantData'])) unset($_SESSION['3Dsecure_merchantData']);
    2036. 

  2036.     if (isset($_SESSION['3Dsecure_enroll_lookup_attempted'])) unset($_SESSION['3Dsecure_enroll_lookup_attempted']);
    2037. 

  2037.     if (isset($_SESSION['3Dsecure_authentication_attempted'])) unset($_SESSION['3Dsecure_authentication_attempted']);
    2038. 

  2038.     if (isset($_SESSION['3Dsecure_transactionId'])) unset($_SESSION['3Dsecure_transactionId']);
    2039. 

  2039.     if (isset($_SESSION['3Dsecure_enrolled'])) unset($_SESSION['3Dsecure_enrolled']);
    2040. 

  2040.     if (isset($_SESSION['3Dsecure_acsURL'])) unset($_SESSION['3Dsecure_acsURL']);
    2041. 

  2041.     if (isset($_SESSION['3Dsecure_payload'])) unset($_SESSION['3Dsecure_payload']);
    2042. 

  2042.     if (isset($_SESSION['3Dsecure_auth_status'])) unset($_SESSION['3Dsecure_auth_status']);
    2043. 

  2043.     if (isset($_SESSION['3Dsecure_sig_status'])) unset($_SESSION['3Dsecure_sig_status']);
    2044. 

  2044.     if (isset($_SESSION['3Dsecure_auth_xid'])) unset($_SESSION['3Dsecure_auth_xid']);
    2045. 

  2045.     if (isset($_SESSION['3Dsecure_auth_cavv'])) unset($_SESSION['3Dsecure_auth_cavv']);
    2046. 

  2046.     if (isset($_SESSION['3Dsecure_auth_eci'])) unset($_SESSION['3Dsecure_auth_eci']);
    2047. 

  2047.     if (isset($_SESSION['3Dsecure_term_url'])) unset($_SESSION['3Dsecure_term_url']);
    2048. 

  2048.     if (isset($_SESSION['3Dsecure_auth_url'])) unset($_SESSION['3Dsecure_auth_url']);
    2049. 

  2049.   }
    2050. 

  2050. 

  2051. 

  2052.   function determine3DSecureProtection($cardType, $ECI) {
    2053. 

  2053.     $resultStatus = "NOT PROTECTED";
    2054. 

  2054.     if (strcasecmp($cardType, "VISA") == 0){
    2055. 

  2055.       if ((strcasecmp($ECI, "05") == 0) || (strcasecmp($ECI, "06") == 0)) {
    2056. 

  2056.         $resultStatus = "PROTECTED";
    2057. 

  2057.       } else {
    2058. 

  2058.         $resultStatus = "NOT PROTECTED";
    2059. 

  2059.       }
    2060. 

  2060.     } else if (strcasecmp($cardType, "MASTERCARD") == 0){
    2061. 

  2061.       if (strcasecmp($ECI, "02") == 0) {
    2062. 

  2062.         $resultStatus = "PROTECTED";
    2063. 

  2063.       } else {
    2064. 

  2064.         $resultStatus = "NOT PROTECTED";
    2065. 

  2065.       }
    2066. 

  2066.     } else if (strcasecmp($cardType, "JCB") == 0){
    2067. 

  2067.       if ((strcasecmp($ECI, "05") == 0) || (strcasecmp($ECI, "06") == 0)) {
    2068. 

  2068.         $resultStatus = "PROTECTED";
    2069. 

  2069.       } else {
    2070. 

  2070.         $resultStatus = "NOT PROTECTED";
    2071. 

  2071.       }
    2072. 

  2072.     }
    2073. 

  2073.     return $resultStatus;
    2074. 

  2074.   }
    2075. 

  2075. 

  2076.   /**
    2077. 

  2077.    * 3D-Secure lookup
    2078. 

  2078.    *
    2079. 

  2079.    * @param array $lookup_data_array
    2080. 

  2080.    * @return array
    2081. 

  2081.    */
    2082. 

  2082.   function get3DSecureLookupResponse($lookup_data_array) {
    2083. 

  2083.     // Set some defaults
    2084. 

  2084.     if (!isset($lookup_data_array['order_desc']) || $lookup_data_array['order_desc'] == '') $lookup_data_array['order_desc'] = 'Zen Cart(R) Transaction';
    2085. 

  2085.     if (!isset($lookup_data_array['order_number']) || $lookup_data_array['order_number'] == '') $lookup_data_array['order_number'] = zen_session_id();
    2086. 

  2086.     // format the card expiration
    2087. 

  2087.     $lookup_data_array['cc3d_exp_year'] = (strlen($lookup_data_array['cc3d_exp_year']) == 2 ? '20' : '') . $lookup_data_array['cc3d_exp_year'];
    2088. 

  2088.     // get the ISO 4217 currency
    2089. 

  2089.     $iso_currency = $this->getISOCurrency($lookup_data_array['currency']);
    2090. 

  2090.     // format the transaction amounts
    2091. 

  2091.     $raw_amount = $this->formatRawAmount($lookup_data_array['txn_amount'], $iso_currency);
    2092. 

  2092.     // determine the appropriate product code for submission
    2093. 

  2093.     $prodCode = FALSE;
    2094. 

  2094.     if (isset($_SESSION['cart'])) {
    2095. 

  2095.       if ($_SESSION['cart']->get_cart_type == 'virtual') {
    2096. 

  2096.         $prodCode = 'DIG';
    2097. 

  2097.       } else {
    2098. 

  2098.         $prodCode = 'PHY';
    2099. 

  2099.       }
    2100. 

  2100.     }
    2101. 

  2101. 

  2102.     // DEBUG ONLY: $this->zcLog(__FILE__ . '->' . __LINE__, 'session details: ' . print_r(array_merge($_POST, $_SESSION), true));
    2103. 

  2103. 

  2104.     // Build the XML cmpi_lookup message
    2105. 

  2105.     $data = '<CardinalMPI>';
    2106. 

  2106.     $data .= '<MsgType>cmpi_lookup</MsgType>';
    2107. 

  2107.     $data .= '<Version>1.7</Version>';
    2108. 

  2108.     $data .= '<ProcessorId>' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_PROCESSOR) . '</ProcessorId>';
    2109. 

  2109.     $data .= '<MerchantId><![CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_MERCHANT) . ']]></MerchantId>';
    2110. 

  2110.     $data .= '<TransactionPwd><![CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_PASSWORD) . ']]></TransactionPwd>';
    2111. 

  2111.     $data .= '<TransactionType>CC</TransactionType>';
    2112. 

  2112.     $data .= '<TransactionMode>S</TransactionMode>';
    2113. 

  2113.     $data .= '<OrderNumber>' . $this->escapeXML($lookup_data_array['order_number']) . '</OrderNumber>';
    2114. 

  2114.     $data .= '<OrderDescription>' . $this->escapeXML($lookup_data_array['order_desc']) . '</OrderDescription>';
    2115. 

  2115.     $data .= '<Amount>' . $this->escapeXML($raw_amount) . '</Amount>';
    2116. 

  2116.     $data .= '<CurrencyCode>' . $this->escapeXML($iso_currency) . '</CurrencyCode>';
    2117. 

  2117.     $data .= '<CardNumber>' . $this->escapeXML($lookup_data_array['cc3d_card_number']) . '</CardNumber>';
    2118. 

  2118.     $data .= '<Cvv>' . $this->escapeXML($lookup_data_array['cc3d_checkcode']) . '</Cvv>';
    2119. 

  2119.     $data .= '<CardCode>' . $this->escapeXML($lookup_data_array['cc3d_checkcode']) . '</CardCode>';
    2120. 

  2120.     $data .= '<CardExpMonth>' . $this->escapeXML($lookup_data_array['cc3d_exp_month']) . '</CardExpMonth>';
    2121. 

  2121.     $data .= '<CardExpYear>' . $this->escapeXML($lookup_data_array['cc3d_exp_year']) . '</CardExpYear>';
    2122. 

  2122.     $data .= '<UserAgent>' . $this->escapeXML($_SERVER["HTTP_USER_AGENT"]) . '</UserAgent>';
    2123. 

  2123.     $ipAddress = current(explode(':', str_replace(',', ':', zen_get_ip_address())));
    2124. 

  2124.     $data .= '<IPAddress>' . $this->escapeXML($ipAddress) . '</IPAddress>';
    2125. 

  2125.     $data .= '<BrowserHeader>' . $this->escapeXML($_SERVER["HTTP_ACCEPT"]) . '</BrowserHeader>';
    2126. 

  2126.     $data .= '<OrderChannel>' . $this->escapeXML('MARK') . '</OrderChannel>';
    2127. 

  2127.     if (isset($lookup_data_array['merchantData'])) $data .= '<MerchantData>' . $this->escapeXML($lookup_data_array['merchantData']) . '</MerchantData>';
    2128. 

  2128.     if ($prodCode !== FALSE && $prodCode != '') $data .= '<ProductCode>' . $this->escapeXML($prodCode) . '</ProductCode>';
    2129. 

  2129.     $data .= '</CardinalMPI>';
    2130. 

  2130.     $debugData = str_replace(array('[CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_MERCHANT) . ']]', '[CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_PASSWORD) . ']]', $this->escapeXML($lookup_data_array['cc3d_card_number']), $this->escapeXML($lookup_data_array['cc3d_checkcode'])), '********', $data);
    2131. 

  2131. 

  2132.     if (MODULE_PAYMENT_CARDINAL_CENTINEL_DEBUGGING !== FALSE) {
    2133. 

  2133.       $this->zcLog('Cardinal Lookup 1', '[' . zen_session_id() . '] Cardinal Centinel - cmpi_lookup request (' . MODULE_PAYMENT_PAYPALDP_CARDINAL_TXN_URL . ') - ' . $debugData);
    2134. 

  2134.     }
    2135. 

  2135. 

  2136.     $responseString = $this->send3DSecureHttp(MODULE_PAYMENT_PAYPALDP_CARDINAL_TXN_URL, $data, $debugData);
    2137. 

  2137. 

  2138.     if (MODULE_PAYMENT_CARDINAL_CENTINEL_DEBUGGING !== FALSE) {
    2139. 

  2139.       $this->zcLog('Cardinal Lookup 2', '[' . zen_session_id() . '] Cardinal Centinel - cmpi_lookup response - ' . $responseString);
    2140. 

  2140.     }
    2141. 

  2141. 

  2142.     // parse the XML
    2143. 

  2143.     $parser = new CardinalXMLParser;
    2144. 

  2144.     $parser->deserializeXml($responseString);
    2145. 

  2145. 

  2146.     $errorNo = $parser->deserializedResponse['ErrorNo'];
    2147. 

  2147.     $errorDesc = $parser->deserializedResponse['ErrorDesc'];
    2148. 

  2148.     $enrolled = $parser->deserializedResponse['Enrolled'];
    2149. 

  2149. 

  2150.     if ($errorNo != 0) {
    2151. 

  2151.       $this->zcLog('Cardinal Lookup 3', '[' . zen_session_id() . '] Cardinal Centinel - cmpi_lookup error - ' . $errorNo . ' - ' . $errorDesc);
    2152. 

  2152.       $errorText = 'Cardinal Lookup 3' . '[' . zen_session_id() . '] Cardinal Centinel - cmpi_lookup error - ' . $errorNo . ' - ' . $errorDesc;
    2153. 

  2153.       $errorText .= "\n\n" . 'There are 3 steps to configuring your Cardinal 3D-Secure service properly: ' . "\n1-Login to the Cardinal Merchant Admin URL supplied in your welcome package (NOT the test URL), and accept the license agreement.\n2-Set a transaction password.\n3-Copy your Cardinal Merchant ID and Cardinal Transaction Password into your ZC PayPal module.\n\nFor specific help, please contact implement@cardinalcommerce.com to sort out your account configuration issues.";
    2154. 

  2154.       $errorText .= "\n\nProblem observed while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication. THEIR PURCHASE WAS NOT SUCCESSFUL. Please resolve this matter to enable future checkouts.';
    2155. 

  2155.       zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, substr($errorDesc, 0, 75) . ' (' . $errorNo . ')', $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    2156. 

  2156.     }
    2157. 

  2157. 

  2158.     // default the continue flag to 'N'
    2159. 

  2159.     $continue_flag = 'N';
    2160. 

  2160. 

  2161.     // determine whether the transaction should continue or fail based upon
    2162. 

  2162.     // the enrollment lookup results
    2163. 

  2163.     if (strcasecmp(MODULE_PAYMENT_PAYPALDP_CARDINAL_AUTHENTICATE_REQ, 'No') == 0) {
    2164. 

  2164.       $continue_flag = 'Y';
    2165. 

  2165.     } else if (strcmp($errorNo, '0') == 0) {
    2166. 

  2166.       if (strcasecmp($enrolled, 'Y') == 0) {
    2167. 

  2167.         $continue_flag = 'Y';
    2168. 

  2168.       } else if (strcasecmp($enrolled, 'N') == 0) {
    2169. 

  2169.         $cardType = $this->determineCardType($this->cc_card_number);
    2170. 

  2170.         if (strcasecmp($cardType, 'VISA') == 0 || strcasecmp($cardType, 'JCB') == 0) {
    2171. 

  2171.           $continue_flag = 'Y';
    2172. 

  2172.         }
    2173. 

  2173.       }
    2174. 

  2174.     } else if ($errorNo == 1001) { // merchant has an account configuration problem to fix
    2175. 

  2175.       $errorText = CENTINEL_ERROR_CODE_1001 . ' - ' . CENTINEL_ERROR_CODE_1001_DESC;
    2176. 

  2176.       $errorText .= "\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    2177. 

  2177.       zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, CENTINEL_ERROR_CODE_1001_DESC . ' (' . CENTINEL_ERROR_CODE_1001 . ')', $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    2178. 

  2178.       $continue_flag = 'Y';
    2179. 

  2179.     }
    2180. 

  2180. 

  2181.     if (strcasecmp('Y', $continue_flag) == 0) {
    2182. 

  2182.       // For validation/security purposes, mark the session that the lookup result was acceptable.
    2183. 

  2183.       $_SESSION['3Dsecure_enroll_lookup_attempted'] = 'Y';
    2184. 

  2184.     } else {
    2185. 

  2185.       // For validation/security purposes, mark the session that the lookup result was not acceptable.
    2186. 

  2186.       unset($_SESSION['3Dsecure_enroll_lookup_attempted']);
    2187. 

  2187.     }
    2188. 

  2188. 

  2189.     $result = array('continue_flag' => $continue_flag,
    2190. 

  2190.                     'enrolled' => $enrolled,
    2191. 

  2191.                     'transaction_id' => $parser->deserializedResponse['TransactionId'],
    2192. 

  2192.                     'error_no' => $errorNo,
    2193. 

  2193.                     'error_desc' => $errorDesc,
    2194. 

  2194.                     'acs_url' => $parser->deserializedResponse['ACSUrl'],
    2195. 

  2195.                     'spa_hidden_fields' => $parser->deserializedResponse['SPAHiddenFields'],
    2196. 

  2196.                     'payload' => $parser->deserializedResponse['Payload'],
    2197. 

  2197.                     'cc3d_card_number' => $parser->deserializedResponse['CardNumber'],
    2198. 

  2198.                     'cc3d_checkcode' => $parser->deserializedResponse['CardCode'],
    2199. 

  2199.                     'cc3d_exp_month' => $parser->deserializedResponse['CardExpMonth'],
    2200. 

  2200.                     'cc3d_exp_year' => $parser->deserializedResponse['CardExpYear'],
    2201. 

  2201.                     'EciFlag' => $parser->deserializedResponse['EciFlag'],
    2202. 

  2202.                     'cc3d_merchantdata' => $parser->deserializedResponse['MerchantData']);
    2203. 

  2203.     return $result;
    2204. 

  2204.   }
    2205. 

  2205.   /**
    2206. 

  2206.    * 3D-Secure Authenticate
    2207. 

  2207.    * @param array $authenticate_data_array
    2208. 

  2208.    * @return array
    2209. 

  2209.    */
    2210. 

  2210.   function get3DSecureAuthenticateResponse($authenticate_data_array) {
    2211. 

  2211.     // Build the XML cmpi_authenticate message
    2212. 

  2212.     $data = '<CardinalMPI>';
    2213. 

  2213.     $data .= '<MsgType>cmpi_authenticate</MsgType>';
    2214. 

  2214.     $data .= '<Version>1.7</Version>';
    2215. 

  2215.     $data .= '<ProcessorId>' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_PROCESSOR) . '</ProcessorId>';
    2216. 

  2216.     $data .= '<MerchantId><![CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_MERCHANT) . ']]></MerchantId>';
    2217. 

  2217.     $data .= '<TransactionType>CC</TransactionType>';
    2218. 

  2218.     $data .= '<TransactionPwd><![CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_PASSWORD) . ']]></TransactionPwd>';
    2219. 

  2219.     $data .= '<TransactionId>' . $this->escapeXML($authenticate_data_array['transaction_id']) . '</TransactionId>';
    2220. 

  2220.     $data .= '<PAResPayload>' . $this->escapeXML($authenticate_data_array['payload']) . '</PAResPayload>';
    2221. 

  2221.     if (isset($authenticate_data_array['merchantData'])) $data .= '<MerchantData>' . $this->escapeXML($authenticate_data_array['merchantData']) . '</MerchantData>';
    2222. 

  2222.     $data .= '</CardinalMPI>';
    2223. 

  2223.     $debugData = str_replace(array('[CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_MERCHANT) . ']]', '[CDATA[' . $this->escapeXML(MODULE_PAYMENT_PAYPALDP_CARDINAL_PASSWORD) . ']]'), '********', $data);
    2224. 

  2224. 

  2225.     if (MODULE_PAYMENT_CARDINAL_CENTINEL_DEBUGGING !== FALSE) {
    2226. 

  2226.       $this->zcLog('Cardinal Auth 1', '[' . zen_session_id() . '] Cardinal Centinel - cmpi_authenticate request (' . MODULE_PAYMENT_PAYPALDP_CARDINAL_TXN_URL . ') - ' . $debugData);
    2227. 

  2227.     }
    2228. 

  2228. 

  2229.     $responseString = $this->send3DSecureHttp(MODULE_PAYMENT_PAYPALDP_CARDINAL_TXN_URL, $data, $debugData);
    2230. 

  2230. 

  2231.     if (MODULE_PAYMENT_CARDINAL_CENTINEL_DEBUGGING !== FALSE) {
    2232. 

  2232.       $this->zcLog('Cardinal Auth 2', '[' . zen_session_id() . '] Cardinal Centinel - cmpi_authenticate response - ' . $responseString);
    2233. 

  2233.     }
    2234. 

  2234. 

  2235.     // parse the XML
    2236. 

  2236.     $parser = new CardinalXMLParser;
    2237. 

  2237.     $parser->deserializeXml($responseString);
    2238. 

  2238. 

  2239.     $errorNo = $parser->deserializedResponse['ErrorNo'];
    2240. 

  2240.     $errorDesc = $parser->deserializedResponse['ErrorDesc'];
    2241. 

  2241.     $authStatus = $parser->deserializedResponse['PAResStatus'];
    2242. 

  2242.     $sigStatus = $parser->deserializedResponse['SignatureVerification'];
    2243. 

  2243.     $xid = $parser->deserializedResponse['Xid'];
    2244. 

  2244.     $cavv = $parser->deserializedResponse['Cavv'];
    2245. 

  2245.     $eci = $parser->deserializedResponse['EciFlag'];
    2246. 

  2246. 

  2247.     // default the continue flag to 'N'
    2248. 

  2248.     $continue_flag = 'N';
    2249. 

  2249. 

  2250.     if ($errorNo == 0) {
    2251. 

  2251.       if (strcasecmp($authStatus, 'Y') == 0 || strcasecmp($authStatus, 'A') == 0) {
    2252. 

  2252.         $continue_flag = 'Y';
    2253. 

  2253.       } else if (strcasecmp($authStatus, 'N') == 0) {
    2254. 

  2254.         $continue_flag = 'N';
    2255. 

  2255.       } else if (strcasecmp($authStatus, 'U') == 0) {
    2256. 

  2256.         if (strcasecmp(MODULE_PAYMENT_PAYPALDP_CARDINAL_AUTHENTICATE_REQ, 'No') == 0) {
    2257. 

  2257.           $this->zcLog('Cardinal Auth 3', 'Business rule in effect (not requiring chargeback protection), so setting to continue to Y');
    2258. 

  2258.           $continue_flag = 'Y';
    2259. 

  2259.         }
    2260. 

  2260.       }
    2261. 

  2261.     } else {
    2262. 

  2262.       $this->zcLog('Cardinal Auth 4', '[' . zen_session_id() . '] Cardinal Centinel - cmpi_authenticate returned an error - ' . $errorNo . ' - ' . $errorDesc);
    2263. 

  2263.       $continue_flag = 'N';
    2264. 

  2264.     }
    2265. 

  2265. 

  2266.     if ($continue_flag =='Y' && strcasecmp($sigStatus, 'N') == 0) {
    2267. 

  2267.       // Signature status is 'N', do not continue
    2268. 

  2268.       $continue_flag = 'N';
    2269. 

  2269.     }
    2270. 

  2270. 

  2271.     if ($continue_flag == 'Y') {
    2272. 

  2272.       // For validation/security purposes, mark the session that the
    2273. 

  2273.       // authentication result was acceptable.
    2274. 

  2274.       $_SESSION['3Dsecure_authentication_attempted'] = 'Y';
    2275. 

  2275.     } else {
    2276. 

  2276.       // For validation/security purposes, mark the session that the
    2277. 

  2277.       // authentication result was not acceptable.
    2278. 

  2278.       unset($_SESSION['3Dsecure_authentication_attempted']);
    2279. 

  2279.     }
    2280. 

  2280. 

  2281.     $result = array('continue_flag' => $continue_flag,
    2282. 

  2282.                     'auth_status' => $authStatus,
    2283. 

  2283.                     'sig_status' => $sigStatus,
    2284. 

  2284.                     'error_no' => $errorNo,
    2285. 

  2285.                     'error_desc' => $errorDesc,
    2286. 

  2286.                     'auth_xid' => $xid,
    2287. 

  2287.                     'auth_cavv' => $cavv,
    2288. 

  2288.                     'auth_eci' => $eci,
    2289. 

  2289.                     'cc3d_card_number' => $parser->deserializedResponse['CardNumber'],
    2290. 

  2290.                     'cc3d_checkcode' => $parser->deserializedResponse['CardCode'],
    2291. 

  2291.                     'cc3d_exp_month' => $parser->deserializedResponse['CardExpMonth'],
    2292. 

  2292.                     'cc3d_exp_year' => $parser->deserializedResponse['CardExpYear'],
    2293. 

  2293.                     'cc3d_merchantdata' => $parser->deserializedResponse['MerchantData']);
    2294. 

  2294.     return $result;
    2295. 

  2295.   }
    2296. 

  2296. 

  2297.   /////////////////////////////////////////////////////////////////////////////////////////////
    2298. 

  2298.   // Function sendHttp(url, data)
    2299. 

  2299.   //
    2300. 

  2300.   // HTTP POST the form payload to the url using cURL.
    2301. 

  2301.   // form payload according to the Centinel XML Message APIs. The form payload is returned from
    2302. 

  2302.   // the function.
    2303. 

  2303.   /////////////////////////////////////////////////////////////////////////////////////////////
    2304. 

  2304. 

  2305.   function send3DSecureHttp($url, $data, $debugData) {
    2306. 

  2306.       // verify that the URL uses a supported protocol.
    2307. 

  2307.     if ((strpos($url, "http://")=== 0) || (strpos($url, "https://")=== 0)) {
    2308. 

  2308. 

  2309.       // create a new cURL resource and set params
    2310. 

  2310.       $ch = curl_init($url);
    2311. 

  2311.       curl_setopt($ch, CURLOPT_POST,1);
    2312. 

  2312.       curl_setopt($ch, CURLOPT_POSTFIELDS, "cmpi_msg=".urlencode($data));
    2313. 

  2313.       curl_setopt($ch, CURLOPT_SSL_VERIFYHOST,  2);
    2314. 

  2314.       curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
    2315. 

  2315.       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
    2316. 

  2316.       curl_setopt($ch, CURLOPT_TIMEOUT, 8);
    2317. 

  2317. 

  2318.       // Execute the request.
    2319. 

  2319.       $result = curl_exec($ch);
    2320. 

  2320.       $succeeded  = curl_errno($ch) == 0 ? true : false;
    2321. 

  2321.       $error = curl_errno($ch) . '-' . curl_error($ch);
    2322. 

  2322. 

  2323.       // close cURL resource, and free up system resources
    2324. 

  2324.       curl_close($ch);
    2325. 

  2325. 

  2326.       // If Communication was not successful set error result
    2327. 

  2327.       if (!$succeeded) {
    2328. 

  2328.         $this->zcLog('Cardinal Send 1', '[' . zen_session_id() . '] Cardinal Centinel - ' . CENTINEL_ERROR_CODE_8030_DESC);
    2329. 

  2329.         $this->zcLog('Cardinal Send 2', '[' . zen_session_id() . '] Centinel Request:  ' . $debugData);
    2330. 

  2330.         $this->zcLog('Cardinal Send 3', '[' . zen_session_id() . '] Centinel Response: ' . $result);
    2331. 

  2331.         $result = $this->setErrorResponse(CENTINEL_ERROR_CODE_8030, CENTINEL_ERROR_CODE_8030_DESC);
    2332. 

  2332. 

  2333.         $errorText = CENTINEL_ERROR_CODE_8030 . ' - ' . CENTINEL_ERROR_CODE_8030_DESC;
    2334. 

  2334.         $errorText .= "\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    2335. 

  2335.         if ($error != '-') $errorText .= "\n\nCURL error: " . $error;
    2336. 

  2336.         zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, CENTINEL_ERROR_CODE_8030_DESC . ' (' . CENTINEL_ERROR_CODE_8030 . ')', $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    2337. 

  2337.       } else if (strpos($result, "<CardinalMPI>") === false) {
    2338. 

  2338.         // Assert that we received an expected Centinel Message in response.
    2339. 

  2339.         $this->zcLog('Cardinal Send 4', '[' . zen_session_id() . '] Cardinal Centinel - ' . CENTINEL_ERROR_CODE_8010_DESC);
    2340. 

  2340.         $this->zcLog('Cardinal Send 5', '[' . zen_session_id() . '] Centinel Request:  ' . $debugData);
    2341. 

  2341.         $this->zcLog('Cardinal Send 6', '[' . zen_session_id() . '] Centinel Response: ' . $result);
    2342. 

  2342.         $result = $this->setErrorResponse(CENTINEL_ERROR_CODE_8010, CENTINEL_ERROR_CODE_8010_DESC);
    2343. 

  2343.         $errorText = CENTINEL_ERROR_CODE_8010 . ' - ' . CENTINEL_ERROR_CODE_8010_DESC;
    2344. 

  2344.         $errorText .= "\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    2345. 

  2345.         zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, CENTINEL_ERROR_CODE_8010_DESC . ' (' . CENTINEL_ERROR_CODE_8010 . ')', $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    2346. 

  2346.       } else {
    2347. 

  2347.         // Check whether the merchant has a properly configured 3D-Secure account
    2348. 

  2348.         if (strpos($result, "<ErrorNo>4243") > 0) {
    2349. 

  2349.           $this->zcLog('Cardinal Send 4', '[' . zen_session_id() . '] Cardinal Centinel - ' . CENTINEL_ERROR_CODE_4243_DESC);
    2350. 

  2350.           $this->zcLog('Cardinal Send 5', '[' . zen_session_id() . '] Centinel Request:  ' . $debugData);
    2351. 

  2351.           $this->zcLog('Cardinal Send 6', '[' . zen_session_id() . '] Centinel Response: ' . $result);
    2352. 

  2352.           $result = $this->setErrorResponse(CENTINEL_ERROR_CODE_4243, CENTINEL_ERROR_CODE_4243_DESC);
    2353. 

  2353.           $errorText = CENTINEL_ERROR_CODE_4243 . ' - ' . CENTINEL_ERROR_CODE_4243_DESC;
    2354. 

  2354.           $errorText .= "\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    2355. 

  2355.           zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, CENTINEL_ERROR_CODE_4243_DESC . ' (' . CENTINEL_ERROR_CODE_4243 . ')', $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    2356. 

  2356.         }
    2357. 

  2357.       }
    2358. 

  2358.     } else {
    2359. 

  2359.       $this->zcLog('Cardinal Send 7', '[' . zen_session_id() . '] Cardinal Centinel - ' . CENTINEL_ERROR_CODE_8000_DESC . ' - ' . $url);
    2360. 

  2360.       $result = $this->setErrorResponse(CENTINEL_ERROR_CODE_8000, CENTINEL_ERROR_CODE_8000_DESC);
    2361. 

  2361.       $errorText = CENTINEL_ERROR_CODE_8000 . ' - ' . CENTINEL_ERROR_CODE_8000_DESC;
    2362. 

  2362.       $errorText .= "\n\nProblem occurred while customer " . $_SESSION['customer_id'] . ' ' . $_SESSION['customer_first_name'] . ' ' . $_SESSION['customer_last_name'] . ' was attempting checkout with 3D-Secure authentication.';
    2363. 

  2363.       zen_mail(STORE_NAME, STORE_OWNER_EMAIL_ADDRESS, CENTINEL_ERROR_CODE_8000_DESC . ' (' . CENTINEL_ERROR_CODE_8000 . ')', $errorText, STORE_OWNER, STORE_OWNER_EMAIL_ADDRESS, array('EMAIL_MESSAGE_HTML'=>nl2br($errorText)), 'paymentalert');
    2364. 

  2364.     }
    2365. 

  2365. 

  2366.     return $result;
    2367. 

  2367.   }
    2368. 

  2368. 

  2369.   /////////////////////////////////////////////////////////////////////////////////////////////
    2370. 

  2370.   // Function escapeXML(value)
    2371. 

  2371.   //
    2372. 

  2372.   // Escaped string converting all '&' to '&amp;' and all '<' to '&lt'. Return the escaped value.
    2373. 

  2373.   /////////////////////////////////////////////////////////////////////////////////////////////
    2374. 

  2374.   function escapeXML($elementValue){
    2375. 

  2375.     $escapedValue = str_replace("&", "&amp;", trim($elementValue));
    2376. 

  2376.     $escapedValue = str_replace("<", "&lt;", $escapedValue);
    2377. 

  2377.     return $escapedValue;
    2378. 

  2378.   }
    2379. 

  2379. 

  2380.   /////////////////////////////////////////////////////////////////////////////////////////////
    2381. 

  2381.   // Function setErrorResponse(errorNo, errorDesc)
    2382. 

  2382.   //
    2383. 

  2383.   // Initialize an Error response to ensure that parsing will be handled properly.
    2384. 

  2384.   /////////////////////////////////////////////////////////////////////////////////////////////
    2385. 

  2385.   function setErrorResponse($errorNo, $errorDesc) {
    2386. 

  2386.     $resultText  = "<CardinalMPI>";
    2387. 

  2387.     $resultText = $resultText."<ErrorNo>".($errorNo)."</ErrorNo>" ;
    2388. 

  2388.     $resultText = $resultText."<ErrorDesc>".($errorDesc)."</ErrorDesc>" ;
    2389. 

  2389.     $resultText  = $resultText."</CardinalMPI>";
    2390. 

  2390.     return $resultText;
    2391. 

  2391.   }
    2392. 

  2392. 

  2393.   function get_authentication_error() {
    2394. 

  2394.     $this->clear_3DSecure_session_vars();
    2395. 

  2395.     return CENTINEL_AUTHENTICATION_ERROR;
    2396. 

  2396.   }
    2397. 

  2397. 

  2398.   // Convert Currency to ISO4217 3 digit code
    2399. 

  2399.   //   If curr is char code will convert to digit code
    2400. 

  2400.   //   If curr is digits less than 3, will pad with leading zeros
    2401. 

  2401.   //   If we are unable to format curr, curr is returned unformatted.
    2402. 

  2402.   //   MAPs will return the appropriate error code.
    2403. 

  2403.   function getISOCurrency($curr) {
    2404. 

  2404.     $out = "";
    2405. 

  2405.     if(ctype_digit($curr) || is_int($curr)) {
    2406. 

  2406.       $numCurr = $curr + 0;
    2407. 

  2407.       if($numCurr < 10) {
    2408. 

  2408.         $out = "00" . $numCurr;
    2409. 

  2409.       } else if ($numCurr < 100) {
    2410. 

  2410.         $out = "0" . $numCurr;
    2411. 

  2411.       } else {
    2412. 

  2412.         //Assume 3 digits (if greater let MAPs handle error)
    2413. 

  2413.         $out = "" . $numCurr;
    2414. 

  2414.       }
    2415. 

  2415.     } else {
    2416. 

  2416.       // Convert char to digit
    2417. 

  2417.       $curCode = Array();
    2418. 

  2418.       $curCode["AUD"]="036";
    2419. 

  2419.       $curCode["CAD"]="124";
    2420. 

  2420.       $curCode["CHF"]="756";
    2421. 

  2421.       $curCode["CZK"]="203";
    2422. 

  2422.       $curCode["DKK"]="208";
    2423. 

  2423.       $curCode["EUR"]="978";
    2424. 

  2424.       $curCode["GBP"]="826";
    2425. 

  2425.       $curCode["HUF"]="348";
    2426. 

  2426.       $curCode["JPY"]="392";
    2427. 

  2427.       $curCode["NOK"]="578";
    2428. 

  2428.       $curCode["NZD"]="554";
    2429. 

  2429.       $curCode["PLN"]="985";
    2430. 

  2430.       $curCode["SEK"]="752";
    2431. 

  2431.       $curCode["SGD"]="702";
    2432. 

  2432.       $curCode["USD"]="840";
    2433. 

  2433.       $out = $curCode[$curr];
    2434. 

  2434.     }
    2435. 

  2435. 

  2436.     return $out;
    2437. 

  2437.   }
    2438. 

  2438. 

  2439.   // Format Amount to rawamount
    2440. 

  2440.   //   Rawamount does not contain a decimal and is rounded and padded
    2441. 

  2441.   //   based on the currency exponenet value
    2442. 

  2442.   //   amount - Double floating point
    2443. 

  2443.   //   curr - ISO4217 Currency code, 3char or 3digit
    2444. 

  2444.   function formatRawAmount($amount, $curr) {
    2445. 

  2445.     $dblAmount = $amount + 0.0;
    2446. 

  2446. 

  2447.     // Build Currency format table
    2448. 

  2448.     $curFormat = Array();
    2449. 

  2449.     $curFormat["036"]=2;
    2450. 

  2450.     $curFormat["124"]=2;
    2451. 

  2451.     $curFormat["203"]=2;
    2452. 

  2452.     $curFormat["208"]=2;
    2453. 

  2453.     $curFormat["348"]=2;
    2454. 

  2454.     $curFormat["392"]=0;
    2455. 

  2455.     $curFormat["554"]=2;
    2456. 

  2456.     $curFormat["578"]=2;
    2457. 

  2457.     $curFormat["702"]=2;
    2458. 

  2458.     $curFormat["752"]=2;
    2459. 

  2459.     $curFormat["756"]=2;
    2460. 

  2460.     $curFormat["826"]=2;
    2461. 

  2461.     $curFormat["840"]=2;
    2462. 

  2462.     $curFormat["978"]=2;
    2463. 

  2463.     $curFormat["985"]=2;
    2464. 

  2464. 

  2465.     $digCurr = $this->getISOCurrency("" . $curr);
    2466. 

  2466.     $exponent = $curFormat[$digCurr];
    2467. 

  2467.     $strAmount = "" . Round($dblAmount, $exponent);
    2468. 

  2468.     $strRetVal = "" . $strAmount;
    2469. 

  2469. 

  2470.     // decimal position
    2471. 

  2471.     $curpos = strpos($strRetVal, ".");
    2472. 

  2472. 

  2473.     // Pad with zeros
    2474. 

  2474.     if($curpos == true) {
    2475. 

  2475.       $padCount = $exponent - (strlen($strRetVal) - $curpos - 1);
    2476. 

  2476.       for($i=0;$i<$padCount;$i++) {
    2477. 

  2477.         $strRetVal .= "0";
    2478. 

  2478.       }
    2479. 

  2479.     } else {
    2480. 

  2480.       $padCount = $exponent;
    2481. 

  2481.       for($i=0;$i<$padCount;$i++) {
    2482. 

  2482.         $strRetVal .= "0";
    2483. 

  2483.       }
    2484. 

  2484.     }
    2485. 

  2485. 

  2486.     if($curpos !== false) {
    2487. 

  2487.       $strRetVal = substr($strRetVal, 0, $curpos) . substr($strRetVal, $curpos+1);
    2488. 

  2488.     }
    2489. 

  2489.     return $strRetVal;
    2490. 

  2490.   }
    2491. 

  2491. 

  2492.   function requiresLookup($info) {
    2493. 

  2493.     if (is_numeric($info)) {
    2494. 

  2494.       $cardType = $this->determineCardType($info);
    2495. 

  2495.     } else {
    2496. 

  2496.       $cardType = $info;
    2497. 

  2497.     }
    2498. 

  2498.     if (in_array(strtoupper($cardType), array('VISA', 'MASTERCARD', 'JCB', 'MAESTRO'))) {
    2499. 

  2499.       return true;
    2500. 

  2500.     } else {
    2501. 

  2501.       return false;
    2502. 

  2502.     }
    2503. 

  2503.   }
    2504. 

  2504. 

  2505.   function determineCardType($cardNumber) {
    2506. 

  2506.     $cardNumber = preg_replace('/[^0-9]/', '', $cardNumber);
    2507. 

  2507.     // NOTE: We check Solo before Maestro, and Maestro/Switch *before* we check Visa/Mastercard, so we don't have to rule-out numerous types from V/MC matching rules.
    2508. 

  2508.     if (preg_match('/^(6334[5-9][0-9]|6767[0-9]{2})[0-9]{10}([0-9]{2,3}?)?$/', $cardNumber)) {
    2509. 

  2509.       $cardType = "SOLO";
    2510. 

  2510.     } else if (preg_match('/^(49369[8-9]|490303|6333[0-4][0-9]|6759[0-9]{2}|5[0678][0-9]{4}|6[0-9][02-9][02-9][0-9]{2})[0-9]{6,13}?$/', $cardNumber)) {
    2511. 

  2511.       $cardType = "MAESTRO";
    2512. 

  2512.     } else if (preg_match('/^(49030[2-9]|49033[5-9]|4905[0-9]{2}|49110[1-2]|49117[4-9]|49918[0-2]|4936[0-9]{2}|564182|6333[0-4][0-9])[0-9]{10}([0-9]{2,3}?)?$/', $cardNumber)) {
    2513. 

  2513.       $cardType = "MAESTRO"; // SWITCH is now Maestro
    2514. 

  2514.     } elseif (preg_match('/^4[0-9]{12}([0-9]{3})?$/', $cardNumber)) {
    2515. 

  2515.       $cardType = 'VISA';
    2516. 

  2516.     } elseif (preg_match('/^5[1-5][0-9]{14}$/', $cardNumber)) {
    2517. 

  2517.       $cardType = 'MASTERCARD';
    2518. 

  2518.     } elseif (preg_match('/^3[47][0-9]{13}$/', $cardNumber)) {
    2519. 

  2519.       $cardType = 'AMEX';
    2520. 

  2520.     } elseif (preg_match('/^3(0[0-5]|[68][0-9])[0-9]{11}$/', $cardNumber)) {
    2521. 

  2521.       $cardType = 'DINERS CLUB';
    2522. 

  2522.     } elseif (preg_match('/^(6011[0-9]{12}|622[1-9][0-9]{12}|64[4-9][0-9]{13}|65[0-9]{14})$/', $cardNumber)) {
    2523. 

  2523.       $cardType = 'DISCOVER';
    2524. 

  2524.     } elseif (preg_match('/^(35(28|29|[3-8][0-9])[0-9]{12}|2131[0-9]{11}|1800[0-9]{11})$/', $cardNumber)) {
    2525. 

  2525.       $cardType = "JCB";
    2526. 

  2526.     } else {
    2527. 

  2527.       $cardType = "UNKNOWN";
    2528. 

  2528.     }
    2529. 

  2529.     return $cardType;
    2530. 

  2530.   }
    2531. 

  2531. 

  2532. }
    2533. 

  2533. 

  2534. 

  2535. 

  2536. class CardinalXMLParser{
    2537. 

  2537. 

  2538.   var $xml_parser;
    2539. 

  2539.   var $deseralizedResponse;
    2540. 

  2540.   var $elementName;
    2541. 

  2541.   var $elementValue;
    2542. 

  2542. 

  2543.   /////////////////////////////////////////////////////////////////////////////////////////////
    2544. 

  2544.   // Function CardinalXMLParser()
    2545. 

  2545.   //
    2546. 

  2546.   // Initialize the XML parser.
    2547. 

  2547.   /////////////////////////////////////////////////////////////////////////////////////////////
    2548. 

  2548. 

  2549.   function CardinalXMLParser() {
    2550. 

  2550.     $this->xml_parser = xml_parser_create();
    2551. 

  2551.   }
    2552. 

  2552. 

  2553.   /////////////////////////////////////////////////////////////////////////////////////////////
    2554. 

  2554.   // Function startElement(parser, name, attribute)
    2555. 

  2555.   //
    2556. 

  2556.   // Start Tag Element Handler
    2557. 

  2557.   /////////////////////////////////////////////////////////////////////////////////////////////
    2558. 

  2558. 

  2559.   function startElement($parser, $name, $attrs='') {
    2560. 

  2560.     $this->elementName = $name;
    2561. 

  2561.   }
    2562. 

  2562. 

  2563.   /////////////////////////////////////////////////////////////////////////////////////////////
    2564. 

  2564.   // Function elementData(parser, data)
    2565. 

  2565.   //
    2566. 

  2566.   // Element Data Handler
    2567. 

  2567.   /////////////////////////////////////////////////////////////////////////////////////////////
    2568. 

  2568. 

  2569.   function elementData($parser, $data) {
    2570. 

  2570.     $this->elementValue .= $data;
    2571. 

  2571.   }
    2572. 

  2572. 

  2573.   /////////////////////////////////////////////////////////////////////////////////////////////
    2574. 

  2574.   // Function endElement(name, value)
    2575. 

  2575.   //
    2576. 

  2576.   // End Tag Element Handler
    2577. 

  2577.   /////////////////////////////////////////////////////////////////////////////////////////////
    2578. 

  2578. 

  2579.   function endElement($parser, $name) {
    2580. 

  2580.     if (substr($this->elementValue, 0, 1) == "\n") $this->elementValue = substr($this->elementValue, 1);
    2581. 

  2581.     $this->deserializedResponse[$this->elementName]= $this->elementValue;
    2582. 

  2582.     $this->elementName = "";
    2583. 

  2583.     $this->elementValue = "";
    2584. 

  2584.   }
    2585. 

  2585. 

  2586.   /////////////////////////////////////////////////////////////////////////////////////////////
    2587. 

  2587.   // Function deserialize(xmlString)
    2588. 

  2588.   //
    2589. 

  2589.   // Deserialize the XML reponse message and add each element to the deserializedResponse collection.
    2590. 

  2590.   // Once complete, then each element reference will be available using the getValue function.
    2591. 

  2591.   /////////////////////////////////////////////////////////////////////////////////////////////
    2592. 

  2592. 

  2593.   function deserializeXml($responseString) {
    2594. 

  2594.     xml_set_object($this->xml_parser, $this);
    2595. 

  2595.     xml_parser_set_option($this->xml_parser,XML_OPTION_CASE_FOLDING,FALSE);
    2596. 

  2596.     xml_set_element_handler($this->xml_parser, "startElement", "endElement");
    2597. 

  2597.     xml_set_character_data_handler($this->xml_parser, "elementData");
    2598. 

  2598. 

  2599.     if (!xml_parse($this->xml_parser, $responseString)) {
    2600. 

  2600.       $this->deserializedResponse["ErrorNo"]= CENTINEL_ERROR_CODE_8020;
    2601. 

  2601.       $this->deserializedResponse["ErrorDesc"]= CENTINEL_ERROR_CODE_8020_DESC;
    2602. 

  2602.     }
    2603. 

  2603. 

  2604.     xml_parser_free($this->xml_parser);
    2605. 

  2605.   }
    2606. 

  2606. }
    2607. 

  2607.