PageRenderTime 68ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 1ms

/includes/modules/payment/paypalwpp.php

https://bitbucket.org/gcooksey3/zencart
PHP | 2949 lines | 2060 code | 262 blank | 627 comment | 808 complexity | 2dd11783943721b5963187ec25c48d8a MD5 | raw file
Possible License(s): AGPL-1.0

Large files files are truncated, but you can click here to view the full file

    

  1. <?php
    2. 

  2. /**
    3. 

  3.  * paypalwpp.php payment module class for PayPal Express Checkout payment method
    4. 

  4.  *
    5. 

  5.  * @package paymentMethod
    6. 

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

  7.  * @copyright Portions Copyright 2003 osCommerce
    8. 

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

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

  10.  */
    11. 

  11. /**
    12. 

  12.  * load the communications layer code
    13. 

  13.  */
    14. 

  14. require_once(DIR_FS_CATALOG . DIR_WS_MODULES . 'payment/paypal/paypal_curl.php');
    15. 

  15. /**
    16. 

  16.  * the PayPal payment module with Express Checkout
    17. 

  17.  */
    18. 

  18. class paypalwpp extends base {
    19. 

  19.   /**
    20. 

  20.    * name of this module
    21. 

  21.    *
    22. 

  22.    * @var string
    23. 

  23.    */
    24. 

  24.   var $code;
    25. 

  25.   /**
    26. 

  26.    * displayed module title
    27. 

  27.    *
    28. 

  28.    * @var string
    29. 

  29.    */
    30. 

  30.   var $title;
    31. 

  31.   /**
    32. 

  32.    * displayed module description
    33. 

  33.    *
    34. 

  34.    * @var string
    35. 

  35.    */
    36. 

  36.   var $description;
    37. 

  37.   /**
    38. 

  38.    * module status - set based on various config and zone criteria
    39. 

  39.    *
    40. 

  40.    * @var string
    41. 

  41.    */
    42. 

  42.   var $enabled;
    43. 

  43.   /**
    44. 

  44.    * the zone to which this module is restricted for use
    45. 

  45.    *
    46. 

  46.    * @var string
    47. 

  47.    */
    48. 

  48.   var $zone;
    49. 

  49.   /**
    50. 

  50.    * debugging flag
    51. 

  51.    *
    52. 

  52.    * @var boolean
    53. 

  53.    */
    54. 

  54.   var $enableDebugging = false;
    55. 

  55.   /**
    56. 

  56.    * Determines whether payment page is displayed or not
    57. 

  57.    *
    58. 

  58.    * @var boolean
    59. 

  59.    */
    60. 

  60.   var $showPaymentPage = false;
    61. 

  61.   var $flagDisablePaymentAddressChange = false;
    62. 

  62.   /**
    63. 

  63.    * sort order of display
    64. 

  64.    *
    65. 

  65.    * @var int
    66. 

  66.    */
    67. 

  67.   var $sort_order = 0;
    68. 

  68.   /**
    69. 

  69.    * Button Source / BN code -- enables the module to work for Zen Cart
    70. 

  70.    *
    71. 

  71.    * @var string
    72. 

  72.    */
    73. 

  73.   var $buttonSourceEC = 'ZenCart-EC_us';
    74. 

  74.   /**
    75. 

  75.    * order status setting for pending orders
    76. 

  76.    *
    77. 

  77.    * @var int
    78. 

  78.    */
    79. 

  79.   var $order_pending_status = 1;
    80. 

  80.   /**
    81. 

  81.    * order status setting for completed orders
    82. 

  82.    *
    83. 

  83.    * @var int
    84. 

  84.    */
    85. 

  85.   var $order_status = DEFAULT_ORDERS_STATUS_ID;
    86. 

  86.   /**
    87. 

  87.    * Debug tools
    88. 

  88.    */
    89. 

  89.   var $_logDir = 'includes/modules/payment/paypal/logs/';
    90. 

  90.   var $_logLevel = 0;
    91. 

  91.   /**
    92. 

  92.    * FMF
    93. 

  93.    */
    94. 

  94.   var $fmfResponse = '';
    95. 

  95.   var $fmfErrors = array();
    96. 

  96.   /**
    97. 

  97.    * class constructor
    98. 

  98.    */
    99. 

  99.   function paypalwpp() {
    100. 

  100.     include_once(zen_get_file_directory(DIR_FS_CATALOG . DIR_WS_LANGUAGES . $_SESSION['language'] . '/modules/payment/', 'paypalwpp.php', 'false'));
    101. 

  101.     global $order;
    102. 

  102.     $this->code = 'paypalwpp';
    103. 

  103.     $this->codeTitle = MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_TITLE_EC;
    104. 

  104.     $this->codeVersion = '1.5.1';
    105. 

  105.     $this->enableDirectPayment = FALSE;
    106. 

  106.     $this->enabled = (MODULE_PAYMENT_PAYPALWPP_STATUS == 'True');
    107. 

  107.     // Set the title & description text based on the mode we're in ... EC vs US/UK vs admin
    108. 

  108.     if (IS_ADMIN_FLAG === true) {
    109. 

  109.       $this->description = sprintf(MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_DESCRIPTION, ' (rev' . $this->codeVersion . ')');
    110. 

  110.       switch (MODULE_PAYMENT_PAYPALWPP_MODULE_MODE) {
    111. 

  111.         case ('PayPal'):
    112. 

  112.           $this->title = MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_TITLE_EC;
    113. 

  113.         break;
    114. 

  114.         case ('Payflow-UK'):
    115. 

  115.           $this->title = MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_TITLE_PRO20;
    116. 

  116.         break;
    117. 

  117.         case ('Payflow-US'):
    118. 

  118.           if (defined('MODULE_PAYMENT_PAYPALWPP_PAYFLOW_EC') && MODULE_PAYMENT_PAYPALWPP_PAYFLOW_EC == 'Yes') {
    119. 

  119.             $this->title = MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_TITLE_PF_EC;
    120. 

  120.           } else {
    121. 

  121.             $this->title = MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_TITLE_PF_GATEWAY;
    122. 

  122.           }
    123. 

  123.         break;
    124. 

  124.         default:
    125. 

  125.           $this->title = MODULE_PAYMENT_PAYPALWPP_TEXT_ADMIN_TITLE_EC;
    126. 

  126.       }
    127. 

  127.       if ($this->enabled) {
    128. 

  128.         if ( (MODULE_PAYMENT_PAYPALWPP_MODULE_MODE == 'PayPal' && (MODULE_PAYMENT_PAYPALWPP_APISIGNATURE == '' || MODULE_PAYMENT_PAYPALWPP_APIUSERNAME == '' || MODULE_PAYMENT_PAYPALWPP_APIPASSWORD == ''))
    129. 

  129.           || (substr(MODULE_PAYMENT_PAYPALWPP_MODULE_MODE,0,7) == 'Payflow' && (MODULE_PAYMENT_PAYPALWPP_PFPARTNER == '' || MODULE_PAYMENT_PAYPALWPP_PFVENDOR == '' || MODULE_PAYMENT_PAYPALWPP_PFUSER == '' || MODULE_PAYMENT_PAYPALWPP_PFPASSWORD == ''))
    130. 

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

  131.         if (MODULE_PAYMENT_PAYPALWPP_SERVER =='sandbox') $this->title .= '<strong><span class="alert"> (sandbox active)</span></strong>';
    132. 

  132.         if (MODULE_PAYMENT_PAYPALWPP_DEBUGGING =='Log File' || MODULE_PAYMENT_PAYPALWPP_DEBUGGING =='Log and Email') $this->title .= '<strong> (Debug)</strong>';
    133. 

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

  134.       }
    135. 

  135.     } else {
    136. 

  136.       $this->description = MODULE_PAYMENT_PAYPALWPP_TEXT_DESCRIPTION;
    137. 

  137.       $this->title = MODULE_PAYMENT_PAYPALWPP_EC_TEXT_TITLE; //pp
    138. 

  138.     }
    139. 

  139. 

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

  141. 

  142.     $this->enableDebugging = (MODULE_PAYMENT_PAYPALWPP_DEBUGGING == 'Log File' || MODULE_PAYMENT_PAYPALWPP_DEBUGGING =='Log and Email');
    143. 

  143.     $this->emailAlerts = (MODULE_PAYMENT_PAYPALWPP_DEBUGGING == 'Log File' || MODULE_PAYMENT_PAYPALWPP_DEBUGGING =='Log and Email' || MODULE_PAYMENT_PAYPALWPP_DEBUGGING == 'Alerts Only');
    144. 

  144.     $this->doDPonly = (MODULE_PAYMENT_PAYPALWPP_MODULE_MODE =='Payflow-US' && !(defined('MODULE_PAYMENT_PAYPALWPP_PAYFLOW_EC') && MODULE_PAYMENT_PAYPALWPP_PAYFLOW_EC == 'Yes'));
    145. 

  145.     $this->showPaymentPage = (MODULE_PAYMENT_PAYPALWPP_SKIP_PAYMENT_PAGE == 'No') ? true : false;
    146. 

  146.     $this->sort_order = MODULE_PAYMENT_PAYPALWPP_SORT_ORDER;
    147. 

  147. 

  148.     $this->buttonSourceEC = 'ZenCart-EC_us';
    149. 

  149.     $this->buttonSourceDP = 'ZenCart-DP_us';
    150. 

  150.     if (MODULE_PAYMENT_PAYPALWPP_MODULE_MODE == 'Payflow-UK') {
    151. 

  151.       $this->buttonSourceEC = 'ZenCart-EC_uk';
    152. 

  152.       $this->buttonSourceDP = 'ZenCart-DP_uk';
    153. 

  153.     }
    154. 

  154.     if (MODULE_PAYMENT_PAYPALWPP_MODULE_MODE == 'Payflow-US') {
    155. 

  155.       $this->buttonSourceEC = 'ZenCart-ECGW_us';
    156. 

  156.       $this->buttonSourceDP = 'ZenCart-GW_us';
    157. 

  157.     }
    158. 

  158. 

  159.     $this->order_pending_status = MODULE_PAYMENT_PAYPALWPP_ORDER_PENDING_STATUS_ID;
    160. 

  160.     if ((int)MODULE_PAYMENT_PAYPALWPP_ORDER_STATUS_ID > 0) {
    161. 

  161.       $this->order_status = MODULE_PAYMENT_PAYPALWPP_ORDER_STATUS_ID;
    162. 

  162.     }
    163. 

  163.     $this->new_acct_notify = MODULE_PAYMENT_PAYPALWPP_NEW_ACCT_NOTIFY;
    164. 

  164.     $this->zone = (int)MODULE_PAYMENT_PAYPALWPP_ZONE;
    165. 

  165.     if (is_object($order)) $this->update_status();
    166. 

  166. 

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

  168. 

  169.     $this->cards = array();
    170. 

  170.     // if operating in markflow mode, start EC process when submitting order
    171. 

  171.     if (!$this->in_special_checkout()) {
    172. 

  172.       $this->form_action_url = zen_href_link('ipn_main_handler.php', 'type=ec&markflow=1&clearSess=1&stage=final', 'SSL', true, true, true);
    173. 

  173.     }
    174. 

  174. 

  175.     // debug setup
    176. 

  176.     if (!@is_writable($this->_logDir)) $this->_logDir = DIR_FS_CATALOG . $this->_logDir;
    177. 

  177.     if (!@is_writable($this->_logDir)) $this->_logDir = DIR_FS_SQL_CACHE;
    178. 

  178.     // Regular mode:
    179. 

  179.     if ($this->enableDebugging) $this->_logLevel = 2;
    180. 

  180.     // DEV MODE:
    181. 

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

  182. 

  183.     if (IS_ADMIN_FLAG === true) $this->tableCheckup();
    184. 

  184. 

  185.   }
    186. 

  186.   /**
    187. 

  187.    *  Sets payment module status based on zone restrictions etc
    188. 

  188.    */
    189. 

  189.   function update_status() {
    190. 

  190.     global $order, $db;
    191. 

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

  192.     if ($this->enabled && (int)$this->zone > 0) {
    193. 

  193.       $check_flag = false;
    194. 

  194.       $sql = "SELECT zone_id
    195. 

  195.               FROM " . TABLE_ZONES_TO_GEO_ZONES . "
    196. 

  196.               WHERE geo_zone_id = :zoneId
    197. 

  197.               AND zone_country_id = :countryId
    198. 

  198.               ORDER BY zone_id";
    199. 

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

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

  201.       $check = $db->Execute($sql);
    202. 

  202.       while (!$check->EOF) {
    203. 

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

  204.           $check_flag = true;
    205. 

  205.           break;
    206. 

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

  207.           $check_flag = true;
    208. 

  208.           break;
    209. 

  209.         }
    210. 

  210.         $check->MoveNext();
    211. 

  211.       }
    212. 

  212. 

  213.       if (!$check_flag) {
    214. 

  214.         $this->enabled = false;
    215. 

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

  216.       }
    217. 

  217. 

  218.       // module cannot be used for purchase > $10,000 USD
    219. 

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

  220.       if ($order_amount > 10000) {
    221. 

  221.         $this->enabled = false;
    222. 

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

  223.       }
    224. 

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

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

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

  227.       }
    228. 

  228.     }
    229. 

  229.   }
    230. 

  230.   /**
    231. 

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

  232.    */
    233. 

  233.   function javascript_validation() {
    234. 

  234.     return false;
    235. 

  235.   }
    236. 

  236.   /**
    237. 

  237.    * Display Credit Card Information Submission Fields on the Checkout Payment Page
    238. 

  238.    */
    239. 

  239.   function selection() {
    240. 

  240.     $this->cc_type_check = '';
    241. 

  241.     /**
    242. 

  242.      * since we are NOT processing via the gateway, we will only display MarkFlow payment option, and no CC fields
    243. 

  243.      */
    244. 

  244.     return array('id' => $this->code,
    245. 

  245.                  'module' => '<img src="' . MODULE_PAYMENT_PAYPALEC_MARK_BUTTON_IMG . '" alt="' . MODULE_PAYMENT_PAYPALWPP_TEXT_BUTTON_ALTTEXT . '" /><span style="font-size:11px; font-family: Arial, Verdana;"> ' . MODULE_PAYMENT_PAYPALWPP_MARK_BUTTON_TXT . '</span>');
    246. 

  246.   }
    247. 

  247.   function pre_confirmation_check() {
    248. 

  248.     // Since this is an EC checkout, do nothing.
    249. 

  249.     return false;
    250. 

  250.   }
    251. 

  251.   /**
    252. 

  252.    * Display Payment Information for review on the Checkout Confirmation Page
    253. 

  253.    */
    254. 

  254.   function confirmation() {
    255. 

  255.     $confirmation = array('title' => '', 'fields' => array());
    256. 

  256.     return $confirmation;
    257. 

  257.   }
    258. 

  258.   /**
    259. 

  259.    * Prepare the hidden fields comprising the parameters for the Submit button on the checkout confirmation page
    260. 

  260.    */
    261. 

  261.   function process_button() {
    262. 

  262.     $_SESSION['paypal_ec_markflow'] = 1;
    263. 

  263.     return '';
    264. 

  264.   }
    265. 

  265.   /**
    266. 

  266.    * Prepare and submit the final authorization to PayPal via the appropriate means as configured
    267. 

  267.    */
    268. 

  268.   function before_process() {
    269. 

  269.     global $order, $doPayPal, $messageStack;
    270. 

  270.     $options = array();
    271. 

  271.     $optionsShip = array();
    272. 

  272.     $optionsNVP = array();
    273. 

  273. 

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

  275.     if (defined('MODULE_PAYMENT_PAYPALEC_ALLOWEDPAYMENT') && MODULE_PAYMENT_PAYPALEC_ALLOWEDPAYMENT == 'Instant Only') $options['ALLOWEDPAYMENTMETHOD'] = 'InstantPaymentOnly';
    276. 

  276. 

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

  278. 

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

  280.     $options['DESC'] = '';
    281. 

  281. 

  282.     $doPayPal = $this->paypal_init();
    283. 

  283.     $this->zcLog('before_process - EC-1', 'Beginning EC mode');
    284. 

  284.      /****************************************
    285. 

  285.       * Do EC checkout
    286. 

  286.       ****************************************/
    287. 

  287.       // do not allow blank address to be sent to PayPal
    288. 

  288.       if ($_SESSION['paypal_ec_payer_info']['ship_street_1'] != '' && strtoupper($_SESSION['paypal_ec_payer_info']['ship_address_status']) != 'NONE') {
    289. 

  289.         $options = array_merge($options,
    290. 

  290.                  array('SHIPTONAME'   => $_SESSION['paypal_ec_payer_info']['ship_name'],
    291. 

  291.                        'SHIPTOSTREET' => $_SESSION['paypal_ec_payer_info']['ship_street_1'],
    292. 

  292.                        'SHIPTOSTREET2'=> $_SESSION['paypal_ec_payer_info']['ship_street_2'],
    293. 

  293.                        'SHIPTOCITY'   => $_SESSION['paypal_ec_payer_info']['ship_city'],
    294. 

  294.                        'SHIPTOSTATE'  => $_SESSION['paypal_ec_payer_info']['ship_state'],
    295. 

  295.                        'SHIPTOZIP'    => $_SESSION['paypal_ec_payer_info']['ship_postal_code'],
    296. 

  296.                        'SHIPTOCOUNTRYCODE'=> $_SESSION['paypal_ec_payer_info']['ship_country_code'],
    297. 

  297.                        ));
    298. 

  298.         $this->zcLog('before_process - EC-2', 'address overrides added:' . "\n" . print_r($options, true));
    299. 

  299.       }
    300. 

  300. 

  301.       $this->zcLog('before_process - EC-3', 'address info added:' . "\n" . print_r($options, true));
    302. 

  302. 

  303.       $options['BUTTONSOURCE'] = $this->buttonSourceEC;
    304. 

  304. 

  305.       // If the customer has changed their shipping address,
    306. 

  306.       // override the shipping address in PayPal with the shipping
    307. 

  307.       // address that is selected in Zen Cart.
    308. 

  308.       if ($order->delivery['street_address'] != '' && $order->delivery['street_address'] != $_SESSION['paypal_ec_payer_info']['ship_street_1'] && $_SESSION['paypal_ec_payer_info']['ship_street_1'] != '') {
    309. 

  309.         $_GET['markflow'] = 2;
    310. 

  310.         if (($address_arr = $this->getOverrideAddress()) !== false) {
    311. 

  311.           // set the override var
    312. 

  312.           $options['ADDROVERRIDE'] = 1;
    313. 

  313.           // set the address info
    314. 

  314.           $options['SHIPTONAME']    = $address_arr['entry_firstname'] . ' ' . $address_arr['entry_lastname'];
    315. 

  315.           $options['SHIPTOSTREET']  = $address_arr['entry_street_address'];
    316. 

  316.           if ($address_arr['entry_suburb'] != '') $options['SHIPTOSTREET2'] = $address_arr['entry_suburb'];
    317. 

  317.           $options['SHIPTOCITY']    = $address_arr['entry_city'];
    318. 

  318.           $options['SHIPTOZIP']     = $address_arr['entry_postcode'];
    319. 

  319.           $options['SHIPTOSTATE']   = $address_arr['zone_code'];
    320. 

  320.           $options['SHIPTOCOUNTRYCODE'] = $address_arr['countries_iso_code_2'];
    321. 

  321.         }
    322. 

  322.       }
    323. 

  323.       // if these optional parameters are blank, remove them from transaction
    324. 

  324.       if (isset($options['SHIPTOSTREET2']) && trim($options['SHIPTOSTREET2']) == '') unset($options['SHIPTOSTREET2']);
    325. 

  325.       if (isset($options['SHIPTOPHONENUM']) && trim($options['SHIPTOPHONENUM']) == '') unset($options['SHIPTOPHONENUM']);
    326. 

  326. 

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

  328.       if ((!isset($options['SHIPTOSTATE']) || trim($options['SHIPTOSTATE']) == '') && $options['SHIPTOCITY'] != '') $options['SHIPTOSTATE'] = $options['SHIPTOCITY'];
    329. 

  329. 

  330.       // FMF support
    331. 

  331.       $options['RETURNFMFDETAILS'] = (MODULE_PAYMENT_PAYPALWPP_EC_RETURN_FMF_DETAILS == 'Yes') ? 1 : 0;
    332. 

  332. 

  333.       // Add note to track that this was an EC transaction (used in properly handling update IPNs related to EC transactions):
    334. 

  334.       $options['CUSTOM'] = 'EC-' . (int)$_SESSION['customer_id'] . '-' . time();
    335. 

  335. 

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

  337.       $options['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)
    338. 

  338. 

  339.       $options['CURRENCY'] = $this->selectCurrency($order->info['currency']);
    340. 

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

  341.       $order_amount = $this->calc_order_amount($order->info['total'], $options['CURRENCY'], FALSE);
    342. 

  342. 

  343.       // debug output
    344. 

  344.       $this->zcLog('before_process - EC-4', 'info being submitted:' . "\n" . $_SESSION['paypal_ec_token'] . ' ' . $_SESSION['paypal_ec_payer_id'] . ' ' . number_format($order_amount, 2) .  "\n" . print_r($options, true));
    345. 

  345. 

  346.       if (isset($options['DESC']) && $options['DESC'] == '') unset($options['DESC']);
    347. 

  347. 

  348.       if (!isset($options['AMT'])) $options['AMT'] = number_format($order_amount, 2, '.', '');
    349. 

  349.       $response = $doPayPal->DoExpressCheckoutPayment($_SESSION['paypal_ec_token'],
    350. 

  350.                                                       $_SESSION['paypal_ec_payer_id'],
    351. 

  351.                                                       $options);
    352. 

  352. 

  353.       $this->zcLog('before_process - EC-5', 'resultset:' . "\n" . urldecode(print_r($response, true)));
    354. 

  354. 

  355.       // CHECK RESPONSE -- if error, actions are taken in the errorHandler
    356. 

  356.       $errorHandlerMessage = $this->_errorHandler($response, 'DoExpressCheckoutPayment');
    357. 

  357. 

  358.       if ($this->fmfResponse != '') {
    359. 

  359.         $this->order_status = $this->order_pending_status;
    360. 

  360.       }
    361. 

  361. 

  362.       // SUCCESS
    363. 

  363.       $this->payment_type = MODULE_PAYMENT_PAYPALWPP_EC_TEXT_TYPE;
    364. 

  364.       $this->responsedata = $response;
    365. 

  365.       if ($response['PAYMENTTYPE'] != '') $this->payment_type .=  ' (' . urldecode($response['PAYMENTTYPE']) . ')';
    366. 

  366. 

  367.       $this->transaction_id = trim($response['PNREF'] . ' ' . $response['TRANSACTIONID']);
    368. 

  368.       if (empty($response['PENDINGREASON']) ||
    369. 

  369.           $response['PENDINGREASON'] == 'none' ||
    370. 

  370.           $response['PENDINGREASON'] == 'completed' ||
    371. 

  371.           $response['PAYMENTSTATUS'] == 'Completed') {
    372. 

  372.         $this->payment_status = 'Completed';
    373. 

  373.         if ($this->order_status > 0) $order->info['order_status'] = $this->order_status;
    374. 

  374.       } else {
    375. 

  375.         if ($response['PAYMENTSTATUS'] == 'Pending')
    376. 

  376.         {
    377. 

  377.           if ($response['L_ERRORCODE0'] == 11610 && $response['PENDINGREASON'] == '') $response['PENDINGREASON'] = 'Pending FMF Review by Storeowner';
    378. 

  378.         }
    379. 

  379.         $this->payment_status = 'Pending (' . $response['PENDINGREASON'] . ')';
    380. 

  380.         $order->info['order_status'] = $this->order_pending_status;
    381. 

  381.       }
    382. 

  382.       $this->avs = 'N/A';
    383. 

  383.       $this->cvv2 = 'N/A';
    384. 

  384.       $this->correlationid = $response['CORRELATIONID'];
    385. 

  385.       $this->transactiontype = $response['TRANSACTIONTYPE'];
    386. 

  386.       $this->payment_time = urldecode($response['ORDERTIME']);
    387. 

  387.       $this->feeamt = urldecode($response['FEEAMT']);
    388. 

  388.       $this->taxamt = urldecode($response['TAXAMT']);
    389. 

  389.       $this->pendingreason = $response['PENDINGREASON'];
    390. 

  390.       $this->reasoncode = $response['REASONCODE'];
    391. 

  391.       $this->numitems = sizeof($order->products);
    392. 

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

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

  394.   }
    395. 

  395.   /**
    396. 

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

  397.    */
    398. 

  398.   function after_process() {
    399. 

  399.     global $insert_id, $db, $order;
    400. 

  400.     // FMF
    401. 

  401.     if ($this->fmfResponse != '') {
    402. 

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

  403.       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');
    404. 

  404.     }
    405. 

  405. 

  406.     // add a new OSH record for this order's PP details
    407. 

  407.     $commentString = "Transaction ID: :transID: " .
    408. 

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

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

  410.                                  "\nPayment Type: :pmtType: " .
    411. 

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

  412.                                  "\nPayment Status: :pmtStatus: " .
    413. 

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

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

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

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

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

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

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

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

  421. 

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

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

  424.                            array('fieldName'=>'date_added', 'value'=>'now()', 'type'=>'noquotestring'),
    425. 

  425.                            array('fieldName'=>'customer_notified', 'value'=>0, 'type'=>'integer'),
    426. 

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

  427.     $db->perform(TABLE_ORDERS_STATUS_HISTORY, $sql_data_array);
    428. 

  428. 

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

  430.     $paypal_order = array('order_id' => $insert_id,
    431. 

  431.                           'txn_type' => $this->transactiontype,
    432. 

  432.                           'module_name' => $this->code,
    433. 

  433.                           'module_mode' => MODULE_PAYMENT_PAYPALWPP_MODULE_MODE,
    434. 

  434.                           'reason_code' => $this->reasoncode,
    435. 

  435.                           'payment_type' => $this->payment_type,
    436. 

  436.                           'payment_status' => $this->payment_status,
    437. 

  437.                           'pending_reason' => $this->pendingreason,
    438. 

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

  439.                           'first_name' => $_SESSION['paypal_ec_payer_info']['payer_firstname'],
    440. 

  440.                           'last_name' => $_SESSION['paypal_ec_payer_info']['payer_lastname'],
    441. 

  441.                           'payer_business_name' => $_SESSION['paypal_ec_payer_info']['payer_business'],
    442. 

  442.                           'address_name' => $_SESSION['paypal_ec_payer_info']['ship_name'],
    443. 

  443.                           'address_street' => $_SESSION['paypal_ec_payer_info']['ship_street_1'],
    444. 

  444.                           'address_city' => $_SESSION['paypal_ec_payer_info']['ship_city'],
    445. 

  445.                           'address_state' => $_SESSION['paypal_ec_payer_info']['ship_state'],
    446. 

  446.                           'address_zip' => $_SESSION['paypal_ec_payer_info']['ship_postal_code'],
    447. 

  447.                           'address_country' => $_SESSION['paypal_ec_payer_info']['ship_country'],
    448. 

  448.                           'address_status' => $_SESSION['paypal_ec_payer_info']['ship_address_status'],
    449. 

  449.                           'payer_email' => $_SESSION['paypal_ec_payer_info']['payer_email'],
    450. 

  450.                           'payer_id' => $_SESSION['paypal_ec_payer_id'],
    451. 

  451.                           'payer_status' => $_SESSION['paypal_ec_payer_info']['payer_status'],
    452. 

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

  453.                           'business' => '',
    454. 

  454.                           'receiver_email' => (substr(MODULE_PAYMENT_PAYPALWPP_MODULE_MODE,0,7) == 'Payflow' ? MODULE_PAYMENT_PAYPALWPP_PFVENDOR : str_replace('_api1', '', MODULE_PAYMENT_PAYPALWPP_APIUSERNAME)),
    455. 

  455.                           'receiver_id' => '',
    456. 

  456.                           'txn_id' => $this->transaction_id,
    457. 

  457.                           'parent_txn_id' => '',
    458. 

  458.                           'num_cart_items' => (float)$this->numitems,
    459. 

  459.                           'mc_gross' => (float)$this->amt,
    460. 

  460.                           'mc_fee' => (float)urldecode($this->feeamt),
    461. 

  461.                           'mc_currency' => $this->responsedata['CURRENCYCODE'],
    462. 

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

  463.                           'settle_currency' => $this->responsedata['CURRENCYCODE'],
    464. 

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

  465.                           'notify_version' => '0',
    466. 

  466.                           'verify_sign' =>'',
    467. 

  467.                           'date_added' => 'now()',
    468. 

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

  469.                          );
    470. 

  470.     zen_db_perform(TABLE_PAYPAL, $paypal_order);
    471. 

  471. 

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

  473.     unset($_SESSION['paypal_ec_temp']);
    474. 

  474.     unset($_SESSION['paypal_ec_token']);
    475. 

  475.     unset($_SESSION['paypal_ec_payer_id']);
    476. 

  476.     unset($_SESSION['paypal_ec_payer_info']);
    477. 

  477.     unset($_SESSION['paypal_ec_final']);
    478. 

  478.     unset($_SESSION['paypal_ec_markflow']);
    479. 

  479.   }
    480. 

  480.   /**
    481. 

  481.     * Build admin-page components
    482. 

  482.     *
    483. 

  483.     * @param int $zf_order_id
    484. 

  484.     * @return string
    485. 

  485.     */
    486. 

  486.   function admin_notification($zf_order_id) {
    487. 

  487.     if (!defined('MODULE_PAYMENT_PAYPALWPP_STATUS')) return '';
    488. 

  488.     global $db;
    489. 

  489.     $module = $this->code;
    490. 

  490.     $output = '';
    491. 

  491.     $response = $this->_GetTransactionDetails($zf_order_id);
    492. 

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

  493.     $sql = "SELECT * from " . TABLE_PAYPAL . " WHERE order_id = :orderID
    494. 

  494.             AND parent_txn_id = '' AND order_id > 0
    495. 

  495.             ORDER BY paypal_ipn_id DESC LIMIT 1";
    496. 

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

  497.     $ipn = $db->Execute($sql);
    498. 

  498.     if ($ipn->RecordCount() == 0) $ipn->fields = array();
    499. 

  499.     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');
    500. 

  500.     return $output;
    501. 

  501.   }
    502. 

  502.   /**
    503. 

  503.    * Used to read details of an existing transaction.  FOR FUTURE USE.
    504. 

  504.    */
    505. 

  505.   function _GetTransactionDetails($oID) {
    506. 

  506.     if ($oID == '' || $oID < 1) return FALSE;
    507. 

  507.     global $db, $messageStack, $doPayPal;
    508. 

  508.     $doPayPal = $this->paypal_init();
    509. 

  509.     // look up history on this order from PayPal table
    510. 

  510.     $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 ";
    511. 

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

  512.     $zc_ppHist = $db->Execute($sql);
    513. 

  513.     if ($zc_ppHist->RecordCount() == 0) return false;
    514. 

  514.     $txnID = $zc_ppHist->fields['txn_id'];
    515. 

  515.     if ($txnID == '' || $txnID === 0) return FALSE;
    516. 

  516.     /**
    517. 

  517.      * Read data from PayPal
    518. 

  518.      */
    519. 

  519.     $response = $doPayPal->GetTransactionDetails($txnID);
    520. 

  520. 

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

  522.     if ($error === false) {
    523. 

  523.       return false;
    524. 

  524.     } else {
    525. 

  525.       return $response;
    526. 

  526.     }
    527. 

  527.   }
    528. 

  528.   /**
    529. 

  529.    * Used to read details of existing transactions.  FOR FUTURE USE.
    530. 

  530.    */
    531. 

  531.   function _TransactionSearch($startDate = '', $oID = '', $criteria = '') {
    532. 

  532.     global $db, $messageStack, $doPayPal;
    533. 

  533.     $doPayPal = $this->paypal_init();
    534. 

  534.     // look up history on this order from PayPal table
    535. 

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

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

  537.     $zc_ppHist = $db->Execute($sql);
    538. 

  538.     if ($zc_ppHist->RecordCount() == 0) return false;
    539. 

  539.     $txnID = $zc_ppHist->fields['txn_id'];
    540. 

  540.     $startDate = $zc_ppHist->fields['payment_date'];
    541. 

  541.     $timeval = time();
    542. 

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

  543.     /**
    544. 

  544.      * Read data from PayPal
    545. 

  545.      */
    546. 

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

  547. 

  548.     $error = $this->_errorHandler($response, 'TransactionSearch');
    549. 

  549.     if ($error === false) {
    550. 

  550.       return false;
    551. 

  551.     } else {
    552. 

  552.       return $response;
    553. 

  553.     }
    554. 

  554.   }
    555. 

  555.   /**
    556. 

  556.    * Evaluate installation status of this module. Returns true if the status key is found.
    557. 

  557.    */
    558. 

  558.   function check() {
    559. 

  559.     global $db;
    560. 

  560.     if (!isset($this->_check)) {
    561. 

  561.       $check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_PAYMENT_PAYPALWPP_STATUS'");
    562. 

  562.       $this->_check = !$check_query->EOF;
    563. 

  563.     }
    564. 

  564.     return $this->_check;
    565. 

  565.   }
    566. 

  566.   /**
    567. 

  567.    * Installs all the configuration keys for this module
    568. 

  568.    */
    569. 

  569.   function install() {
    570. 

  570.     global $db, $messageStack;
    571. 

  571.     if (defined('MODULE_PAYMENT_PAYPALWPP_STATUS')) {
    572. 

  572.       $messageStack->add_session('Express Checkout module already installed.', 'error');
    573. 

  573.       zen_redirect(zen_href_link(FILENAME_MODULES, 'set=payment&module=paypalwpp', 'NONSSL'));
    574. 

  574.       return 'failed';
    575. 

  575.     }
    576. 

  576.     if (defined('MODULE_PAYMENT_PAYPAL_STATUS')) {
    577. 

  577.       $messageStack->add_session('NOTE: You already have the PayPal Website Payments Standard module installed. You should REMOVE it if you want to install Express Checkout.', 'error');
    578. 

  578.       zen_redirect(zen_href_link(FILENAME_MODULES, 'set=payment&module=paypal', 'NONSSL'));
    579. 

  579.       return 'failed';
    580. 

  580.     }
    581. 

  581. 

  582.     $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_PAYPALWPP_STATUS', 'True', 'Do you want to enable this payment module?', '6', '25', 'zen_cfg_select_option(array(\'True\', \'False\'), ', now())");
    583. 

  583.     $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_PAYPALWPP_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())");
    584. 

  584.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Express Checkout Shortcut Button', 'MODULE_PAYMENT_PAYPALWPP_ECS_BUTTON', 'On', 'The Express Checkout Shortcut button shows up on your shopping cart page to invite your customers to pay using PayPal without having to give all their address details on your site first before selecting shipping options.<br />It has been shown to increase sales and conversions when enabled.<br />Default: On ', '6', '25', 'zen_cfg_select_option(array(\'On\', \'Off\'), ', now())");
    585. 

  585.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Express Checkout: Require Confirmed Address', 'MODULE_PAYMENT_PAYPALWPP_CONFIRMED_ADDRESS', 'No', 'Do you want to require that your (not-logged-in) customers use a *confirmed* address when choosing their shipping address in PayPal?<br />(this is ignored for logged-in customers)', '6', '25',  'zen_cfg_select_option(array(\'Yes\', \'No\'), ', now())");
    586. 

  586.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Express Checkout: Select Cheapest Shipping Automatically', 'MODULE_PAYMENT_PAYPALWPP_AUTOSELECT_CHEAPEST_SHIPPING', 'Yes', 'When customer returns from PayPal, do we want to automatically select the Cheapest shipping method and skip the shipping page? (making it more *express*)<br />Note: enabling this means the customer does *not* have easy access to select an alternate shipping method (without going back to the Checkout-Step-1 page)', '6', '25',  'zen_cfg_select_option(array(\'Yes\', \'No\'), ', now())");
    587. 

  587.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Express Checkout: Skip Payment Page', 'MODULE_PAYMENT_PAYPALWPP_SKIP_PAYMENT_PAGE', 'Yes', 'If the customer is checking out with Express Checkout, do you want to skip the checkout payment page, making things more *express*? <br /><strong>(NOTE: The Payment Page will auto-display regardless of this setting if you have Coupons or Gift Certificates enabled in your store.)</strong>', '6', '25',  'zen_cfg_select_option(array(\'Yes\', \'No\'), ', now())");
    588. 

  588.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Express Checkout: Automatic Account Creation', 'MODULE_PAYMENT_PAYPALWPP_NEW_ACCT_NOTIFY', 'Yes', 'If a visitor is not an existing customer, a Zen Cart account is created for them.  Would you like make it a permanent account and send them an email containing their login information?<br />NOTE: Permanent accounts are auto-created if the customer purchases downloads or gift certificates, regardless of this setting.', '6', '25', 'zen_cfg_select_option(array(\'Yes\', \'No\'), ', now())");
    589. 

  589.     $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_PAYPALWPP_SORT_ORDER', '0', 'Sort order of display. Lowest is displayed first.', '6', '25', now())");
    590. 

  590.     $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_PAYPALWPP_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())");
    591. 

  591.     $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_PAYPALWPP_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())");
    592. 

  592.     $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_PAYPALWPP_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())");
    593. 

  593.     $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_PAYPALWPP_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())");
    594. 

  594.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('PayPal Page Style', 'MODULE_PAYMENT_PAYPALWPP_PAGE_STYLE', 'Primary', 'The page-layout style you want customers to see when they visit the PayPal site. You can configure your <strong>Custom Page Styles</strong> in your PayPal Profile settings. This value is case-sensitive.', '6', '25', now())");
    595. 

  595.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Store (Brand) Name at PayPal', 'MODULE_PAYMENT_PAYPALWPP_BRANDNAME', '', 'The name of your store as it should appear on the PayPal login page. If blank, your store name will be used.', '6', '25', now())");
    596. 

  596.     $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_PAYPALWPP_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())");
    597. 

  597.     $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_PAYPALWPP_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\', \'Only THB\', \'Only MXN\', \'Only ILS\', \'Only PHP\', \'Only TWD\', \'Only BRL\', \'Only MYR\', \'Only TKD\'), ', now())");
    598. 

  598.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Allow eCheck?', 'MODULE_PAYMENT_PAYPALEC_ALLOWEDPAYMENT', 'Any', 'Do you want to allow non-instant payments like eCheck/EFT/ELV?', '6', '25', 'zen_cfg_select_option(array(\'Any\', \'Instant Only\'), ', now())");
    599. 

  599. 

  600.     $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_PAYPALWPP_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())");
    601. 

  601.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('API Signature -- Username', 'MODULE_PAYMENT_PAYPALWPP_APIUSERNAME', '', 'The API Username from your PayPal API Signature settings under *API Access*. This value typically looks like an email address and is case-sensitive.', '6', '25', now())");
    602. 

  602.     $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 ('API Signature -- Password', 'MODULE_PAYMENT_PAYPALWPP_APIPASSWORD', '', 'The API Password from your PayPal API Signature settings under *API Access*. This value is a 16-character code and is case-sensitive.', '6', '25', now(), 'zen_cfg_password_input(', 'zen_cfg_password_display')");
    603. 

  603.     $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 ('API Signature -- Signature Code', 'MODULE_PAYMENT_PAYPALWPP_APISIGNATURE', '', 'The API Signature from your PayPal API Signature settings under *API Access*. This value is a 56-character code, and is case-sensitive.', '6', '25', now(), '', 'zen_cfg_password_display')");
    604. 

  604. 

  605.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('PAYFLOW: User', 'MODULE_PAYMENT_PAYPALWPP_PFUSER', '', 'If you set up one or more additional users on the account, this value is the ID of the user authorized to process transactions. Otherwise it should be the same value as VENDOR. This value is case-sensitive.', '6', '25', now())");
    606. 

  606.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('PAYFLOW: Partner', 'MODULE_PAYMENT_PAYPALWPP_PFPARTNER', 'ZenCart', 'Your Payflow Partner name linked to your Payflow account. This value is case-sensitive.<br />Typical values: <strong>PayPal</strong> or <strong>ZenCart</strong>', '6', '25', now())");
    607. 

  607.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('PAYFLOW: Vendor', 'MODULE_PAYMENT_PAYPALWPP_PFVENDOR', '', 'Your merchant login ID that you created when you registered for the Payflow Pro account. This value is case-sensitive.', '6', '25', now())");
    608. 

  608.     $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 ('PAYFLOW: Password', 'MODULE_PAYMENT_PAYPALWPP_PFPASSWORD', '', 'The 6- to 32-character password that you defined while registering for the account. This value is case-sensitive.', '6', '25', now(), 'zen_cfg_password_input(', 'zen_cfg_password_display')");
    609. 

  609. 

  610.     $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('PayPal Mode', 'MODULE_PAYMENT_PAYPALWPP_MODULE_MODE', 'PayPal', 'Which PayPal API system should be used for processing? <br /><u>Choices:</u><br /><font color=green>For choice #1, you need to supply <strong>API Settings</strong> above.</font><br /><strong>1. PayPal</strong> = Express Checkout with a regular PayPal account<br />or<br /><font color=green>for choices 2 &amp; 3 you need to supply <strong>PAYFLOW settings</strong>, below (and have a Payflow account)</font><br /><strong>2. Payflow-UK</strong> = Website Payments Pro UK Payflow Edition<br /><strong>3. Payflow-US</strong> = Payflow Pro Gateway only<!--<br /><strong>4. PayflowUS+EC</strong> = Payflow Pro with Express Checkout-->', '6', '25',  'zen_cfg_select_option(array(\'PayPal\', \'Payflow-UK\', \'Payflow-US\'), ', now())");
    611. 

  611.     $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_PAYPALWPP_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())");
    612. 

  612. 

  613.     $this->notify('NOTIFY_PAYMENT_PAYPALWPP_INSTALLED');
    614. 

  614.   }
    615. 

  615. 

  616.   function keys() {
    617. 

  617.     if (defined('MODULE_PAYMENT_PAYPALWPP_STATUS')) {
    618. 

  618.       global $db;
    619. 

  619.       if (!defined('MODULE_PAYMENT_PAYPALWPP_ECS_BUTTON')) {
    620. 

  620.         $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Express Checkout Shortcut Button', 'MODULE_PAYMENT_PAYPALWPP_ECS_BUTTON', 'On', 'The Express Checkout Shortcut button shows up on your shopping cart page to invite your customers to pay using PayPal without having to give all their address details on your site first before selecting shipping options.<br />It has been shown to increase sales and conversions when enabled.<br />Default: On ', '6', '25', 'zen_cfg_select_option(array(\'On\', \'Off\'), ', now())");
    621. 

  621.       }
    622. 

  622.       if (!defined('MODULE_PAYMENT_PAYPALWPP_BRANDNAME')) {
    623. 

  623.         $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Store Brand Name at PayPal', 'MODULE_PAYMENT_PAYPALWPP_BRANDNAME', '', 'The name of your store as it should appear on the PayPal login page. If blank, your store name will be used.', '6', '25', now())");
    624. 

  624.       }
    625. 

  625.       if (!defined('MODULE_PAYMENT_PAYPALEC_ALLOWEDPAYMENT')) {
    626. 

  626.         $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Allow eCheck?', 'MODULE_PAYMENT_PAYPALEC_ALLOWEDPAYMENT', 'Any', 'Do you want to allow non-instant payments like eCheck/EFT/ELV?', '6', '25', 'zen_cfg_select_option(array(\'Any\', \'Instant Only\'), ', now())");
    627. 

  627.       }
    628. 

  628.     }
    629. 

  629.     $keys_list = array('MODULE_PAYMENT_PAYPALWPP_STATUS', 'MODULE_PAYMENT_PAYPALWPP_SORT_ORDER', 'MODULE_PAYMENT_PAYPALWPP_ZONE', 'MODULE_PAYMENT_PAYPALWPP_ECS_BUTTON', 'MODULE_PAYMENT_PAYPALWPP_ORDER_STATUS_ID', 'MODULE_PAYMENT_PAYPALWPP_ORDER_PENDING_STATUS_ID', 'MODULE_PAYMENT_PAYPALWPP_REFUNDED_STATUS_ID', 'MODULE_PAYMENT_PAYPALWPP_CONFIRMED_ADDRESS', 'MODULE_PAYMENT_PAYPALWPP_AUTOSELECT_CHEAPEST_SHIPPING', 'MODULE_PAYMENT_PAYPALWPP_SKIP_PAYMENT_PAGE', 'MODULE_PAYMENT_PAYPALWPP_NEW_ACCT_NOTIFY', 'MODULE_PAYMENT_PAYPALWPP_TRANSACTION_MODE', 'MODULE_PAYMENT_PAYPALWPP_CURRENCY', 'MODULE_PAYMENT_PAYPALWPP_BRANDNAME', 'MODULE_PAYMENT_PAYPALEC_ALLOWEDPAYMENT', 'MODULE_PAYMENT_PAYPALWPP_PAGE_STYLE', 'MODULE_PAYMENT_PAYPALWPP_APIUSERNAME', 'MODULE_PAYMENT_PAYPALWPP_APIPASSWORD', 'MODULE_PAYMENT_PAYPALWPP_APISIGNATURE', 'MODULE_PAYMENT_PAYPALWPP_MODULE_MODE', 'MODULE_PAYMENT_PAYPALWPP_SERVER', 'MODULE_PAYMENT_PAYPALWPP_DEBUGGING');
    630. 

  630.     if (IS_ADMIN_FLAG === true && (PAYPAL_DEV_MODE == 'true' || strstr(MODULE_PAYMENT_PAYPALWPP_MODULE_MODE, 'Payflow'))) {
    631. 

  631.       $keys_list = array_merge($keys_list, array('MODULE_PAYMENT_PAYPALWPP_PFPARTNER', 'MODULE_PAYMENT_PAYPALWPP_PFVENDOR', 'MODULE_PAYMENT_PAYPALWPP_PFUSER', 'MODULE_PAYMENT_PAYPALWPP_PFPASSWORD'));
    632. 

  632.     }
    633. 

  633.     return $keys_list;
    634. 

  634.   }
    635. 

  635.   /**
    636. 

  636.    * De-install this module
    637. 

  637.    */
    638. 

  638.   function remove() {
    639. 

  639.     global $messageStack;
    640. 

  640.     // cannot remove EC if DP installed:
    641. 

  641.     if (defined('MODULE_PAYMENT_PAYPALDP_STATUS')) {
    642. 

  642.       // this language text is hard-coded in english since Website Payments Pro is not yet available in any countries that speak any other language at this time.
    643. 

  643.       $messageStack->add_session('<strong>Sorry, you must remove PayPal Payments Pro (paypaldp) first.</strong> PayPal Payments Pro (Website Payments Pro) requires that you offer Express Checkout to your customers.<br /><a href="' . zen_href_link('modules.php?set=payment&module=paypaldp', '', 'NONSSL') . '">Click here to edit or remove your PayPal Payments Pro module.</a>' , 'error');
    644. 

  644.       zen_redirect(zen_href_link(FILENAME_MODULES, 'set=payment&module=paypalwpp', 'NONSSL'));
    645. 

  645.       return 'failed';
    646. 

  646.     }
    647. 

  647. 

  648.     global $db;
    649. 

  649.     $db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key LIKE 'MODULE\_PAYMENT\_PAYPALWPP\_%' or configuration_key like 'MODULE\_PAYMENT\_PAYPALEC\_%'");
    650. 

  650.     $this->notify('NOTIFY_PAYMENT_PAYPALWPP_UNINSTALLED');
    651. 

  651.   }
    652. 

  652.   /**
    653. 

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

  654.    */
    655. 

  655.   function in_special_checkout() {
    656. 

  656.     if ((defined('MODULE_PAYMENT_PAYPALWPP_STATUS') && MODULE_PAYMENT_PAYPALWPP_STATUS == 'True') &&
    657. 

  657.              !empty($_SESSION['paypal_ec_token']) &&
    658. 

  658.              !empty($_SESSION['paypal_ec_payer_id']) &&
    659. 

  659.              !empty($_SESSION['paypal_ec_payer_info'])) {
    660. 

  660.       $this->flagDisablePaymentAddressChange = true;
    661. 

  661.       return true;
    662. 

  662.     }
    663. 

  663.   }
    664. 

  664.   /**
    665. 

  665.    * Determine whether the shipping-edit button should be displayed or not
    666. 

  666.    */
    667. 

  667.   function alterShippingEditButton() {
    668. 

  668.     return false;
    669. 

  669.     if ($this->in_special_checkout() && empty($_SESSION['paypal_ec_markflow'])) {
    670. 

  670.       return zen_href_link('ipn_main_handler.php', 'type=ec&clearSess=1', 'SSL', true,true, true);
    671. 

  671.     }
    672. 

  672.   }
    673. 

  673.   /**
    674. 

  674.    * Debug Logging support
    675. 

  675.    */
    676. 

  676.   function zcLog($stage, $message) {
    677. 

  677.     static $tokenHash;
    678. 

  678.     if ($tokenHash == '') $tokenHash = '_' . zen_create_random_value(4);
    679. 

  679.     if (MODULE_PAYMENT_PAYPALWPP_DEBUGGING == 'Log and Email' || MODULE_PAYMENT_PAYPALWPP_DEBUGGING == 'Log File') {
    680. 

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

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

  682.       $token .= $tokenHash;
    683. 

  683.       $file = $this->_logDir . '/' . $this->code . '_Paypal_Action_' . $token . '.log';
    684. 

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

  685.       $fp = @fopen($file, 'a');
    686. 

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

  687.       @fclose($fp);
    688. 

  688.     }
    689. 

  689.     $this->_doDebug($stage, $message, false);
    690. 

  690.   }
    691. 

  691.   /**
    692. 

  692.    * Debug Emailing support
    693. 

  693.    */
    694. 

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

  695.     if (MODULE_PAYMENT_PAYPALWPP_DEBUGGING == 'Log and Email') {
    696. 

  696.       $data =  urldecode($data) . "\n\n";
    697. 

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

  698.       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');
    699. 

  699.     }
    700. 

  700.   }
    701. 

  701.   /**
    702. 

  702.    * Initialize the PayPal/PayflowPro o…
    703.

Large files files are truncated, but you can click here to view the full file