* @copyright 2007-2011 PrestaShop SA * @version Release: $Revision: 7290 $ * @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0) * International Registered Trademark & Property of PrestaShop SA */ if (!defined('_CAN_LOAD_FILES_')) exit; class UpsCarrier extends CarrierModule { public $id_carrier; private $_html = ''; private $_postErrors = array(); private $_webserviceError = ''; private $_rateServiceGroupList = array(); private $_fieldsList = array(); private $_pickupTypeList = array(); private $_packagingTypeList = array(); private $_calculModeList = array(); private $_dimensionUnit = ''; private $_weightUnit = ''; private $_dimensionUnitList = array('CM' => 'CM', 'IN' => 'IN', 'CMS' => 'CM', 'INC' => 'IN'); private $_weightUnitList = array('KG' => 'KGS', 'KGS' => 'KGS', 'LBS' => 'LBS', 'LB' => 'LBS'); private $_moduleName = 'upscarrier'; /* ** Construct Method ** */ public function __construct() { $this->name = 'upscarrier'; $this->tab = 'shipping_logistics'; $this->version = '1.2'; $this->author = 'PrestaShop'; $this->limited_countries = array('us'); parent::__construct (); $this->displayName = $this->l('UPS Carrier'); $this->description = $this->l('Offer your customers, different delivery methods with UPS'); if (self::isInstalled($this->name)) { // Loading Var $warning = array(); $this->loadingVar(); // Check Configuration Values foreach ($this->_fieldsList as $keyConfiguration => $name) if (!Configuration::get($keyConfiguration) && !empty($name)) $warning[] = '\''.$name.'\' '; // Check calcul mode if (!Configuration::get('UPS_CARRIER_CALCUL_MODE')) Configuration::updateValue('UPS_CARRIER_CALCUL_MODE', 'split'); // Checking Unit $this->_dimensionUnit = $this->_dimensionUnitList[strtoupper(Configuration::get('PS_DIMENSION_UNIT'))]; $this->_weightUnit = $this->_weightUnitList[strtoupper(Configuration::get('PS_WEIGHT_UNIT'))]; if (!$this->_weightUnit || !$this->_weightUnitList[$this->_weightUnit]) $warning[] = $this->l('\'Weight Unit (LB or KG).\'').' '; if (!$this->_dimensionUnit || !$this->_dimensionUnitList[$this->_dimensionUnit]) $warning[] = $this->l('\'Dimension Unit (CM or IN).\'').' '; // Generate Warnings if (count($warning)) $this->warning .= implode(' , ',$warning).$this->l('must be configured to use this module correctly.').' '; } } public function loadingVar() { // Loading Fields List $this->_fieldsList = array( 'UPS_CARRIER_LOGIN' => $this->l('UPS Login'), 'UPS_CARRIER_PASSWORD' => $this->l('UPS Password'), 'UPS_CARRIER_SHIPPER_ID' => $this->l('MyUps ID'), 'UPS_CARRIER_API_KEY' => $this->l('UPS API Key'), 'UPS_CARRIER_PACKAGING_WEIGHT' => $this->l('Packaging weight'), 'UPS_CARRIER_HANDLING_FEE' => $this->l('Handling fee'), 'UPS_CARRIER_PICKUP_TYPE' => $this->l('UPS Pickup Type'), 'UPS_CARRIER_PACKAGING_TYPE' => $this->l('UPS Packaging Type'), 'UPS_CARRIER_RATE_SERVICE_GROUP' => $this->l('UPS Rate Service Group'), 'UPS_CARRIER_ADDRESS1' => '', 'UPS_CARRIER_ADDRESS2' => '', 'UPS_CARRIER_POSTAL_CODE' => '', 'UPS_CARRIER_CITY' => '', 'UPS_CARRIER_STATE' => '', 'UPS_CARRIER_COUNTRY' => '', 'UPS_CARRIER_CALCUL_MODE' => '', ); // Loading Rate Service Group List $this->_rateServiceGroupList = array( 'United States Domestic Shipments' => $this->l('United States Domestic Shipments'), 'Shipments Originating in United States' => $this->l('Shipments Originating in United States'), 'Shipments Originating in Puerto Rico' => $this->l('Shipments Originating in Puerto Rico'), 'Shipments Originating in Canada' => $this->l('Shipments Originating in Canada'), 'Shipments Originating in Mexico' => $this->l('Shipments Originating in Mexico'), 'Polish Domestic Shipments' => $this->l('Polish Domestic Shipments'), 'Shipments Originating in the European Union' => $this->l('Shipments Originating in the European Union'), 'Shipments Originating in Other Countries' => $this->l('Shipments Originating in Other Countries') ); // Loading Pickup Type List $this->_pickupTypeList = array( '01' => $this->l('Daily Pickup'), '03' => $this->l('Customer Counter'), '06' => $this->l('One Time Pickup'), '07' => $this->l('On Call Air'), '11' => $this->l('Suggested Retail Rates'), '19' => $this->l('Letter Center'), '20' => $this->l('Air Service Center') ); // Loading Packaging Type List $this->_packagingTypeList = array( '00' => $this->l('UNKNOWN'), '01' => $this->l('UPS Letter'), '02' => $this->l('Package'), '03' => $this->l('Tube'), '04' => $this->l('Pak'), '21' => $this->l('Express Box'), '24' => $this->l('25KG Box'), '25' => $this->l('10KG Box'), '30' => $this->l('Pallet'), '2a' => $this->l('Small Express Box'), '2b' => $this->l('Medium Express Box'), '2c' => $this->l('Large Express Box') ); // Loading calcul mode list $this->_calculModeList = array( 'onepackage' => $this->l('All items in one package'), 'split' => $this->l('Split one item per package') ); } /* ** Install / Uninstall Methods ** */ public function install() { // Install SQL include(dirname(__FILE__).'/sql-install.php'); foreach ($sql as $s) if (!Db::getInstance()->Execute($s)) return false; // Install Module if (!parent::install() OR !$this->registerHook('updateCarrier')) return false; return true; } public function uninstall() { // Uninstall Carriers Db::getInstance()->autoExecute(_DB_PREFIX_.'carrier', array('deleted' => 1), 'UPDATE', '`external_module_name` = \'upscarrier\' OR `id_carrier` IN (SELECT DISTINCT(`id_carrier`) FROM `'._DB_PREFIX_.'ups_rate_service_code`)'); // Uninstall Config foreach ($this->_fieldsList as $keyConfiguration => $name) if (!Configuration::deleteByName($keyConfiguration)) return false; // Uninstall SQL include(dirname(__FILE__).'/sql-uninstall.php'); foreach ($sql as $s) if (!Db::getInstance()->Execute($s)) return false; // Uninstall Module if (!parent::uninstall() OR !$this->unregisterHook('updateCarrier')) return false; return true; } public function installCarriers($id_ups_rate_service_group) { // Unactive all UPS Carriers Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_service_code', array('active' => 0), 'UPDATE'); // Get all services availables for this group $rateServiceList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)($id_ups_rate_service_group)); foreach ($rateServiceList as $rateService) if (!$rateService['id_carrier']) { $config = array( 'name' => $rateService['service'], 'id_tax_rules_group' => 0, 'active' => true, 'deleted' => 0, 'shipping_handling' => false, 'range_behavior' => 0, 'delay' => array('fr' => $rateService['service'], 'en' => $rateService['service'], Language::getIsoById(Configuration::get('PS_LANG_DEFAULT')) => $rateService['service']), 'id_zone' => 1, 'is_module' => true, 'shipping_external' => true, 'external_module_name' => $this->_moduleName, 'need_range' => true ); $id_carrier = $this->installExternalCarrier($config); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_service_code', array('id_carrier' => (int)($id_carrier), 'id_carrier_history' => (int)($id_carrier)), 'UPDATE', '`id_ups_rate_service_code` = '.(int)($rateService['id_ups_rate_service_code'])); } } public static function installExternalCarrier($config) { $carrier = new Carrier(); $carrier->name = $config['name']; $carrier->id_tax_rules_group = $config['id_tax_rules_group']; $carrier->id_zone = $config['id_zone']; $carrier->active = $config['active']; $carrier->deleted = $config['deleted']; $carrier->delay = $config['delay']; $carrier->shipping_handling = $config['shipping_handling']; $carrier->range_behavior = $config['range_behavior']; $carrier->is_module = $config['is_module']; $carrier->shipping_external = $config['shipping_external']; $carrier->external_module_name = $config['external_module_name']; $carrier->need_range = $config['need_range']; $languages = Language::getLanguages(true); foreach ($languages as $language) { if ($language['iso_code'] == 'fr') $carrier->delay[(int)$language['id_lang']] = $config['delay'][$language['iso_code']]; if ($language['iso_code'] == 'en') $carrier->delay[(int)$language['id_lang']] = $config['delay'][$language['iso_code']]; if ($language['iso_code'] == Language::getIsoById(Configuration::get('PS_LANG_DEFAULT'))) $carrier->delay[(int)$language['id_lang']] = $config['delay'][$language['iso_code']]; } if ($carrier->add()) { $groups = Group::getGroups(true); foreach ($groups as $group) Db::getInstance()->autoExecute(_DB_PREFIX_.'carrier_group', array('id_carrier' => (int)($carrier->id), 'id_group' => (int)($group['id_group'])), 'INSERT'); $rangePrice = new RangePrice(); $rangePrice->id_carrier = $carrier->id; $rangePrice->delimiter1 = '0'; $rangePrice->delimiter2 = '10000'; $rangePrice->add(); $rangeWeight = new RangeWeight(); $rangeWeight->id_carrier = $carrier->id; $rangeWeight->delimiter1 = '0'; $rangeWeight->delimiter2 = '10000'; $rangeWeight->add(); $zones = Zone::getZones(true); foreach ($zones as $zone) { Db::getInstance()->autoExecute(_DB_PREFIX_.'carrier_zone', array('id_carrier' => (int)($carrier->id), 'id_zone' => (int)($zone['id_zone'])), 'INSERT'); Db::getInstance()->autoExecuteWithNullValues(_DB_PREFIX_.'delivery', array('id_carrier' => (int)($carrier->id), 'id_range_price' => (int)($rangePrice->id), 'id_range_weight' => NULL, 'id_zone' => (int)($zone['id_zone']), 'price' => '0'), 'INSERT'); Db::getInstance()->autoExecuteWithNullValues(_DB_PREFIX_.'delivery', array('id_carrier' => (int)($carrier->id), 'id_range_price' => NULL, 'id_range_weight' => (int)($rangeWeight->id), 'id_zone' => (int)($zone['id_zone']), 'price' => '0'), 'INSERT'); } // Copy Logo if (!copy(dirname(__FILE__).'/carrier.jpg', _PS_SHIP_IMG_DIR_.'/'.(int)$carrier->id.'.jpg')) return false; // Return ID Carrier return (int)($carrier->id); } return false; } /* ** Global Form Config Methods ** */ public function getContent() { $this->_html .= '

' . $this->l('UPS Carrier').'

'; if (!empty($_POST) AND Tools::isSubmit('submitSave')) { $this->_postValidation(); if (!sizeof($this->_postErrors)) $this->_postProcess(); else foreach ($this->_postErrors AS $err) $this->_html .= '
nok '.$err.'
'; } $this->_displayForm(); return $this->_html; } private function _displayForm() { $this->_html .= '
'.$this->l('UPS Module Status').''; $alert = array(); if (!Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) $alert['rateServiceGroup'] = 1; if (Db::getInstance()->getValue('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP').' AND `active` = 1') < 1) $alert['deliveryServices'] = 1; if (!$this->webserviceTest()) $alert['webserviceTest'] = 1; if (!count($alert)) $this->_html .= ''.$this->l('UPS Carrier is configured and online!').''; else { $this->_html .= ''.$this->l('UPS Carrier is not configured yet, please:').''; $this->_html .= '
'.(isset($alert['rateServiceGroup']) ? '' : '').' 1) '.$this->l('Fill the "General Settings" form and choose your rate service group.'); $this->_html .= '
'.(isset($alert['webserviceTest']) ? '' : '').' 2) '.$this->l('Webservice test connection').($this->_webserviceError ? ' : '.$this->_webserviceError : ''); $this->_html .= '
'.(isset($alert['deliveryServices']) ? '' : '').' 3) '.$this->l('Select your available delivery service (you must validate your rate service group first).'); } if (!is_callable('curl_exec')) $this->_html .= '

