<?php
/**
 * TNT OFFICIAL MODULE FOR PRESTASHOP
 *
 * @author    GFI Informatique <www.gfi.world>
 * @copyright 2016-2019 GFI Informatique, 2016-2019 TNT
 * @license   https://opensource.org/licenses/MIT MIT License
 */

require_once _PS_MODULE_DIR_.'tntofficiel/libraries/TNTOfficiel_ClassLoader.php';

/**
 * Class TNTOfficielCart
 */
class TNTOfficielCart extends ObjectModel
{
    // id_tntofficiel_cart
    public $id;

    public $id_cart;
    public $id_address;
    public $id_carrier;
    public $delivery_point;

    public static $definition = array(
        'table' => 'tntofficiel_cart',
        'primary' => 'id_tntofficiel_cart',
        'fields' => array(
            'id_cart' => array(
                'type' => ObjectModel::TYPE_INT,
                'validate' => 'isUnsignedId',
                'required' => true
            ),
            'id_address' => array(
                'type' => ObjectModel::TYPE_INT,
                'validate' => 'isUnsignedId'
            ),
            'id_carrier' => array(
                'type' => ObjectModel::TYPE_INT,
                'validate' => 'isUnsignedId'
            ),
            'delivery_point' => array(
                'type' => ObjectModel::TYPE_STRING
                /*, 'validate' => 'isSerializedArray', 'size' => 65000*/
            ),
        ),
    );

    // cache and prevent race condition.
    private static $arrLoadedEntities = array();


    /**
     * Creates the tables needed by the model.
     *
     * @return bool
     */
    public static function createTables()
    {
        TNTOfficiel_Logstack::log();

        $strLogMessage = sprintf('%s::%s', __CLASS__, __FUNCTION__);

        $strTablePrefix = _DB_PREFIX_;
        $strTableEngine = _MYSQL_ENGINE_;

        $strTableName = $strTablePrefix.TNTOfficielCart::$definition['table'];

        // Create table.
        $strSQLCreateCart = <<<SQL
CREATE TABLE IF NOT EXISTS `${strTableName}` (
    `id_tntofficiel_cart`           INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
    `id_cart`                       INT(10) UNSIGNED NOT NULL,
    `id_address`                    INT(10) UNSIGNED NOT NULL,
    `id_carrier`                    INT(10) UNSIGNED NOT NULL,
    `delivery_point`                TEXT NULL,
-- Key.
    PRIMARY KEY (`id_tntofficiel_cart`),
    UNIQUE INDEX `id_cart` (`id_cart`)
) ENGINE = ${strTableEngine} DEFAULT CHARSET='utf8' COLLATE='utf8_general_ci';
SQL;

        $objDB = Db::getInstance();

        if (!$objDB->execute($strSQLCreateCart)) {
            TNTOfficiel_Logger::logInstall($strLogMessage.' : '.$objDB->getMsgError(), false);

            return false;
        }

        TNTOfficiel_Logger::logInstall($strLogMessage);

        return true;
    }

    /**
     * Constructor.
     */
    public function __construct($intArgId = null)
    {
        TNTOfficiel_Logstack::log();

        parent::__construct($intArgId);
    }

