itellacod.php

<?php
if (!defined('_PS_VERSION_'))
	exit;

class ItellaCod extends PaymentModule
{
	private $_prefix = 'ITELLACOD_';

	public function __construct()
	{
		$this->name = 'itellacod';
		$this->tab = 'payments_gateways';
		$this->version = '1.0.3';
		$this->author = 'Mijora';
		$this->need_instance = 1;
		$this->controllers = array('validation');
		$this->is_eu_compatible = 1;

		$this->currencies = false;
		$this->bootstrap = true;

		parent::__construct();

		$this->displayName = $this->l('Itella Card on Delivery (COD)');
		$this->description = $this->l('Accept card on delivery payments');
	}

	public function install()
	{
		if (!parent::install() or !$this->registerHook('payment') or !$this->registerHook('displayPaymentEU') or !$this->registerHook('paymentReturn'))
			return false;

		Configuration::updateValue('ITELLACOD_STATUS', '1');
		return true;
	}

	public function postProcess()
	{
		// save settings
		foreach (array('FEE_TYPE', 'FEE_FLAT', 'FEE_PERC', 'TOTAL_MIN', 'TOTAL_MAX', 'TOTAL_FREE') as $key) {
			if ($key == 'FEE_TYPE') {
				$value = (int) Tools::getValue($this->_prefix . $key);
			} else {
				$value = (float) Tools::getValue($this->_prefix . $key);
			}

			Configuration::updateValue($this->_prefix . $key, $value);
		}

		// checkbox settings handling
		$carriers = array();
		foreach ($_POST as $key => $value) {
			if (strpos($key, $this->_prefix . 'CARRIERS_') !== false) {
				$carriers[] = str_replace($this->_prefix . 'CARRIERS_', '', $key);
			}
		}

		Configuration::updateValue($this->_prefix . 'CARRIERS', implode(',', $carriers));

		return $this->displayConfirmation($this->l('Settings updated'));
	}

	public function getContent()
	{

		$output = '';

		if (Tools::isSubmit('submit' . $this->name)) {
			$output .= $this->postProcess();
		}

		return $output .  $this->displaySettings(); //$output;
	}

	public function displaySettings()
	{
		// Get default language
		$defaultLang = (int) Configuration::get('PS_LANG_DEFAULT');

		$carriers = Carrier::getCarriers($defaultLang, false, false, false, null, 0); //array();

		// Init Fields form array
		$fieldsForm[0]['form'] = [
			'legend' => array(
				'title' => 'Module Settings',
			),
			'input' => array(
				array(
					'type' => 'html',
					'label' => $this->l('Fee:'),
					'name' => 'itellacod_fee_html',
					'html_content' => '',
				),
				array(
					'type' => 'switch',
					'is_bool' => true,
					'label' => $this->l('Use % fee type?'),
					'name' => 'ITELLACOD_FEE_TYPE',
					'values' => array(
						array(
							'value' => 1,
							'label' => $this->l('YES')
						),
						array(
							'value' => 0,
							'label' => $this->l('NO')
						)
					)
				),
				array(
					'type' => 'text',
					'label' => $this->l('Flat fee'),
					'name' => 'ITELLACOD_FEE_FLAT',
					'size' => 20
				),
				array(
					'type' => 'text',
					'label' => $this->l('% fee'),
					'name' => 'ITELLACOD_FEE_PERC',
					'size' => 20,
				),
				array(
					'type' => 'html',
					'label' => $this->l('Order total:'),
					'name' => 'itellacod_enable_html',
					'html_content' => '',
				),
				array(
					'type' => 'text',
					'label' => $this->l('MIN'),
					'name' => 'ITELLACOD_TOTAL_MIN',
					'size' => 20,
				),
				array(
					'type' => 'text',
					'label' => $this->l('MAX'),
					'name' => 'ITELLACOD_TOTAL_MAX',
					'size' => 20,
					'desc' => $this->l('MIN MAX defines range where fee is active')
				),
				array(
					'type' => 'html',
					'label' => '',
					'name' => 'itellacod_carriers_html',
					'html_content' => '',
				),
				array(
					'type' => 'checkbox',
					'label' => $this->l('Shipping carriers'),
					'name' => 'ITELLACOD_CARRIERS',
					'desc' => $this->l('Select shipping carriers to use Itella COD with. Select none to enable for all.'),
					'values' => array(
						'query' => $carriers,
						'id' => 'id_reference',
						'name' => 'name'
					)
				),
			),
			'submit' => [
				'title' => $this->l('Save'),
				'class' => 'btn btn-default pull-right'
			]
		];

		$helper = new HelperForm();

		// Module, token and currentIndex
		$helper->module = $this;
		$helper->name_controller = $this->name;
		$helper->token = Tools::getAdminTokenLite('AdminModules');
		$helper->currentIndex = AdminController::$currentIndex . '&configure=' . $this->name;

		// Language
		$helper->default_form_language = $defaultLang;
		$helper->allow_employee_form_lang = $defaultLang;

		// Title and toolbar
		$helper->title = $this->displayName;
		$helper->show_toolbar = true;        // false -> remove toolbar
		$helper->toolbar_scroll = true;      // yes - > Toolbar is always visible on the top of the screen.
		$helper->submit_action = 'submit' . $this->name;
		$helper->toolbar_btn = [
			'save' => [
				'desc' => $this->l('Save'),
				'href' => AdminController::$currentIndex . '&configure=' . $this->name . '&save' . $this->name .
					'&token=' . Tools::getAdminTokenLite('AdminModules'),
			],
			'back' => [
				'href' => AdminController::$currentIndex . '&token=' . Tools::getAdminTokenLite('AdminModules'),
				'desc' => $this->l('Back to list')
			]
		];

		// load saved settings
		foreach (array('FEE_TYPE', 'FEE_FLAT', 'FEE_PERC', 'TOTAL_MIN', 'TOTAL_MAX', 'TOTAL_FREE') as $key) {
			$helper->fields_value[$this->_prefix . $key] = Configuration::get($this->_prefix . $key);
		}

		// check cod module boxes
		$enabled_carriers = explode(',', Configuration::get($this->_prefix . 'CARRIERS'));

		if (!$enabled_carriers) {
			$enabled_carriers = array();
		}

		foreach ($enabled_carriers as $carrier) {
			$helper->fields_value[$this->_prefix . 'CARRIERS_' . $carrier] = true;
		}

		return $helper->generateForm($fieldsForm);
	}