'.$this->l('cURL Extension is not enabled, UPS module can work without cURL but it would be better to enable it.'); $this->_html .= '
 
'; $this->_html .= $this->_displayFormConfig(); } private function _postValidation() { if (Tools::getValue('section') == 'general') $this->_postValidationGeneral(); elseif (Tools::getValue('section') == 'category' && Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) $this->_postValidationCategory(); elseif (Tools::getValue('section') == 'product' && Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) $this->_postValidationProduct(); } private function _postProcess() { if (Tools::getValue('section') == 'general') $this->_postProcessGeneral(); elseif (Tools::getValue('section') == 'category' && Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) $this->_postProcessCategory(); elseif (Tools::getValue('section') == 'product' && Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) $this->_postProcessProduct(); } /* ** General Form Config Methods ** */ private function _displayFormConfig() { $html = '


'; if (isset($_GET['id_tab'])) $html .= ''; return $html; } private function _displayFormGeneral() { global $cookie; $configCurrency = new Currency((int)Configuration::get('PS_CURRENCY_DEFAULT')); $html = '

'.$this->l('General configuration').' :



'.Tools::getValue('ps_weight_unit', Configuration::get('PS_WEIGHT_UNIT')).'
'.$configCurrency->sign.'

'.$this->l('Localization configuration').' :

'.$this->l('The weight unit of your shop (eg. kg or lbs)').'

'.$this->l('The dimension unit of your shop (eg. cm or in)').'

'.$this->l('Address configuration').' :


' . $this->l('Select country from within the list.') . '

'; $id_country_current = 0; $statesList = Db::getInstance()->ExecuteS(' SELECT `id_state`, `id_country`, `name` FROM `'._DB_PREFIX_.'state` WHERE `active` = 1 ORDER BY `id_country`, `name` ASC'); foreach ($statesList as $v) { if ($id_country_current != $v['id_country']) { if ($id_country_current != 0) $html .= ''; $html .= '
'.$this->l('There is no state configuration for this country').'

'.$this->l('Service configuration').' :

' . $this->l('Shipments originating.') . '

' . $this->l('Select pickup type from within the list.') . '

' . $this->l('Select packaging type from within the list.') . '

' . $this->l('Using the calcul mode "All items in one package" will automatically use default packaging size, packaging type and delivery services. Specifics configurations for categories or product won\'t be used.') . '

'; if (Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) { $html .= '
'; $rateServiceList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')); foreach($rateServiceList as $rateService) $html .= ' '.$rateService['service'].' '.($this->webserviceTest($rateService['code']) ? '('.$this->l('Available').')' : '('.$this->l('Not available').')').'
'; $html .= '