    /**
     * Load existing object model or optionally create a new one for it's ID.
     *
     * @param $intArgCartID
     * @param bool $boolArgCreate
     *
     * @return TNTOfficielCart|null
     */
    public static function loadCartID($intArgCartID, $boolArgCreate = true)
    {
        TNTOfficiel_Logstack::log();

        $intCartID = (int)$intArgCartID;

        // No new cart ID.
        if (!($intCartID > 0)) {
            return null;
        }

        $strEntityID = '_'.$intCartID.'-'.(int)null.'-'.(int)null;
        // If already loaded.
        if (array_key_exists($strEntityID, TNTOfficielCart::$arrLoadedEntities)) {
            $objTNTCartModel = TNTOfficielCart::$arrLoadedEntities[$strEntityID];
            // Check.
            if ((int)$objTNTCartModel->id_cart === $intCartID && Validate::isLoadedObject($objTNTCartModel)) {
                return $objTNTCartModel;
            }
        }

        // Search row for cart ID.
        $objDbQuery = new DbQuery();
        $objDbQuery->select('*');
        $objDbQuery->from(TNTOfficielCart::$definition['table']);
        $objDbQuery->where('id_cart = '.$intCartID);

        $objDB = Db::getInstance();
        $arrResult = $objDB->executeS($objDbQuery);
        // If row found and match cart ID.
        if (count($arrResult)===1 && $intCartID===(int)$arrResult[0]['id_cart']) {
            // Load existing TNT cart entry.
            $objTNTCartModel = new TNTOfficielCart((int)$arrResult[0]['id_tntofficiel_cart']);
        } elseif ($boolArgCreate === true) {
            // Create a new TNT cart entry.
            $objTNTCartModelCreate = new TNTOfficielCart(null);
            $objTNTCartModelCreate->id_cart = $intCartID;
            $objTNTCartModelCreate->save();
            // Reload to get default DB values after creation.
            $objTNTCartModel = TNTOfficielCart::loadCartID($intCartID, false);
        } else {
            $objException = new Exception('TNTOfficielCart not found for Cart ID #'.$intCartID);
            TNTOfficiel_Logger::logException($objException);

            return null;
        }

        // Check.
        if ((int)$objTNTCartModel->id_cart !== $intCartID || !Validate::isLoadedObject($objTNTCartModel)) {
            return null;
        }
        $objTNTCartModel->id = (int)$objTNTCartModel->id;
        $objTNTCartModel->id_cart = (int)$objTNTCartModel->id_cart;
        $objTNTCartModel->id_address = (int)$objTNTCartModel->id_address;
        $objTNTCartModel->id_carrier = (int)$objTNTCartModel->id_carrier;

        TNTOfficielCart::$arrLoadedEntities[$strEntityID] = $objTNTCartModel;

        return $objTNTCartModel;
    }


    /**
     * Load a Prestashop Cart object from id.
     *
     * @return Cart|null
     */
    public static function getPSCart($intArgCartID)
    {
        TNTOfficiel_Logstack::log();

        // Carrier ID must be an integer greater than 0.
        if (empty($intArgCartID) || $intArgCartID != (int)$intArgCartID || !((int)$intArgCartID > 0)) {
            return null;
        }

        $intCartID = (int)$intArgCartID;

        // Load cart.
        $objCart = new Cart($intCartID);

        // If cart object not available.
        if (!(Validate::isLoadedObject($objCart) && (int)$objCart->id === $intCartID)) {
            return null;
        }

        return $objCart;
    }

