uc_ups.ship.inc in Ubercart 6.2
Same filename and directory in other branches
UPS functions for label generation.
File
shipping/uc_ups/uc_ups.ship.incView source
<?php
/**
* @file
* UPS functions for label generation.
*/
/**
* Shipment creation callback.
*
* Confirms shipment data before requesting a shipping label.
*
* @param $order_id
* The order id for the shipment.
* @param $package_ids
* Array of package ids to shipped.
*
* @see uc_ups_fulfill_order_validate()
* @see uc_ups_fulfill_order_submit()
* @ingroup forms
*/
function uc_ups_fulfill_order($form_state, $order, $package_ids) {
$form = array();
$pkg_types = _uc_ups_pkg_types();
$form['order_id'] = array(
'#type' => 'value',
'#value' => $order->order_id,
);
$packages = array();
$addresses = array();
// Container for package data
$form['packages'] = array(
'#type' => 'fieldset',
'#title' => t('Packages'),
'#collapsible' => TRUE,
'#tree' => TRUE,
);
foreach ($package_ids as $id) {
$package = uc_shipping_package_load($id);
if ($package) {
foreach ($package->addresses as $address) {
if (!in_array($address, $addresses)) {
$addresses[] = $address;
}
}
// Create list of products and get a representative product (last one in
// the loop) to use for some default values
$product_list = array();
$declared_value = 0;
foreach ($package->products as $product) {
$product_list[] = $product->qty . ' x ' . $product->model;
$declared_value += $product->qty * $product->price;
}
// Use last product in package to determine package type
$ups_data = db_fetch_array(db_query("SELECT pkg_type FROM {uc_ups_products} WHERE nid = %d", $product->nid));
$product->ups = $ups_data;
$pkg_form = array(
'#type' => 'fieldset',
'#title' => t('Package !id', array(
'!id' => $id,
)),
);
$pkg_form['products'] = array(
'#value' => theme('item_list', $product_list),
);
$pkg_form['package_id'] = array(
'#type' => 'hidden',
'#value' => $id,
);
$pkg_form['pkg_type'] = array(
'#type' => 'select',
'#title' => t('Package type'),
'#options' => $pkg_types,
'#default_value' => $product->ups['pkg_type'],
'#required' => TRUE,
);
$pkg_form['declared_value'] = array(
'#type' => 'textfield',
'#title' => t('Declared value'),
'#default_value' => $declared_value,
'#required' => TRUE,
);
$pkg_form['weight'] = array(
'#type' => 'fieldset',
'#title' => t('Weight'),
'#description' => t('Weight of the package. Default value is sum of product weights in the package.'),
'#weight' => 15,
'#theme' => 'uc_shipping_package_dimensions',
);
$pkg_form['weight']['weight'] = array(
'#type' => 'textfield',
'#title' => t('Weight'),
'#default_value' => isset($package->weight) ? $package->weight : 0,
'#size' => 10,
'#maxlength' => 15,
);
$pkg_form['weight']['units'] = array(
'#type' => 'select',
'#title' => t('Units'),
'#options' => array(
'lb' => t('Pounds'),
'kg' => t('Kilograms'),
'oz' => t('Ounces'),
'g' => t('Grams'),
),
'#default_value' => isset($package->weight_units) ? $package->weight_units : variable_get('uc_weight_unit', 'lb'),
);
$pkg_form['dimensions'] = array(
'#type' => 'fieldset',
'#title' => t('Dimensions'),
'#description' => t('Physical dimensions of the package.'),
'#weight' => 20,
'#theme' => 'uc_shipping_package_dimensions',
);
$pkg_form['dimensions']['length'] = array(
'#type' => 'textfield',
'#title' => t('Length'),
'#default_value' => isset($product->length) ? $product->length : 1,
'#size' => 8,
);
$pkg_form['dimensions']['width'] = array(
'#type' => 'textfield',
'#title' => t('Width'),
'#default_value' => isset($product->width) ? $product->width : 1,
'#size' => 8,
);
$pkg_form['dimensions']['height'] = array(
'#type' => 'textfield',
'#title' => t('Height'),
'#default_value' => isset($product->height) ? $product->height : 1,
'#size' => 8,
);
$pkg_form['dimensions']['units'] = array(
'#type' => 'select',
'#title' => t('Units of measurement'),
'#options' => array(
'in' => t('Inches'),
'ft' => t('Feet'),
'cm' => t('Centimeters'),
'mm' => t('Millimeters'),
),
'#default_value' => isset($product->length_units) ? $product->length_units : variable_get('uc_length_unit', 'in'),
);
$form['packages'][$id] = $pkg_form;
}
}
$form = array_merge($form, uc_shipping_address_form($form_state, $addresses, $order));
foreach (array(
'delivery_email',
'delivery_last_name',
'delivery_street1',
'delivery_city',
'delivery_country',
'delivery_postal_code',
) as $field) {
$form['destination'][$field]['#required'] = TRUE;
}
// Determine shipping option chosen by the customer
$method = $order->quote['method'];
$methods = module_invoke_all('shipping_method');
if (isset($methods[$method])) {
$services = $methods[$method]['quote']['accessorials'];
$method = $services[$order->quote['accessorials']];
}
// Container for shipment data
$form['shipment'] = array(
'#type' => 'fieldset',
'#title' => t('Shipment data'),
'#collapsible' => TRUE,
);
// Inform user of customer's shipping choice
$form['shipment']['shipping_choice'] = array(
'#type' => 'markup',
'#prefix' => '<div>',
'#value' => t('Customer selected "@method" as the shipping method and paid @rate', array(
'@method' => $method,
'@rate' => uc_currency_format($order->quote['rate']),
)),
'#suffix' => '</div>',
);
// Pass shipping charge paid information on to validation function so it
// can be displayed alongside actual costs
$form['shipment']['paid'] = array(
'#type' => 'value',
'#value' => uc_currency_format($order->quote['rate']),
);
$services = _uc_ups_service_list();
$default_service = '';
if ($method == 'ups') {
$default_service = $order->quote['accessorials'];
}
$form['shipment']['service'] = array(
'#type' => 'select',
'#title' => t('UPS service'),
'#options' => $services,
'#default_value' => $default_service,
);
$today = getdate();
$form['shipment']['ship_date'] = array(
'#type' => 'date',
'#title' => t('Ship date'),
'#default_value' => array(
'year' => $today['year'],
'month' => $today['mon'],
'day' => $today['mday'],
),
);
$form['shipment']['expected_delivery'] = array(
'#type' => 'date',
'#title' => t('Expected delivery'),
'#default_value' => array(
'year' => $today['year'],
'month' => $today['mon'],
'day' => $today['mday'],
),
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Review shipment'),
);
return $form;
}
/**
* Passes final information into shipment object.
*
* @see uc_ups_fulfill_order()
* @see uc_ups_confirm_shipment()
*/
function uc_ups_fulfill_order_validate($form, &$form_state) {
$errors = form_get_errors();
if (isset($errors)) {
// Some required elements are missing - don't bother with making
// a UPS API call until that gets fixed.
return;
}
$origin = new stdClass();
$destination = new stdClass();
$packages = array();
foreach ($form_state['values'] as $key => $value) {
if (substr($key, 0, 7) == 'pickup_') {
$field = substr($key, 7);
$origin->{$field} = $value;
}
elseif (substr($key, 0, 9) == 'delivery_') {
$field = substr($key, 9);
$destination->{$field} = $value;
}
}
$_SESSION['ups'] = array();
$_SESSION['ups']['origin'] = $origin;
if (empty($destination->company)) {
$destination->company = $destination->first_name . ' ' . $destination->last_name;
}
// Determine if address is Residential or Commercial
$destination->residential = variable_get('uc_ups_residential_quotes', FALSE);
$_SESSION['ups']['destination'] = $destination;
foreach ($form_state['values']['packages'] as $id => $pkg_form) {
$package = uc_shipping_package_load($id);
$package->pkg_type = $pkg_form['pkg_type'];
$package->value = $pkg_form['declared_value'];
$package->length = $pkg_form['dimensions']['length'];
$package->width = $pkg_form['dimensions']['width'];
$package->height = $pkg_form['dimensions']['height'];
$package->length_units = $pkg_form['dimensions']['units'];
$package->qty = 1;
$_SESSION['ups']['packages'][$id] = $package;
}
$_SESSION['ups']['service'] = $form_state['values']['service'];
$_SESSION['ups']['paid'] = $form_state['values']['paid'];
$_SESSION['ups']['ship_date'] = $form_state['values']['ship_date'];
$_SESSION['ups']['expected_delivery'] = $form_state['values']['expected_delivery'];
$_SESSION['ups']['order_id'] = $form_state['values']['order_id'];
$request = uc_ups_shipment_request($_SESSION['ups']['packages'], $origin, $destination, $form_state['values']['service']);
//print htmlentities($request);
$response_obj = drupal_http_request(variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/') . 'ShipConfirm', array(), 'POST', $request);
$response = new SimpleXMLElement($response_obj->data);
//drupal_set_message('<pre>'. htmlentities($response->asXML()) .'</pre>');
if (isset($response->Response->Error)) {
$error = $response->Response->Error;
$error_msg = (string) $error->ErrorSeverity . ' Error ' . (string) $error->ErrorCode . ': ' . (string) $error->ErrorDescription;
//drupal_set_message('<pre>'. print_r($_SESSION['ups']['packages'], TRUE) .'</pre>' . htmlentities($request) .' <br /><br /> '. htmlentities($response->data));
if (strpos((string) $error->ErrorSeverity, 'Hard') !== FALSE) {
form_set_error('', $error_msg);
return FALSE;
}
else {
drupal_set_message($error_msg, 'error');
}
}
$charge = new stdClass();
// if NegotiatedRates exist, quote based on those, otherwise, use TotalCharges
if (isset($response->ShipmentCharges)) {
$charge = $response->ShipmentCharges->TotalCharges;
$_SESSION['ups']['rate']['type'] = t('Total Charges');
if (isset($response->NegotiatedRates)) {
$charge = $response->NegotiatedRates->NetSummaryCharges->GrandTotal;
$_SESSION['ups']['rate']['type'] = t('Negotiated Rates');
}
}
$_SESSION['ups']['rate']['currency'] = (string) $charge->CurrencyCode;
$_SESSION['ups']['rate']['amount'] = (string) $charge->MonetaryValue;
$_SESSION['ups']['digest'] = (string) $response->ShipmentDigest;
}
/**
* Passes final information into shipment object.
*
* @see uc_ups_fulfill_order()
* @see uc_ups_confirm_shipment()
*/
function uc_ups_fulfill_order_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/store/orders/' . $form_state['values']['order_id'] . '/shipments/ups';
}
/**
* Constructs an XML shipment request.
*
* @param $packages
* Array of packages received from the cart.
* @param $origin
* Delivery origin address information.
* @param $destination
* Delivery destination address information.
* @param $ups_service
* UPS service code (refers to UPS Ground, Next-Day Air, etc.).
*
* @return
* ShipConfirm XML document to send to UPS.
*/
function uc_ups_shipment_request($packages, $origin, $destination, $ups_service) {
$store['name'] = variable_get('uc_store_name', NULL);
$store['owner'] = variable_get('uc_store_owner', NULL);
$store['email'] = uc_store_email();
$store['email_from'] = uc_store_email();
$store['phone'] = variable_get('uc_store_phone', NULL);
$store['fax'] = variable_get('uc_store_fax', NULL);
$store['street1'] = variable_get('uc_store_street1', NULL);
$store['street2'] = variable_get('uc_store_street2', NULL);
$store['city'] = variable_get('uc_store_city', NULL);
$store['zone'] = variable_get('uc_store_zone', NULL);
$store['postal_code'] = variable_get('uc_store_postal_code', NULL);
$store['country'] = variable_get('uc_store_country', 840);
$account = variable_get('uc_ups_shipper_number', '');
$ua = explode(' ', $_SERVER['HTTP_USER_AGENT']);
$user_agent = $ua[0];
$services = _uc_ups_service_list();
$service = array(
'code' => $ups_service,
'description' => $services[$ups_service],
);
$pkg_types = _uc_ups_pkg_types();
$shipper_zone = uc_get_zone_code($store['zone']);
$shipper_country = uc_get_country_data(array(
'country_id' => $store['country'],
));
$shipper_country = $shipper_country[0]['country_iso_code_2'];
$shipper_zip = $store['postal_code'];
$shipto_zone = uc_get_zone_code($destination->zone);
$shipto_country = uc_get_country_data(array(
'country_id' => $destination->country,
));
$shipto_country = $shipto_country[0]['country_iso_code_2'];
$shipto_zip = $destination->postal_code;
$shipfrom_zone = uc_get_zone_code($origin->zone);
$shipfrom_country = uc_get_country_data(array(
'country_id' => $origin->country,
));
$shipfrom_country = $shipfrom_country[0]['country_iso_code_2'];
$shipfrom_zip = $origin->postal_code;
$ups_units = variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'));
$package_schema = '';
foreach ($packages as $package) {
// Determine length conversion factor and weight conversion factor
// for this shipment
$length_factor = uc_length_conversion($package->length_units, variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in')));
switch ($ups_units) {
case 'in':
$weight_factor = uc_weight_conversion($package->weight_units, 'lb');
break;
case 'cm':
$weight_factor = uc_weight_conversion($package->weight_units, 'kg');
break;
}
$qty = $package->qty;
for ($i = 0; $i < $qty; $i++) {
$package_type = array(
'code' => $package->pkg_type,
'description' => $pkg_types[$package->pkg_type],
);
$package_schema .= "<Package>";
$package_schema .= "<PackagingType>";
$package_schema .= "<Code>" . $package_type['code'] . "</Code>";
$package_schema .= "</PackagingType>";
if ($package->pkg_type == '02' && $package->length && $package->width && $package->height) {
if ($package->length < $package->width) {
list($package->length, $package->width) = array(
$package->width,
$package->length,
);
}
$package_schema .= "<Dimensions>";
$package_schema .= "<UnitOfMeasurement>";
$package_schema .= "<Code>" . strtoupper(variable_get('uc_ups_unit_system', variable_get('uc_length_unit', 'in'))) . "</Code>";
$package_schema .= "</UnitOfMeasurement>";
$package_schema .= "<Length>" . (floor($package->length * $length_factor) + 1) . "</Length>";
$package_schema .= "<Width>" . (floor($package->width * $length_factor) + 1) . "</Width>";
$package_schema .= "<Height>" . (floor($package->height * $length_factor) + 1) . "</Height>";
$package_schema .= "</Dimensions>";
}
$size = $package->length * $length_factor + 2 * $length_factor * ($package->width + $package->height);
$weight = max(1, $package->weight * $weight_factor);
$package_schema .= "<PackageWeight>";
$package_schema .= "<UnitOfMeasurement>";
$package_schema .= "<Code>" . $units . "</Code>";
$package_schema .= "<Description>" . $unit_name . "</Description>";
$package_schema .= "</UnitOfMeasurement>";
$package_schema .= "<Weight>" . number_format($weight, 1, '.', '') . "</Weight>";
$package_schema .= "</PackageWeight>";
if ($size > 130 && $size <= 165) {
$package_schema .= "<LargePackageIndicator/>";
}
$package_schema .= "<PackageServiceOptions>";
$package_schema .= "<InsuredValue>";
$package_schema .= "<CurrencyCode>" . variable_get('uc_currency_code', 'USD') . "</CurrencyCode>";
$package_schema .= "<MonetaryValue>" . number_format($package->value, 2, '.', '') . "</MonetaryValue>";
$package_schema .= "</InsuredValue>";
$package_schema .= "</PackageServiceOptions>";
$package_schema .= "</Package>";
}
}
$schema = uc_ups_access_request() . "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ShipmentConfirmRequest xml:lang=\"en-US\">\n <Request>\n <TransactionReference>\n <CustomerContext>Complex Rate Request</CustomerContext>\n <XpciVersion>1.0001</XpciVersion>\n </TransactionReference>\n <RequestAction>ShipConfirm</RequestAction>\n <RequestOption>validate</RequestOption>\n </Request>\n <Shipment>";
$schema .= "<Shipper>";
$schema .= "<Name>" . $store['name'] . "</Name>";
$schema .= "<ShipperNumber>" . variable_get('uc_ups_shipper_number', '') . "</ShipperNumber>";
if ($store['phone']) {
$schema .= "<PhoneNumber>" . $store['phone'] . "</PhoneNumber>";
}
if ($store['fax']) {
$schema .= "<FaxNumber>" . $store['fax'] . "</FaxNumber>";
}
if ($store['email']) {
$schema .= "<EMailAddress>" . $store['email'] . "</EMailAddress>";
}
$schema .= "<Address>";
$schema .= "<AddressLine1>" . $store['street1'] . "</AddressLine1>";
if ($store['street2']) {
$schema .= "<AddressLine2>" . $store['street2'] . "</AddressLine2>";
}
$schema .= "<City>" . $store['city'] . "</City>";
$schema .= "<StateProvinceCode>{$shipper_zone}</StateProvinceCode>";
$schema .= "<PostalCode>{$shipper_zip}</PostalCode>";
$schema .= "<CountryCode>{$shipper_country}</CountryCode>";
$schema .= "</Address>";
$schema .= "</Shipper>";
$schema .= "<ShipTo>";
$schema .= "<CompanyName>" . $destination->company . "</CompanyName>";
$schema .= "<AttentionName>" . $destination->first_name . ' ' . $destination->last_name . "</AttentionName>";
$schema .= "<PhoneNumber>" . $destination->phone . "</PhoneNumber>";
$schema .= "<EMailAddress>" . $destination->email . "</EMailAddress>";
$schema .= "<Address>";
$schema .= "<AddressLine1>" . $destination->street1 . "</AddressLine1>";
if ($destination->street2) {
$schema .= "<AddressLine2>" . $destination->street2 . "</AddressLine2>";
}
$schema .= "<City>" . $destination->city . "</City>";
$schema .= "<StateProvinceCode>{$shipto_zone}</StateProvinceCode>";
$schema .= "<PostalCode>{$shipto_zip}</PostalCode>";
$schema .= "<CountryCode>{$shipto_country}</CountryCode>";
if ($destination->residential) {
$schema .= "<ResidentialAddressIndicator/>";
}
$schema .= "</Address>";
$schema .= "</ShipTo>";
$schema .= "<ShipFrom>";
$schema .= "<CompanyName>" . $origin->company . "</CompanyName>";
$schema .= "<AttentionName>" . $origin->first_name . ' ' . $origin->last_name . "</AttentionName>";
$schema .= "<PhoneNumber>" . $origin->phone . "</PhoneNumber>";
$schema .= "<EMailAddress>" . $origin->email . "</EMailAddress>";
$schema .= "<Address>";
$schema .= "<AddressLine1>" . $origin->street1 . "</AddressLine1>";
if ($origin->street2) {
$schema .= "<AddressLine2>" . $origin->street2 . "</AddressLine2>";
}
$schema .= "<City>" . $origin->city . "</City>";
$schema .= "<StateProvinceCode>{$shipfrom_zone}</StateProvinceCode>";
$schema .= "<PostalCode>{$shipfrom_zip}</PostalCode>";
$schema .= "<CountryCode>{$shipfrom_country}</CountryCode>";
$schema .= "</Address>";
$schema .= "</ShipFrom>";
$schema .= "<PaymentInformation>";
$schema .= "<Prepaid>";
$schema .= "<BillShipper>";
$schema .= "<AccountNumber>{$account}</AccountNumber>";
$schema .= "</BillShipper>";
$schema .= "</Prepaid>";
$schema .= "</PaymentInformation>";
if (variable_get('uc_ups_negotiated_rates', FALSE)) {
$schema .= "<RateInformation><NegotiatedRatesIndicator/></RateInformation>";
}
$schema .= "<Service>";
$schema .= "<Code>{$service['code']}</Code>";
$schema .= "<Description>{$service['description']}</Description>";
$schema .= "</Service>";
$schema .= $package_schema;
$schema .= "</Shipment>";
$schema .= "<LabelSpecification>";
$schema .= "<LabelPrintMethod>";
$schema .= "<Code>GIF</Code>";
$schema .= "</LabelPrintMethod>";
$schema .= "<LabelImageFormat>";
$schema .= "<Code>GIF</Code>";
$schema .= "</LabelImageFormat>";
$schema .= "</LabelSpecification>";
$schema .= "</ShipmentConfirmRequest>";
return $schema;
}
/**
* Last chance for user to review shipment.
*
* @see uc_ups_confirm_shipment_submit()
* @see theme_uc_ups_confirm_shipment()
* @ingroup forms
*/
function uc_ups_confirm_shipment($order) {
$form = array();
$form['digest'] = array(
'#type' => 'hidden',
'#value' => $_SESSION['ups']['digest'],
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Request Pickup'),
);
return $form;
}
/**
* Displays final shipment information for review.
*
* @see uc_ups_confirm_shipment()
* @ingroup themeable
*/
function theme_uc_ups_confirm_shipment($form) {
$output = '';
$output .= '<div class="shipping-address"><b>' . t('Ship from:') . '</b><br />';
$output .= uc_address_format(check_plain($_SESSION['ups']['origin']->first_name), check_plain($_SESSION['ups']['origin']->last_name), check_plain($_SESSION['ups']['origin']->company), check_plain($_SESSION['ups']['origin']->street1), check_plain($_SESSION['ups']['origin']->street2), check_plain($_SESSION['ups']['origin']->city), check_plain($_SESSION['ups']['origin']->zone), check_plain($_SESSION['ups']['origin']->postal_code), check_plain($_SESSION['ups']['origin']->country));
$output .= '<br />' . check_plain($_SESSION['ups']['origin']->email);
$output .= '</div>';
$output .= '<div class="shipping-address"><b>' . t('Ship to:') . '</b><br />';
$output .= uc_address_format(check_plain($_SESSION['ups']['destination']->first_name), check_plain($_SESSION['ups']['destination']->last_name), check_plain($_SESSION['ups']['destination']->company), check_plain($_SESSION['ups']['destination']->street1), check_plain($_SESSION['ups']['destination']->street2), check_plain($_SESSION['ups']['destination']->city), check_plain($_SESSION['ups']['destination']->zone), check_plain($_SESSION['ups']['destination']->postal_code), check_plain($_SESSION['ups']['destination']->country));
$output .= '<br />' . check_plain($_SESSION['ups']['destination']->email);
$output .= '</div>';
$output .= '<div class="shipment-data">';
$method = uc_ups_shipping_method();
$output .= '<b>' . $method['ups']['quote']['accessorials'][$_SESSION['ups']['service']] . '</b><br />';
$context = array(
'revision' => 'themed',
'type' => 'amount',
);
$output .= '<i>' . check_plain($_SESSION['ups']['rate']['type']) . '</i>: ' . uc_price($_SESSION['ups']['rate']['amount'], $context) . ' (' . check_plain($_SESSION['ups']['rate']['currency']) . ') -- ';
$output .= '<i>' . t('Paid') . '</i>: ' . $_SESSION['ups']['paid'] . '<br />';
$ship_date = $_SESSION['ups']['ship_date'];
$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'));
$exp_delivery = $_SESSION['ups']['expected_delivery'];
$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'));
$output .= "</div>\n<br style=\"clear: both;\" />";
$output .= drupal_render($form);
return $output;
}
/**
* Generates label and schedules pickup of the shipment.
*
* @see uc_ups_confirm_shipment()
*/
function uc_ups_confirm_shipment_submit($form, &$form_state) {
// Request pickup using parameters in form.
$order_id = $_SESSION['ups']['order_id'];
$packages = array_keys($_SESSION['ups']['packages']);
$request = uc_ups_request_pickup($form_state['values']['digest'], $order_id, $packages);
$result = drupal_http_request(variable_get('uc_ups_connection_address', 'https://wwwcie.ups.com/ups.app/xml/') . 'ShipAccept', array(), 'POST', $request);
$response = new SimpleXMLElement($result->data);
$code = (string) $response->Response->ResponseStatusCode;
if ($code == 0) {
// failed request
$error = $response->Response->Error;
$error_severity = (string) $error->ErrorSeverity;
$error_code = (string) $error->ErrorCode;
$error_description = (string) $error->ErrorDescription;
drupal_set_message(t('(@severity error @code) @description', array(
'@severity' => $error_severity,
'@code' => $error_code,
'@description' => $error_description,
)), 'error');
if ($error_severity == 'HardError') {
$form_state['redirect'] = 'admin/store/orders/' . $order_id . '/shipments/ups/' . implode('/', $packages);
return;
}
}
$shipment = new stdClass();
$shipment->order_id = $order_id;
$shipment->origin = drupal_clone($_SESSION['ups']['origin']);
$shipment->destination = drupal_clone($_SESSION['ups']['destination']);
$shipment->packages = $_SESSION['ups']['packages'];
$shipment->shipping_method = 'ups';
$shipment->accessorials = $_SESSION['ups']['service'];
$shipment->carrier = t('UPS');
// if NegotiatedRates exist, quote based on those, otherwise, use TotalCharges
if (isset($response->ShipmentResults->ShipmentCharges)) {
$charge = $response->ShipmentResults->ShipmentCharges->TotalCharges;
if (isset($response->ShipmentResults->NegotiatedRates)) {
$charge = $response->ShipmentResults->NegotiatedRates->NetSummaryCharges->GrandTotal;
}
}
$cost = (string) $charge->MonetaryValue;
$shipment->cost = $cost;
$shipment->tracking_number = (string) $response->ShipmentResults->ShipmentIdentificationNumber;
$ship_date = $_SESSION['ups']['ship_date'];
$shipment->ship_date = gmmktime(12, 0, 0, $ship_date['month'], $ship_date['day'], $ship_date['year']);
$exp_delivery = $_SESSION['ups']['expected_delivery'];
$shipment->expected_delivery = gmmktime(12, 0, 0, $exp_delivery['month'], $exp_delivery['day'], $exp_delivery['year']);
foreach ($response->ShipmentResults->PackageResults as $package_results) {
$package =& current($shipment->packages);
$package->tracking_number = (string) $package_results->TrackingNumber;
$label_image = (string) $package_results->LabelImage->GraphicImage;
if (file_check_directory(file_create_path('ups_labels'), FILE_CREATE_DIRECTORY)) {
$label_path = file_create_path('ups_labels') . '/label' . $package->tracking_number . '.gif';
if ($label_file = fopen($label_path, 'wb')) {
fwrite($label_file, base64_decode($label_image));
fclose($label_file);
$package->label_image = 'ups_labels/' . basename($label_path);
}
else {
drupal_set_message(t('Could not open a file to save the label image.'), 'error');
}
}
else {
drupal_set_message(t('Could not find or create the directory "ups_labels" in the file system path.'), 'error');
}
unset($package);
next($shipment->packages);
}
uc_shipping_shipment_save($shipment);
unset($_SESSION['ups']);
$form_state['redirect'] = 'admin/store/orders/' . $order_id . '/shipments';
}
/**
* Constructs an XML label and pickup request.
*
* @param $digest
* Base-64 encoded shipment request.
* @param $order_id
* The order id of the shipment.
* @param $packages
* An array of package ids to be shipped.
*
* @return
* ShipmentAcceptRequest XML document to send to UPS.
*/
function uc_ups_request_pickup($digest, $order_id = 0, $packages = array()) {
$packages = (array) $packages;
$schema = uc_ups_access_request();
$schema .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ShipmentAcceptRequest>\n <Request>\n <RequestAction>ShipAccept</RequestAction>";
if ($order_id || count($packages)) {
$schema .= "\n<TransactionReference>\n <CustomerContext>";
if ($order_id) {
$schema .= "<OrderId>" . $order_id . "</OrderId>\n";
}
foreach ($packages as $pkg_id) {
$schema .= "<PackageId>" . $pkg_id . "</PackageId>\n";
}
$schema .= "</CustomerContext>\n</TransactionReference>\n";
}
$schema .= " </Request>\n <ShipmentDigest>" . $digest . "</ShipmentDigest>\n</ShipmentAcceptRequest>";
//drupal_set_message('<pre>'. htmlentities($schema) .'</pre>');
return $schema;
}
/**
* Displays the shipping label for printing.
*
* Each argument is a component of the file path to the image.
*
* @ingroup themeable
*/
function theme_uc_ups_label_image() {
$args = func_get_args();
$image_path = file_create_url(implode('/', $args));
$output = <<<EOLABEL
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.2//EN">
<html>
<head>
<title>View/Print Label</title>
<style>
.small-text {font-size: 80%;}
.large-text {font-size: 115%;}
</style>
</head>
<body bgcolor="#FFFFFF">
<table border="0" cellpadding="0" cellspacing="0" width="600"><tr>
<td height="410" align="left" valign="top">
<b class="large-text">View/Print Label</b>
<br />
<ol class="small-text"> <li><b>Print the label:</b>
Select Print from the File menu in this browser window to print the label below.<br /><br /><li><b>
Fold the printed label at the dotted line.</b>
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 />
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>
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 />
<b>Customers with a Daily Pickup</b><ul><li>
Your driver will pickup your shipment(s) as usual. </ul>
</ol></td></tr></table><table border="0" cellpadding="0" cellspacing="0" width="600">
<tr>
<td class="small-text" align="left" valign="top">
FOLD HERE</td>
</tr>
<tr>
<td align="left" valign="top"><hr />
</td>
</tr>
</table>
<table>
<tr>
<td height="10">
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="650" ><tr>
<td align="left" valign="top">
<img src="{<span class="php-variable">$image_path</span>}" height="392" width="672">
</td>
</tr></table>
</body>
</html>
EOLABEL;
print $output;
exit;
}Functions
Name |
Description |
|---|---|
| theme_uc_ups_confirm_shipment | Displays final shipment information for review. |
| theme_uc_ups_label_image | Displays the shipping label for printing. |
| uc_ups_confirm_shipment | Last chance for user to review shipment. |
| uc_ups_confirm_shipment_submit | Generates label and schedules pickup of the shipment. |
| uc_ups_fulfill_order | Shipment creation callback. |
| uc_ups_fulfill_order_submit | Passes final information into shipment object. |
| uc_ups_fulfill_order_validate | Passes final information into shipment object. |
| uc_ups_request_pickup | Constructs an XML label and pickup request. |
| uc_ups_shipment_request | Constructs an XML shipment request. |