' . $this->l('Choose the delivery service which will be available for customers.') . '

'; } $html .= '
'; return $html; } private function _postValidationGeneral() { // Check configuration values if (Tools::getValue('ups_carrier_login') == NULL) $this->_postErrors[] = $this->l('Your UPS login is not specified'); elseif (Tools::getValue('ups_carrier_password') == NULL) $this->_postErrors[] = $this->l('Your UPS password is not specified'); elseif (Tools::getValue('ups_carrier_shipper_id') == NULL) $this->_postErrors[] = $this->l('Your MyUps ID is not specified'); elseif (Tools::getValue('ups_carrier_api_key') == NULL) $this->_postErrors[] = $this->l('Your UPS API Key is not specified'); elseif (Tools::getValue('ups_carrier_postal_code') == NULL) $this->_postErrors[] = $this->l('Your Zip / Postal code is not specified'); elseif (Tools::getValue('ups_carrier_city') == NULL) $this->_postErrors[] = $this->l('Your city is not specified'); elseif (Tools::getValue('ups_carrier_country') == NULL OR Tools::getValue('ups_carrier_country') == 0) $this->_postErrors[] = $this->l('Your country is not specified'); elseif (Tools::getValue('ups_carrier_pickup_type') == NULL OR Tools::getValue('ups_carrier_pickup_type') == 0) $this->_postErrors[] = $this->l('Your pickup type is not specified'); elseif (Tools::getValue('ups_carrier_packaging_type') == NULL OR Tools::getValue('ups_carrier_packaging_type') == 0) $this->_postErrors[] = $this->l('Your packaging type is not specified'); elseif (Tools::getValue('ups_carrier_rate_service_group') == NULL OR Tools::getValue('ups_carrier_rate_service_group') == 0) $this->_postErrors[] = $this->l('Your rate service group is not specified'); // Check ups webservice availibity if (!$this->_postErrors) { // Install Carriers (if not) Configuration::updateValue('UPS_CARRIER_RATE_SERVICE_GROUP', Tools::getValue('ups_carrier_rate_service_group')); $this->installCarriers((int)Tools::getValue('ups_carrier_rate_service_group')); // If no errors appear, the carrier is being activated, else, the carrier is being deactivated if (!$this->_postErrors) { // Get available services $serviceSelected = Tools::getValue('service'); // Active available carrier if ($serviceSelected) foreach ($serviceSelected as $ss) { $id_carrier = Db::getInstance()->getValue('SELECT `id_carrier` FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_code` = '.(int)($ss)); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_service_code', array('active' => 1), 'UPDATE', '`id_ups_rate_service_code` = '.(int)($ss)); } } // All new configurations values are saved to be sure to test webservices with it Configuration::updateValue('UPS_CARRIER_LOGIN', Tools::getValue('ups_carrier_login')); Configuration::updateValue('UPS_CARRIER_PASSWORD', Tools::getValue('ups_carrier_password')); Configuration::updateValue('UPS_CARRIER_SHIPPER_ID', Tools::getValue('ups_carrier_shipper_id')); Configuration::updateValue('UPS_CARRIER_API_KEY', Tools::getValue('ups_carrier_api_key')); Configuration::updateValue('UPS_CARRIER_PACKAGING_WEIGHT', Tools::getValue('ups_carrier_packaging_weight')); Configuration::updateValue('UPS_CARRIER_HANDLING_FEE', Tools::getValue('ups_carrier_handling_fee')); Configuration::updateValue('UPS_CARRIER_PICKUP_TYPE', Tools::getValue('ups_carrier_pickup_type')); Configuration::updateValue('UPS_CARRIER_PACKAGING_TYPE', Tools::getValue('ups_carrier_packaging_type')); Configuration::updateValue('UPS_CARRIER_ADDRESS1', Tools::getValue('ups_carrier_address1')); Configuration::updateValue('UPS_CARRIER_ADDRESS2', Tools::getValue('ups_carrier_address2')); Configuration::updateValue('UPS_CARRIER_POSTAL_CODE', Tools::getValue('ups_carrier_postal_code')); Configuration::updateValue('UPS_CARRIER_CITY', Tools::getValue('ups_carrier_city')); Configuration::updateValue('UPS_CARRIER_STATE', Tools::getValue('ups_carrier_state')); Configuration::updateValue('UPS_CARRIER_COUNTRY', Tools::getValue('ups_carrier_country')); Configuration::updateValue('UPS_CARRIER_CALCUL_MODE', Tools::getValue('ups_carrier_calcul_mode')); Configuration::updateValue('PS_WEIGHT_UNIT', $this->_weightUnitList[strtoupper(Tools::getValue('ps_weight_unit'))]); Configuration::updateValue('PS_DIMENSION_UNIT', $this->_dimensionUnitList[strtoupper(Tools::getValue('ps_dimension_unit'))]); if (isset($this->_weightUnitList[strtoupper(Tools::getValue('ps_weight_unit'))])) $this->_weightUnit = $this->_weightUnitList[strtoupper(Tools::getValue('ps_weight_unit'))]; if (isset($this->_dimensionUnitList[strtoupper(Tools::getValue('ps_dimension_unit'))])) $this->_dimensionUnit = $this->_dimensionUnitList[strtoupper(Tools::getValue('ps_dimension_unit'))]; if (!$this->webserviceTest()) $this->_postErrors[] = $this->l('Prestashop could not connect to UPS webservices').' :
'.($this->_webserviceError ? $this->_webserviceError : $this->l('No error description found')); } } private function _postProcessGeneral() { // Saving new configurations if (Configuration::updateValue('UPS_CARRIER_LOGIN', Tools::getValue('ups_carrier_login')) AND Configuration::updateValue('UPS_CARRIER_PASSWORD', Tools::getValue('ups_carrier_password')) AND Configuration::updateValue('UPS_CARRIER_SHIPPER_ID', Tools::getValue('ups_carrier_shipper_id')) AND Configuration::updateValue('UPS_CARRIER_API_KEY', Tools::getValue('ups_carrier_api_key')) AND Configuration::updateValue('UPS_CARRIER_PACKAGING_WEIGHT', Tools::getValue('ups_carrier_packaging_weight')) AND Configuration::updateValue('UPS_CARRIER_HANDLING_FEE', Tools::getValue('ups_carrier_handling_fee')) AND Configuration::updateValue('UPS_CARRIER_PICKUP_TYPE', Tools::getValue('ups_carrier_pickup_type')) AND Configuration::updateValue('UPS_CARRIER_PACKAGING_TYPE', Tools::getValue('ups_carrier_packaging_type')) AND Configuration::updateValue('UPS_CARRIER_POSTAL_CODE', Tools::getValue('ups_carrier_postal_code')) AND Configuration::updateValue('UPS_CARRIER_CITY', Tools::getValue('ups_carrier_city')) AND Configuration::updateValue('UPS_CARRIER_STATE', Tools::getValue('ups_carrier_state')) AND Configuration::updateValue('UPS_CARRIER_COUNTRY', Tools::getValue('ups_carrier_country')) AND Configuration::updateValue('UPS_CARRIER_CALCUL_MODE', Tools::getValue('ups_carrier_calcul_mode')) AND Configuration::updateValue('PS_WEIGHT_UNIT', $this->_weightUnitList[strtoupper(Tools::getValue('ps_weight_unit'))]) AND Configuration::updateValue('PS_DIMENSION_UNIT', $this->_dimensionUnitList[strtoupper(Tools::getValue('ps_dimension_unit'))])) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } /* ** Category Form Config Methods ** */ private function _getPathInTab($id_category) { global $cookie; $category = Db::getInstance()->getRow(' SELECT id_category, level_depth, nleft, nright FROM '._DB_PREFIX_.'category WHERE id_category = '.(int)$id_category); if (isset($category['id_category'])) { $categories = Db::getInstance()->ExecuteS(' SELECT c.id_category, cl.name, cl.link_rewrite FROM '._DB_PREFIX_.'category c LEFT JOIN '._DB_PREFIX_.'category_lang cl ON (cl.id_category = c.id_category) WHERE c.nleft <= '.(int)$category['nleft'].' AND c.nright >= '.(int)$category['nright'].' AND cl.id_lang = '.(int)($cookie->id_lang).' ORDER BY c.level_depth ASC LIMIT '.(int)($category['level_depth'] + 1)); $n = 1; $pathTab = array(); $nCategories = (int)sizeof($categories); foreach ($categories AS $category) $pathTab[] = htmlentities($category['name'], ENT_NOQUOTES, 'UTF-8'); return $pathTab; } } private function _getChildCategories($categories, $id, $path = array(), $pathAdd = '') { $html = ''; if ($pathAdd != '') $path[] = $pathAdd; if (isset($categories[$id])) foreach ($categories[$id] as $idc => $cc) { $html .= ''; $html .= $this->_getChildCategories($categories, $idc, $path, $cc['infos']['name']); } return $html; } private function _isPostCheck($id_ups_rate_service_code) { $services = Tools::getValue('service'); if ($services) foreach ($services as $s) if ($s == $id_ups_rate_service_code) return 1; return 0; } private function _displayFormCategory() { global $cookie; // Check if the module is configured if (!Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) return '

'.$this->l('You have to configure "General Settings" tab before using this tab.').'


'; // Display header $html = '

'.$this->l('In this tab, you can set a specific configuration for each category.').'


'; // Loading config list $configCategoryList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_category` > 0'); if (!$configCategoryList) $html .= ''; foreach ($configCategoryList as $k => $c) { // Category Path $path = ''; $pathTab = $this->_getPathInTab($c['id_category']); foreach ($pathTab as $p) { if (!empty($path)) { $path .= ' > '; } $path .= $p; } // Loading config currency $configCurrency = new Currency($c['id_currency']); // Loading services attached to this config $services = ''; $servicesTab = Db::getInstance()->ExecuteS(' SELECT ursc.`service` FROM `'._DB_PREFIX_.'ups_rate_config_service` urcs LEFT JOIN `'._DB_PREFIX_.'ups_rate_service_code` ursc ON (ursc.`id_ups_rate_service_code` = urcs.`id_ups_rate_service_code`) WHERE ursc.`id_ups_rate_service_group` = '.(int)(Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')).' AND urcs.`id_ups_rate_config` = '.(int)$c['id_ups_rate_config']); foreach ($servicesTab as $s) $services .= $s['service'].'
'; // Display line $alt = 0; if ($k % 2 != 0) $alt = ' class="alt_row"'; $html .= ' '; } $html .= '
'.$this->l('ID Config').' '.$this->l('Category').' '.$this->l('Packaging type').' '.$this->l('Additional charges').' '.$this->l('Services').' '.$this->l('Actions').'
'.$this->l('There is no specific UPS configuration for categories at this point.').'
'.$c['id_ups_rate_config'].' '.$path.' '.(isset($this->_packagingTypeList[$c['packaging_type_code']]) ? $this->_packagingTypeList[$c['packaging_type_code']] : '-').' '.$c['additionnal_charges'].' '.$configCurrency->sign.' '.$services.'


