Home » API reference » Drupal 5

uc_ups.module

Tracking 5.x-1.x branch
  1. drupal
    1. 5 contributions/ubercart/shipping/uc_ups/uc_ups.module
    2. 6 contributions/ubercart/shipping/uc_ups/uc_ups.module
    3. 7 contributions/ubercart/shipping/uc_ups/uc_ups.module

Shipping quote module that interfaces with www.ups.com to get rates for small package shipments.

Coded by Lyle Mantooth

Functions & methods

NameDescription
theme_uc_ups_confirm_shipmentDisplay final shipment information for review.
theme_uc_ups_label_imageDisplay the shipping label for printing.
uc_ups_access_requestReturn XML access request to be prepended to all requests to the UPS webservice.
uc_ups_admin_settingsUPS Online Tool settings.
uc_ups_admin_settings_validateValidation handler for uc_ups_admin_settings.
uc_ups_configurationImplementation of hook_configuration().
uc_ups_confirm_shipmentLast chance for user to review shipment.
uc_ups_confirm_shipment_submitSubmit handler for uc_ups_confirm_shipment().
uc_ups_form_alterImplementation of hook_form_alter().
uc_ups_fulfill_orderShipment creation callback.
uc_ups_fulfill_order_submitSubmit handler for uc_ups_fulfill_order().
uc_ups_fulfill_order_validateValidation handler for uc_ups_fulfill_order().
uc_ups_markupModify the rate received from UPS before displaying to the customer.
uc_ups_menuImplementation of hook_menu().
uc_ups_nodeapiImplementation of hook_nodeapi().
uc_ups_product_alter_validateValidation handler for UPS product fields.
uc_ups_quoteCallback for retrieving a UPS shipping quote.
uc_ups_request_pickupConstruct an XML label and pickup request.
uc_ups_shipment_requestConstruct an XML shippment request.
uc_ups_shipping_methodImplementation of Übercart's hook_shipping_method().
uc_ups_shipping_quoteConstruct an XML quote request.
uc_ups_shipping_typeImplementation of Übercart's hook_shipping_type().
uc_ups_store_statusImplementation of Übercart's hook_store_status().
uc_ups_void_shipment
uc_ups_void_shipment_request
_uc_ups_new_package
_uc_ups_pkg_typesConvenience function to get UPS codes for their package types.
_uc_ups_service_listConvenience function to get UPS codes for their services.

File

