* @copyright 2007-2019 PrestaShop SA and Contributors * @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) * International Registered Trademark & Property of PrestaShop SA */ /** * @property Carrier $object */ class AdminCarriersControllerCore extends AdminController { protected $position_identifier = 'id_carrier'; public function __construct() { if ($id_carrier = Tools::getValue('id_carrier') && !Tools::isSubmit('deletecarrier') && !Tools::isSubmit('statuscarrier') && !Tools::isSubmit('isFreecarrier')) { Tools::redirectAdmin(Context::getContext()->link->getAdminLink('AdminCarrierWizard', true, array(), array('id_carrier' => (int) $id_carrier))); } $this->bootstrap = true; $this->table = 'carrier'; $this->className = 'Carrier'; $this->lang = false; $this->deleted = true; $this->addRowAction('edit'); $this->addRowAction('delete'); $this->_defaultOrderBy = 'position'; parent::__construct(); $this->bulk_actions = array( 'delete' => array( 'text' => $this->trans('Delete selected', array(), 'Admin.Notifications.Info'), 'confirm' => $this->trans('Delete selected items?', array(), 'Admin.Notifications.Info'), 'icon' => 'icon-trash', ), ); $this->fieldImageSettings = array( 'name' => 'logo', 'dir' => 's', ); $this->fields_list = array( 'id_carrier' => array( 'title' => $this->trans('ID', array(), 'Admin.Global'), 'align' => 'center', 'class' => 'fixed-width-xs', ), 'name' => array( 'title' => $this->trans('Name', array(), 'Admin.Global'), ), 'image' => array( 'title' => $this->trans('Logo', array(), 'Admin.Global'), 'align' => 'center', 'image' => 's', 'class' => 'fixed-width-xs', 'orderby' => false, 'search' => false, ), 'delay' => array( 'title' => $this->trans('Delay', array(), 'Admin.Shipping.Feature'), 'orderby' => false, ), 'active' => array( 'title' => $this->trans('Status', array(), 'Admin.Global'), 'align' => 'center', 'active' => 'status', 'type' => 'bool', 'class' => 'fixed-width-sm', 'orderby' => false, ), 'is_free' => array( 'title' => $this->trans('Free Shipping', array(), 'Admin.Shipping.Feature'), 'align' => 'center', 'active' => 'isFree', 'type' => 'bool', 'class' => 'fixed-width-sm', 'orderby' => false, ), 'position' => array( 'title' => $this->trans('Position', array(), 'Admin.Global'), 'filter_key' => 'a!position', 'align' => 'center', 'class' => 'fixed-width-sm', 'position' => 'position', ), ); } public function initToolbar() { parent::initToolbar(); if (isset($this->toolbar_btn['new']) && $this->display != 'view') { $this->toolbar_btn['new']['href'] = $this->context->link->getAdminLink('AdminCarrierWizard'); } } public function initPageHeaderToolbar() { $this->page_header_toolbar_title = $this->trans('Carriers', array(), 'Admin.Shipping.Feature'); if ($this->display != 'view') { $this->page_header_toolbar_btn['new_carrier'] = array( 'href' => $this->context->link->getAdminLink('AdminCarrierWizard'), 'desc' => $this->trans('Add new carrier', array(), 'Admin.Shipping.Feature'), 'icon' => 'process-icon-new', ); } parent::initPageHeaderToolbar(); } public function renderList() { $this->_select = 'b.*'; $this->_join = 'INNER JOIN `' . _DB_PREFIX_ . 'carrier_lang` b ON a.id_carrier = b.id_carrier' . Shop::addSqlRestrictionOnLang('b') . ' AND b.id_lang = ' . (int) $this->context->language->id . ' LEFT JOIN `' . _DB_PREFIX_ . 'carrier_tax_rules_group_shop` ctrgs ON (a.`id_carrier` = ctrgs.`id_carrier` AND ctrgs.id_shop=' . (int) $this->context->shop->id . ')'; $this->_use_found_rows = false; // Removes the Recommended modules button unset($this->page_header_toolbar_btn['modules-list']); // test if need to show header alert. $sql = 'SELECT COUNT(1) FROM `' . _DB_PREFIX_ . 'carrier` WHERE deleted = 0 AND id_reference > 2'; $showHeaderAlert = (Db::getInstance()->executeS($sql, false)->fetchColumn(0) == 0); // Assign them in two steps! Because renderModulesList needs it before to be called. $this->context->smarty->assign('panel_title', $this->trans('Use one of our recommended carrier modules', array(), 'Admin.Shipping.Feature')); $this->context->smarty->assign('panel_id', 'recommended-carriers-panel'); $this->context->smarty->assign(array( 'showHeaderAlert' => $showHeaderAlert, 'modules_list' => $this->renderModulesList('back-office,AdminCarriers,new'), )); return parent::renderList(); } public function renderForm() { $this->fields_form = array( 'legend' => array( 'title' => $this->trans('Carriers', array(), 'Admin.Shipping.Feature'), 'icon' => 'icon-truck', ), 'input' => array( array( 'type' => 'text', 'label' => $this->trans('Company', array(), 'Admin.Global'), 'name' => 'name', 'required' => true, 'hint' => array( $this->trans('Allowed characters: letters, spaces and "%special_chars%".', array('%special_chars%' => '().-'), 'Admin.Shipping.Help'), $this->trans('Carrier name displayed during checkout', array(), 'Admin.Shipping.Help'), $this->trans('For in-store pickup, enter 0 to replace the carrier name with your shop name.', array(), 'Admin.Shipping.Help'), ), ), array( 'type' => 'file', 'label' => $this->trans('Logo', array(), 'Admin.Global'), 'name' => 'logo', 'hint' => $this->trans('Upload a logo from your computer.', array(), 'Admin.Shipping.Help') . ' (.gif, .jpg, .jpeg ' . $this->trans('or', array(), 'Admin.Shipping.Help') . ' .png)', ), array( 'type' => 'text', 'label' => $this->trans('Transit time', array(), 'Admin.Shipping.Feature'), 'name' => 'delay', 'lang' => true, 'required' => true, 'maxlength' => 512, 'hint' => $this->trans('Estimated delivery time will be displayed during checkout.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'text', 'label' => $this->trans('Speed grade', array(), 'Admin.Shipping.Feature'), 'name' => 'grade', 'required' => false, 'hint' => $this->trans('Enter "0" for a longest shipping delay, or "9" for the shortest shipping delay.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'text', 'label' => $this->trans('URL', array(), 'Admin.Global'), 'name' => 'url', 'hint' => $this->trans('Delivery tracking URL: Type \'@\' where the tracking number should appear. It will then be automatically replaced by the tracking number.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'checkbox', 'label' => $this->trans('Zone', array(), 'Admin.Global'), 'name' => 'zone', 'values' => array( 'query' => Zone::getZones(false), 'id' => 'id_zone', 'name' => 'name', ), 'hint' => $this->trans('The zones in which this carrier will be used.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'group', 'label' => $this->trans('Group access', array(), 'Admin.Shipping.Help'), 'name' => 'groupBox', 'values' => Group::getGroups(Context::getContext()->language->id), 'hint' => $this->trans('Mark the groups that are allowed access to this carrier.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'switch', 'label' => $this->trans('Status', array(), 'Admin.Global'), 'name' => 'active', 'required' => false, 'class' => 't', 'is_bool' => true, 'values' => array( array( 'id' => 'active_on', 'value' => 1, 'label' => $this->trans('Enabled', array(), 'Admin.Global'), ), array( 'id' => 'active_off', 'value' => 0, 'label' => $this->trans('Disabled', array(), 'Admin.Global'), ), ), 'hint' => $this->trans('Enable the carrier in the front office.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'switch', 'label' => $this->trans('Apply shipping cost', array(), 'Admin.Shipping.Feature'), 'name' => 'is_free', 'required' => false, 'class' => 't', 'values' => array( array( 'id' => 'is_free_on', 'value' => 0, 'label' => '' . $this->trans('Yes', array(), 'Admin.Global') . '', ), array( 'id' => 'is_free_off', 'value' => 1, 'label' => '' . $this->trans('No', array(), 'Admin.Global') . '', ), ), 'hint' => $this->trans('Apply both regular shipping cost and product-specific shipping costs.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'select', 'label' => $this->trans('Tax', array(), 'Admin.Global'), 'name' => 'id_tax_rules_group', 'options' => array( 'query' => TaxRulesGroup::getTaxRulesGroups(true), 'id' => 'id_tax_rules_group', 'name' => 'name', 'default' => array( 'label' => $this->trans('No Tax', array(), 'Admin.Global'), 'value' => 0, ), ), ), array( 'type' => 'switch', 'label' => $this->trans('Shipping and handling', array(), 'Admin.Shipping.Feature'), 'name' => 'shipping_handling', 'required' => false, 'class' => 't', 'is_bool' => true, 'values' => array( array( 'id' => 'shipping_handling_on', 'value' => 1, 'label' => $this->trans('Enabled', array(), 'Admin.Global'), ), array( 'id' => 'shipping_handling_off', 'value' => 0, 'label' => $this->trans('Disabled', array(), 'Admin.Global'), ), ), 'hint' => $this->trans('Include the shipping and handling costs in the carrier price.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'radio', 'label' => $this->trans('Billing', array(), 'Admin.Shipping.Feature'), 'name' => 'shipping_method', 'required' => false, 'class' => 't', 'br' => true, 'values' => array( array( 'id' => 'billing_default', 'value' => Carrier::SHIPPING_METHOD_DEFAULT, 'label' => $this->trans('Default behavior', array(), 'Admin.Shipping.Feature'), ), array( 'id' => 'billing_price', 'value' => Carrier::SHIPPING_METHOD_PRICE, 'label' => $this->trans('According to total price', array(), 'Admin.Shipping.Feature'), ), array( 'id' => 'billing_weight', 'value' => Carrier::SHIPPING_METHOD_WEIGHT, 'label' => $this->trans('According to total weight', array(), 'Admin.Shipping.Feature'), ), ), ), array( 'type' => 'select', 'label' => $this->trans('Out-of-range behavior', array(), 'Admin.Shipping.Feature'), 'name' => 'range_behavior', 'options' => array( 'query' => array( array( 'id' => 0, 'name' => $this->trans('Apply the cost of the highest defined range', array(), 'Admin.Shipping.Help'), ), array( 'id' => 1, 'name' => $this->trans('Disable carrier', array(), 'Admin.Shipping.Feature'), ), ), 'id' => 'id', 'name' => 'name', ), 'hint' => $this->trans('Out-of-range behavior occurs when none is defined (e.g. when a customer\'s cart weight is greater than the highest range limit).', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'text', 'label' => $this->trans('Maximum package height', array(), 'Admin.Shipping.Feature'), 'name' => 'max_height', 'required' => false, 'hint' => $this->trans('Maximum height managed by this carrier. Set the value to "0," or leave this field blank to ignore.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'text', 'label' => $this->trans('Maximum package width', array(), 'Admin.Shipping.Feature'), 'name' => 'max_width', 'required' => false, 'hint' => $this->trans('Maximum width managed by this carrier. Set the value to "0," or leave this field blank to ignore.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'text', 'label' => $this->trans('Maximum package depth', array(), 'Admin.Shipping.Feature'), 'name' => 'max_depth', 'required' => false, 'hint' => $this->trans('Maximum depth managed by this carrier. Set the value to "0," or leave this field blank to ignore.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'text', 'label' => $this->trans('Maximum package weight', array(), 'Admin.Shipping.Feature'), 'name' => 'max_weight', 'required' => false, 'hint' => $this->trans('Maximum weight managed by this carrier. Set the value to "0," or leave this field blank to ignore.', array(), 'Admin.Shipping.Help'), ), array( 'type' => 'hidden', 'name' => 'is_module', ), array( 'type' => 'hidden', 'name' => 'external_module_name', ), array( 'type' => 'hidden', 'name' => 'shipping_external', ), array( 'type' => 'hidden', 'name' => 'need_range', ), ), ); if (Shop::isFeatureActive()) { $this->fields_form['input'][] = array( 'type' => 'shop', 'label' => $this->trans('Shop association', array(), 'Admin.Global'), 'name' => 'checkBoxShopAsso', ); } $this->fields_form['submit'] = array( 'title' => $this->trans('Save', array(), 'Admin.Actions'), ); if (!($obj = $this->loadObject(true))) { return; } $this->getFieldsValues($obj); return parent::renderForm(); } public function postProcess() { if (Tools::getValue('action') == 'GetModuleQuickView' && Tools::getValue('ajax') == '1') { $this->ajaxProcessGetModuleQuickView(); } if (Tools::getValue('submitAdd' . $this->table)) { /* Checking fields validity */ $this->validateRules(); if (!count($this->errors)) { $id = (int) Tools::getValue('id_' . $this->table); /* Object update */ if (isset($id) && !empty($id)) { try { if ($this->access('edit')) { $current_carrier = new Carrier($id); if (!Validate::isLoadedObject($current_carrier)) { throw new PrestaShopException('Cannot load Carrier object'); } /** @var Carrier $new_carrier */ // Duplicate current Carrier $new_carrier = $current_carrier->duplicateObject(); if (Validate::isLoadedObject($new_carrier)) { // Set flag deteled to true for historization $current_carrier->deleted = true; $current_carrier->update(); // Fill the new carrier object $this->copyFromPost($new_carrier, $this->table); $new_carrier->position = $current_carrier->position; $new_carrier->update(); $this->updateAssoShop($new_carrier->id); $new_carrier->copyCarrierData((int) $current_carrier->id); $this->changeGroups($new_carrier->id); // Call of hooks Hook::exec('actionCarrierUpdate', array( 'id_carrier' => (int) $current_carrier->id, 'carrier' => $new_carrier, )); $this->postImage($new_carrier->id); $this->changeZones($new_carrier->id); $new_carrier->setTaxRulesGroup((int) Tools::getValue('id_tax_rules_group')); Tools::redirectAdmin(self::$currentIndex . '&id_' . $this->table . '=' . $current_carrier->id . '&conf=4&token=' . $this->token); } else { $this->errors[] = $this->trans('An error occurred while updating an object.', array(), 'Admin.Notifications.Error') . ' ' . $this->table . ''; } } else { $this->errors[] = $this->trans('You do not have permission to edit this.', array(), 'Admin.Notifications.Error'); } } catch (PrestaShopException $e) { $this->errors[] = $e->getMessage(); } } else { // Object creation if ($this->access('add')) { // Create new Carrier $carrier = new Carrier(); $this->copyFromPost($carrier, $this->table); $carrier->position = Carrier::getHigherPosition() + 1; if ($carrier->add()) { if (($_POST['id_' . $this->table] = $carrier->id /* voluntary */) && $this->postImage($carrier->id) && $this->_redirect) { $carrier->setTaxRulesGroup((int) Tools::getValue('id_tax_rules_group'), true); $this->changeZones($carrier->id); $this->changeGroups($carrier->id); $this->updateAssoShop($carrier->id); Tools::redirectAdmin(self::$currentIndex . '&id_' . $this->table . '=' . $carrier->id . '&conf=3&token=' . $this->token); } } else { $this->errors[] = $this->trans('An error occurred while creating an object.', array(), 'Admin.Notifications.Error') . ' ' . $this->table . ''; } } else { $this->errors[] = $this->trans('You do not have permission to add this.', array(), 'Admin.Notifications.Error'); } } } parent::postProcess(); } elseif (isset($_GET['isFree' . $this->table])) { $this->processIsFree(); } else { // if deletion : removes the carrier from the warehouse/carrier association if (Tools::isSubmit('delete' . $this->table)) { $id = (int) Tools::getValue('id_' . $this->table); // Delete from the reference_id and not from the carrier id $carrier = new Carrier((int) $id); Warehouse::removeCarrier($carrier->id_reference); } elseif (Tools::isSubmit($this->table . 'Box') && count(Tools::isSubmit($this->table . 'Box')) > 0) { $ids = Tools::getValue($this->table . 'Box'); array_walk($ids, 'intval'); foreach ($ids as $id) { // Delete from the reference_id and not from the carrier id $carrier = new Carrier((int) $id); Warehouse::removeCarrier($carrier->id_reference); } } parent::postProcess(); Carrier::cleanPositions(); } } public function processIsFree() { $carrier = new Carrier($this->id_object); if (!Validate::isLoadedObject($carrier)) { $this->errors[] = $this->trans('An error occurred while updating carrier information.', array(), 'Admin.Shipping.Notification'); } $carrier->is_free = $carrier->is_free ? 0 : 1; if (!$carrier->update()) { $this->errors[] = $this->trans('An error occurred while updating carrier information.', array(), 'Admin.Shipping.Notification'); } Tools::redirectAdmin(self::$currentIndex . '&token=' . $this->token); } /** * Overload the property $fields_value. * * @param object $obj */ public function getFieldsValues($obj) { if ($this->getFieldValue($obj, 'is_module')) { $this->fields_value['is_module'] = 1; } if ($this->getFieldValue($obj, 'shipping_external')) { $this->fields_value['shipping_external'] = 1; } if ($this->getFieldValue($obj, 'need_range')) { $this->fields_value['need_range'] = 1; } // Added values of object Zone $carrier_zones = $obj->getZones(); $carrier_zones_ids = array(); if (is_array($carrier_zones)) { foreach ($carrier_zones as $carrier_zone) { $carrier_zones_ids[] = $carrier_zone['id_zone']; } } $zones = Zone::getZones(false); foreach ($zones as $zone) { $this->fields_value['zone_' . $zone['id_zone']] = Tools::getValue('zone_' . $zone['id_zone'], (in_array($zone['id_zone'], $carrier_zones_ids))); } // Added values of object Group $carrier_groups = $obj->getGroups(); $carrier_groups_ids = array(); if (is_array($carrier_groups)) { foreach ($carrier_groups as $carrier_group) { $carrier_groups_ids[] = $carrier_group['id_group']; } } $groups = Group::getGroups($this->context->language->id); foreach ($groups as $group) { $this->fields_value['groupBox_' . $group['id_group']] = Tools::getValue('groupBox_' . $group['id_group'], (in_array($group['id_group'], $carrier_groups_ids) || empty($carrier_groups_ids) && !$obj->id)); } $this->fields_value['id_tax_rules_group'] = $this->object->getIdTaxRulesGroup($this->context); } /** * @param Carrier $object * * @return int */ protected function beforeDelete($object) { return $object->isUsed(); } protected function changeGroups($id_carrier, $delete = true) { if ($delete) { Db::getInstance()->execute('DELETE FROM ' . _DB_PREFIX_ . 'carrier_group WHERE id_carrier = ' . (int) $id_carrier); } $groups = Db::getInstance()->executeS('SELECT id_group FROM `' . _DB_PREFIX_ . 'group`'); foreach ($groups as $group) { if (Tools::getIsset('groupBox') && in_array($group['id_group'], Tools::getValue('groupBox'))) { Db::getInstance()->execute(' INSERT INTO ' . _DB_PREFIX_ . 'carrier_group (id_group, id_carrier) VALUES(' . (int) $group['id_group'] . ',' . (int) $id_carrier . ') '); } } } public function changeZones($id) { /** @var Carrier $carrier */ $carrier = new $this->className($id); if (!Validate::isLoadedObject($carrier)) { die($this->trans('The object cannot be loaded.', array(), 'Admin.Notifications.Error')); } $zones = Zone::getZones(false); foreach ($zones as $zone) { if (count($carrier->getZone($zone['id_zone']))) { if (!isset($_POST['zone_' . $zone['id_zone']]) || !$_POST['zone_' . $zone['id_zone']]) { $carrier->deleteZone($zone['id_zone']); } } elseif (isset($_POST['zone_' . $zone['id_zone']]) && $_POST['zone_' . $zone['id_zone']]) { $carrier->addZone($zone['id_zone']); } } } /** * Modifying initial getList method to display position feature (drag and drop). * * @param int $id_lang * @param string|null $order_by * @param string|null $order_way * @param int $start * @param int|null $limit * @param int|bool $id_lang_shop * * @throws PrestaShopException */ public function getList($id_lang, $order_by = null, $order_way = null, $start = 0, $limit = null, $id_lang_shop = false) { parent::getList($id_lang, $order_by, $order_way, $start, $limit, $id_lang_shop); foreach ($this->_list as $key => $list) { if ($list['name'] == '0') { $this->_list[$key]['name'] = Carrier::getCarrierNameFromShopName(); } } } public function ajaxProcessUpdatePositions() { $way = (int) (Tools::getValue('way')); $id_carrier = (int) (Tools::getValue('id')); $positions = Tools::getValue($this->table); foreach ($positions as $position => $value) { $pos = explode('_', $value); if (isset($pos[2]) && (int) $pos[2] === $id_carrier) { if ($carrier = new Carrier((int) $pos[2])) { if (isset($position) && $carrier->updatePosition($way, $position)) { echo 'ok position ' . (int) $position . ' for carrier ' . (int) $pos[1] . '\r\n'; } else { echo '{"hasError" : true, "errors" : "Can not update carrier ' . (int) $id_carrier . ' to position ' . (int) $position . ' "}'; } } else { echo '{"hasError" : true, "errors" : "This carrier (' . (int) $id_carrier . ') can t be loaded"}'; } break; } } } public function displayEditLink($token, $id, $name = null) { if ($this->access('edit')) { $tpl = $this->createTemplate('helpers/list/list_action_edit.tpl'); if (!array_key_exists('Edit', self::$cache_lang)) { self::$cache_lang['Edit'] = $this->trans('Edit', array(), 'Admin.Actions'); } $tpl->assign(array( 'href' => $this->context->link->getAdminLink('AdminCarrierWizard', true, array(), array('id_carrier' => (int) $id)), 'action' => self::$cache_lang['Edit'], 'id' => $id, )); return $tpl->fetch(); } else { return; } } public function displayDeleteLink($token, $id, $name = null) { if ($this->access('delete')) { $tpl = $this->createTemplate('helpers/list/list_action_delete.tpl'); if (!array_key_exists('Delete', self::$cache_lang)) { self::$cache_lang['Delete'] = $this->trans('Delete', array(), 'Admin.Actions'); } if (!array_key_exists('DeleteItem', self::$cache_lang)) { self::$cache_lang['DeleteItem'] = $this->trans('Delete selected item?', array(), 'Admin.Notifications.Info'); } if (!array_key_exists('Name', self::$cache_lang)) { self::$cache_lang['Name'] = $this->trans('Name:', array(), 'Admin.Shipping.Feature'); } if (null !== $name) { $name = '\n\n' . self::$cache_lang['Name'] . ' ' . $name; } $data = array( $this->identifier => $id, 'href' => $this->context->link->getAdminLink('AdminCarriers', true, array(), array('id_carrier' => (int) $id, 'deletecarrier' => 1)), 'action' => self::$cache_lang['Delete'], ); if ($this->specificConfirmDelete !== false) { $data['confirm'] = null !== $this->specificConfirmDelete ? '\r' . $this->specificConfirmDelete : addcslashes(Tools::htmlentitiesDecodeUTF8(self::$cache_lang['DeleteItem'] . $name), '\''); } $tpl->assign(array_merge($this->tpl_delete_link_vars, $data)); return $tpl->fetch(); } else { return; } } protected function initTabModuleList() { parent::initTabModuleList(); $this->filter_modules_list = $this->tab_modules_list['default_list'] = $this->tab_modules_list['slider_list']; } }