'; // Add or Edit Category Configuration if (Tools::getValue('action') == 'edit' && Tools::getValue('section') == 'category') { // Loading config $configSelected = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_ups_rate_config` = '.(int)(Tools::getValue('id_ups_rate_config'))); // Category Path $path = ''; $pathTab = $this->_getPathInTab($configSelected['id_category']); foreach ($pathTab as $p) { if (!empty($path)) { $path .= ' > '; } $path .= $p; } $html .= '

'.$this->l('Update a rule').' ('.$this->l('Add a rule').' ?)

'.$path.'


'; $rateServiceList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')); foreach($rateServiceList as $rateService) { $configServiceSelected = Db::getInstance()->getValue('SELECT `id_ups_rate_service_code` FROM `'._DB_PREFIX_.'ups_rate_config_service` WHERE `id_ups_rate_config` = '.(int)(Tools::getValue('id_ups_rate_config')).' AND `id_ups_rate_service_code` = '.(int)($rateService['id_ups_rate_service_code'])); $html .= '_isPostCheck($rateService['id_ups_rate_service_code']) == 1 || $configServiceSelected > 0) ? 'checked="checked"' : '').' /> '.$rateService['service'].'
'; } $html .= '

' . $this->l('Choose the delivery service which will be available for customers.') . '

'; } else { $html .= '

'.$this->l('Add a rule').'


'; $rateServiceList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')); foreach($rateServiceList as $rateService) $html .= '_isPostCheck($rateService['id_ups_rate_service_code']) == 1) ? 'checked="checked"' : '').' /> '.$rateService['service'].'
'; $html .= '

' . $this->l('Choose the delivery service which will be available for customers.') . '

'; } return $html; } private function _postValidationCategory() { // Check post values if (Tools::getValue('id_category') == NULL) $this->_postErrors[] = $this->l('You have to select a category.'); if (!$this->_postErrors) { $id_ups_rate_config = Db::getInstance()->getValue('SELECT `id_ups_rate_config` FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_category` = '.(int)Tools::getValue('id_category')); // Check if a config does not exist in Add case if ($id_ups_rate_config > 0 && Tools::getValue('action') == 'add') $this->_postErrors[] = $this->l('This category already has a specific UPS configuration.'); // Check if a config exists and if the IDs config correspond in Upd case if (Tools::getValue('action') == 'edit' && (!isset($id_ups_rate_config) || $id_ups_rate_config != Tools::getValue('id_ups_rate_config'))) $this->_postErrors[] = $this->l('An error occurred, please try again.'); // Check if a config exists in Delete case if (Tools::getValue('action') == 'delete' && !isset($id_ups_rate_config)) $this->_postErrors[] = $this->l('An error occurred, please try again.'); } } private function _postProcessCategory() { // Init Var $date = date('Y-m-d H:i:s'); $services = Tools::getValue('service'); // Add Script if (Tools::getValue('action') == 'add') { $addTab = array( 'id_product' => 0, 'id_category' => (int)(Tools::getValue('id_category')), 'id_currency' => (int)(Configuration::get('PS_CURRENCY_DEFAULT')), 'packaging_type_code' => pSQL(Tools::getValue('packaging_type_code')), 'additionnal_charges' => pSQL(Tools::getValue('additionnal_charges')), 'date_add' => pSQL($date), 'date_upd' => pSQL($date) ); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config', $addTab, 'INSERT'); $id_ups_rate_config = Db::getInstance()->Insert_ID(); foreach ($services as $s) { $addTab = array('id_ups_rate_service_code' => pSQL($s), 'id_ups_rate_config' => (int)$id_ups_rate_config, 'date_add' => pSQL($date), 'date_upd' => pSQL($date)); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config_service', $addTab, 'INSERT'); } // Display Results if ($id_ups_rate_config > 0) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } // Update Script if (Tools::getValue('action') == 'edit' && Tools::getValue('id_ups_rate_config')) { $updTab = array( 'id_currency' => (int)(Configuration::get('PS_CURRENCY_DEFAULT')), 'packaging_type_code' => pSQL(Tools::getValue('packaging_type_code')), 'additionnal_charges' => pSQL(Tools::getValue('additionnal_charges')), 'date_upd' => pSQL($date) ); $result = Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config', $updTab, 'UPDATE', '`id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.'ups_rate_config_service` WHERE `id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); foreach ($services as $s) { $addTab = array('id_ups_rate_service_code' => pSQL($s), 'id_ups_rate_config' => (int)Tools::getValue('id_ups_rate_config'), 'date_add' => pSQL($date), 'date_upd' => pSQL($date)); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config_service', $addTab, 'INSERT'); } // Display Results if ($result) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } // Delete Script if (Tools::getValue('action') == 'delete' && Tools::getValue('id_ups_rate_config')) { $result1 = Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); $result2 = Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.'ups_rate_config_service` WHERE `id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); // Display Results if ($result1) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } } /* ** Product Form Config Methods ** */ private function _displayFormProduct() { global $cookie; // Check if the module is configured if (!Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')) return '