View source
  1. <?php

  2. 

  3. /**

  4.  * @file

  5.  * Shipping quote module that interfaces with www.ups.com to get rates for small

  6.  * package shipments.

  7.  *

  8.  * Coded by Lyle Mantooth

  9.  */

  10. 

  11. /******************************************************************************

  12.  * Drupal Hooks                                                               *

  13.  ******************************************************************************/

  14. 

  15. /**

  16.  * Implementation of hook_menu().

  17.  */

  18. function uc_ups_menu($may_cache) {

  19.   $items = array();

  20. 

  21.   if ($may_cache) {

  22.     $items[] = array('path' => 'admin/store/settings/quotes/methods/ups',

  23.       'access' => user_access('configure quotes'),

  24.       'title' => t('UPS'),

  25.       'callback' => 'drupal_get_form',

  26.       'callback arguments' => 'uc_ups_admin_settings',

  27.       'type' => MENU_LOCAL_TASK,

  28.     );

  29.   }

  30.   else {

  31.     $items[] = array('path' => 'admin/store/orders/'. arg(3) .'/shipments/ups',

  32.       'access' => user_access('fulfill orders'),

  33.       'title' => t('UPS shipment'),

  34.       'callback' => 'drupal_get_form',

  35.       'callback arguments' => array('uc_ups_confirm_shipment', arg(3)),

  36.       'type' => MENU_CALLBACK,

  37.     );

  38.     $items[] = array('path' => 'admin/store/orders/'. arg(3) .'/shipments/labels/ups',

  39.       'access' => user_access('fulfill orders'),

  40.       'callback' => 'theme',

  41.       'callback arguments' => array('uc_ups_label_image'),

  42.       'type' => MENU_CALLBACK,

  43.     );

  44.     drupal_add_css(drupal_get_path('module', 'uc_ups') .'/uc_ups.css');

  45.   }

  46. 

  47.   return $items;

  48. }

  49. 

  50. /**

  51.  * Implementation of hook_form_alter().

  52.  *

  53.  * Add package type to products.

  54.  *

  55.  * @see uc_product_form

  56.  * @see uc_ups_product_alte_validate

  57.  */

  58. function uc_ups_form_alter($form_id, &$form) {

  59.   $node = $form['#node'];

  60.   if (is_object($node) && $form_id == $node->type .'_node_form' && isset($form['base']['dimensions']) && in_array($node->type, module_invoke_all('product_types'))) {

  61.     $enabled = variable_get('uc_quote_enabled', array());

  62.     $weight = variable_get('uc_quote_method_weight', array('ups' => 0));

  63.     $ups = array('#type' => 'fieldset',

  64.       '#title' => t('UPS product description'),

  65.       '#collapsible' => true,

  66.       '#collapsed' => ($enabled['ups'] == false || uc_product_get_shipping_type($node) != 'small_package'),

  67.       '#weight' => $weight['ups'],

  68.       '#tree' => true,

  69.     );

  70.     $ups['pkg_type'] = array('#type' => 'select',

  71.       '#title' => t('Package type'),

  72.       '#options' => _uc_ups_pkg_types(),

  73.       '#default_value' => $node->ups['pkg_type'] ? $node->ups['pkg_type'] : '02',

  74.     );

  75.     $form['shipping']['ups'] = $ups;

  76.     if ($enabled['ups']) {

  77.       $form['#validate']['uc_ups_product_alter_validate'] = array();

  78.     }

  79.   }

  80. }

  81. 

  82. /**

  83.  * Validation handler for UPS product fields.

  84.  */

  85. function uc_ups_product_alter_validate($form_id, $form_values) {

  86.   $enabled = variable_get('uc_quote_enabled', array());

  87.   if ($form_values['shippable'] && ($form_values['shipping_type'] == 'small_package' || (empty($form_values['shipping_type']) && variable_get('uc_store_shipping_type', 'small_package') == 'small_package'))) {

  88.     if ($form_values['ups']['pkg_type'] == '02' && (empty($form_values['length']) || empty($form_values['width']) || empty($form_values['height']))) {

  89.       form_set_error('base][dimensions', t('Dimensions are required for custom packaging.'));

  90.     }

  91.   }

  92. }

  93. 

  94. /**

  95.  * Implementation of hook_nodeapi().

  96.  */

  97. function uc_ups_nodeapi(&$node, $op) {

  98.   if (in_array($node->type, module_invoke_all('product_types'))) {

  99.     switch ($op) {

  100.       case 'insert':

  101.       case 'update':

  102.         if (isset($node->ups)) {

  103.           $ups_values = $node->ups;

  104.           if (!$node->revision) {

  105.             db_query("DELETE FROM {uc_ups_products} WHERE vid = %d", $node->vid);

  106.           }

  107.           db_query("INSERT INTO {uc_ups_products} (vid, nid, pkg_type) VALUES (%d, %d, '%s')",

  108.             $node->vid, $node->nid, $ups_values['pkg_type']);

  109.         }

  110.       break;

  111.       case 'load':

  112.         if (uc_product_get_shipping_type($node) == 'small_package') {

  113.           return array('ups' => db_fetch_array(db_query("SELECT * FROM {uc_ups_products} WHERE vid = %d", $node->vid)));

  114.         }

  115.       break;

  116.       case 'delete':

  117.         db_query("DELETE FROM {uc_ups_products} WHERE nid = %d", $node->nid);

  118.       break;

  119.       case 'delete revision':

  120.         db_query("DELETE FROM {uc_ups_products} WHERE vid = %d", $node->vid);

  121.       break;

  122.     }

  123.   }

  124. }

  125. 

  126. /******************************************************************************

  127.  * Workflow-ng Hooks                                                          *

  128.  ******************************************************************************/

  129. 

  130. /**

  131.  * Implementation of hook_configuration().

  132.  *

  133.  * Connect the UPS quote action and event.

  134.  */

  135. function uc_ups_configuration() {

  136.   $enabled = variable_get('uc_quote_enabled', array());

  137.   $configurations = array(

  138.     'uc_ups_get_quote' => array(

  139.       '#label' => t('Shipping quote from UPS'),

  140.       '#event' => 'get_quote_from_ups',

  141.       '#module' => 'uc_ups',

  142.       '#active' => $enabled['ups'],

  143.     ),

  144.   );

  145. 

  146.   $action = workflow_ng_use_action('uc_quote_action_get_quote', array(

  147.     '#label' => t('Fetch a shipping quote'),

  148.   ));

  149.   $configurations['uc_ups_get_quote'] = workflow_ng_configure($configurations['uc_ups_get_quote'], $action);

  150. 

  151.   return $configurations;

  152. }

  153. 

  154. /******************************************************************************

  155.  * Übercart Hooks                                                             *

  156.  ******************************************************************************/

  157. 

  158. /**

  159.  * Implementation of Übercart's hook_shipping_type().

  160.  */

  161. function uc_ups_shipping_type() {

  162.   $weight = variable_get('uc_quote_type_weight', array('small_package' => 0));

  163. 

  164.   $types = array();

  165.   $types['small_package'] = array(

  166.     'id' => 'small_package',

  167.     'title' => t('Small packages'),

  168.     'weight' => $weight['small_package'],

  169.   );

  170. 

  171.   return $types;

  172. }

  173. 

  174. /**

  175.  * Implementation of Übercart's hook_shipping_method().

  176.  */

  177. function uc_ups_shipping_method() {

  178.   $methods = array();

  179. 

  180.   $enabled = variable_get('uc_quote_enabled', array());

  181.   $weight = variable_get('uc_quote_method_weight', array('ups' => 0));

  182.   $methods['ups'] = array(

  183.     'id' => 'ups',

  184.     'module' => 'uc_ups',

  185.     'title' => t('UPS'),

  186.     'enabled' => $enabled['ups'],

  187.     'quote' => array(

  188.       'type' => 'small_package',

  189.       'callback' => 'uc_ups_quote',

  190.       'accessorials' => _uc_ups_service_list(),

  191.     ),

  192.     'ship' => array(

  193.       'type' => 'small_package',

  194.       'callback' => 'uc_ups_fulfill_order',

  195.       'pkg_types' => _uc_ups_pkg_types(),

  196.     ),

  197.     'cancel' => 'uc_ups_void_shipment',

  198.     'weight' => $weight['ups'],

  199.   );

  200. 

  201.   return $methods;

  202. }

  203. 

  204. /**

  205.  * Implementation of Übercart's hook_store_status().

  206.  *

  207.  * Let the administrator know that the UPS account information has not been

  208.  * filled out.

  209.  */

  210. function uc_ups_store_status() {

  211.   $messages = array();

  212.   $access = variable_get('uc_ups_access_license', '') != '';

  213.   $account = variable_get('uc_ups_shipper_number', '') != '';

  214.   $user = variable_get('uc_ups_user_id', '') != '';

  215.   $password = variable_get('uc_ups_password', '') != '';

  216.   if ($access && $account && $user && $password) {

  217.     $messages[] = array('status' => 'ok', 'title' => t('UPS Online Tools'),

  218.       'desc' => t('Information needed to access UPS Online Tools has been entered.'),

  219.     );

  220.   }

  221.   else {

  222.     $messages[] = array('status' => 'error', 'title' => t('UPS Online Tools'),

  223.       'desc' => t('More information is needed to access UPS Online Tools. Please enter it <a href="!url">here</a>.', array('!url' => url('admin/store/settings/quotes/methods/ups'))),

  224.     );

  225.   }

  226. 

  227.   return $messages;

  228. }

  229. 

  230. /******************************************************************************

  231.  * Menu Callbacks                                                             *

  232.  ******************************************************************************/

  233. 

  234. /**

  235.  * UPS Online Tool settings.

  236.  *

  237.  * Record UPS account information neccessary to use the service. Allow testing

  238.  * or production mode. Configure which UPS services are quoted to customers.

  239.  *

  240.  * @ingroup forms

  241.  * @see uc_admin_settings_validate

  242.  */

  243. function uc_ups_admin_settings() {

  244.   $form = array();

  245. 

  246.   $form['uc_ups_access_license'] = array('#type' => 'textfield',

  247.     '#title' => t('UPS OnLine Tools XML Access Key'),

  248.     '#default_value' => variable_get('uc_ups_access_license', ''),

  249.     '#required' => true,

  250.   );

  251.   $form['uc_ups_shipper_number'] = array('#type' => 'textfield',

  252.     '#title' => t('UPS Shipper #'),

  253.     '#description' => t('The 6-character string identifying your UPS account as a shipper.'),

  254.     '#default_value' => variable_get('uc_ups_shipper_number', ''),

  255.     '#required' => true,

  256.   );

  257.   $form['uc_ups_user_id'] = array('#type' => 'textfield',

  258.     '#title' => t('UPS.com user ID'),

  259.     '#default_value' => variable_get('uc_ups_user_id', ''),

  260.     '#required' => true,

  261.   );

  262.   $form['uc_ups_password'] = array('#type' => 'password',

  263.     '#title' => t('Password'),

  264.     '#default_value' => variable_get('uc_ups_password', ''),

  265.   );

  266.   $form['uc_ups_connection_address'] = array('#type' => 'select',

  267.     '#title' => t('Mode'),

  268.     '#description' => t('Quotes and shipments requested in Testing mode will not be picked up or charged to your account.'),

  269.     '#options' => array('https://wwwcie.ups.com/ups.app/xml/' => t('Testing'),

  270.       'https://www.ups.com/ups.app/xml/' => t('Production'),

  271.     ),

  272.     '#default_value' => variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/'),

  273.   );

  274.   $form['uc_ups_services'] = array('#type' => 'checkboxes',

  275.     '#title' => t('UPS services'),

  276.     '#default_value' => variable_get('uc_ups_services', _uc_ups_service_list()),

  277.     '#options' => _uc_ups_service_list(),

  278.     '#description' => t('Select the UPS services that are available to customers.'),

  279.   );

  280.   $form['uc_ups_pickup_type'] = array('#type' => 'select',

  281.     '#title' => t('Pickup type'),

  282.     '#options' => array(

  283.       '01' => 'Daily Pickup',

  284.       '03' => 'Customer Counter',

  285.       '06' => 'One Time Pickup',

  286.       '07' => 'On Call Air',

  287.       '11' => 'Suggested Retail Rates',

  288.       '19' => 'Letter Center',

  289.       '20' => 'Air Service Center',

  290.     ),

  291.     '#default_value' => variable_get('uc_ups_pickup_type', '01'),

  292.   );

  293.   $form['uc_ups_classification'] = array('#type' => 'select',

  294.     '#title' => t('UPS Customer classification'),

  295.     '#options' => array(

  296.       '01' => t('Wholesale'),

  297.       '03' => t('Occasional'),

  298.       '04' => t('Retail'),

  299.     ),

  300.     '#default_value' => variable_get('uc_ups_classification', '04'),

  301.     '#description' => t('The kind of customer you are to UPS. For daily pickups the default is wholesale; for customer counter pickups the default is retail; for other pickups the default is occasional.'),

  302.   );

  303.   $form['uc_ups_negotiated_rates'] = array('#type' => 'radios',

  304.     '#title' => t('Negotiated rates'),

  305.     '#default_value' => variable_get('uc_ups_negotiated_rates', 0),

  306.     '#options' => array(1 => t('Yes'), 0 => t('No')),

  307.     '#description' => t('Is your UPS account receiving negotiated rates on shipments?'),

  308.   );

  309.   $form['uc_ups_residential_quotes'] = array('#type' => 'radios',

  310.     '#title' => t('Assume UPS shipping quotes will be delivered to'),

  311.     '#default_value' => variable_get('uc_ups_residential_quotes', 0),

  312.     '#options' => array(

  313.       0 => t('Business locations'),

  314.       1 => t('Residential locations (extra fees)'),

  315.     ),

  316.   );

  317.   $form['uc_ups_markup_type'] = array('#type' => 'select',

  318.     '#title' => t('Markup type'),

  319.     '#default_value' => variable_get('uc_ups_markup_type', 'percentage'),

  320.     '#options' => array(

  321.       'percentage' => t('Percentage (%)'),

  322.       'multiplier' => t('Multiplier (×)'),

  323.       'currency' => t('Addition (!currency)', array('!currency' => variable_get('uc_currency_sign', '$'))),

  324.     ),

  325.   );

  326.   $form['uc_ups_markup'] = array('#type' => 'textfield',

  327.     '#title' => t('Shipping rate markup'),

  328.     '#default_value' => variable_get('uc_ups_markup', '0'),

  329.     '#description' => t('Markup shipping rate quote by currency amount, percentage, or multiplier.'),

  330.   );

  331.   $form['uc_ups_all_in_one'] = array('#type' => 'radios',

  332.     '#title' => t('Product packages'),

  333.     '#default_value' => variable_get('uc_ups_all_in_one', 1),

  334.     '#options' => array(

  335.       0 => t('Each in its own package'),

  336.       1 => t('All in one'),

  337.     ),

  338.     '#description' => t('Indicate whether each product is quoted as shipping separately or all in one package.'),

  339.   );

  340.   $form['uc_ups_unit_system'] = array('#type' => 'select',

  341.     '#title' => t('System of measurement'),

  342.     '#default_value' => variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in')),

  343.     '#options' => array(

  344.       'in' => t('British'),

  345.       'cm' => t('Metric'),

  346.     ),

  347.     '#description' => t('Choose the standard system of measurement for your country.'),

  348.   );

  349.   $form['uc_ups_insurance'] = array(

  350.     '#type' => 'checkbox',

  351.     '#title' => t('Package insurance'),

  352.     '#default_value' => variable_get('uc_ups_insurance', TRUE),

  353.     '#description' => t('When enabled, products are insured for their full value.'),

  354.   );

  355. 

  356.   return system_settings_form($form);

  357. }

  358. 

  359. /**

  360.  * Validation handler for uc_ups_admin_settings.

  361.  *

  362.  * Require password only if it hasn't been set.

  363.  */

  364. function uc_ups_admin_settings_validate($form_id, $form_values, $form) {

  365.   $old_password = variable_get('uc_ups_password', '');

  366.   if (!$form_values['uc_ups_password']) {

  367.     if ($old_password) {

  368.       form_set_value($form['uc_ups_password'], $old_password);

  369.     }

  370.     else {

  371.       form_set_error('uc_ups_password', t('Password field is required.'));

  372.     }

  373.   }

  374. }

  375. 

  376. /******************************************************************************

  377.  * Module Functions                                                           *

  378.  ******************************************************************************/

  379. 

  380. /**

  381.  * Return XML access request to be prepended to all requests to the UPS webservice.

  382.  */

  383. function uc_ups_access_request() {

  384.   $access = variable_get('uc_ups_access_license', '');

  385.   $user = variable_get('uc_ups_user_id', '');

  386.   $password = variable_get('uc_ups_password', '');

  387.   return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>

  388. <AccessRequest xml:lang=\"en-US\">

  389.   <AccessLicenseNumber>$access</AccessLicenseNumber>

  390.   <UserId>$user</UserId>

  391.   <Password>$password</Password>

  392. </AccessRequest>

  393. ";

  394. }

  395. 

  396. /**

  397.  * Construct an XML quote request.

  398.  *

  399.  * @param $packages

  400.  *   Array of packages received from the cart.

  401.  * @param $origin

  402.  *   Delivery origin address information.

  403.  * @param $destination

  404.  *   Delivery destination address information.

  405.  * @param $ups_service

  406.  *   UPS service code (refers to UPS Ground, Next-Day Air, etc.).

  407.  * @return

  408.  *   RatingServiceSelectionRequest XML document to send to UPS

  409.  */

  410. function uc_ups_shipping_quote($packages, $origin, $destination, $ups_service) {

  411.   $store['name'] = variable_get('uc_store_name', NULL);

  412.   $store['owner'] = variable_get('uc_store_owner', NULL);

  413.   $store['email'] = variable_get('uc_store_email', NULL);

  414.   $store['email_from'] = variable_get('uc_store_email', NULL);

  415.   $store['phone'] = variable_get('uc_store_phone', NULL);

  416.   $store['fax'] = variable_get('uc_store_fax', NULL);

  417.   $store['street1'] = variable_get('uc_store_street1', NULL);

  418.   $store['street2'] = variable_get('uc_store_street2', NULL);

  419.   $store['city'] = variable_get('uc_store_city', NULL);

  420.   $store['zone'] = variable_get('uc_store_zone', NULL);

  421.   $store['postal_code'] = variable_get('uc_store_postal_code', NULL);

  422.   $store['country'] = variable_get('uc_store_country', 840);

  423. 

  424.   $account = variable_get('uc_ups_shipper_number', '');

  425.   $ua = explode(' ', $_SERVER['HTTP_USER_AGENT']);

  426.   $user_agent = $ua[0];

  427. 

  428.   $services = _uc_ups_service_list();

  429.   $service = array('code' => $ups_service, 'description' => $services[$ups_service]);

  430. 

  431.   $pkg_types = _uc_ups_pkg_types();

  432. 

  433.   $shipper_zone = uc_get_zone_code($store['zone']);

  434.   $shipper_country = uc_get_country_data(array('country_id' => $store['country']));

  435.   $shipper_country = $shipper_country[0]['country_iso_code_2'];

  436.   $shipper_zip = $store['postal_code'];

  437.   $shipto_zone = uc_get_zone_code($destination->zone);

  438.   $shipto_country = uc_get_country_data(array('country_id' => $destination->country));

  439.   $shipto_country = $shipto_country[0]['country_iso_code_2'];

  440.   $shipto_zip = $destination->postal_code;

  441.   $shipfrom_zone = uc_get_zone_code($origin->zone);

  442.   $shipfrom_country = uc_get_country_data(array('country_id' => $origin->country));

  443.   $shipfrom_country = $shipfrom_country[0]['country_iso_code_2'];

  444.   $shipfrom_zip = $origin->postal_code;

  445. 

  446.   $ups_units = variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'));

  447.   switch ($ups_units) {

  448.     case 'in':

  449.       $units = 'LBS';

  450.       $unit_name = 'Pounds';

  451.       break;

  452.     case 'cm':

  453.       $units = 'KGS';

  454.       $unit_name = 'Kilograms';

  455.       break;

  456.   }

  457. 

  458.   $shipment_weight = 0;

  459.   $package_schema = '';

  460.   foreach ($packages as $package) {

  461.     $qty = $package->qty;

  462.     for ($i = 0; $i < $qty; $i++) {

  463.       $package_type = array('code' => $package->pkg_type, 'description' => $pkg_types[$package->pkg_type]);

  464.       $package_schema .= "<Package>";

  465.         $package_schema .= "<PackagingType>";

  466.           $package_schema .= "<Code>". $package_type['code'] ."</Code>";

  467.           //$package_schema .= "<Description>". $package_type['description'] ."</Description>";

  468.         $package_schema .= "</PackagingType>";

  469.         if ($package->pkg_type == '02' && $package->length && $package->width && $package->height) {

  470.           if ($package->length < $package->width) {

  471.             list($package->length, $package->width) = array($package->width, $package->length);

  472.           }

  473.           $package_schema .= "<Dimensions>";

  474.             $package_schema .= "<UnitOfMeasurement>";

  475.             $conversion = uc_weight_conversion($package->length_units, variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in')));

  476.             $package_schema .= "<Code>". strtoupper(variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'))) ."</Code>";

  477.             $package_schema .= "</UnitOfMeasurement>";

  478.             $package_schema .= "<Length>". number_format($package->length * $conversion, 2, '.', '') ."</Length>";

  479.             $package_schema .= "<Width>". number_format($package->width * $conversion, 2, '.', '') ."</Width>";

  480.             $package_schema .= "<Height>". number_format($package->height * $conversion, 2, '.', '') ."</Height>";

  481.           $package_schema .= "</Dimensions>";

  482.         }

  483.         $size = $package->length * $conversion + 2 * $conversion * ($package->width + $package->height);

  484.         switch ($ups_units) {

  485.           case 'in':

  486.             $conversion = uc_weight_conversion($package->weight_units, 'lb');

  487.             break;

  488.           case 'cm':

  489.             $conversion = uc_weight_conversion($package->weight_units, 'kg');

  490.             break;

  491.         }

  492.         $weight = max(1, $package->weight * $conversion);

  493.         $shipment_weight += $weight;

  494.         $package_schema .= "<PackageWeight>";

  495.           $package_schema .= "<UnitOfMeasurement>";

  496.             $package_schema .= "<Code>$units</Code>";

  497.             $package_schema .= "<Description>$unit_name</Description>";

  498.           $package_schema .= "</UnitOfMeasurement>";

  499.           $package_schema .= "<Weight>". number_format($weight, 1, '.', '') ."</Weight>";

  500.         $package_schema .= "</PackageWeight>";

  501.         if ($size > 130 && $size <= 165) {

  502.           $package_schema .= "<LargePackageIndicator/>";

  503.         }

  504.         if (variable_get('uc_ups_insurance', TRUE)) {

  505.           $package_schema .= "<PackageServiceOptions>";

  506.             $package_schema .= "<InsuredValue>";

  507.               $package_schema .= "<CurrencyCode>". variable_get('uc_currency_code', 'USD') ."</CurrencyCode>";

  508.               $package_schema .= "<MonetaryValue>". $package->price ."</MonetaryValue>";

  509.             $package_schema .= "</InsuredValue>";

  510.           $package_schema .= "</PackageServiceOptions>";

  511.         }

  512.       $package_schema .= "</Package>";

  513.     }

  514.   }

  515. 

  516.   $schema = uc_ups_access_request() ."

  517. <?xml version=\"1.0\" encoding=\"UTF-8\"?>

  518. <RatingServiceSelectionRequest xml:lang=\"en-US\">

  519.   <Request>

  520.     <TransactionReference>

  521.       <CustomerContext>Complex Rate Request</CustomerContext>

  522.       <XpciVersion>1.0001</XpciVersion>

  523.     </TransactionReference>

  524.     <RequestAction>Rate</RequestAction>

  525.     <RequestOption>rate</RequestOption>

  526.   </Request>

  527.   <PickupType>

  528.     <Code>". variable_get('uc_ups_pickup_type', '01') ."</Code>

  529.   </PickupType>

  530.   <CustomerClassification>

  531.     <Code>". variable_get('uc_ups_classification', '04') ."</Code>

  532.   </CustomerClassification>

  533.   <Shipment>

  534.     <Shipper>

  535.       <ShipperNumber>". variable_get('uc_ups_shipper_number', '') ."</ShipperNumber>

  536.       <Address>

  537.         <City>". $store['city'] ."</City>

  538.         <StateProvinceCode>$shipper_zone</StateProvinceCode>

  539.         <PostalCode>$shipper_zip</PostalCode>

  540.         <CountryCode>$shipper_country</CountryCode>

  541.       </Address>

  542.     </Shipper>

  543.     <ShipTo>

  544.       <Address>

  545.         <StateProvinceCode>$shipto_zone</StateProvinceCode>

  546.         <PostalCode>$shipto_zip</PostalCode>

  547.         <CountryCode>$shipto_country</CountryCode>

  548.       ";

  549.       if (variable_get('uc_ups_residential_quotes', 0)) {

  550.         $schema .= "<ResidentialAddressIndicator/>

  551.       ";

  552.       }

  553.       $schema .= "</Address>

  554.     </ShipTo>

  555.     <ShipFrom>

  556.       <Address>

  557.         <StateProvinceCode>$shipfrom_zone</StateProvinceCode>

  558.         <PostalCode>$shipfrom_zip</PostalCode>

  559.         <CountryCode>$shipfrom_country</CountryCode>

  560.       </Address>

  561.     </ShipFrom>

  562.     <ShipmentWeight>

  563.       <UnitOfMeasurement>

  564.         <Code>$units</Code>

  565.         <Description>$unit_name</Description>

  566.       </UnitOfMeasurement>

  567.       <Weight>". number_format($shipment_weight, 1, '.', '') ."</Weight>

  568.     </ShipmentWeight>

  569.     <Service>

  570.       <Code>{$service[code]}</Code>

  571.       <Description>{$service[description]}</Description>

  572.     </Service>

  573.     ";

  574.     $schema .= $package_schema;

  575.     if (variable_get('uc_ups_negotiated_rates', false)) {

  576.       $schema .= "<RateInformation>

  577.           <NegotiatedRatesIndicator/>

  578.         </RateInformation>";

  579.     }

  580.   $schema .= "</Shipment>

  581. </RatingServiceSelectionRequest>";

  582. 

  583.   return $schema;

  584. }

  585. 

  586. /**

  587.  * Construct an XML shippment request.

  588.  *

  589.  * @param $packages

  590.  *   Array of packages received from the cart.

  591.  * @param $origin

  592.  *   Delivery origin address information.

  593.  * @param $destination

  594.  *   Delivery destination address information.

  595.  * @param $ups_service

  596.  *   UPS service code (refers to UPS Ground, Next-Day Air, etc.).

  597.  * @return

  598.  *   ShipConfirm XML document to send to UPS

  599.  */

  600. function uc_ups_shipment_request($packages, $origin, $destination, $ups_service) {

  601.   $store['name'] = variable_get('uc_store_name', NULL);

  602.   $store['owner'] = variable_get('uc_store_owner', NULL);

  603.   $store['email'] = variable_get('uc_store_email', NULL);

  604.   $store['email_from'] = variable_get('uc_store_email', NULL);

  605.   $store['phone'] = variable_get('uc_store_phone', NULL);

  606.   $store['fax'] = variable_get('uc_store_fax', NULL);

  607.   $store['street1'] = variable_get('uc_store_street1', NULL);

  608.   $store['street2'] = variable_get('uc_store_street2', NULL);

  609.   $store['city'] = variable_get('uc_store_city', NULL);

  610.   $store['zone'] = variable_get('uc_store_zone', NULL);

  611.   $store['postal_code'] = variable_get('uc_store_postal_code', NULL);

  612.   $store['country'] = variable_get('uc_store_country', 840);

  613. 

  614.   $account = variable_get('uc_ups_shipper_number', '');

  615.   $ua = explode(' ', $_SERVER['HTTP_USER_AGENT']);

  616.   $user_agent = $ua[0];

  617. 

  618.   $services = _uc_ups_service_list();

  619.   $service = array('code' => $ups_service, 'description' => $services[$ups_service]);

  620. 

  621.   $pkg_types = _uc_ups_pkg_types();

  622. 

  623.   $shipper_zone = uc_get_zone_code($store['zone']);

  624.   $shipper_country = uc_get_country_data(array('country_id' => $store['country']));

  625.   $shipper_country = $shipper_country[0]['country_iso_code_2'];

  626.   $shipper_zip = $store['postal_code'];

  627.   $shipto_zone = uc_get_zone_code($destination->zone);

  628.   $shipto_country = uc_get_country_data(array('country_id' => $destination->country));

  629.   $shipto_country = $shipto_country[0]['country_iso_code_2'];

  630.   $shipto_zip = $destination->postal_code;

  631.   $shipfrom_zone = uc_get_zone_code($origin->zone);

  632.   $shipfrom_country = uc_get_country_data(array('country_id' => $origin->country));

  633.   $shipfrom_country = $shipfrom_country[0]['country_iso_code_2'];

  634.   $shipfrom_zip = $origin->postal_code;

  635. 

  636.   $ups_units = variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'));

  637. 

  638.   $package_schema = '';

  639.   foreach ($packages as $package) {

  640.     $qty = $package->qty;

  641.     for ($i = 0; $i < $qty; $i++) {

  642.       $package_type = array('code' => $package->pkg_type, 'description' => $pkg_types[$package->pkg_type]);

  643.       $package_schema .= "<Package>";

  644.         $package_schema .= "<PackagingType>";

  645.           $package_schema .= "<Code>". $package_type['code'] ."</Code>";

  646.         $package_schema .= "</PackagingType>";

  647.         if ($package->pkg_type == '02' && $package->length && $package->width && $package->height) {

  648.           if ($package->length < $package->width) {

  649.             list($package->length, $package->width) = array($package->width, $package->length);

  650.           }

  651.           $package_schema .= "<Dimensions>";

  652.             $package_schema .= "<UnitOfMeasurement>";

  653.             $conversion = constant(strtoupper($package->length_units) .'_TO_'. strtoupper(variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'))));

  654.             $package_schema .= "<Code>". strtoupper(variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'))) ."</Code>";

  655.             $package_schema .= "</UnitOfMeasurement>";

  656.             $package_schema .= "<Length>". (floor($package->length * $conversion) + 1) ."</Length>";

  657.             $package_schema .= "<Width>". (floor($package->width * $conversion) + 1) ."</Width>";

  658.             $package_schema .= "<Height>". (floor($package->height * $conversion) + 1) ."</Height>";

  659.           $package_schema .= "</Dimensions>";

  660.         }

  661.         $size = $package->length * $conversion + 2 * $conversion * ($package->width + $package->height);

  662.         switch ($ups_units) {

  663.           case 'in':

  664.             $conversion = uc_weight_conversion($package->weight_units, 'lb');

  665.             break;

  666.           case 'cm':

  667.             $conversion = uc_weight_conversion($package->weight_units, 'kg');

  668.             break;

  669.         }

  670.         $weight = $package->weight * $conversion;

  671.         $package_schema .= "<PackageWeight>";

  672.           $package_schema .= "<UnitOfMeasurement>";

  673.             $package_schema .= "<Code>$units</Code>";

  674.             $package_schema .= "<Description>$unit_name</Description>";

  675.           $package_schema .= "</UnitOfMeasurement>";

  676.           $package_schema .= "<Weight>". number_format($weight, 1, '.', '') ."</Weight>";

  677.         $package_schema .= "</PackageWeight>";

  678.         if ($size > 130 && $size <= 165) {

  679.           $package_schema .= "<LargePackageIndicator/>";

  680.         }

  681.         $package_schema .= "<PackageServiceOptions>";

  682.           $package_schema .= "<InsuredValue>";

  683.             $package_schema .= "<CurrencyCode>". variable_get('uc_currency_code', 'USD') ."</CurrencyCode>";

  684.             $package_schema .= "<MonetaryValue>". number_format($package->price, 2, '.', '') ."</MonetaryValue>";

  685.           $package_schema .= "</InsuredValue>";

  686.         $package_schema .= "</PackageServiceOptions>";

  687.       $package_schema .= "</Package>";

  688.     }

  689.   }

  690. 

  691.   $schema = uc_ups_access_request() ."

  692. <?xml version=\"1.0\" encoding=\"UTF-8\"?>

  693. <ShipmentConfirmRequest xml:lang=\"en-US\">

  694.   <Request>

  695.     <TransactionReference>

  696.       <CustomerContext>Complex Rate Request</CustomerContext>

  697.       <XpciVersion>1.0001</XpciVersion>

  698.     </TransactionReference>

  699.     <RequestAction>ShipConfirm</RequestAction>

  700.     <RequestOption>validate</RequestOption>

  701.   </Request>

  702.   <Shipment>";

  703.     $schema .= "<Shipper>";

  704.       $schema .= "<Name>". $store['name'] ."</Name>";

  705.       $schema .= "<ShipperNumber>". variable_get('uc_ups_shipper_number', '') ."</ShipperNumber>";

  706.       if ($store['phone']) {

  707.         $schema .= "<PhoneNumber>". $store['phone'] ."</PhoneNumber>";

  708.       }

  709.       if ($store['fax']) {

  710.         $schema .= "<FaxNumber>". $store['fax'] ."</FaxNumber>";

  711.       }

  712.       if ($store['email']) {

  713.         $schema .= "<EMailAddress>". $store['email'] ."</EMailAddress>";

  714.       }

  715.       $schema .= "<Address>";

  716.         $schema .= "<AddressLine1>". $store['street1'] ."</AddressLine1>";

  717.         if ($store['street2']) {

  718.           $schema .= "<AddressLine2>". $store['street2'] ."</AddressLine2>";

  719.         }

  720.         $schema .= "<City>". $store['city'] ."</City>";

  721.         $schema .= "<StateProvinceCode>$shipper_zone</StateProvinceCode>";

  722.         $schema .= "<PostalCode>$shipper_zip</PostalCode>";

  723.         $schema .= "<CountryCode>$shipper_country</CountryCode>";

  724.       $schema .= "</Address>";

  725.     $schema .= "</Shipper>";

  726.     $schema .= "<ShipTo>";

  727.       $schema .= "<CompanyName>". $destination->company ."</CompanyName>";

  728.       $schema .= "<AttentionName>". $destination->first_name .' '. $destination->last_name ."</AttentionName>";

  729.       $schema .= "<PhoneNumber>". $destination->phone ."</PhoneNumber>";

  730.       $schema .= "<EMailAddress>". $destination->email ."</EMailAddress>";

  731.       $schema .= "<Address>";

  732.         $schema .= "<AddressLine1>". $destination->street1 ."</AddressLine1>";

  733.         if ($destination->street2) {

  734.           $schema .= "<AddressLine2>". $destination->street2 ."</AddressLine2>";

  735.         }

  736.         $schema .= "<City>". $destination->city ."</City>";

  737.         $schema .= "<StateProvinceCode>$shipto_zone</StateProvinceCode>";

  738.         $schema .= "<PostalCode>$shipto_zip</PostalCode>";

  739.         $schema .= "<CountryCode>$shipto_country</CountryCode>";

  740.       if ($destination->residence) {

  741.         $schema .= "<ResidentialAddressIndicator/>";

  742.       }

  743.       $schema .= "</Address>";

  744.     $schema .= "</ShipTo>";

  745.     $schema .= "<ShipFrom>";

  746.       $schema .= "<CompanyName>". $origin->company ."</CompanyName>";

  747.       $schema .= "<AttentionName>". $origin->first_name .' '. $origin->last_name ."</AttentionName>";

  748.       $schema .= "<PhoneNumber>". $origin->phone ."</PhoneNumber>";

  749.       $schema .= "<EMailAddress>". $origin->email ."</EMailAddress>";

  750.       $schema .= "<Address>";

  751.         $schema .= "<AddressLine1>". $origin->street1 ."</AddressLine1>";

  752.         if ($origin->street2) {

  753.           $schema .= "<AddressLine2>". $origin->street2 ."</AddressLine2>";

  754.         }

  755.         $schema .= "<City>". $origin->city ."</City>";

  756.         $schema .= "<StateProvinceCode>$shipfrom_zone</StateProvinceCode>";

  757.         $schema .= "<PostalCode>$shipfrom_zip</PostalCode>";

  758.         $schema .= "<CountryCode>$shipfrom_country</CountryCode>";

  759.       $schema .= "</Address>";

  760.     $schema .= "</ShipFrom>";

  761.     $schema .= "<PaymentInformation>";

  762.       $schema .= "<Prepaid>";

  763.         $schema .= "<BillShipper>";

  764.           $schema .= "<AccountNumber>$account</AccountNumber>";

  765.         $schema .= "</BillShipper>";

  766.       $schema .= "</Prepaid>";

  767.     $schema .= "</PaymentInformation>";

  768.     if (variable_get('uc_ups_negotiated_rates', false)) {

  769.       $schema .= "<RateInformation>

  770.           <NegotiatedRatesIndicator/>

  771.         </RateInformation>";

  772.     }

  773.     $schema .= "<Service>";

  774.       $schema .= "<Code>{$service[code]}</Code>";

  775.       $schema .= "<Description>{$service[description]}</Description>";

  776.     $schema .= "</Service>";

  777.     $schema .= $package_schema;

  778.   $schema .= "</Shipment>";

  779.   $schema .= "<LabelSpecification>";

  780.     $schema .= "<LabelPrintMethod>";

  781.       $schema .= "<Code>GIF</Code>";

  782.     $schema .= "</LabelPrintMethod>";

  783.     $schema .= "<LabelImageFormat>";

  784.       $schema .= "<Code>GIF</Code>";

  785.     $schema .= "</LabelImageFormat>";

  786.   $schema .= "</LabelSpecification>";

  787. $schema .= "</ShipmentConfirmRequest>";

  788. 

  789.   return $schema;

  790. }

  791. 

  792. /**

  793.  * Callback for retrieving a UPS shipping quote.

  794.  *

  795.  * Request a quote for each enabled UPS Service. Therefore, the quote will

  796.  * take longer to display to the user for each option the customer has available.

  797.  *

  798.  * @param $products

  799.  *   Array of cart contents.

  800.  * @param $details

  801.  *   Order details other than product information.

  802.  * @return

  803.  *   JSON object containing rate, error, and debugging information.

  804.  */

  805. function uc_ups_quote($products, $details) {

  806.   include_once(drupal_get_path('module', 'uc_store') .'/includes/simplexml.php');

  807.   $quotes = array();

  808. 

  809.   $method = uc_ups_shipping_method();

  810. 

  811.   $addresses = array((array)variable_get('uc_quote_store_default_address', new stdClass()));

  812.   $key = 0;

  813.   $last_key = 0;

  814.   $packages = array();

  815.   if (variable_get('uc_ups_all_in_one', true) && count($products) > 1) {

  816.     foreach ($products as $product) {

  817.       if ($product->nid) {

  818.         // Packages are grouped by the address from which they will be

  819.         // shipped. We will keep track of the different addresses in an array

  820.         // and use their keys for the array of packages.

  821. 

  822.         $address = (array)uc_quote_get_default_shipping_address($product->nid);

  823.         $key = array_search($address, $addresses);

  824.         if ($key === false) {

  825.           // This is a new address. Increment the address counter $last_key

  826.           // instead of using [] so that it can be used in $packages and

  827.           // $addresses.

  828.           $addresses[++$last_key] = $address;

  829.           $key = $last_key;

  830.         }

  831.       }

  832. 

  833.       // Add this product to the last package from the found address or start

  834.       // a new package.

  835.       if (isset($packages[$key]) && count($packages[$key])) {

  836.         $package = array_pop($packages[$key]);

  837.       }

  838.       else {

  839.         $package = _uc_ups_new_package();

  840.       }

  841. 

  842.       $weight = $product->weight * $product->qty * uc_weight_conversion($product->weight_units, 'lb');

  843. 

  844.       $package->weight += $weight;

  845.       $package->price += $product->price * $product->qty;

  846. 

  847.       $conversion = uc_weight_conversion($product->length_units, 'in');

  848.       $package->length = max($product->length * $conversion, $package->length);

  849.       $package->width = max($product->width * $conversion, $package->width);

  850.       $package->height = max($product->height * $conversion, $package->height);

  851. 

  852.       $packages[$key][] = $package;

  853.     }

  854.     foreach ($packages as $addr_key => $shipment) {

  855.       foreach ($shipment as $key => $package) {

  856.         if (!$package->weight) {

  857.           unset($packages[$addr_key][$key]);

  858.           continue;

  859.         }

  860.         elseif ($package->weight > 150) {

  861.           // UPS has a weight limit on packages of 150 lbs. Pretend the

  862.           // products can be divided into enough packages.

  863.           $qty = floor($package->weight / 150) + 1;

  864.           $package->qty = $qty;

  865.           $package->weight /= $qty;

  866.           $package->price /= $qty;

  867.         }

  868.       }

  869.     }

  870.   }

  871.   else {

  872.     foreach ($products as $product) {

  873.       $key = 0;

  874.       if ($product->nid) {

  875.         $address = (array)uc_quote_get_default_shipping_address($product->nid);

  876.         $key = array_search($address, $addresses);

  877.         if ($key === false) {

  878.           $addresses[++$last_key] = $address;

  879.           $key = $last_key;

  880.         }

  881.       }

  882.       if (!$product->pkg_qty) {

  883.         $product->pkg_qty = 1;

  884.       }

  885.       $num_of_pkgs = (int)($product->qty / $product->pkg_qty);

  886.       if ($num_of_pkgs) {

  887.         $package = drupal_clone($product);

  888.         $package->description = $product->model;

  889.         $package->weight = $product->weight * $product->pkg_qty;

  890.         $package->price = $product->price * $product->pkg_qty;

  891.         $package->qty = $num_of_pkgs;

  892.         $package->pkg_type = $product->ups ? $product->ups['pkg_type'] : '02';

  893.         if ($package->weight) {

  894.           $packages[$key][] = $package;

  895.         }

  896.       }

  897.       $remaining_qty = $product->qty % $product->pkg_qty;

  898.       if ($remaining_qty) {

  899.         $package = drupal_clone($product);

  900.         $package->description = $product->model;

  901.         $package->weight = $product->weight * $remaining_qty;

  902.         $package->price = $product->price * $remaining_qty;

  903.         $package->qty = 1;

  904.         $package->pkg_type = $product->ups ? $product->ups['pkg_type'] : '02';

  905.         if ($package->weight) {

  906.           $packages[$key][] = $package;

  907.         }

  908.       }

  909.     }

  910.   }

  911.   if (!count($packages)) {

  912.     return array();

  913.   }

  914. 

  915.   $dest = (object)$details;

  916. 

  917.   foreach ($packages as $key => $ship_packages) {

  918.     $orig = (object)$addresses[$key];

  919.     $orig->email = variable_get('uc_store_email', '');

  920.     foreach (array_keys(array_filter(variable_get('uc_ups_services', array()))) as $ups_service) {

  921.       $request = uc_ups_shipping_quote($ship_packages, $orig, $dest, $ups_service);

  922.       $resp = drupal_http_request(variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/') .'Rate', array(), 'POST', $request);

  923.       if (user_access('configure quotes') && variable_get('uc_quote_display_debug', false)) {

  924.         $quotes[$ups_service]['debug'] .= /* '<pre>'. print_r($ship_packages, true) .'</pre>' . */ htmlentities($request) .' <br /><br /> '. htmlentities($resp->data);

  925.       }

  926.       $response = new JSimpleXML();

  927.       $response->loadString($resp->data);

  928.       if (isset($response->document->response[0]->error)) {

  929.         foreach ($response->document->response[0]->error as $error) {

  930.           if (user_access('configure quotes') && variable_get('uc_quote_display_debug', false)) {

  931.             $quotes[$ups_service]['error'][] = $error->errorseverity[0]->data() .' '. $error->errorcode[0]->data() .': '. $error->errordescription[0]->data();

  932.           }

  933.           if ($error->errorseverity[0]->data() == 'HardError') {

  934.             // All or nothing quote. If some products can't be shipped by

  935.             // a certain service, no quote is given for that service. If

  936.             // that means no quotes are given at all, they'd better call in.

  937.             unset($quotes[$ups_service]['rate']);

  938.           }

  939.         }

  940.       }

  941.       // if NegotiatedRates exist, quote based on those, otherwise, use TotalCharges

  942.       if (isset($response->document->ratedshipment)) {

  943.         $charge = $response->document->ratedshipment[0]->totalcharges[0];

  944.         if (isset($response->document->ratedshipment[0]->negotiatedrates)) {

  945.           $charge = $response->document->ratedshipment[0]->negotiatedrates[0]->netsummarycharges[0]->grandtotal[0];

  946.         }

  947.         if (!isset($charge->currencycode) || $charge->currencycode[0]->data() == variable_get('uc_currency_code', "USD")) {

  948.           $rate = uc_ups_markup($charge->monetaryvalue[0]->data());

  949.           $quotes[$ups_service]['rate'] += $rate;

  950.         }

  951.       }

  952.     }

  953.   }

  954.   uasort($quotes, 'uc_quote_price_sort');

  955.   foreach ($quotes as $key => $quote) {

  956.     if (isset($quote['rate'])) {

  957.       $quotes[$key]['format'] = uc_currency_format($quote['rate']);

  958.       $quotes[$key]['option_label'] = '<img class="ups_logo" src="'. base_path() . drupal_get_path('module', 'uc_ups') .'/uc_ups_logo.gif" /> '. $method['ups']['quote']['accessorials'][$key] . t(' Rate');

  959.     }

  960.   }

  961. 

  962.   /**

  963.    * Ugly hack to work around PHP bug, details here:

  964.    *   http://bugs.php.net/bug.php?id=23220

  965.    * We strip out errors that look something like:

  966.    *  warning: fread() [function.fread]: SSL fatal protocol error in...

  967.    * Copied from http://drupal.org/node/70915 and then improved by Lyle.

  968.    */

  969.   $messages = drupal_set_message();

  970.   $errors = $messages['error'];

  971.   $total = count($errors);

  972.   for ($i = 0; $i <= $total; $i++) {

  973.     if (strpos($errors[$i], 'SSL: fatal protocol error in')) {

  974.       unset($_SESSION['messages']['error'][$i]);

  975.     }

  976.   }

  977.   if (empty($_SESSION['messages']['error'])) {

  978.     unset($_SESSION['messages']['error']);

  979.   }

  980.   db_query("DELETE FROM {watchdog} WHERE type = 'php' AND message LIKE '%%SSL: fatal protocol error%%'");

  981.   // End of ugly hack.

  982. 

  983.   return $quotes;

  984. }

  985. 

  986. /**

  987.  * Shipment creation callback.

  988.  *

  989.  * Confirm shipment data before requesting a shipping label.

  990.  *

  991.  * @param $order_id

  992.  *   The order id for the shipment.

  993.  * @param $package_ids

  994.  *   Array of package ids to shipped.

  995.  * @ingroup forms

  996.  * @see uc_ups_fulfill_order_submit

  997.  */

  998. function uc_ups_fulfill_order($order_id, $package_ids) {

  999.   $form = array();

  1000.   $pkg_types = _uc_ups_pkg_types();

  1001.   if ($order = uc_order_load($order_id)) {

  1002.     $form['order_id'] = array('#type' => 'value', '#value' => $order_id);

  1003.     $packages = array();

  1004.     $addresses = array();

  1005.     $form['packages'] = array('#tree' => true);

  1006.     foreach ($package_ids as $id) {

  1007.       $package = uc_shipping_package_load($id);

  1008.       if ($package) {

  1009.         foreach ($package->addresses as $address) {

  1010.           if (!in_array($address, $addresses)) {

  1011.             $addresses[] = $address;

  1012.           }

  1013.         }

  1014.         // Create list of products and get a representative product for default values

  1015.         $product_list = array();

  1016.         $declared_value = 0;

  1017.         foreach ($package->products as $product) {

  1018.           $product_list[] = $product->qty .' x '. $product->model;

  1019.           $declared_value += $product->qty * $product->price;

  1020.         }

  1021.         $ups_data = db_fetch_array(db_query("SELECT pkg_type FROM {uc_ups_products} WHERE nid = %d", $product->nid));

  1022.         $product->ups = $ups_data;

  1023.         $pkg_form = array('#type' => 'fieldset',

  1024.           '#title' => t('Package !id', array('!id' => $id)),

  1025.         );

  1026.         $pkg_form['products'] = array('#value' => theme('item_list', $product_list));

  1027.         $pkg_form['package_id'] = array('#type' => 'hidden', '#value' => $id);

  1028.         $pkg_form['pkg_type'] = array('#type' => 'select',

  1029.           '#title' => t('Package type'),

  1030.           '#options' => $pkg_types,

  1031.           '#default_value' => $product->ups['pkg_type'],

  1032.           '#required' => true,

  1033.         );

  1034.         $pkg_form['declared_value'] = array('#type' => 'textfield',

  1035.           '#title' => t('Declared value'),

  1036.           '#default_value' => $declared_value,

  1037.           '#required' => true,

  1038.         );

  1039.         $pkg_type['dimensions'] = array('#type' => 'fieldset',

  1040.           '#title' => t('Dimensions'),

  1041.           '#description' => t('Physical dimensions of the package.'),

  1042.           '#theme' => 'uc_ups_dimensions',

  1043.         );

  1044.         $pkg_form['dimensions']['units'] = array('#type' => 'select',

  1045.           '#title' => t('Units of measurement'),

  1046.           '#options' => array(

  1047.             'in' => t('Inches'),

  1048.             'ft' => t('Feet'),

  1049.             'cm' => t('Centimeters'),

  1050.             'mm' => t('Millimeters'),

  1051.           ),

  1052.           '#default_value' => $product->length_units ? $product->length_units : variable_get('uc_length_unit', 'in'),

  1053.         );

  1054.         $pkg_form['dimensions']['length'] = array('#type' => 'textfield',

  1055.           '#title' => t('Length'),

  1056.           '#default_value' => $product->length,

  1057.         );

  1058.         $pkg_form['dimensions']['width'] = array('#type' => 'textfield',

  1059.           '#title' => t('Width'),

  1060.           '#default_value' => $product->width,

  1061.         );

  1062.         $pkg_form['dimensions']['height'] = array('#type' => 'textfield',

  1063.           '#title' => t('Height'),

  1064.           '#default_value' => $product->height,

  1065.         );

  1066.         $form['packages'][$id] = $pkg_form;

  1067.       }

  1068.     }

  1069. 

  1070.     $form = array_merge($form, uc_shipping_address_form($addresses, $order));

  1071. 

  1072.     foreach (array('delivery_email', 'delivery_last_name', 'delivery_company', 'delivery_street1', 'delivery_city', 'delivery_zone', 'delivery_country', 'delivery_postal_code') as $field) {

  1073.       $form['destination'][$field]['#required'] = true;

  1074.     }

  1075. 

  1076.     $ups_services = _uc_ups_service_list();

  1077.     $services = array_filter(variable_get('uc_ups_services', array()));

  1078.     foreach ($services as $ups_id => $service) {

  1079.       $services[$ups_id] = $ups_services[$ups_id];

  1080.     }

  1081.     if (count($services)) {

  1082.       $form['service'] = array('#type' => 'select',

  1083.         '#title' => t('UPS service'),

  1084.         '#options' => $services,

  1085.       );

  1086.     }

  1087.     $today = getdate();

  1088.     $form['ship_date'] = array('#type' => 'date',

  1089.       '#title' => t('Ship date'),

  1090.       '#default_value' => array('year' => $today['year'], 'month' => $today['mon'], 'day' => $today['mday']),

  1091.     );

  1092.     $form['expected_delivery'] = array('#type' => 'date',

  1093.       '#title' => t('Expected delivery'),

  1094.       '#default_value' => array('year' => $today['year'], 'month' => $today['mon'], 'day' => $today['mday']),

  1095.     );

  1096.     $form['submit'] = array('#type' => 'submit', '#value' => t('Review shipment'));

  1097.   }

  1098.   else {

  1099.     drupal_set_message(t("What? That's not an order id. You can't create a shipment without an order."));

  1100.     drupal_goto('admin/store/orders');

  1101.   }

  1102.   return $form;

  1103. }

  1104. 

  1105. /**

  1106.  * Validation handler for uc_ups_fulfill_order().

  1107.  *

  1108.  * Pass final information into shipment object.

  1109.  *

  1110.  * @see uc_ups_confirm_shipment

  1111.  */

  1112. function uc_ups_fulfill_order_validate($form_id, $form_values) {

  1113.   include_once(drupal_get_path('module', 'uc_store') .'/includes/simplexml.php');

  1114.   $origin = new stdClass();

  1115.   $destination = new stdClass();

  1116.   $packages = array();

  1117.   foreach ($form_values as $key => $value) {

  1118.     if (substr($key, 0, 7) == 'pickup_') {

  1119.       $field = substr($key, 7);

  1120.       $origin->$field = $value;

  1121.     }

  1122.     else if (substr($key, 0, 9) == 'delivery_') {

  1123.       $field = substr($key, 9);

  1124.       $destination->$field = $value;

  1125.     }

  1126.   }

  1127.   $_SESSION['ups'] = array();

  1128.   $_SESSION['ups']['origin'] = $origin;

  1129.   $_SESSION['ups']['destination'] = $destination;

  1130.   foreach ($form_values['packages'] as $id => $pkg_form) {

  1131.     $package = uc_shipping_package_load($id);

  1132.     $package->pkg_type = $pkg_form['pkg_type'];

  1133.     $package->value = $pkg_form['declared_value'];

  1134.     $package->length = $pkg_form['dimensions']['length'];

  1135.     $package->width = $pkg_form['dimensions']['width'];

  1136.     $package->height = $pkg_form['dimensions']['height'];

  1137.     $package->length_units = $pkg_form['dimensions']['units'];

  1138.     $package->qty = 1;

  1139.     $_SESSION['ups']['packages'][$id] = $package;

  1140.   }

  1141.   $_SESSION['ups']['service'] = $form_values['service'];

  1142.   $_SESSION['ups']['ship_date'] = $form_values['ship_date'];

  1143.   $_SESSION['ups']['expected_delivery'] = $form_values['expected_delivery'];

  1144.   $_SESSION['ups']['order_id'] = $form_values['order_id'];

  1145. 

  1146.   $request = uc_ups_shipment_request($_SESSION['ups']['packages'], $origin, $destination, $form_values['service']);

  1147.   //print htmlentities($request);

  1148.   $response_obj = drupal_http_request(variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/') .'ShipConfirm', array(), 'POST', $request);

  1149.   $response = new JSimpleXML();

  1150.   $response->loadString($response_obj->data);

  1151.   //drupal_set_message('<pre>'. htmlentities($response->document->asXML()) .'</pre>');

  1152.   if (is_array($response->document->response[0]->error)) {

  1153.     $error = $response->document->response[0]->error[0];

  1154.     $error_msg = $error->errorseverity[0]->data() .' Error '. $error->errorcode[0]->data() .': '. $error->errordescription[0]->data();

  1155.     drupal_set_message($error_msg, 'error');

  1156.     //drupal_set_message('<pre>'. print_r($_SESSION['ups']['packages'], true) .'</pre>' . htmlentities($request) .' <br /><br /> '. htmlentities($response->data));

  1157.     if ($error->errorseverity[0]->data() == 'Hard') {

  1158.       return null;

  1159.     }

  1160.   }

  1161.   $charge = new stdClass();

  1162.   // if NegotiatedRates exist, quote based on those, otherwise, use TotalCharges

  1163.   if (is_array($response->document->shipmentcharges)) {

  1164.     $charge = $response->document->shipmentcharges[0]->totalcharges[0];

  1165.     $_SESSION['ups']['rate']['type'] = t('Total Charges');

  1166.     if (is_array($response->document->shipmentcharges[0]->negotiatedrates)) {

  1167.       $charge = $response->document->shipmentcharges[0]->negotiatedrates[0]->netsummarycharges[0]->grandtotal[0];

  1168.       $_SESSION['ups']['rate']['type'] = t('Negotiated Rates');

  1169.     }

  1170.   }

  1171.   $_SESSION['ups']['rate']['currency'] = $charge->currencycode[0]->data();

  1172.   $_SESSION['ups']['rate']['amount'] = $charge->monetaryvalue[0]->data();

  1173.   $_SESSION['ups']['digest'] = $response->document->shipmentdigest[0]->data();

  1174. }

  1175. 

  1176. /**

  1177.  * Submit handler for uc_ups_fulfill_order().

  1178.  *

  1179.  * Pass final information into shipment object.

  1180.  *

  1181.  * @see uc_ups_confirm_shipment

  1182.  */

  1183. function uc_ups_fulfill_order_submit($form_id, $form_values) {

  1184.   return 'admin/store/orders/'. $form_values['order_id'] .'/shipments/ups';

  1185. }

  1186. 

  1187. /**

  1188.  * Last chance for user to review shipment.

  1189.  *

  1190.  * @ingroup forms

  1191.  * @see theme_uc_ups_confirm_shipment

  1192.  * @see uc_ups_confirm_shipment_submit

  1193.  */

  1194. function uc_ups_confirm_shipment($order_id) {

  1195.   $form = array();

  1196.   $form['digest'] = array('#type' => 'hidden', '#value' => $_SESSION['ups']['digest']);

  1197.   $form['submit'] = array('#type' => 'submit', '#value' => t('Request Pickup'));

  1198.   return $form;

  1199. }

  1200. 

  1201. /**

  1202.  * Display final shipment information for review.

  1203.  */

  1204. function theme_uc_ups_confirm_shipment($form) {

  1205.   $output = '';

  1206. 

  1207.   $output .= '<div class="shipping_address"><b>'. t('Ship from:') .'</b><br />';

  1208.   $output .= uc_address_format(

  1209.     check_plain($_SESSION['ups']['origin']->first_name),

  1210.     check_plain($_SESSION['ups']['origin']->last_name),

  1211.     check_plain($_SESSION['ups']['origin']->company),

  1212.     check_plain($_SESSION['ups']['origin']->street1),

  1213.     check_plain($_SESSION['ups']['origin']->street2),

  1214.     check_plain($_SESSION['ups']['origin']->city),

  1215.     check_plain($_SESSION['ups']['origin']->zone),

  1216.     check_plain($_SESSION['ups']['origin']->postal_code),

  1217.     check_plain($_SESSION['ups']['origin']->country)

  1218.   );

  1219.   $output .= '<br />'. check_plain($_SESSION['ups']['origin']->email);

  1220.   $output .= '</div>';

  1221. 

  1222.   $output .= '<div class="shipping_address"><b>'. t('Ship to:') .'</b><br />';

  1223.   $output .= uc_address_format(

  1224.     check_plain($_SESSION['ups']['destination']->first_name),

  1225.     check_plain($_SESSION['ups']['destination']->last_name),

  1226.     check_plain($_SESSION['ups']['destination']->company),

  1227.     check_plain($_SESSION['ups']['destination']->street1),

  1228.     check_plain($_SESSION['ups']['destination']->street2),

  1229.     check_plain($_SESSION['ups']['destination']->city),

  1230.     check_plain($_SESSION['ups']['destination']->zone),

  1231.     check_plain($_SESSION['ups']['destination']->postal_code),

  1232.     check_plain($_SESSION['ups']['destination']->country)

  1233.   );

  1234.   $output .= '<br />'. check_plain($_SESSION['ups']['destination']->email);

  1235.   $output .= '</div>';

  1236.   $output .= '<div class="shipment_data">';

  1237.   $method = uc_ups_shipping_method();

  1238.   $output .= '<b>'. $method['ups']['quote']['accessorials'][$_SESSION['ups']['service']] .'</b><br />';

  1239.   $output .= '<i>'. check_plain($_SESSION['ups']['rate']['type']) .'</i>: '. uc_currency_format($_SESSION['ups']['rate']['amount']) .' ('. check_plain($_SESSION['ups']['rate']['currency']) .')<br />';

  1240.   $ship_date = $_SESSION['ups']['ship_date'];

  1241.   $output .= 'Ship date: '. format_date(gmmktime(12, 0, 0, $ship_date['month'], $ship_date['day'], $ship_date['year']), 'custom', variable_get('uc_date_format_default', 'm/d/Y'));

  1242.   $exp_delivery = $_SESSION['ups']['expected_delivery'];

  1243.   $output .= '<br />Expected delivery: '. format_date(gmmktime(12, 0, 0, $exp_delivery['month'], $exp_delivery['day'], $exp_delivery['year']), 'custom', variable_get('uc_date_format_default', 'm/d/Y'));

  1244.   $output .= "</div>\n<br style=\"clear: both;\" />";

  1245.   $output .= drupal_render($form);

  1246.   return $output;

  1247. }

  1248. 

  1249. /**

  1250.  * Submit handler for uc_ups_confirm_shipment().

  1251.  *

  1252.  * Generate label and schedule pickup of the shipment.

  1253.  */

  1254. function uc_ups_confirm_shipment_submit($form_id, $form_values) {

  1255.   include_once(drupal_get_path('module', 'uc_store') .'/includes/simplexml.php');

  1256.   // Request pickup using parameters in form.

  1257.   $order_id = $_SESSION['ups']['order_id'];

  1258.   $packages = array_keys($_SESSION['ups']['packages']);

  1259.   $request = uc_ups_request_pickup($form_values['digest'], $order_id, $packages);

  1260.   $result = drupal_http_request(variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/') .'ShipAccept', array(), 'POST', $request);

  1261.   $response = new JSimpleXML();

  1262.   $response->loadString($result->data);

  1263.   $code = $response->document->response[0]->responsestatuscode[0]->data();

  1264.   if ($code == 0) { // failed request

  1265.     $error = $response->document->response[0]->error[0];

  1266.     $error_severity = $error->errorseverity[0]->data();

  1267.     $error_code = $error->errorcode[0]->data();

  1268.     $error_description = $error->errordescription[0]->data();

  1269.     drupal_set_message(t('(@severity error @code) @description', array('@severity' => $error_severity, '@code' => $error_code, '@description' => $error_description)), 'error');

  1270.     if ($error_severity == 'HardError') {

  1271.       return 'admin/store/orders/'. $order_id .'/shipments/ups/'. implode('/', $packages);

  1272.     }

  1273.   }

  1274. 

  1275.   $shipment = new stdClass();

  1276.   $shipment->order_id = $order_id;

  1277.   $shipment->origin = drupal_clone($_SESSION['ups']['origin']);

  1278.   $shipment->destination = drupal_clone($_SESSION['ups']['destination']);

  1279.   $shipment->packages = $_SESSION['ups']['packages'];

  1280.   $shipment->shipping_method = 'ups';

  1281.   $shipment->accessorials = $_SESSION['ups']['service'];

  1282.   $shipment->carrier = t('UPS');

  1283.   // if NegotiatedRates exist, quote based on those, otherwise, use TotalCharges

  1284.   if (is_array($response->document->shipmentresults[0]->shipmentcharges)) {

  1285.     $charge = $response->document->shipmentresults[0]->shipmentcharges[0]->totalcharges[0];

  1286.     if (is_array($response->document->shipmentresults[0]->negotiatedrates)) {

  1287.       $charge = $response->document->shipmentresults[0]->negotiatedrates[0]->netsummarycharges[0]->grandtotal[0];

  1288.     }

  1289.   }

  1290.   $cost = $charge->monetaryvalue[0]->data();

  1291.   $shipment->cost = $cost;

  1292.   $shipment->tracking_number = $response->document->shipmentresults[0]->shipmentidentificationnumber[0]->data();

  1293.   $ship_date = $_SESSION['ups']['ship_date'];

  1294.   $shipment->ship_date = gmmktime(12, 0, 0, $ship_date['month'], $ship_date['day'], $ship_date['year']);

  1295.   $exp_delivery = $_SESSION['ups']['expected_delivery'];

  1296.   $shipment->expected_delivery = gmmktime(12, 0, 0, $exp_delivery['month'], $exp_delivery['day'], $exp_delivery['year']);

  1297. 

  1298.   foreach ($response->document->shipmentresults[0]->packageresults as $package_results) {

  1299.     $package =& current($shipment->packages);

  1300.     $package->tracking_number = $package_results->trackingnumber[0]->data();

  1301.     $label_image = $package_results->labelimage[0]->graphicimage[0]->data();

  1302.     if (file_check_directory(file_create_path('ups_labels'), FILE_CREATE_DIRECTORY)) {

  1303.       $label_path = file_create_path('ups_labels') .'/label'. $package->tracking_number .'.gif';

  1304.       if ($label_file = fopen($label_path, 'wb')) {

  1305.         fwrite($label_file, base64_decode($label_image));

  1306.         fclose($label_file);

  1307.         $package->label_image = $label_path;

  1308.       }

  1309.       else {

  1310.         drupal_set_message(t('Could not open a file to save the label image.'), 'error');

  1311.       }

  1312.     }

  1313.     else {

  1314.       drupal_set_message(t('Could not find or create the directory "ups_labels" in the file system path.'), 'error');

  1315.     }

  1316.     unset($package);

  1317.     next($shipment->packages);

  1318.   }

  1319. 

  1320.   uc_shipping_shipment_save($shipment);

  1321. 

  1322.   unset($_SESSION['ups']);

  1323.   return 'admin/store/orders/'. $order_id .'/shipments';

  1324. }

  1325. 

  1326. /**

  1327.  * Construct an XML label and pickup request.

  1328.  *

  1329.  * @param $digest

  1330.  *   Base-64 encoded shipment request.

  1331.  * @param $order_id

  1332.  *   The order id of the shipment.

  1333.  * @param $packages

  1334.  *   An array of package ids to be shipped.

  1335.  * @return

  1336.  *   ShipmentAcceptRequest XML document to send to UPS.

  1337.  */

  1338. function uc_ups_request_pickup($digest, $order_id = 0, $packages = array()) {

  1339.   $packages = (array)$packages;

  1340. 

  1341.   $schema = uc_ups_access_request();

  1342.   $schema .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>

  1343. <ShipmentAcceptRequest>

  1344.   <Request>

  1345.     <RequestAction>ShipAccept</RequestAction>";

  1346.     if ($order_id || count($packages)) {

  1347.       $schema .= "\n<TransactionReference>

  1348.       <CustomerContext>";

  1349.       if ($order_id) {

  1350.         $schema .= "<OrderId>". $order_id ."</OrderId>\n";

  1351.       }

  1352.       foreach ($packages as $pkg_id) {

  1353.         $schema .= "<PackageId>". $pkg_id ."</PackageId>\n";

  1354.       }

  1355.       $schema .= "</CustomerContext>\n</TransactionReference>\n";

  1356.     }

  1357.   $schema .= "  </Request>

  1358.   <ShipmentDigest>". $digest ."</ShipmentDigest>

  1359. </ShipmentAcceptRequest>";

  1360. 

  1361.   //drupal_set_message('<pre>'. htmlentities($schema) .'</pre>');

  1362.   return $schema;

  1363. }

  1364. 

  1365. /**

  1366.  * Display the shipping label for printing.

  1367.  *

  1368.  * Each argument is a component of the file path to the image.

  1369.  *

  1370.  * @ingroup themeable

  1371.  */

  1372. function theme_uc_ups_label_image() {

  1373.   $args = func_get_args();

  1374.   $image_path = implode('/', $args);

  1375.   print '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.2//EN">

  1376. <html><head><title>

  1377. View/Print Label</title></head><style>

  1378.     .small_text {font-size: 80%;}

  1379.     .large_text {font-size: 115%;}

  1380. </style>

  1381. <body bgcolor="#FFFFFF">

  1382. <table border="0" cellpadding="0" cellspacing="0" width="600"><tr>

  1383. <td height="410" align="left" valign="top">

  1384. <b class="large_text">View/Print Label</b>

  1385. &nbsp;<br />

  1386. <ol class="small_text"> <li><b>Print the label:</b> &nbsp;

  1387. Select Print from the File menu in this browser window to print the label below.<br /><br /><li><b>

  1388. Fold the printed label at the dotted line.</b> &nbsp;

  1389. Place the label in a UPS Shipping Pouch. If you do not have a pouch, affix the folded label using clear plastic shipping tape over the entire label.<br /><br /><li><b>GETTING YOUR SHIPMENT TO UPS<br />

  1390. Customers without a Daily Pickup</b><ul><li>Ground, 3 Day Select, and Standard to Canada shipments must be dropped off at an authorized UPS location, or handed to a UPS driver. Pickup service is not available for these services. To find the nearest drop-off location, select the Drop-off icon from the UPS tool bar.<li>

  1391. Air shipments (including Worldwide Express and Expedited) can be picked up or dropped off. To schedule a pickup, or to find a drop-off location, select the Pickup or Drop-off icon from the UPS tool bar.  </ul> <br />

  1392. <b>Customers with a Daily Pickup</b><ul><li>

  1393. Your driver will pickup your shipment(s) as usual. </ul>

  1394. </ol></td></tr></table><table border="0" cellpadding="0" cellspacing="0" width="600">

  1395. <tr>

  1396. <td class="small_text" align="left" valign="top">

  1397. &nbsp;&nbsp;&nbsp;

  1398. FOLD HERE</td>

  1399. </tr>

  1400. <tr>

  1401. <td align="left" valign="top"><hr />

  1402. </td>

  1403. </tr>

  1404. </table>

  1405. 

  1406. <table>

  1407. <tr>

  1408. <td height="10">&nbsp;

  1409. </td>

  1410. </tr>

  1411. </table>

  1412. 

  1413. <table border="0" cellpadding="0" cellspacing="0" width="650" ><tr>

  1414. <td align="left" valign="top">

  1415. <img src="'. base_path() . $image_path .'" height="392" width="672">

  1416. </td>

  1417. </tr></table>

  1418. </body>

  1419. </html>';

  1420. 

  1421.   exit();

  1422. }

  1423. 

  1424. function uc_ups_void_shipment_request($shipment_number, $tracking_numbers = array()) {

  1425.   $schema = uc_ups_access_request();

  1426.   $schema .= '<?xml version="1.0"?>';

  1427.   $schema .= '<VoidShipmentRequest>';

  1428.   $schema .= '<Request>';

  1429.     $schema .= '<RequestAction>Void</RequestAction>';

  1430.     $schema .= '<TransactionReference>';

  1431.       $schema .= '<CustomerContext>';

  1432.       $schema .= t('Void shipment @ship_number and tracking numbers @track_list', array('@ship_number' => $shipment_number, '@track_list' => implode(', ', $tracking_numbers)));

  1433.       $schema .= '</CustomerContext>';

  1434.       $schema .= '<XpciVersion>1.0</XpciVersion>';

  1435.     $schema .= '</TransactionReference>';

  1436.   $schema .= '</Request>';

  1437.   $schema .= '<ExpandedVoidShipment>';

  1438.     $schema .= '<ShipmentIdentificationNumber>'. $shipment_number .'</ShipmentIdentificationNumber>';

  1439.     foreach ($tracking_numbers as $number) {

  1440.       $schema .= '<TrackingNumber>'. $number .'</TrackingNumber>';

  1441.     }

  1442.   $schema .= '</ExpandedVoidShipment>';

  1443.   $schema .= '</VoidShipmentRequest>';

  1444.   return $schema;

  1445. }

  1446. 

  1447. function uc_ups_void_shipment($shipment_number, $tracking_numbers = array()) {

  1448.   include_once(drupal_get_path('module', 'uc_store') .'/includes/simplexml.php');

  1449.   $success = false;

  1450.   $request = uc_ups_void_shipment_request($shipment_number, $tracking_numbers);

  1451.   $resp = drupal_http_request(variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/') .'Void', array(), 'POST', $request);

  1452.   $response = new JSimpleXML();

  1453.   $response->loadString($resp->data);

  1454.   if (is_array($response->document->response)) {

  1455.     if (is_array($response->document->response[0]->responsestatuscode)) {

  1456.       $success = $response->document->response[0]->responsestatuscode[0]->data();

  1457.     }

  1458.     if (is_array($response->document->response[0]->error)) {

  1459.       foreach ($response->document->response[0]->error as $error) {

  1460.         drupal_set_message($error->errorseverity[0]->data() .' '. $error->errorcode[0]->data() .': '. $error->errordescription[0]->data(), 'error');

  1461.       }

  1462.     }

  1463.   }

  1464.   if (is_array($response->document->status)) {

  1465.     if (is_array($response->document->status[0]->statustype)) {

  1466.       $success = $response->document->status[0]->statustype[0]->code[0]->data();

  1467.     }

  1468.   }

  1469.   return (bool)$success;

  1470. }

  1471. 

  1472. /**

  1473.  * Modify the rate received from UPS before displaying to the customer.

  1474.  */

  1475. function uc_ups_markup($rate) {

  1476.   $markup = variable_get('uc_ups_markup', '0');

  1477.   $type = variable_get('uc_ups_markup_type', 'percentage');

  1478.   if (is_numeric(trim($markup))) {

  1479.     switch ($type) {

  1480.       case 'percentage':

  1481.         return $rate + $rate * floatval(trim($markup)) / 100;

  1482.       case 'multiplier':

  1483.         return $rate * floatval(trim($markup));

  1484.       case 'currency':

  1485.         return $rate + floatval(trim($markup));

  1486.     }

  1487.   }

  1488.   else {

  1489.     return $rate;

  1490.   }

  1491. }

  1492. 

  1493. /**

  1494.  * Convenience function to get UPS codes for their services.

  1495.  */

  1496. function _uc_ups_service_list() {

  1497.   return array(

  1498.     '03' => t('UPS Ground'),

  1499.     '11' => t('UPS Standard'),

  1500.     '01' => t('UPS Next Day Air'),

  1501.     '13' => t('UPS Next Day Air Saver'),

  1502.     '14' => t('UPS Next Day Early A.M.'),

  1503.     '02' => t('UPS 2nd Day Air'),

  1504.     '59' => t('UPS 2nd Day Air A.M.'),

  1505.     '12' => t('UPS 3-Day Select'),

  1506.   );

  1507. }

  1508. 

  1509. /**

  1510.  * Convenience function to get UPS codes for their package types.

  1511.  */

  1512. function _uc_ups_pkg_types() {

  1513.   return array(

  1514.     '01' => t('UPS Letter'),

  1515.     '02' => t('Customer Supplied Package'),

  1516.     '03' => t('Tube'),

  1517.     '04' => t('PAK'),

  1518.     '21' => t('UPS Express Box'),

  1519.     '24' => t('UPS 25KG Box'),

  1520.     '25' => t('UPS 10KG Box'),

  1521.     '30' => t('Pallet'),

  1522.   );

  1523. }

  1524. 

  1525. function _uc_ups_new_package() {

  1526.   $package = new stdClass();

  1527. 

  1528.   $package->weight = 0;

  1529.   $package->price = 0;

  1530. 

  1531.   $package->length = 0;

  1532.   $package->width = 0;

  1533.   $package->height = 0;

  1534. 

  1535.   $package->length_units = 'in';

  1536.   $package->weight_units = 'lb';

  1537.   $package->qty = 1;

  1538.   $package->pkg_type = '02';

  1539. 

  1540.   return $package;

  1541. }

  1542.