	public function hasProductDownload($cart)
	{
		foreach ($cart->getProducts() as $product) {
			$pd = ProductDownload::getIdFromIdProduct((int) ($product['id_product']));
			if ($pd and Validate::isUnsignedInt($pd))
				return true;
		}
		return false;
	}

	/**
	 * Return calculated fee or false if not within range
	 * @param mixed $cart	Cart object
	 * 
	 * @return bool|float
	 */
	public function getCodFee($cart)
	{
		$cart_total = (float) $cart->getOrderTotal(false, Cart::BOTH_WITHOUT_SHIPPING);
		$min = (float) Configuration::get($this->_prefix . 'TOTAL_MIN');
		$max = (float) Configuration::get($this->_prefix . 'TOTAL_MAX');

		// if min or max is set (not 0) check total is within range
		if (($min && $cart_total < $min) || ($max && $cart_total > $max)) {
			return false;
		}

		if (Configuration::get($this->_prefix . 'FEE_TYPE')) {
			// percentile fee
			$fee = $cart_total * ((float) Configuration::get($this->_prefix . 'FEE_PERC') / 100);
		} else {
			// flat fee
			$fee = (float) Configuration::get($this->_prefix . 'FEE_FLAT');
		}

		return $fee > 0 ? $fee : false;
	}

	public function hookPayment($params)
	{
		if (!$this->active)
			return;

		if (!$this->isCarrierAllowed($params['cart']->id_carrier))
			return;

		global $smarty;

		// Check if cart has product download
		if ($this->hasProductDownload($params['cart']))
			return false;

		$smarty->assign(array(
			'cod_fee' => Tools::displayPrice(Tools::convertPrice($this->getCodFee($params['cart']))),
			'this_path' => $this->_path, //keep for retro compat
			'this_path_cod' => $this->_path,
			'this_path_ssl' => Tools::getShopDomainSsl(true, true) . __PS_BASE_URI__ . 'modules/' . $this->name . '/'
		));
		return $this->display(__FILE__, 'payment.tpl');
	}

	public function isCarrierAllowed($id_carrier)
	{
		$carrier = new Carrier((int) $id_carrier);

		$enabled_carriers = explode(',', Configuration::get($this->_prefix . 'CARRIERS'));

		// if nothing selected allow all carriers
		if (!$enabled_carriers) {
			return true;
		}

		return in_array($carrier->id_reference, $enabled_carriers);
	}

	public function hookDisplayPaymentEU($params)
	{
		if (!$this->active)
			return;

		if (!$this->isCarrierAllowed($params['cart']->id_carrier))
			return;

		// Check if cart has product download
		if ($this->hasProductDownload($params['cart']))
			return false;

		return array(
			'cta_text' => $this->l('Pay with card on delivery (COD)'),
			'logo' => Media::getMediaPath(dirname(__FILE__) . '/itella.jpg'),
			'action' => $this->context->link->getModuleLink($this->name, 'validation', array('confirm' => true), true)
		);
	}

	public function hookPaymentReturn($params)
	{
		if (!$this->active)
			return;

		return $this->display(__FILE__, 'confirmation.tpl');
	}