'.$this->l('You have to configure "General Settings" tab before using this tab.').'


'; // Display header $html = '

'.$this->l('In this tab, you can set a specific configuration for each product.').'


'; // Loading config list $configProductList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_product` > 0'); if (!$configProductList) $html .= ''; foreach ($configProductList as $k => $c) { // Loading Product $product = new Product((int)$c['id_product'], false, (int)$cookie->id_lang); // Loading config currency $configCurrency = new Currency($c['id_currency']); // Loading services attached to this config $services = ''; $servicesTab = Db::getInstance()->ExecuteS(' SELECT ursc.`service` FROM `'._DB_PREFIX_.'ups_rate_config_service` urcs LEFT JOIN `'._DB_PREFIX_.'ups_rate_service_code` ursc ON (ursc.`id_ups_rate_service_code` = urcs.`id_ups_rate_service_code`) WHERE ursc.`id_ups_rate_service_group` = '.(int)(Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')).' AND urcs.`id_ups_rate_config` = '.(int)$c['id_ups_rate_config']); foreach ($servicesTab as $s) $services .= $s['service'].'
'; // Display line $alt = 0; if ($k % 2 != 0) $alt = ' class="alt_row"'; $html .= ' '; } $html .= '
'.$this->l('ID Config').' '.$this->l('Product').' '.$this->l('Packaging type').' '.$this->l('Additional charges').' '.$this->l('Services').' '.$this->l('Actions').'
'.$this->l('There is no specific UPS configuration for products at this point.').'
'.$c['id_ups_rate_config'].' '.$product->name.' '.(isset($this->_packagingTypeList[$c['packaging_type_code']]) ? $this->_packagingTypeList[$c['packaging_type_code']] : '-').' '.$c['additionnal_charges'].' '.$configCurrency->sign.' '.$services.'


'; // Add or Edit Product Configuration if (Tools::getValue('action') == 'edit' && Tools::getValue('section') == 'product') { // Loading config $configSelected = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_ups_rate_config` = '.(int)(Tools::getValue('id_ups_rate_config'))); $product = new Product((int)$configSelected['id_product'], false, (int)$cookie->id_lang); $html .= '

'.$this->l('Update a rule').' ('.$this->l('Add a rule').' ?)

'.$product->name.'


'; $rateServiceList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')); foreach($rateServiceList as $rateService) { $configServiceSelected = Db::getInstance()->getValue('SELECT `id_ups_rate_service_code` FROM `'._DB_PREFIX_.'ups_rate_config_service` WHERE `id_ups_rate_config` = '.(int)(Tools::getValue('id_ups_rate_config')).' AND `id_ups_rate_service_code` = '.(int)($rateService['id_ups_rate_service_code'])); $html .= '_isPostCheck($rateService['id_ups_rate_service_code']) == 1 || $configServiceSelected > 0) ? 'checked="checked"' : '').' /> '.$rateService['service'].'
'; } $html .= '

' . $this->l('Choose the delivery service which will be available for customers.') . '

'; } else { $html .= '

'.$this->l('Add a rule').'


'; $rateServiceList = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')); foreach($rateServiceList as $rateService) $html .= '_isPostCheck($rateService['id_ups_rate_service_code']) == 1) ? 'checked="checked"' : '').' /> '.$rateService['service'].'
'; $html .= '

' . $this->l('Choose the delivery service which will be available for customers.') . '

'; } return $html; } private function _postValidationProduct() { // Check post values if (Tools::getValue('id_product') == NULL) $this->_postErrors[] = $this->l('You have to select a product.'); if (!$this->_postErrors) { $id_ups_rate_config = Db::getInstance()->getValue('SELECT `id_ups_rate_config` FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_product` = '.(int)Tools::getValue('id_product')); // Check if a config does not exist in Add case if ($id_ups_rate_config > 0 && Tools::getValue('action') == 'add') $this->_postErrors[] = $this->l('This product already has a specific UPS configuration.'); // Check if a config exists and if the IDs config correspond in Upd case if (Tools::getValue('action') == 'edit' && (!isset($id_ups_rate_config) || $id_ups_rate_config != Tools::getValue('id_ups_rate_config'))) $this->_postErrors[] = $this->l('An error occurred, please try again.'); // Check if a config exists in Delete case if (Tools::getValue('action') == 'delete' && !isset($id_ups_rate_config)) $this->_postErrors[] = $this->l('An error occurred, please try again.'); } } private function _postProcessProduct() { // Init Var $date = date('Y-m-d H:i:s'); $services = Tools::getValue('service'); // Add Script if (Tools::getValue('action') == 'add') { $addTab = array( 'id_product' => (int)(Tools::getValue('id_product')), 'id_category' => 0, 'id_currency' => (int)(Configuration::get('PS_CURRENCY_DEFAULT')), 'packaging_type_code' => pSQL(Tools::getValue('packaging_type_code')), 'additionnal_charges' => pSQL(Tools::getValue('additionnal_charges')), 'date_add' => pSQL($date), 'date_upd' => pSQL($date) ); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config', $addTab, 'INSERT'); $id_ups_rate_config = Db::getInstance()->Insert_ID(); foreach ($services as $s) { $addTab = array('id_ups_rate_service_code' => pSQL($s), 'id_ups_rate_config' => (int)$id_ups_rate_config, 'date_add' => pSQL($date), 'date_upd' => pSQL($date)); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config_service', $addTab, 'INSERT'); } // Display Results if ($id_ups_rate_config > 0) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } // Update Script if (Tools::getValue('action') == 'edit' && Tools::getValue('id_ups_rate_config')) { $updTab = array( 'id_currency' => (int)(Configuration::get('PS_CURRENCY_DEFAULT')), 'packaging_type_code' => pSQL(Tools::getValue('packaging_type_code')), 'additionnal_charges' => pSQL(Tools::getValue('additionnal_charges')), 'date_upd' => pSQL($date) ); $result = Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config', $updTab, 'UPDATE', '`id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.'ups_rate_config_service` WHERE `id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); foreach ($services as $s) { $addTab = array('id_ups_rate_service_code' => pSQL($s), 'id_ups_rate_config' => (int)Tools::getValue('id_ups_rate_config'), 'date_add' => pSQL($date), 'date_upd' => pSQL($date)); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_config_service', $addTab, 'INSERT'); } // Display Results if ($result) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } // Delete Script if (Tools::getValue('action') == 'delete' && Tools::getValue('id_ups_rate_config')) { $result1 = Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); $result2 = Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.'ups_rate_config_service` WHERE `id_ups_rate_config` = '.(int)Tools::getValue('id_ups_rate_config')); // Display Results if ($result1) $this->_html .= $this->displayConfirmation($this->l('Settings updated')); else $this->_html .= $this->displayErrors($this->l('Settings failed')); } } /* ** Help Config Methods ** */ private function _displayHelp() { return '

