* @copyright Since 2007 PrestaShop SA and Contributors * @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) */ /** * @property OrderState $object */ class AdminStatusesControllerCore extends AdminController { public function __construct() { $this->bootstrap = true; $this->table = 'order_state'; $this->className = 'OrderState'; $this->lang = true; $this->deleted = true; $this->colorOnBackground = false; $this->multishop_context = Shop::CONTEXT_ALL; $this->imageType = 'gif'; $this->fieldImageSettings = [ 'name' => 'icon', 'dir' => 'os', ]; parent::__construct(); $this->bulk_actions = ['delete' => ['text' => $this->trans('Delete selected', [], 'Admin.Actions'), 'confirm' => $this->trans('Delete selected items?', [], 'Admin.Notifications.Warning')]]; } public function init() { if (Tools::isSubmit('addorder_return_state')) { $this->display = 'add'; } if (Tools::isSubmit('updateorder_return_state')) { $this->display = 'edit'; } return parent::init(); } /** * init all variables to render the order status list. */ protected function initOrderStatusList(): void { $this->table = 'order_state'; $this->className = 'OrderState'; $this->_defaultOrderBy = $this->identifier = 'id_order_state'; $this->list_id = 'order_state'; $this->deleted = true; $this->_orderBy = null; $this->fields_list = [ 'id_order_state' => [ 'title' => $this->trans('ID', [], 'Admin.Global'), 'align' => 'text-center', 'class' => 'fixed-width-xs', ], 'name' => [ 'title' => $this->trans('Name', [], 'Admin.Global'), 'width' => 'auto', 'color' => 'color', ], 'logo' => [ 'title' => $this->trans('Icon', [], 'Admin.Shopparameters.Feature'), 'align' => 'text-center', 'image' => 'os', 'orderby' => false, 'search' => false, 'class' => 'fixed-width-xs', ], 'send_email' => [ 'title' => $this->trans('Send email to customer', [], 'Admin.Shopparameters.Feature'), 'align' => 'text-center', 'active' => 'sendEmail', 'type' => 'bool', 'ajax' => true, 'orderby' => false, 'class' => 'fixed-width-sm', ], 'delivery' => [ 'title' => $this->trans('Delivery', [], 'Admin.Global'), 'align' => 'text-center', 'active' => 'delivery', 'type' => 'bool', 'ajax' => true, 'orderby' => false, 'class' => 'fixed-width-sm', ], 'invoice' => [ 'title' => $this->trans('Invoice', [], 'Admin.Global'), 'align' => 'text-center', 'active' => 'invoice', 'type' => 'bool', 'ajax' => true, 'orderby' => false, 'class' => 'fixed-width-sm', ], 'template' => [ 'title' => $this->trans('Email template', [], 'Admin.Shopparameters.Feature'), ], ]; } /** * Init all variables to render the order status list. * * @deprecated Use `initOrderStatusList` */ protected function initOrderStatutsList() { $this->initOrderStatusList(); } /** * init all variables to render the order return list. */ protected function initOrdersReturnsList() { $this->table = 'order_return_state'; $this->className = 'OrderReturnState'; $this->_defaultOrderBy = $this->identifier = 'id_order_return_state'; $this->list_id = 'order_return_state'; $this->deleted = false; $this->_orderBy = null; $this->fields_list = [ 'id_order_return_state' => [ 'title' => $this->trans('ID', [], 'Admin.Global'), 'align' => 'center', 'class' => 'fixed-width-xs', ], 'name' => [ 'title' => $this->trans('Name', [], 'Admin.Global'), 'align' => 'left', 'width' => 'auto', 'color' => 'color', ], ]; } protected function initOrderReturnsForm() { $id_order_return_state = (int) Tools::getValue('id_order_return_state'); // Create Object OrderReturnState $order_return_state = new OrderReturnState($id_order_return_state); //init field form variable for order return form $this->fields_form = []; //$this->initToolbar(); $this->getlanguages(); $helper = new HelperForm(); $helper->currentIndex = self::$currentIndex; $helper->token = $this->token; $helper->table = 'order_return_state'; $helper->identifier = 'id_order_return_state'; $helper->id = $order_return_state->id; $helper->toolbar_scroll = false; $helper->languages = $this->_languages; $helper->default_form_language = $this->default_form_language; $helper->allow_employee_form_lang = $this->allow_employee_form_lang; if ($order_return_state->id) { $helper->fields_value = [ 'name' => $this->getFieldValue($order_return_state, 'name'), 'color' => $this->getFieldValue($order_return_state, 'color'), ]; } else { $helper->fields_value = [ 'name' => $this->getFieldValue($order_return_state, 'name'), 'color' => '#ffffff', ]; } $helper->toolbar_btn = $this->toolbar_btn; $helper->title = $this->trans('Edit return status', [], 'Admin.Shopparameters.Feature'); return $helper; } public function initPageHeaderToolbar() { if (empty($this->display)) { $this->page_header_toolbar_btn['new_order_state'] = [ 'href' => self::$currentIndex . '&addorder_state&token=' . $this->token, 'desc' => $this->trans('Add new order status', [], 'Admin.Shopparameters.Feature'), 'icon' => 'process-icon-new', ]; $this->page_header_toolbar_btn['new_order_return_state'] = [ 'href' => self::$currentIndex . '&addorder_return_state&token=' . $this->token, 'desc' => $this->trans('Add new order return status', [], 'Admin.Shopparameters.Feature'), 'icon' => 'process-icon-new', ]; } parent::initPageHeaderToolbar(); } /** * Function used to render the list to display for this controller. */ public function renderList() { //init and render the first list $this->addRowAction('edit'); $this->addRowAction('delete'); $this->addRowActionSkipList('delete', $this->getUnremovableStatuses()); $this->bulk_actions = [ 'delete' => [ 'text' => $this->trans('Delete selected', [], 'Admin.Actions'), 'confirm' => $this->trans('Delete selected items?', [], 'Admin.Notifications.Warning'), 'icon' => 'icon-trash', ], ]; $this->initOrderStatusList(); $lists = parent::renderList(); //init and render the second list $this->list_skip_actions = []; $this->_filter = false; $this->addRowActionSkipList('delete', [1, 2, 3, 4, 5]); $this->initOrdersReturnsList(); $this->checkFilterForOrdersReturnsList(); // call postProcess() to take care of actions and filters $this->postProcess(); $this->toolbar_title = $this->trans('Return statuses', [], 'Admin.Shopparameters.Feature'); parent::initToolbar(); $lists .= parent::renderList(); return $lists; } protected function getUnremovableStatuses() { return array_map(function ($row) { return (int) $row['id_order_state']; }, Db::getInstance()->executeS('SELECT id_order_state FROM ' . _DB_PREFIX_ . 'order_state WHERE unremovable = 1')); } protected function checkFilterForOrdersReturnsList() { // test if a filter is applied for this list if (Tools::isSubmit('submitFilter' . $this->table) || $this->context->cookie->{'submitFilter' . $this->table} !== false) { $this->filter = true; } // test if a filter reset request is required for this list if (isset($_POST['submitReset' . $this->table])) { $this->action = 'reset_filters'; } else { $this->action = ''; } } public function renderForm() { $this->fields_form = [ 'tinymce' => true, 'legend' => [ 'title' => $this->trans('Order status', [], 'Admin.Shopparameters.Feature'), 'icon' => 'icon-time', ], 'input' => [ [ 'type' => 'text', 'label' => $this->trans('Status name', [], 'Admin.Shopparameters.Feature'), 'name' => 'name', 'lang' => true, 'required' => true, 'hint' => [ $this->trans('Order status (e.g. \'Pending\').', [], 'Admin.Shopparameters.Help'), $this->trans('Invalid characters: numbers and', [], 'Admin.Shopparameters.Help') . ' !<>,;?=+()@#"{}_$%:', ], ], [ 'type' => 'file', 'label' => $this->trans('Icon', [], 'Admin.Shopparameters.Feature'), 'name' => 'icon', 'hint' => $this->trans('Upload an icon from your computer (File type: .gif, suggested size: 16x16).', [], 'Admin.Shopparameters.Help'), ], [ 'type' => 'color', 'label' => $this->trans('Color', [], 'Admin.Shopparameters.Feature'), 'name' => 'color', 'hint' => $this->trans('Status will be highlighted in this color. HTML colors only.', [], 'Admin.Shopparameters.Help') . ' "lightblue", "#CC6600")', ], [ 'type' => 'checkbox', 'name' => 'logable', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Consider the associated order as validated.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'invoice', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Allow a customer to download and view PDF versions of their invoices.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'hidden', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Hide this status in all customer orders.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'send_email', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Send an email to the customer when their order status has changed.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'pdf_invoice', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Attach invoice PDF to email.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'pdf_delivery', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Attach delivery slip PDF to email.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'shipped', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Set the order as shipped.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'paid', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Set the order as paid.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'checkbox', 'name' => 'delivery', 'values' => [ 'query' => [ ['id' => 'on', 'name' => $this->trans('Show delivery PDF.', [], 'Admin.Shopparameters.Feature'), 'val' => '1'], ], 'id' => 'id', 'name' => 'name', ], ], [ 'type' => 'select_template', 'label' => $this->trans('Template', [], 'Admin.Shopparameters.Feature'), 'name' => 'template', 'lang' => true, 'options' => [ 'query' => $this->getTemplates(), 'id' => 'id', 'name' => 'name', 'folder' => 'folder', ], 'hint' => [ $this->trans('Only letters, numbers and underscores ("_") are allowed.', [], 'Admin.Shopparameters.Help'), $this->trans('Email template for both .html and .txt.', [], 'Admin.Shopparameters.Help'), ], ], ], 'submit' => [ 'title' => $this->trans('Save', [], 'Admin.Actions'), ], ]; if (Tools::isSubmit('updateorder_state') || Tools::isSubmit('addorder_state')) { return $this->renderOrderStatusForm(); } elseif (Tools::isSubmit('updateorder_return_state') || Tools::isSubmit('addorder_return_state')) { return $this->renderOrderReturnsForm(); } else { return parent::renderForm(); } } protected function renderOrderStatusForm() { if (!($obj = $this->loadObject(true))) { return; } $this->fields_value = [ 'logable_on' => $this->getFieldValue($obj, 'logable'), 'invoice_on' => $this->getFieldValue($obj, 'invoice'), 'hidden_on' => $this->getFieldValue($obj, 'hidden'), 'send_email_on' => $this->getFieldValue($obj, 'send_email'), 'shipped_on' => $this->getFieldValue($obj, 'shipped'), 'paid_on' => $this->getFieldValue($obj, 'paid'), 'delivery_on' => $this->getFieldValue($obj, 'delivery'), 'pdf_delivery_on' => $this->getFieldValue($obj, 'pdf_delivery'), 'pdf_invoice_on' => $this->getFieldValue($obj, 'pdf_invoice'), ]; if ($this->getFieldValue($obj, 'color') !== false) { $this->fields_value['color'] = $this->getFieldValue($obj, 'color'); } else { $this->fields_value['color'] = '#ffffff'; } return parent::renderForm(); } protected function renderOrderReturnsForm() { $helper = $this->initOrderReturnsForm(); $helper->show_cancel_button = true; $back = Tools::safeOutput(Tools::getValue('back', '')); if (empty($back)) { $back = self::$currentIndex . '&token=' . $this->token; } if (!Validate::isCleanHtml($back)) { die(Tools::displayError('Provided "back" parameter is invalid.')); } $helper->back_url = $back; $this->fields_form[0]['form'] = [ 'tinymce' => true, 'legend' => [ 'title' => $this->trans('Return status', [], 'Admin.Shopparameters.Feature'), 'icon' => 'icon-time', ], 'input' => [ [ 'type' => 'text', 'label' => $this->trans('Status name', [], 'Admin.Shopparameters.Feature'), 'name' => 'name', 'lang' => true, 'required' => true, 'hint' => [ $this->trans('Order\'s return status name.', [], 'Admin.Shopparameters.Help'), $this->trans('Invalid characters: numbers and', [], 'Admin.Shopparameters.Help') . ' !<>,;?=+()@#"�{}_$%:', ], ], [ 'type' => 'color', 'label' => $this->trans('Color', [], 'Admin.Shopparameters.Feature'), 'name' => 'color', 'hint' => $this->trans('Status will be highlighted in this color. HTML colors only.', [], 'Admin.Shopparameters.Help') . ' "lightblue", "#CC6600")', ], ], 'submit' => [ 'title' => $this->trans('Save', [], 'Admin.Actions'), ], ]; return $helper->generateForm($this->fields_form); } protected function getTemplates() { $default_path = '../mails/'; // Mail templates can also be found in the theme folder $theme_path = '../themes/' . $this->context->shop->theme->getName() . '/mails/'; $array = []; foreach (Language::getLanguages(false) as $language) { $iso_code = $language['iso_code']; // If there is no folder for the given iso_code in /mails or in /themes/[theme_name]/mails, we bypass this language if (!@filemtime(_PS_ADMIN_DIR_ . '/' . $default_path . $iso_code) && !@filemtime(_PS_ADMIN_DIR_ . '/' . $theme_path . $iso_code)) { continue; } $theme_templates_dir = _PS_ADMIN_DIR_ . '/' . $theme_path . $iso_code; $theme_templates = is_dir($theme_templates_dir) ? scandir($theme_templates_dir, SCANDIR_SORT_NONE) : []; // We merge all available emails in one array $templates = array_unique(array_merge(scandir(_PS_ADMIN_DIR_ . '/' . $default_path . $iso_code, SCANDIR_SORT_NONE), $theme_templates)); foreach ($templates as $key => $template) { if (!strncmp(strrev($template), 'lmth.', 5)) { $search_result = array_search($template, $theme_templates); $array[$iso_code][] = [ 'id' => substr($template, 0, -5), 'name' => substr($template, 0, -5), 'folder' => ((!empty($search_result) ? $theme_path : $default_path)), ]; } } } return $array; } public function postProcess() { if (Tools::isSubmit($this->table . 'Orderby') || Tools::isSubmit($this->table . 'Orderway')) { $this->filter = true; } if (Tools::isSubmit('submitAddorder_return_state')) { if (!$this->access('add')) { return; } $id_order_return_state = Tools::getValue('id_order_return_state'); // Create Object OrderReturnState $order_return_state = new OrderReturnState((int) $id_order_return_state); $order_return_state->color = Tools::getValue('color'); $order_return_state->name = []; foreach (Language::getIDs(false) as $id_lang) { $order_return_state->name[$id_lang] = Tools::getValue('name_' . $id_lang); } // Update object if (!$order_return_state->save()) { $this->errors[] = $this->trans('An error has occurred: Can\'t save the current order\'s return status.', [], 'Admin.Orderscustomers.Notification'); } else { Tools::redirectAdmin(self::$currentIndex . '&conf=4&token=' . $this->token); } } if (Tools::isSubmit('submitBulkdeleteorder_return_state')) { if (!$this->access('delete')) { return; } $this->className = 'OrderReturnState'; $this->table = 'order_return_state'; $this->boxes = Tools::getValue('order_return_stateBox'); $this->deleted = false; parent::processBulkDelete(); } if (Tools::isSubmit('deleteorder_return_state')) { if (!$this->access('delete')) { return; } $id_order_return_state = Tools::getValue('id_order_return_state'); // Create Object OrderReturnState $order_return_state = new OrderReturnState((int) $id_order_return_state); if (!$order_return_state->delete()) { $this->errors[] = $this->trans('An error has occurred: Can\'t delete the current order\'s return status.', [], 'Admin.Orderscustomers.Notification'); } else { Tools::redirectAdmin(self::$currentIndex . '&conf=1&token=' . $this->token); } } if (Tools::isSubmit('submitAdd' . $this->table)) { if (!$this->access('add')) { return; } $langIds = Language::getIDs(false); $langDefault = (int) Configuration::get('PS_LANG_DEFAULT'); foreach ($langIds as $id_lang) { $name = (string) Tools::getValue('name_' . $id_lang); if (empty($name)) { $name = (string) Tools::getValue('name_' . $langDefault); } $exists = OrderState::existsLocalizedNameInDatabase( $name, (int) $id_lang, Tools::getIsset('id_order_state') ? (int) Tools::getValue('id_order_state') : null ); if ($exists) { $this->errors[] = $this->trans('This name already exists.', [], 'Admin.Design.Notification'); break; } } $this->deleted = false; // Disabling saving historisation $_POST['invoice'] = (int) Tools::getValue('invoice_on'); $_POST['logable'] = (int) Tools::getValue('logable_on'); $_POST['send_email'] = (int) Tools::getValue('send_email_on'); $_POST['hidden'] = (int) Tools::getValue('hidden_on'); $_POST['shipped'] = (int) Tools::getValue('shipped_on'); $_POST['paid'] = (int) Tools::getValue('paid_on'); $_POST['delivery'] = (int) Tools::getValue('delivery_on'); $_POST['pdf_delivery'] = (int) Tools::getValue('pdf_delivery_on'); $_POST['pdf_invoice'] = (int) Tools::getValue('pdf_invoice_on'); if (!$_POST['send_email']) { foreach ($langIds as $id_lang) { $_POST['template_' . $id_lang] = ''; } } return parent::postProcess(); } elseif (Tools::isSubmit('delete' . $this->table)) { if (!$this->access('delete')) { return; } $order_state = new OrderState(Tools::getValue('id_order_state'), $this->context->language->id); if (!$order_state->isRemovable()) { $this->errors[] = $this->trans('For security reasons, you cannot delete default order statuses.', [], 'Admin.Shopparameters.Notification'); } else { return parent::postProcess(); } } elseif (Tools::isSubmit('submitBulkdelete' . $this->table)) { if (!$this->access('delete')) { return; } foreach (Tools::getValue($this->table . 'Box', []) as $selection) { $order_state = new OrderState((int) $selection, $this->context->language->id); if (!$order_state->isRemovable()) { $this->errors[] = $this->trans('For security reasons, you cannot delete default order statuses.', [], 'Admin.Shopparameters.Notification'); break; } } if (!count($this->errors)) { return parent::postProcess(); } } else { return parent::postProcess(); } } protected function filterToField($key, $filter) { if ($this->table == 'order_state') { $this->initOrderStatusList(); } elseif ($this->table == 'order_return_state') { $this->initOrdersReturnsList(); } return parent::filterToField($key, $filter); } protected function afterImageUpload() { parent::afterImageUpload(); if (($id_order_state = (int) Tools::getValue('id_order_state')) && count($_FILES) && file_exists(_PS_ORDER_STATE_IMG_DIR_ . $id_order_state . '.gif')) { $current_file = _PS_TMP_IMG_DIR_ . 'order_state_mini_' . $id_order_state . '_' . $this->context->shop->id . '.gif'; if (file_exists($current_file)) { unlink($current_file); } } return true; } public function ajaxProcessSendEmailOrderState() { if ($this->access('edit') != '1') { echo json_encode(['success' => 0, 'text' => $this->trans('You do not have permission to edit this.', [], 'Admin.Notifications.Error')]); return; } $id_order_state = (int) Tools::getValue('id_order_state'); $sql = 'UPDATE ' . _DB_PREFIX_ . 'order_state SET `send_email`= NOT `send_email` WHERE id_order_state=' . $id_order_state; $result = Db::getInstance()->execute($sql); if ($result) { echo json_encode(['success' => 1, 'text' => $this->trans('The status has been updated successfully.', [], 'Admin.Notifications.Success')]); } else { echo json_encode(['success' => 0, 'text' => $this->trans('An error occurred while updating the status.', [], 'Admin.Notifications.Error')]); } } public function ajaxProcessDeliveryOrderState() { if ($this->access('edit') != '1') { echo json_encode(['success' => 0, 'text' => $this->trans('You do not have permission to edit this.', [], 'Admin.Notifications.Error')]); return; } $id_order_state = (int) Tools::getValue('id_order_state'); $sql = 'UPDATE ' . _DB_PREFIX_ . 'order_state SET `delivery`= NOT `delivery` WHERE id_order_state=' . $id_order_state; $result = Db::getInstance()->execute($sql); if ($result) { echo json_encode(['success' => 1, 'text' => $this->trans('The status has been updated successfully.', [], 'Admin.Notifications.Success')]); } else { echo json_encode(['success' => 0, 'text' => $this->trans('An error occurred while updating the status.', [], 'Admin.Notifications.Error')]); } } public function ajaxProcessInvoiceOrderState() { if ($this->access('edit') != '1') { echo json_encode(['success' => 0, 'text' => $this->trans('You do not have permission to edit this.', [], 'Admin.Notifications.Error')]); return; } $id_order_state = (int) Tools::getValue('id_order_state'); $sql = 'UPDATE ' . _DB_PREFIX_ . 'order_state SET `invoice`= NOT `invoice` WHERE id_order_state=' . $id_order_state; $result = Db::getInstance()->execute($sql); if ($result) { echo json_encode(['success' => 1, 'text' => $this->trans('The status has been updated successfully.', [], 'Admin.Notifications.Success')]); } else { echo json_encode(['success' => 0, 'text' => $this->trans('An error occurred while updating the status.', [], 'Admin.Notifications.Error')]); } } }