    /**
     * Get the TNT Carrier model from cart.
     *
     * @return TNTOfficielCarrier|null
     */
    public function getTNTCarrierModel()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return null;
        }

        return TNTOfficielCarrier::loadCarrierID((int)$objPSCart->id_carrier, false);
    }

    /**
     * Get the carrier Account model from cart.
     *
     * @return TNTOfficielAccount|null
     */
    public function getTNTAccountModel()
    {
        TNTOfficiel_Logstack::log();

        $objTNTCarrierModel = $this->getTNTCarrierModel();
        if ($objTNTCarrierModel === null) {
            return null;
        }

        return $objTNTCarrierModel->getTNTAccountModel();
    }

    /**
     * @return array
     */
    public function getDeliveryPoint()
    {
        TNTOfficiel_Logstack::log();

        $arrDeliveryPoint = Tools::unSerialize($this->delivery_point);
        if (!is_array($arrDeliveryPoint)) {
            $arrDeliveryPoint = array();
        }

        $objTNTCarrierModel = $this->getTNTCarrierModel();
        if ($objTNTCarrierModel === null) {
            return false;
        }

        // DEPOT have an PEX code.
        // DROPOFFPOINT have an XETT code.
        if ($objTNTCarrierModel->carrier_type === 'DEPOT'
        &&  isset($arrDeliveryPoint['pex'])
        ) {
            unset($arrDeliveryPoint['xett']);
        } elseif ($objTNTCarrierModel->carrier_type === 'DROPOFFPOINT'
        &&  isset($arrDeliveryPoint['xett'])
        ) {
            unset($arrDeliveryPoint['pex']);
        } else {
            $arrDeliveryPoint = array();
        }

        return $arrDeliveryPoint;
    }

    /**
     * Save a delivery point depending to the current carrier type.
     *
     * @param array $arrArgDeliveryPoint
     *
     * @return boolean
     */
    public function setDeliveryPoint($arrArgDeliveryPoint)
    {
        TNTOfficiel_Logstack::log();

        if (!is_array($arrArgDeliveryPoint)) {
            return false;
        }

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return false;
        }

        $objTNTCarrierModel = $this->getTNTCarrierModel();
        if ($objTNTCarrierModel === null) {
            return false;
        }

        // TODO : id_address + id_carrier
        //$arrDeliveryOption = $this->getDeliveryOption();
        $this->id_address = (int)$objPSCart->id_address_delivery;
        $this->id_carrier = (int)$objTNTCarrierModel->id_carrier;

        // DEPOT have an PEX code.
        // DROPOFFPOINT have an XETT code.
        if ($objTNTCarrierModel->carrier_type === 'DEPOT'
        &&  isset($arrArgDeliveryPoint['pex'])
        ) {
            unset($arrArgDeliveryPoint['xett']);
        } elseif ($objTNTCarrierModel->carrier_type === 'DROPOFFPOINT'
        &&  isset($arrArgDeliveryPoint['xett'])
        ) {
            unset($arrArgDeliveryPoint['pex']);
        } else {
            $arrArgDeliveryPoint = array();
        }

        $this->delivery_point = serialize($arrArgDeliveryPoint);

        return $this->save();
    }

    /**
     * List of product in cart, unit by unit, sorted by weight, from the heaviest to the lightest.
     *
     * @return array
     */
    public function getCartProductUnitList()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return array();
        }

        $arrProductList = $objPSCart->getProducts();

        // Sorting the list of products by weight, from the heaviest to the lightest.
        usort($arrProductList, array(__CLASS__, 'compareProductByWeight'));

        // Set all product in an array of products
        $arrProductUnitList = array();
        foreach ($arrProductList as $arrProduct) {
            $intProductQuantity = (int)$arrProduct['cart_quantity']; // $arrProduct['quantity'];
            for ($intProductCount = 0; $intProductCount < $intProductQuantity; ++$intProductCount) {
                $arrProductUnitList[] = $arrProduct;
            }
        }

        return $arrProductUnitList;
    }

    /**
     * Compare two products by their weight for sorting from the heaviest to the lightest.
     *
     * @param $productA
     * @param $productB
     *
     * @return int
     */
    public static function compareProductByWeight($productA, $productB)
    {
        TNTOfficiel_Logstack::log();

        if ((float)$productA['weight'] == (float)$productB['weight']) {
            return 0;
        }

        return ((float)$productA['weight'] > (float)$productB['weight']) ? -1 : 1;
    }

    /**
     * Get the heaviest product weight from cart.
     *
     * @return float
     */
    public function getCartHeaviestProduct()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return 0.0;
        }

        $fltHeaviestProduct = 0.0;

        $arrProductList = $objPSCart->getProducts();

        foreach ($arrProductList as $arrProduct) {
            // If a product weight is greater than the current max.
            if ($arrProduct['weight'] > $fltHeaviestProduct) {
                // Set the new max.
                $fltHeaviestProduct = (float)$arrProduct['weight'];
            }
        }

        return $fltHeaviestProduct;
    }

    /**
     * Get the total weight of product from cart.
     *
     * @return float
     */
    public function getCartTotalWeight()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return 0.0;
        }

        $fltCartWeight = 0.0;

        $arrProductList = $objPSCart->getProducts();

        foreach ($arrProductList as $arrProduct) {
            // Adding weight.
            $fltCartWeight += ((float)$arrProduct['weight'] * (float)$arrProduct['cart_quantity']);
        }

        return $fltCartWeight;
    }

    /**
     * Get the total weight of product from cart.
     *
     * @return float
     */
    public function getCartTotalPrice()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return 0.0;
        }

        // SubTotal withoiut tax (Cart Items Price)
        $fltSubtotalNoTax = $objPSCart->getOrderTotal(false, Cart::ONLY_PRODUCTS_WITHOUT_SHIPPING);
        // Discount without tax.
        $fltDiscountNoTax = -($objPSCart->getOrderTotal(false, Cart::BOTH_WITHOUT_SHIPPING)
          - $objPSCart->getOrderTotal(false, Cart::ONLY_PRODUCTS_WITHOUT_SHIPPING));
        // Tax part for SubTotal and Discount.
        $fltTaxTotal = $objPSCart->getOrderTotal(true, Cart::BOTH_WITHOUT_SHIPPING)
          - $objPSCart->getOrderTotal(false, Cart::BOTH_WITHOUT_SHIPPING);

        return $fltSubtotalNoTax - $fltDiscountNoTax + $fltTaxTotal;
    }

    /**
     * Is shipping free for cart, through configuration.
     *
     * @param Cart $objArgCart
     * @param null $intArgCarrierID the current carrier for which price is to determine
     *
     * @return bool
     */
    public function isCartShippingFree($intArgCarrierID = null)
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return false;
        }

        $intCarrierID = (int)$intArgCarrierID;
        if ($intArgCarrierID === null) {
            $intCarrierID = (int)$objPSCart->id_carrier;
        }

        $arrConfigShipping = Configuration::getMultiple(array(
            'PS_SHIPPING_FREE_PRICE',
            'PS_SHIPPING_FREE_WEIGHT'
        ));

        // Load carrier object.
        $objPSCarrier = TNTOfficielCarrier::getPSCarrier($intCarrierID);
        // If carrier object not available.
        if ($objPSCarrier === null) {
            return true;
        }

        // If carrier is inactive or free.
        if (!$objPSCarrier->active || $objPSCarrier->getShippingMethod() == Carrier::SHIPPING_METHOD_FREE) {
            return true;
        }

        // Get cart amount to reach for free shipping.
        $fltFreeFeesPrice = 0;
        if (isset($arrConfigShipping['PS_SHIPPING_FREE_PRICE'])) {
            $fltFreeFeesPrice = (float)Tools::convertPrice(
                (float)$arrConfigShipping['PS_SHIPPING_FREE_PRICE'],
                Currency::getCurrencyInstance((int)$objPSCart->id_currency)
            );
        }
        // Free shipping if cart amount, inc. taxes, inc. product & discount, exc. shipping > PS_SHIPPING_FREE_PRICE
        if ($fltFreeFeesPrice > 0
            && $objPSCart->getOrderTotal(true, Cart::BOTH_WITHOUT_SHIPPING, null, null, false) >= $fltFreeFeesPrice
        ) {
            return true;
        }

        // Free shipping if cart weight > PS_SHIPPING_FREE_WEIGHT
        if (isset($arrConfigShipping['PS_SHIPPING_FREE_WEIGHT'])
            && $objPSCart->getTotalWeight() >= (float)$arrConfigShipping['PS_SHIPPING_FREE_WEIGHT']
            && (float)$arrConfigShipping['PS_SHIPPING_FREE_WEIGHT'] > 0
        ) {
            return true;
        }

        return false;
    }

    /**
     * Get additional shipping cost for cart (exc. taxes).
     *
     * @param null $intArgCarrierID the current carrier for which price is to determine
     *
     * @return float
     */
    public function getCartExtraShippingCost($intArgCarrierID = null)
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return 0;
        }

        if ($intArgCarrierID === null) {
            $intArgCarrierID = $objPSCart->id_carrier;
        }

        $fltShippingCost = 0;

        $arrProducts = $objPSCart->getProducts();

        // If no product, no shipping extra cost.
        if (!count($arrProducts)) {
            return 0;
        }

        // If only virtual products in cart, no extra shipping cost.
        if ($objPSCart->isVirtualCart()) {
            return 0;
        }

        // If TNT carrier is free.
        $boolIsCartShippingFree = $this->isCartShippingFree($intArgCarrierID);
        if ($boolIsCartShippingFree) {
            return 0;
        }

        // Load carrier object.
        $objPSCarrier = TNTOfficielCarrier::getPSCarrier($intArgCarrierID);
        // If carrier object not available, no extra shipping cost.
        if ($objPSCarrier === null) {
            return 0;
        }

        // Adding handling charges.
        $shipping_handling = Configuration::get('PS_SHIPPING_HANDLING');
        if (isset($shipping_handling) && $objPSCarrier->shipping_handling) {
            $fltShippingCost += (float)$shipping_handling;
        }

        // Adding additional shipping cost per product.
        foreach ($arrProducts as $product) {
            if (!$product['is_virtual']) {
                $fltShippingCost += $product['additional_shipping_cost'] * $product['cart_quantity'];
            }
        }

        return (float)Tools::convertPrice(
            $fltShippingCost,
            Currency::getCurrencyInstance((int)$objPSCart->id_currency)
        );
    }

    /**
     * Get delivery option preventing recursions.
     *
     * @return array
     */
    public function getDeliveryOption()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return array();
        }

        static $arrMemoize = array();

        $strMemKey = $objPSCart->delivery_option;
        if (isset($arrMemoize[$strMemKey])) {
            return $arrMemoize[$strMemKey];
        }

        // PS 1.7.3 use JSON.
        $arrDeliveryOption = Tools::jsonDecode($objPSCart->delivery_option, true);
        if (!is_array($arrDeliveryOption)) {
            $arrDeliveryOption = Tools::unSerialize($objPSCart->delivery_option);
        }
        if (!is_array($arrDeliveryOption)) {
            $arrDeliveryOption = array();
        }

        // Mem.
        $arrMemoize[$strMemKey] = $arrDeliveryOption;

        return $arrDeliveryOption;
    }

    /**
     * Determine if multi-shipping state from cart is supported.
     *
     * @param Cart $objArgCart
     *
     * @return bool
     */
    public function isMultiShippingSupport()
    {
        TNTOfficiel_Logstack::log();

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);
        if ($objPSCart === null) {
            return false;
        }

        $boolMultiShippingSupport = true;

        $arrDeliveryOption = $this->getDeliveryOption();
        // If multiple address for cart.
        if (count($arrDeliveryOption) > 1) {
            // Not supported.
            $boolMultiShippingSupport = false;
        } else {
            // If an address have an option with different carrier.
            foreach ($arrDeliveryOption as /*$id_address_delivery =>*/ $strCarrierIDList) {
                if (preg_match('/^(?:([0-9]++),?(?:\1,?)*)$/ui', $strCarrierIDList) !== 1) {
                    // Not supported.
                    $boolMultiShippingSupport = false;
                    break;
                }
            }
        }

        return $boolMultiShippingSupport;
    }

    /**
     * @return array
     */
    public function isPaymentReady()
    {
        TNTOfficiel_Logstack::log();

        $arrResult = array(
            'error' => null,
            'carrier' => null
        );

        $objPSCart = TNTOfficielCart::getPSCart($this->id_cart);

        $arrDeliveryOption = $this->getDeliveryOption();

        if ($objPSCart === null) {
            $arrResult['error'] = 'errorTechnical';
        } elseif (count($arrDeliveryOption) === 0) {
            $arrResult['error'] = 'errorNoDeliveryOptionSelected';
        }

        if (count($arrResult['error']) === 0) {
            // Multi-Shipping with multiple address or different carrier not supported.
            $boolMultiShippingSupport = $this->isMultiShippingSupport();
            if (!$boolMultiShippingSupport) {
                // TNT shouldn't be selected (no price available).
            } else {
                if ($objPSCart->id_carrier == 0) {
                    $arrResult['error'] = 'errorNoDeliveryOptionSelected';
                } elseif (!$objPSCart->id_address_delivery) {
                    $arrResult['error'] = 'errorNoDeliveryAddressSelected';
                } else {
                    $objTNTCarrierModel = TNTOfficielCarrier::loadCarrierID($objPSCart->id_carrier, false);
                    // If success and carrier is from TNT module (option selected).
                    if ($objTNTCarrierModel !== null) {
                        // If the selected carrier (core) is TNT, we need handle it.
                        $arrResult['carrier'] = TNTOfficiel::MODULE_NAME;
                        $arrDeliveryPoint = $this->getDeliveryPoint();
                        if ($objTNTCarrierModel->carrier_type === 'DEPOT'
                        && !isset($arrDeliveryPoint['pex'])
                        ) {
                            $arrResult['error'] = 'errorNoDeliveryPointSelected';
                        } elseif ($objTNTCarrierModel->carrier_type === 'DROPOFFPOINT'
                        && !isset($arrDeliveryPoint['xett'])
                        ) {
                            $arrResult['error'] = 'errorNoDeliveryPointSelected';
                        } else {
                            // Load TNT receiver info or create a new one for it's ID.
                            $objTNTReceiverModel = TNTOfficielReceiver::loadAddressID($objPSCart->id_address_delivery);
                            if ($objTNTReceiverModel === null) {
                                $arrResult['error'] = 'errorTechnical';
                            } else {
                                // Validate current receiver info.
                                $arrFormReceiverInfoValidate = TNTOfficielReceiver::validateReceiverInfo(
                                    $objTNTReceiverModel->receiver_email,
                                    $objTNTReceiverModel->receiver_mobile,
                                    $objTNTReceiverModel->receiver_building,
                                    $objTNTReceiverModel->receiver_accesscode,
                                    $objTNTReceiverModel->receiver_floor
                                );
                                if ($arrFormReceiverInfoValidate['length'] !== 0) {
                                    $arrResult['error'] = 'validateAdditionalCarrierInfo';
                                }
                            }
                        }
                    }
                }
            }
        }

        return $arrResult;
    }
}