'.$this->l('Welcome to the PrestaShop UPS Module configurator!').'

'.$this->l('This section will help you to understand how to configure this module correctly.').'


1. '.$this->l('General Settings').'

'.$this->l('See below for the description of each field :').'

'.$this->l('Your UPS Login, UPS Password, MyUps ID, UPS API Key').' : '.$this->l('Please subscribe to the UPS website at this address.').' https://www.ups.com/upsdeveloperkit

'.$this->l('Zip / Postal Code').' : '.$this->l('This field must be the Zip / Postal code of your package starting point.').'

'.$this->l('Country').' : '.$this->l('This field must be the country of your package starting point.').'

'.$this->l('Rate service group').' : '.$this->l('This field must be within the two fields above.').'

'.$this->l('Pickup Type').' : '.$this->l('This field corresponds to the pickup type you prefer with UPS.').'

'.$this->l('Packaging Type').' : '.$this->l('This field corresponds to the default packaging type (when there is no specific configuration for the product or the category product).').'

'.$this->l('Delivery Service').' : '.$this->l('These checkboxes correspond to the delivery services you want to be available (when there is no specific configuration for the product or the category product).').'


2. '.$this->l('Categories Settings').'

'.$this->l('This section allows you to define a specific UPS configuration for each product category (such as Packaging Type and Additional charges).').'


3. '.$this->l('Products Settings').'

'.$this->l('This section allows you to define a specific UPS configuration for each product (such as Packaging Type and Additional charges).').'