	/**
	 * Validate an order in database
	 * Function called from a payment module
	 *
	 * @param integer $id_cart Value
	 * @param integer $id_order_state Value
	 * @param float $amount_paid Amount really paid by customer (in the default currency)
	 * @param string $payment_method Payment method (eg. 'Credit card')
	 * @param string $message Message to attach to order
	 */
	public function validateOrder(
		$id_cart,
		$id_order_state,
		$amount_paid,
		$payment_method = 'Unknown',
		$message = null,
		$extra_vars = array(),
		$currency_special = null,
		$dont_touch_amount = false,
		$secure_key = false,
		Shop $shop = null
	) {
		$this->context->cart = new Cart($id_cart);
		$this->context->customer = new Customer($this->context->cart->id_customer);
		$this->context->language = new Language($this->context->cart->id_lang);
		$this->context->shop = ($shop ? $shop : new Shop($this->context->cart->id_shop));
		$id_currency = $currency_special ? (int) $currency_special : (int) $this->context->cart->id_currency;
		$this->context->currency = new Currency($id_currency, null, $this->context->shop->id);
		if (Configuration::get('PS_TAX_ADDRESS_TYPE') == 'id_address_delivery')
			$context_country = $this->context->country;

		$order_status = new OrderState((int) $id_order_state, (int) $this->context->language->id);
		if (!Validate::isLoadedObject($order_status))
			throw new PrestaShopException('Can\'t load Order state status');

		if (!$this->active)
			die(Tools::displayError());
		// Does order already exists ?
		if (Validate::isLoadedObject($this->context->cart) && $this->context->cart->OrderExists() == false) {
			if ($secure_key !== false && $secure_key != $this->context->cart->secure_key)
				die(Tools::displayError());

			// For each package, generate an order
			$delivery_option_list = $this->context->cart->getDeliveryOptionList();
			$package_list = $this->context->cart->getPackageList();
			$cart_delivery_option = $this->context->cart->getDeliveryOption();

			// If some delivery options are not defined, or not valid, use the first valid option
			foreach ($delivery_option_list as $id_address => $package)
				if (!isset($cart_delivery_option[$id_address]) || !array_key_exists($cart_delivery_option[$id_address], $package))
					foreach ($package as $key => $val) {
						$cart_delivery_option[$id_address] = $key;
						break;
					}

			$order_list = array();
			$order_detail_list = array();
			$reference = Order::generateReference();
			$this->currentOrderReference = $reference;

			$order_creation_failed = false;
			$cart_total_paid = (float) Tools::ps_round((float) $this->context->cart->getOrderTotal(true, Cart::BOTH), 2);

			if ($this->context->cart->orderExists()) {
				$error = Tools::displayError('An order has already been placed using this cart.');
				Logger::addLog($error, 4, '0000001', 'Cart', intval($this->context->cart->id));
				die($error);
			}

			foreach ($cart_delivery_option as $id_address => $key_carriers)
				foreach ($delivery_option_list[$id_address][$key_carriers]['carrier_list'] as $id_carrier => $data)
					foreach ($data['package_list'] as $id_package) {
						// Rewrite the id_warehouse
						/////////////////////////////////////////////////////////////////////
						if (method_exists($this->context->cart, 'getPackageIdWarehouse'))
							$package_list[$id_address][$id_package]['id_warehouse'] = (int) $this->context->cart->getPackageIdWarehouse($package_list[$id_address][$id_package], (int) $id_carrier);
						$package_list[$id_address][$id_package]['id_carrier'] = $id_carrier;
					}
			// Make sure CarRule caches are empty
			CartRule::cleanCache();

			foreach ($package_list as $id_address => $packageByAddress)
				foreach ($packageByAddress as $id_package => $package) {
					$order = new Order();
					$order->product_list = $package['product_list'];

					if (Configuration::get('PS_TAX_ADDRESS_TYPE') == 'id_address_delivery') {
						$address = new Address($id_address);
						$this->context->country = new Country($address->id_country, $this->context->cart->id_lang);
					}

					$carrier = null;
					if (!$this->context->cart->isVirtualCart() && isset($package['id_carrier'])) {
						$carrier = new Carrier($package['id_carrier'], $this->context->cart->id_lang);
						$order->id_carrier = (int) $carrier->id;
						$id_carrier = (int) $carrier->id;
					} else {
						$order->id_carrier = 0;
						$id_carrier = 0;
					}

					$order->id_customer = (int) $this->context->cart->id_customer;
					$order->id_address_invoice = (int) $this->context->cart->id_address_invoice;
					$order->id_address_delivery = (int) $id_address;
					$order->id_currency = $this->context->currency->id;
					$order->id_lang = (int) $this->context->cart->id_lang;
					$order->id_cart = (int) $this->context->cart->id;
					$order->reference = $reference;
					$order->id_shop = (int) $this->context->shop->id;
					$order->id_shop_group = (int) $this->context->shop->id_shop_group;

					$order->secure_key = ($secure_key ? pSQL($secure_key) : pSQL($this->context->customer->secure_key));
					$order->payment = $payment_method;
					if (isset($this->name))
						$order->module = $this->name;
					$order->recyclable = $this->context->cart->recyclable;
					$order->gift = (int) $this->context->cart->gift;
					$order->gift_message = $this->context->cart->gift_message;
					$order->conversion_rate = $this->context->currency->conversion_rate;
					$amount_paid = !$dont_touch_amount ? Tools::ps_round((float) $amount_paid, 2) : $amount_paid;
					$order->total_paid_real = 0;

					$order->total_products = (float) $this->context->cart->getOrderTotal(false, Cart::ONLY_PRODUCTS, $order->product_list, $id_carrier);
					$order->total_products_wt = (float) $this->context->cart->getOrderTotal(true, Cart::ONLY_PRODUCTS, $order->product_list, $id_carrier);

					$order->total_discounts_tax_excl = (float) abs($this->context->cart->getOrderTotal(false, Cart::ONLY_DISCOUNTS, $order->product_list, $id_carrier));
					$order->total_discounts_tax_incl = (float) abs($this->context->cart->getOrderTotal(true, Cart::ONLY_DISCOUNTS, $order->product_list, $id_carrier));
					$order->total_discounts = $order->total_discounts_tax_incl;

					/////////////////////////////////////////////////////////////  
					$fee = Tools::convertPrice((float) $this->getCodFee($this->context->cart), $order->id_currency);
					///////////////////////////////////////////////////////////// 
					if (!is_null($carrier) && Validate::isLoadedObject($carrier))
						$order->carrier_tax_rate = $carrier->getTaxesRate(new Address($this->context->cart->{Configuration::get('PS_TAX_ADDRESS_TYPE')}));

					$feewithout = $fee;
					// fee already contains tax
					if ($order->carrier_tax_rate > 0 && $fee > 0) {
						$feewithout = (float) Tools::ps_round($fee -  (float) $fee / (100 +  $order->carrier_tax_rate) * $order->carrier_tax_rate, 2);
					}


					$order->total_shipping_tax_excl = (float) $this->context->cart->getPackageShippingCost((int) $id_carrier, false, null, $order->product_list) + $feewithout;
					$order->total_shipping_tax_incl = (float) $this->context->cart->getPackageShippingCost((int) $id_carrier, true, null, $order->product_list) + $fee;;
					$order->total_shipping = $order->total_shipping_tax_incl;


					$order->total_wrapping_tax_excl = (float) abs($this->context->cart->getOrderTotal(false, Cart::ONLY_WRAPPING, $order->product_list, $id_carrier));
					$order->total_wrapping_tax_incl = (float) abs($this->context->cart->getOrderTotal(true, Cart::ONLY_WRAPPING, $order->product_list, $id_carrier));
					$order->total_wrapping = $order->total_wrapping_tax_incl;

					/////////////////////////////////////////////////////////////
					$order->total_paid_tax_excl = (float) Tools::ps_round((float) $this->context->cart->getOrderTotal(false, Cart::BOTH, $order->product_list, $id_carrier) + $feewithout, 2);
					$order->total_paid_tax_incl = (float) Tools::ps_round((float) $this->context->cart->getOrderTotal(true, Cart::BOTH, $order->product_list, $id_carrier) + $fee, 2);
					$order->total_paid = $order->total_paid_tax_incl;

					$order->invoice_date = '0000-00-00 00:00:00';
					$order->delivery_date = '0000-00-00 00:00:00';

					// Creating order
					$result = $order->add();

					if (!$result)
						throw new PrestaShopException('Can\'t save Order');

					// Amount paid by customer is not the right one -> Status = payment error
					// We don't use the following condition to avoid the float precision issues : http://www.php.net/manual/en/language.types.float.php
					// if ($order->total_paid != $order->total_paid_real)
					// We use number_format in order to compare two string
					/////////////////////////////////////////////////////////////
					if ($order_status->logable && number_format($cart_total_paid + $fee, 2) != number_format($amount_paid + $fee, 2))
						$id_order_state = Configuration::get('PS_OS_ERROR');

					$order_list[] = $order;

					// Insert new Order detail list using cart for the current order
					$order_detail = new OrderDetail(null, null, $this->context);
					$order_detail->createList($order, $this->context->cart, $id_order_state, $order->product_list, 0, true, $package_list[$id_address][$id_package]['id_warehouse']);
					$order_detail_list[] = $order_detail;

					// Adding an entry in order_carrier table
					if (!is_null($carrier)) {
						$order_carrier = new OrderCarrier();
						$order_carrier->id_order = (int) $order->id;
						$order_carrier->id_carrier = (int) $id_carrier;
						$order_carrier->weight = (float) $order->getTotalWeight();
						$order_carrier->shipping_cost_tax_excl = (float) $order->total_shipping_tax_excl;
						$order_carrier->shipping_cost_tax_incl = (float) $order->total_shipping_tax_incl;
						$order_carrier->add();
					}
				}

			// The country can only change if the address used for the calculation is the delivery address, and if multi-shipping is activated
			if (Configuration::get('PS_TAX_ADDRESS_TYPE') == 'id_address_delivery')
				$this->context->country = $context_country;

			// Register Payment only if the order status validate the order
			if ($order_status->logable) {
				// $order is the last order loop in the foreach
				// The method addOrderPayment of the class Order make a create a paymentOrder
				//     linked to the order reference and not to the order id
				if (isset($extra_vars['transaction_id']))
					$transaction_id = $extra_vars['transaction_id'];
				else
					$transaction_id = null;

				if (!$order->addOrderPayment($amount_paid, null, $transaction_id))
					throw new PrestaShopException('Can\'t save Order Payment');
			}

			// Next !
			$only_one_gift = false;
			$cart_rule_used = array();
			$products = $this->context->cart->getProducts();
			$cart_rules = $this->context->cart->getCartRules();

			// Make sure CarRule caches are empty
			CartRule::cleanCache();

			foreach ($order_detail_list as $key => $order_detail) {
				$order = $order_list[$key];
				if (!$order_creation_failed & isset($order->id)) {
					if (!$secure_key)
						$message .= '<br />' . Tools::displayError('Warning: the secure key is empty, check your payment account before validation');
					// Optional message to attach to this order
					if (isset($message) & !empty($message)) {
						$msg = new Message();
						$message = strip_tags($message, '<br>');
						if (Validate::isCleanHtml($message)) {
							$msg->message = $message;
							$msg->id_order = intval($order->id);
							$msg->private = 1;
							$msg->add();
						}
					}

					// Insert new Order detail list using cart for the current order
					//$orderDetail = new OrderDetail(null, null, $this->context);
					//$orderDetail->createList($order, $this->context->cart, $id_order_state);

					// Construct order detail table for the email
					$products_list = '';
					$virtual_product = true;
					foreach ($products as $key => $product) {
						$price = Product::getPriceStatic((int) $product['id_product'], false, ($product['id_product_attribute'] ? (int) $product['id_product_attribute'] : null), 6, null, false, true, $product['cart_quantity'], false, (int) $order->id_customer, (int) $order->id_cart, (int) $order->{Configuration::get('PS_TAX_ADDRESS_TYPE')});
						$price_wt = Product::getPriceStatic((int) $product['id_product'], true, ($product['id_product_attribute'] ? (int) $product['id_product_attribute'] : null), 2, null, false, true, $product['cart_quantity'], false, (int) $order->id_customer, (int) $order->id_cart, (int) $order->{Configuration::get('PS_TAX_ADDRESS_TYPE')});

						$customization_quantity = 0;
						if (isset($customized_datas[$product['id_product']][$product['id_product_attribute']])) {
							$customization_text = '';
							foreach ($customized_datas[$product['id_product']][$product['id_product_attribute']] as $customization) {
								if (isset($customization['datas'][Product::CUSTOMIZE_TEXTFIELD]))
									foreach ($customization['datas'][Product::CUSTOMIZE_TEXTFIELD] as $text)
										$customization_text .= $text['name'] . ': ' . $text['value'] . '<br />';

								if (isset($customization['datas'][Product::CUSTOMIZE_FILE]))
									$customization_text .= sprintf(Tools::displayError('%d image(s)'), count($customization['datas'][Product::CUSTOMIZE_FILE])) . '<br />';

								$customization_text .= '---<br />';
							}

							$customization_text = rtrim($customization_text, '---<br />');

							$customization_quantity = (int) $product['customizationQuantityTotal'];
							$products_list .=
								'<tr style="background-color: ' . ($key % 2 ? '#DDE2E6' : '#EBECEE') . ';">
                                <td style="padding: 0.6em 0.4em;width: 15%;">' . $product['reference'] . '</td>
                                <td style="padding: 0.6em 0.4em;width: 30%;"><strong>' . $product['name'] . (isset($product['attributes']) ? ' - ' . $product['attributes'] : '') . ' - ' . Tools::displayError('Customized') . (!empty($customization_text) ? ' - ' . $customization_text : '') . '</strong></td>
                                <td style="padding: 0.6em 0.4em; width: 20%;">' . Tools::displayPrice(Product::getTaxCalculationMethod() == PS_TAX_EXC ?  Tools::ps_round($price, 2) : $price_wt, $this->context->currency, false) . '</td>
                                <td style="padding: 0.6em 0.4em; width: 15%;">' . $customization_quantity . '</td>
                                <td style="padding: 0.6em 0.4em; width: 20%;">' . Tools::displayPrice($customization_quantity * (Product::getTaxCalculationMethod() == PS_TAX_EXC ? Tools::ps_round($price, 2) : $price_wt), $this->context->currency, false) . '</td>
                            </tr>';
						}

						if (!$customization_quantity || (int) $product['cart_quantity'] > $customization_quantity)
							$products_list .=
								'<tr style="background-color: ' . ($key % 2 ? '#DDE2E6' : '#EBECEE') . ';">
                                <td style="padding: 0.6em 0.4em;width: 15%;">' . $product['reference'] . '</td>
                                <td style="padding: 0.6em 0.4em;width: 30%;"><strong>' . $product['name'] . (isset($product['attributes']) ? ' - ' . $product['attributes'] : '') . '</strong></td>
                                <td style="padding: 0.6em 0.4em; width: 20%;">' . Tools::displayPrice(Product::getTaxCalculationMethod() == PS_TAX_EXC ? Tools::ps_round($price, 2) : $price_wt, $this->context->currency, false) . '</td>
                                <td style="padding: 0.6em 0.4em; width: 15%;">' . ((int) $product['cart_quantity'] - $customization_quantity) . '</td>
                                <td style="padding: 0.6em 0.4em; width: 20%;">' . Tools::displayPrice(((int) $product['cart_quantity'] - $customization_quantity) * (Product::getTaxCalculationMethod() == PS_TAX_EXC ? Tools::ps_round($price, 2) : $price_wt), $this->context->currency, false) . '</td>
                            </tr>';

						// Check if is not a virutal product for the displaying of shipping
						if (!$product['is_virtual'])
							$virtual_product &= false;
					} // end foreach ($products)

					$cart_rules_list = '';
					foreach ($cart_rules as $cart_rule) {
						$package = array('id_carrier' => $order->id_carrier, 'id_address' => $order->id_address_delivery, 'products' => $order->product_list);
						$values = array(
							'tax_incl' => $cart_rule['obj']->getContextualValue(true, $this->context, CartRule::FILTER_ACTION_ALL, $package),
							'tax_excl' => $cart_rule['obj']->getContextualValue(false, $this->context, CartRule::FILTER_ACTION_ALL, $package)
						);

						// If the reduction is not applicable to this order, then continue with the next one
						if (!$values['tax_excl'])
							continue;

						$order->addCartRule($cart_rule['obj']->id, $cart_rule['obj']->name, $values);

						/* IF
                        ** - This is not multi-shipping
                        ** - The value of the voucher is greater than the total of the order
                        ** - Partial use is allowed
                        ** - This is an "amount" reduction, not a reduction in % or a gift
                        ** THEN
                        ** The voucher is cloned with a new value corresponding to the remainder
                        */
						if (count($order_list) == 1 && $values['tax_incl'] > $order->total_products_wt && $cart_rule['obj']->partial_use == 1 && $cart_rule['obj']->reduction_amount > 0) {
							// Create a new voucher from the original
							$voucher = new CartRule($cart_rule['obj']->id); // We need to instantiate the CartRule without lang parameter to allow saving it
							unset($voucher->id);

							// Set a new voucher code
							$voucher->code = empty($voucher->code) ? substr(md5($order->id . '-' . $order->id_customer . '-' . $cart_rule['obj']->id), 0, 16) : $voucher->code . '-2';
							if (preg_match('/\-([0-9]{1,2})\-([0-9]{1,2})$/', $voucher->code, $matches) && $matches[1] == $matches[2])
								$voucher->code = preg_replace('/' . $matches[0] . '$/', '-' . (intval($matches[1]) + 1), $voucher->code);

							// Set the new voucher value
							if ($voucher->reduction_tax)
								$voucher->reduction_amount = $values['tax_incl'] - $order->total_products_wt;
							else
								$voucher->reduction_amount = $values['tax_excl'] - $order->total_products;

							$voucher->id_customer = $order->id_customer;
							$voucher->quantity = 1;
							if ($voucher->add()) {
								// If the voucher has conditions, they are now copied to the new voucher
								CartRule::copyConditions($cart_rule['obj']->id, $voucher->id);

								$params = array(
									'{voucher_amount}' => Tools::displayPrice($voucher->reduction_amount, $this->context->currency, false),
									'{voucher_num}' => $voucher->code,
									'{firstname}' => $this->context->customer->firstname,
									'{lastname}' => $this->context->customer->lastname,
									'{id_order}' => $order->reference,
									'{order_name}' => $order->getUniqReference()
								);
								Mail::Send(
									(int) $order->id_lang,
									'voucher',
									sprintf(Mail::l('New voucher regarding your order %s', (int) $order->id_lang), $order->reference),
									$params,
									$this->context->customer->email,
									$this->context->customer->firstname . ' ' . $this->context->customer->lastname,
									null,
									null,
									null,
									null,
									_PS_MAIL_DIR_,
									false,
									(int) $order->id_shop
								);
							}
						}

						if ($id_order_state != Configuration::get('PS_OS_ERROR') && $id_order_state != Configuration::get('PS_OS_CANCELED') && !in_array($cart_rule['obj']->id, $cart_rule_used)) {
							$cart_rule_used[] = $cart_rule['obj']->id;

							// Create a new instance of Cart Rule without id_lang, in order to update its quantity
							$cart_rule_to_update = new CartRule($cart_rule['obj']->id);
							$cart_rule_to_update->quantity = max(0, $cart_rule_to_update->quantity - 1);
							$cart_rule_to_update->update();
						}

						$cart_rules_list .= '
                        <tr>
                            <td colspan="4" style="padding:0.6em 0.4em;text-align:right">' . Tools::displayError('Voucher name:') . ' ' . $cart_rule['obj']->name . '</td>
                            <td style="padding:0.6em 0.4em;text-align:right">' . ($values['tax_incl'] != 0.00 ? '-' : '') . Tools::displayPrice($values['tax_incl'], $this->context->currency, false) . '</td>
                        </tr>';
					}

					// Specify order id for message
					$old_message = Message::getMessageByCartId((int) $this->context->cart->id);
					if ($old_message) {
						$update_message = new Message((int) $old_message['id_message']);
						$update_message->id_order = (int) $order->id;
						$update_message->update();

						// Add this message in the customer thread
						$customer_thread = new CustomerThread();
						$customer_thread->id_contact = 0;
						$customer_thread->id_customer = (int) $order->id_customer;
						$customer_thread->id_shop = (int) $this->context->shop->id;
						$customer_thread->id_order = (int) $order->id;
						$customer_thread->id_lang = (int) $this->context->language->id;
						$customer_thread->email = $this->context->customer->email;
						$customer_thread->status = 'open';
						$customer_thread->token = Tools::passwdGen(12);
						$customer_thread->add();

						$customer_message = new CustomerMessage();
						$customer_message->id_customer_thread = $customer_thread->id;
						$customer_message->id_employee = 0;
						$customer_message->message = htmlentities($update_message->message, ENT_COMPAT, 'UTF-8');
						$customer_message->private = 0;

						if (!$customer_message->add())
							$this->errors[] = Tools::displayError('An error occurred while saving message');
					}

					// Hook validate order
					Hook::exec('actionValidateOrder', array(
						'cart' => $this->context->cart,
						'order' => $order,
						'customer' => $this->context->customer,
						'currency' => $this->context->currency,
						'orderStatus' => $order_status
					));

					foreach ($this->context->cart->getProducts() as $product)
						if ($order_status->logable)
							ProductSale::addProductSale((int) $product['id_product'], (int) $product['cart_quantity']);

					if (Configuration::get('PS_STOCK_MANAGEMENT') && $order_detail->getStockState()) {
						$history = new OrderHistory();
						$history->id_order = (int) $order->id;
						$history->changeIdOrderState(Configuration::get('PS_OS_OUTOFSTOCK'), $order, true);
						$history->addWithemail();
					}

					// Set order state in order history ONLY even if the "out of stock" status has not been yet reached
					// So you migth have two order states
					$new_history = new OrderHistory();
					$new_history->id_order = (int) $order->id;
					$new_history->changeIdOrderState((int) $id_order_state, $order, true);
					$new_history->addWithemail(true, $extra_vars);

					unset($order_detail);

					// Order is reloaded because the status just changed
					$order = new Order($order->id);

					// Send an e-mail to customer (one order = one email)
					if ($id_order_state != Configuration::get('PS_OS_ERROR') && $id_order_state != Configuration::get('PS_OS_CANCELED') && $this->context->customer->id) {
						$invoice = new Address($order->id_address_invoice);
						$delivery = new Address($order->id_address_delivery);
						$delivery_state = $delivery->id_state ? new State($delivery->id_state) : false;
						$invoice_state = $invoice->id_state ? new State($invoice->id_state) : false;

						$data = array(
							'{firstname}' => $this->context->customer->firstname,
							'{lastname}' => $this->context->customer->lastname,
							'{email}' => $this->context->customer->email,
							'{delivery_block_txt}' => $this->_getFormatedAddress($delivery, "\n"),
							'{invoice_block_txt}' => $this->_getFormatedAddress($invoice, "\n"),
							'{delivery_block_html}' => $this->_getFormatedAddress($delivery, '<br />', array(
								'firstname'    => '<span style="font-weight:bold;">%s</span>',
								'lastname'    => '<span style="font-weight:bold;">%s</span>'
							)),
							'{invoice_block_html}' => $this->_getFormatedAddress($invoice, '<br />', array(
								'firstname'    => '<span style="font-weight:bold;">%s</span>',
								'lastname'    => '<span style="font-weight:bold;">%s</span>'
							)),
							'{delivery_company}' => $delivery->company,
							'{delivery_firstname}' => $delivery->firstname,
							'{delivery_lastname}' => $delivery->lastname,
							'{delivery_address1}' => $delivery->address1,
							'{delivery_address2}' => $delivery->address2,
							'{delivery_city}' => $delivery->city,
							'{delivery_postal_code}' => $delivery->postcode,
							'{delivery_country}' => $delivery->country,
							'{delivery_state}' => $delivery->id_state ? $delivery_state->name : '',
							'{delivery_phone}' => ($delivery->phone) ? $delivery->phone : $delivery->phone_mobile,
							'{delivery_other}' => $delivery->other,
							'{invoice_company}' => $invoice->company,
							'{invoice_vat_number}' => $invoice->vat_number,
							'{invoice_firstname}' => $invoice->firstname,
							'{invoice_lastname}' => $invoice->lastname,
							'{invoice_address2}' => $invoice->address2,
							'{invoice_address1}' => $invoice->address1,
							'{invoice_city}' => $invoice->city,
							'{invoice_postal_code}' => $invoice->postcode,
							'{invoice_country}' => $invoice->country,
							'{invoice_state}' => $invoice->id_state ? $invoice_state->name : '',
							'{invoice_phone}' => ($invoice->phone) ? $invoice->phone : $invoice->phone_mobile,
							'{invoice_other}' => $invoice->other,
							'{order_name}' => $order->getUniqReference(),
							'{date}' => Tools::displayDate(date('Y-m-d H:i:s'), (int) $order->id_lang, 1),
							'{carrier}' => $virtual_product ? Tools::displayError('No carrier') : $carrier->name,
							'{payment}' => $order->payment,
							'{products}' => $this->formatProductAndVoucherForEmail($products_list),
							'{discounts}' => $this->formatProductAndVoucherForEmail($cart_rules_list),
							'{total_paid}' => Tools::displayPrice($order->total_paid, $this->context->currency, false),
							'{total_tax_paid}' => Tools::displayPrice(($order->total_paid_tax_incl - $order->total_paid_tax_excl), $this->context->currency, false),
							'{total_products}' => Tools::displayPrice($order->total_paid - $order->total_shipping - $order->total_wrapping + $order->total_discounts, $this->context->currency, false),
							'{total_discounts}' => Tools::displayPrice($order->total_discounts, $this->context->currency, false),
							'{total_shipping}' => Tools::displayPrice($order->total_shipping, $this->context->currency, false),
							'{total_wrapping}' => Tools::displayPrice($order->total_wrapping, $this->context->currency, false)
						);

						if (is_array($extra_vars))
							$data = array_merge($data, $extra_vars);

						// Join PDF invoice
						if ((int) Configuration::get('PS_INVOICE') && $order_status->invoice && $order->invoice_number) {
							$pdf = new PDF($order->getInvoicesCollection(), PDF::TEMPLATE_INVOICE, $this->context->smarty);
							$file_attachement['content'] = $pdf->render(false);
							$file_attachement['name'] = Configuration::get('PS_INVOICE_PREFIX', (int) $order->id_lang) . sprintf('%06d', $order->invoice_number) . '.pdf';
							$file_attachement['mime'] = 'application/pdf';
						} else
							$file_attachement = null;

						if (Validate::isEmail($this->context->customer->email))
							Mail::Send(
								(int) $order->id_lang,
								'order_conf',
								Mail::l('Order confirmation', (int) $order->id_lang),
								$data,
								$this->context->customer->email,
								$this->context->customer->firstname . ' ' . $this->context->customer->lastname,
								null,
								null,
								$file_attachement,
								null,
								_PS_MAIL_DIR_,
								false,
								(int) $order->id_shop
							);
					}

					// updates stock in shops
					if (Configuration::get('PS_ADVANCED_STOCK_MANAGEMENT')) {
						$product_list = $order->getProducts();
						foreach ($product_list as $product) {
							// if the available quantities depends on the physical stock
							if (StockAvailable::dependsOnStock($product['product_id'])) {
								// synchronizes
								StockAvailable::synchronize($product['product_id'], $order->id_shop);
							}
						}
					}
				} else {
					$error = Tools::displayError('Order creation failed');
					Logger::addLog($error, 4, '0000002', 'Cart', intval($order->id_cart));
					die($error);
				}
			} // End foreach $order_detail_list
			// Use the last order as currentOrder
			$this->currentOrder = (int) $order->id;
			return true;
		} else {
			$error = Tools::displayError('Cart cannot be loaded or an order has already been placed using this cart');
			Logger::addLog($error, 4, '0000001', 'Cart', intval($this->context->cart->id));
			die($error);
		}
	}
}