'; } public function hookupdateCarrier($params) { if ((int)($params['id_carrier']) != (int)($params['carrier']->id)) { $serviceSelected = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_carrier` = '.(int)$params['id_carrier']); $update = array('id_carrier' => (int)($params['carrier']->id), 'id_carrier_history' => pSQL($serviceSelected['id_carrier_history'].'|'.(int)($params['carrier']->id))); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_rate_service_code', $update, 'UPDATE', '`id_carrier` = '.(int)$params['id_carrier']); } } public function displayInfoByCart() { } /* ** Front Methods ** */ public function getCartCurrencyRate($id_currency_origin, $id_cart) { $conversionRate = 1; $cart = new Cart($id_cart); if ($cart->id_currency != $id_currency_origin) { $currencyOrigin = new Currency((int)$id_currency_origin); $conversionRate /= $currencyOrigin->conversion_rate; $currencySelect = new Currency((int)$cart->id_currency); $conversionRate *= $currencySelect->conversion_rate; } return $conversionRate; } public function getOrderShippingCostHash($wsParams) { $paramHash = ''; $productHash = ''; foreach ($wsParams['products'] as $product) { if (!empty($productHash)) $productHash .= '|'; $productHash .= $product['id_product'].':'.$product['id_product_attribute'].':'.$product['cart_quantity']; } foreach ($wsParams as $k => $v) if ($k != 'products') $paramHash .= '/'.$v; return md5($productHash.$paramHash.Configuration::get('UPS_CARRIER_CALCUL_MODE')); } public function getOrderShippingCostCache($wsParams) { // Get Cache $row = Db::getInstance()->getRow(" SELECT * FROM `"._DB_PREFIX_."ups_cache` WHERE `id_cart` = ".(int)($wsParams['id_cart'])." AND `id_carrier` = ".(int)($this->id_carrier)." AND `hash` = '".pSQL($wsParams['hash'])."'"); if ($row['id_currency']) { // Check Currency Rate And Calcul $conversionRate = $this->getCartCurrencyRate($row['id_currency'], $wsParams['id_cart']); $row['total_charges'] = $row['total_charges'] * $conversionRate; // Return Cache return $row; } return false; } public function saveOrderShippingCostCache($wsParams, $wscost) { $is_available = 1; if (!$wscost) $is_available = 0; $date = date('Y-m-d H:i:s'); $cart = new Cart((int)$wsParams['id_cart']); $insert = array( 'id_cart' => (int)($wsParams['id_cart']), 'id_carrier' => (int)($this->id_carrier), 'hash' => pSQL($wsParams['hash']), 'id_currency' => (int)($cart->id_currency), 'total_charges' => pSQL($wscost), 'is_available' => (int)($is_available), 'date_add' => pSQL($date), 'date_upd' => pSQL($date) ); Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_cache', $insert, 'INSERT'); } public function loadShippingCostConfig($product) { // Init var $config = array(); // Check if there is a specific product configuration if ($product['id_product'] > 0) { $productConfiguration = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_product` = '.(int)($product['id_product'])); if ($productConfiguration['id_ups_rate_config']) { $servicesConfiguration = Db::getInstance()->ExecuteS(' SELECT urcs.*, ursc.`id_carrier` FROM `'._DB_PREFIX_.'ups_rate_config_service` urcs LEFT JOIN `'._DB_PREFIX_.'ups_rate_service_code` ursc ON (ursc.`id_ups_rate_service_code` = urcs.`id_ups_rate_service_code`) WHERE `id_ups_rate_config` = '.(int)($productConfiguration['id_ups_rate_config'])); foreach ($servicesConfiguration as $service) $productConfiguration['services'][$service['id_ups_rate_service_code']] = $service; return $productConfiguration; } } // Check if there is a specific category configuration if ($product['id_category_default'] > 0) { $categoryConfiguration = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_config` WHERE `id_category` = '.(int)($product['id_category_default'])); if ($categoryConfiguration['id_ups_rate_config']) { $servicesConfiguration = Db::getInstance()->ExecuteS(' SELECT urcs.*, ursc.`id_carrier` FROM `'._DB_PREFIX_.'ups_rate_config_service` urcs LEFT JOIN `'._DB_PREFIX_.'ups_rate_service_code` ursc ON (ursc.`id_ups_rate_service_code` = urcs.`id_ups_rate_service_code`) WHERE `id_ups_rate_config` = '.(int)($categoryConfiguration['id_ups_rate_config'])); foreach ($servicesConfiguration as $service) $categoryConfiguration['services'][$service['id_ups_rate_service_code']] = $service; return $categoryConfiguration; } } // Return general config $config['packaging_type_code'] = Configuration::get('UPS_CARRIER_PACKAGING_TYPE'); $servicesConfiguration = Db::getInstance()->ExecuteS('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)(Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')).' AND `active` = 1'); foreach ($servicesConfiguration as $service) $config['services'][$service['id_ups_rate_service_code']] = $service; return $config; } public function getWebserviceShippingCost($wsParams) { // Init var $cost = 0; if (Configuration::get('UPS_CARRIER_CALCUL_MODE') == 'onepackage') { $width = 0; $height = 0; $depth = 0; $weight = 0; foreach ($wsParams['products'] as $product) { if ($product['width'] && $product['width'] > $width) $width = $product['width']; if ($product['height'] && $product['height'] > $height) $height = $product['height']; if ($product['depth'] && $product['depth'] > $depth) $depth = $product['depth']; if ($product['weight']) $weight += ($product['weight'] * $product['quantity']); } $weight += Tools::getValue('ups_carrier_packaging_weight', Configuration::get('UPS_CARRIER_PACKAGING_WEIGHT')); // Get service in adequation with carrier and check if available $serviceSelected = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `active` = 1 AND `id_carrier` = '.(int)($this->id_carrier)); if ($serviceSelected['id_ups_rate_service_code'] < 1) return false; $wsParams['service'] = $serviceSelected['code']; $wsParams['package_list'] = array(); $wsParams['package_list'][] = array( 'width' => ($width > 0 ? $width : 7), 'height' => ($height > 0 ? $height : 3), 'depth' => ($depth > 0 ? $depth : 5), 'weight' => ($weight > 0 ? $weight : 0.5), 'packaging_type' => Configuration::get('UPS_CARRIER_PACKAGING_TYPE'), ); } else { // Getting shipping cost for each product foreach ($wsParams['products'] as $product) { // Load specific configuration $config = $this->loadShippingCostConfig($product); // Get service in adequation with carrier and check if available $serviceSelected = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_carrier` = '.(int)($this->id_carrier)); if (!isset($config['services'][$serviceSelected['id_ups_rate_service_code']])) return false; // Load param product $wsParams['service'] = $serviceSelected['code']; for ($qty = 0; $qty < $product['quantity']; $qty++) $wsParams['package_list'][] = array( 'width' => ($product['width'] ? $product['width'] : 7), 'height' => ($product['height'] ? $product['height'] : 3), 'depth' => ($product['depth'] ? $product['depth'] : 5), 'weight' => ($product['weight'] ? $product['weight'] : 0.5), 'packaging_type' => ($config['packaging_type_code'] ? $config['packaging_type_code'] : Configuration::get('UPS_CARRIER_PACKAGING_TYPE')), ); // If Additional charges if (isset($config['id_currency']) && isset($config['additionnal_charges'])) { $conversionRate = 1; $conversionRate = $this->getCartCurrencyRate((int)($config['id_currency']), (int)$wsParams['id_cart']); $cost += ($config['additionnal_charges'] * $conversionRate); } } } // If webservice return a cost, we add it, else, we return the original shipping cost $result = $this->getUpsShippingCost($wsParams); if ($result['connect'] && $result['cost'] > 0) return ($cost + $result['cost'] + Tools::getValue('ups_carrier_handling_fee', Configuration::get('UPS_CARRIER_HANDLING_FEE'))); return false; } public function getOrderShippingCost($params, $shipping_cost) { // Init var $address = new Address($params->id_address_delivery); $recipient_country = Db::getInstance()->getRow('SELECT `iso_code` FROM `'._DB_PREFIX_.'country` WHERE `id_country` = '.(int)($address->id_country)); $recipient_state = Db::getInstance()->getRow('SELECT `iso_code` FROM `'._DB_PREFIX_.'state` WHERE `id_state` = '.(int)($address->id_state)); $shipper_country = Db::getInstance()->getRow('SELECT `iso_code` FROM `'._DB_PREFIX_.'country` WHERE `id_country` = '.(int)(Configuration::get('UPS_CARRIER_COUNTRY'))); $shipper_state = Db::getInstance()->getRow('SELECT `iso_code` FROM `'._DB_PREFIX_.'state` WHERE `id_state` = '.(int)(Configuration::get('UPS_CARRIER_STATE'))); $products = $params->getProducts(); // Webservices Params $wsParams = array( 'id_cart' => $params->id, 'id_address_delivery' => $params->id_address_delivery, 'recipient_address1' => $address->address1, 'recipient_address2' => $address->address2, 'recipient_postalcode' => $address->postcode, 'recipient_city' => $address->city, 'recipient_country_iso' => $recipient_country['iso_code'], 'recipient_state_iso' => $recipient_state['iso_code'], 'shipper_address1' => Configuration::get('UPS_CARRIER_ADDRESS1'), 'shipper_address2' => Configuration::get('UPS_CARRIER_ADDRESS2'), 'shipper_postalcode' => Configuration::get('UPS_CARRIER_POSTAL_CODE'), 'shipper_city' => Configuration::get('UPS_CARRIER_CITY'), 'shipper_country_iso' => $shipper_country['iso_code'], 'shipper_state_iso' => $shipper_state['iso_code'], 'pickup_type' => Configuration::get('UPS_CARRIER_PICKUP_TYPE'), 'packaging_type' => Configuration::get('UPS_CARRIER_PACKAGING_TYPE'), 'products' => $params->getProducts() ); $wsParams['hash'] = $this->getOrderShippingCostHash($wsParams); // Check cache $cache = $this->getOrderShippingCostCache($wsParams); if ($cache['id_ups_cache'] > 0) { if ($cache['is_available'] == 0) return false; if ($cache['total_charges']) return $cache['total_charges']; } // Get Webservices Cost and Cache it $wscost = $this->getWebserviceShippingCost($wsParams); $this->saveOrderShippingCostCache($wsParams, $wscost); if ($wscost > 0) return $wscost + $shipping_cost; return false; } public function getOrderShippingCostExternal($params) { return $this->getOrderShippingCost($params, 23); } /* ** Webservices Methods ** */ public function parseXML($valTab) { $level = 0; $levelTab = array(); $resultTab = array(); foreach ($valTab as $tmp) { if ($tmp['level'] > $level) $levelTab[] = $tmp['tag']; elseif ($tmp['level'] < $level) array_pop($levelTab); elseif ($tmp['level'] == $level) { array_pop($levelTab); $levelTab[] = $tmp['tag']; } $level = $tmp['level']; if ($tmp['type'] == 'complete' && isset($tmp['value'])) $this->recurseTab($resultTab, $levelTab, 0, $tmp['value']); } return $resultTab; } public function recurseTab(&$resultTab, $levelTab, $index, $value) { if (isset($levelTab[$index])) $this->recurseTab($resultTab[$levelTab[$index]], $levelTab, $index + 1, $value); else $resultTab = $value; } public function webserviceTest($service = '') { // Check API Key if (!Configuration::get('UPS_CARRIER_API_KEY')) return false; // Example Params for testing $shipper_country = Db::getInstance()->getRow('SELECT `iso_code` FROM `'._DB_PREFIX_.'country` WHERE `id_country` = '.(int)(Configuration::get('UPS_CARRIER_COUNTRY'))); $shipper_state = Db::getInstance()->getRow('SELECT `iso_code` FROM `'._DB_PREFIX_.'state` WHERE `id_state` = '.(int)(Configuration::get('UPS_CARRIER_STATE'))); $wsParams = array( 'recipient_address1' => Configuration::get('UPS_CARRIER_ADDRESS1'), 'recipient_address2' => Configuration::get('UPS_CARRIER_ADDRESS2'), 'recipient_postalcode' => Configuration::get('UPS_CARRIER_POSTAL_CODE'), 'recipient_city' => Configuration::get('UPS_CARRIER_CITY'), 'recipient_country_iso' => $shipper_country['iso_code'], 'recipient_state_iso' => $shipper_state['iso_code'], 'shipper_address1' => Configuration::get('UPS_CARRIER_ADDRESS1'), 'shipper_address2' => Configuration::get('UPS_CARRIER_ADDRESS2'), 'shipper_postalcode' => Configuration::get('UPS_CARRIER_POSTAL_CODE'), 'shipper_city' => Configuration::get('UPS_CARRIER_CITY'), 'shipper_country_iso' => $shipper_country['iso_code'], 'shipper_state_iso' => $shipper_state['iso_code'], 'package_list' => array( array('width' => 10, 'height' => 3, 'depth' => 10, 'weight' => 2.0, 'packaging_type' => Configuration::get('UPS_CARRIER_PACKAGING_TYPE')), array('width' => 3, 'height' => 3, 'depth' => 3, 'weight' => 1.0, 'packaging_type' => Configuration::get('UPS_CARRIER_PACKAGING_TYPE')), ), ); // Unit or Large Test if (!empty($service)) $servicesList = array(array('code' => $service)); else $servicesList = Db::getInstance()->ExecuteS('SELECT `code` FROM `'._DB_PREFIX_.'ups_rate_service_code` WHERE `id_ups_rate_service_group` = '.(int)Configuration::get('UPS_CARRIER_RATE_SERVICE_GROUP')); // Testing Service foreach ($servicesList as $service) { // Sending Request $wsParams['service'] = $service['code']; $resultTab = Db::getInstance()->getValue('SELECT `result` FROM `'._DB_PREFIX_.'ups_cache_test` WHERE `hash` = \''.pSQL(md5($this->getXml($wsParams))).'\''); if ($resultTab) $resultTab = unserialize($resultTab); else $resultTab = $this->sendRequest($wsParams); // Return results if (isset($resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['RESPONSESTATUSDESCRIPTION']) && $resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['RESPONSESTATUSDESCRIPTION'] == 'Success') { Db::getInstance()->autoExecute(_DB_PREFIX_.'ups_cache_test', array('hash' => pSQL(md5($this->getXml($wsParams))), 'result' => pSQL(serialize($resultTab)), 'date_add' => pSQL(date('Y-m-d H:i:s')), 'date_upd' => pSQL(date('Y-m-d H:i:s'))), 'INSERT'); return true; } if (isset($resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['ERROR']['ERRORDESCRIPTION'])) $this->_webserviceError = $this->l('Error').' '.$resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['ERROR']['ERRORCODE'].' : '.$resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['ERROR']['ERRORDESCRIPTION']; else { $this->_webserviceError = $this->l('UPS Webservice seems to be down, please wait a few minutes and try again'); return false; } } return false; } public function getUpsShippingCost($wsParams) { // Check Arguments if (!$wsParams) return array('connect' => false, 'cost' => 0); // Sending Request $resultTab = $this->sendRequest($wsParams); // Check currency $conversionRate = 1; if (isset($resultTab['RATINGSERVICESELECTIONRESPONSE']['RATEDSHIPMENT']['TOTALCHARGES']['CURRENCYCODE'])) { $id_currency_return = Db::getInstance()->getValue('SELECT `id_currency` FROM `'._DB_PREFIX_.'currency` WHERE `iso_code` = \''.pSQL($resultTab['RATINGSERVICESELECTIONRESPONSE']['RATEDSHIPMENT']['TOTALCHARGES']['CURRENCYCODE']).'\''); $conversionRate = $this->getCartCurrencyRate($id_currency_return, $wsParams['id_cart']); } // Return results if (isset ($resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['RESPONSESTATUSDESCRIPTION']) && $resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['RESPONSESTATUSDESCRIPTION'] == 'Success') return array('connect' => true, 'cost' => $resultTab['RATINGSERVICESELECTIONRESPONSE']['RATEDSHIPMENT']['TOTALCHARGES']['MONETARYVALUE'] * $conversionRate); if (isset($resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['ERROR']['ERRORDESCRIPTION'])) $this->_webserviceError = $resultTab['RATINGSERVICESELECTIONRESPONSE']['RESPONSE']['ERROR']['ERRORDESCRIPTION']; else $this->_webserviceError = $this->l('UPS Webservice seems to be down, please wait a few minutes and try again'); return array('connect' => false, 'cost' => 0); } public function sendRequest($wsParams) { // POST Request $errno = $errstr = $result = ''; $xml = $this->getXml($wsParams); if (is_callable('curl_exec')) { // Curl Request $ch = curl_init("https://www.ups.com/ups.app/xml/Rate"); curl_setopt($ch, CURLOPT_HEADER, 1); curl_setopt($ch,CURLOPT_POST,1); curl_setopt($ch,CURLOPT_TIMEOUT, 60); curl_setopt($ch,CURLOPT_RETURNTRANSFER,1); curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch,CURLOPT_POSTFIELDS,$xml); $result = curl_exec ($ch); } else { // FsockOpen Request $timeout = 5; $fp = fsockopen("ssl://www.ups.com", "443", $errno, $errstr, $timeout); if ($fp) { $request = "POST /ups.app/xml/Rate HTTP/1.1\r\n"; $request .= "Host: www.ups.com\r\n"; $request .= "Content-type: application/x-www-form-urlencoded\r\n"; $request .= "Connection: Close\r\n"; $request .= "Content-length: ".strlen($xml)."\r\n\r\n"; $request .= $xml."\r\n\r\n"; fwrite($fp, $request); stream_set_blocking($fp, TRUE); stream_set_timeout($fp,$timeout); $info = stream_get_meta_data($fp); $result = ''; while ((!feof($fp)) && (!$info['timed_out'])) { $result .= fgets($fp, 4096); $info = stream_get_meta_data($fp); } if ($info['timed_out']) { $this->_webserviceError = $this->l('UPS Webservice timed out.'); return false; } } else { $this->_webserviceError = $this->l('Could not connect to UPS.com'); return false; } } // Get xml from HTTP Result $data = strstr($result, 'parseXML($valTab); return $resultTab; } public function getXml($wsParams = array()) { $xmlPackageList = ''; $xmlPackageTemplate = @file_get_contents(dirname(__FILE__).'/xml-package.tpl'); foreach ($wsParams['package_list'] as $p) { $search = array('[[PackagingTypeCode]]', '[[PackageWeight]]', '[[WeightUnit]]', '[[Width]]', '[[Height]]', '[[Length]]', '[[DimensionUnit]]'); $replace = array($p['packaging_type'], $p['weight'], $this->_weightUnit, $p['width'], $p['height'], $p['depth'], $this->_dimensionUnit); $xmlPackageList .= str_replace($search, $replace, $xmlPackageTemplate); } $search = array( '[[AccessLicenseNumber]]', '[[UserId]]', '[[Password]]', '[[PickupTypeCode]]', '[[ShipperNumber]]', '[[ShipperAddressLine1]]', '[[ShipperAddressLine2]]', '[[ShipperCity]]', '[[ShipperPostalCode]]', '[[ShipperCountryCode]]', '[[ShipperStateCode]]', '[[ShipToAddressLine1]]', '[[ShipToAddressLine2]]', '[[ShipToCity]]', '[[ShipToPostalCode]]', '[[ShipToCountryCode]]', '[[ShipToStateCode]]', '[[ShipFromAddressLine1]]', '[[ShipFromAddressLine2]]', '[[ShipFromCity]]', '[[ShipFromPostalCode]]', '[[ShipFromCountryCode]]', '[[ShipFromStateCode]]', '[[Service]]', '[[PackageList]]' ); $replace = array( Configuration::get('UPS_CARRIER_API_KEY'), Configuration::get('UPS_CARRIER_LOGIN'), Configuration::get('UPS_CARRIER_PASSWORD'), Configuration::get('UPS_CARRIER_PICKUP_TYPE'), Configuration::get('UPS_CARRIER_SHIPPER_ID'), $wsParams['shipper_address1'], $wsParams['shipper_address2'], $wsParams['shipper_city'], $wsParams['shipper_postalcode'], $wsParams['shipper_country_iso'], $wsParams['shipper_state_iso'], $wsParams['recipient_address1'], $wsParams['recipient_address2'], $wsParams['recipient_city'], $wsParams['recipient_postalcode'], $wsParams['recipient_country_iso'], $wsParams['recipient_state_iso'], $wsParams['shipper_address1'], $wsParams['shipper_address2'], $wsParams['shipper_city'], $wsParams['shipper_postalcode'], $wsParams['shipper_country_iso'], $wsParams['shipper_state_iso'], $wsParams['service'], $xmlPackageList ); $xmlTemplate = @file_get_contents(dirname(__FILE__).'/xml.tpl'); $xml = str_replace($search, $replace, $xmlTemplate); return $xml; } } ?>