roihunter.php

<?php
/**
 * Main class of module ROI Hunter
 *
 * LICENSE: The buyer can free use/edit/modify this software in anyway
 * The buyer is NOT allowed to redistribute this module in anyway or resell it
 * or redistribute it to third party
 *
 * @author    ROI Hunter Easy
 * @copyright 2019 ROI Hunter
 * @license   EULA
 * @version   1.0
 * @link      https://easy.roihunter.com/
 */

if (!defined('_PS_VERSION_')) {
    exit;
}

require_once(_PS_MODULE_DIR_ . 'roihunter/classes/storage/storage.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/cookie/RhEasyCookieManager.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyProductDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyCategoryDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyCartDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyCartItemDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyOrderDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/dtos/RhEasyPageDto.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/classes/requests/ROIHunterRequestsManager.php');
require_once(_PS_MODULE_DIR_ . 'roihunter/enums/EPageType.php');

class Roihunter extends Module
{
    const ROI_HUNTER_MODULE_NAME = 'roihunter';
    const ROI_HUNTER_TAB_CLASS_NAME = 'AdminRoihunter';
    const ROI_HUNTER_TAB_NAME = 'ROI Hunter Easy';

    protected $config_form = false;
    private $roiHunterStorage;
    private $rhEasyCookieManager;
    private $rhRequestsManager;

    public function __construct()
    {
        $this->name = 'roihunter';
        $this->tab = 'advertising_marketing';
        $this->version = '1.2.1';
        $this->author = 'ROI Hunter';
        $this->need_instance = 1;
        $this->bootstrap = true;
        $this->module_key = '9e27146b6c90536cfb3e60a6adb4a054';
        parent::__construct();

        $this->displayName = $this->l('ROI Hunter Easy');
        $this->description = $this->l('Re-engage your past visitors and gain new conversions with
         dynamic remarketing ads on Google and dynamic product ads i.e. dynamic retargeting ads on Facebook.');
        $this->confirmUninstall = $this->l('Are you sure you want to uninstall ROI Hunter Easy module?');
        $this->ps_versions_compliancy = ['min' => '1.6', 'max' => _PS_VERSION_];
        $this->roiHunterStorage = ROIHunterStorage::getInstance();
        $this->rhEasyCookieManager = RhEasyCookieManager::getInstance();
        $this->rhRequestsManager = ROIHunterRequestsManager::getInstance();
    }

    public function install()
    {
        $retval = parent::install() &&
            $this->registerHook('backOfficeHeader') &&
            $this->registerHook('displayFooter') &&
            $this->registerHook('actionCartSave') &&
            $this->registerHook('displayBackOfficeHeader');

        if (Tools::version_compare(_PS_VERSION_, '1.7.1', '>=')) {
            $retval &= $this->registerHook('displayProductAdditionalInfo');
        }

        if ($retval) {
            $this->installModuleTab();
            $this->roiHunterStorage->setClientToken($this->getSecureToken());
        }
        return $retval;
    }

    public function uninstall()
    {
        $this->roiHunterStorage->setClientToken(null);
        $this->uninstallModuleTab();
        $this->roiHunterStorage->clearStorage();
        $this->rhRequestsManager->onAppUninstall();
        return parent::uninstall();
    }

    /************************** hooks start ******************************/

    /**
     * This hook we need for tracking product preview event
     * Note that it works only for prestashop >1.7.1
     */
    public function hookDisplayProductAdditionalInfo()
    {
        if (Tools::getValue('action') != 'refresh') {
            return '';
        }

        $smarty = new Smarty();
        $smarty->assign('rhEasyProductDto', $this->createRhEasyProductDto(true));
        $smarty->assign('activeProfile', $this->roiHunterStorage->getActiveBeProfile());
        return $smarty->fetch($this->local_path . 'views/templates/front/product_preview.tpl') .
            $smarty->fetch($this->local_path . 'views/templates/front/rheasy_events_tracking.tpl');
    }

    public function hookDisplayFooter()
    {
        if (!$this->roiHunterStorage->trackingParamsAreInitialized()) {
            return '';
        }

        $smarty = new Smarty();

        $pageType = EPageType::fromPrestaShopController(Tools::getValue('controller'));
        $smarty->assign(
            'rhEasyDto',
            new RhEasyDto(
                "PRESTA_SHOP",
                $this->roiHunterStorage->getGoogleConversionId(),
                $this->roiHunterStorage->getGoogleConversionLabel(),
                $this->roiHunterStorage->getFbPixelId()
            )
        );

        $smarty->assign('rhEasyPageDto', new RhEasyPageDto($pageType));

        if ($pageType == EPageType::PRODUCT) {
            $smarty->assign('rhEasyProductDto', $this->createRhEasyProductDto(false));
        }

        if ($pageType == EPageType::CATEGORY) {
            $smarty->assign('rhEasyCategoryDto', $this->createRhEasyCategoryDto());
        }

        if ($pageType == EPageType::ORDER_CONFIRMATION) {
            $smarty->assign('rhEasyOrderDto', $this->createRhEasyOrderDto());
        }

        if (isset(Context::getContext()->cookie->roihunter)) {  // add to cart event from previous web page
            $cartDto =  $this->getRhEasyCartDtoFromCookie();
            if (!empty($cartDto->getCartItems())) {
                $smarty->assign('rhEasyCartDto', $cartDto);
            }
        }

        $smarty->assign('activeProfile', $this->roiHunterStorage->getActiveBeProfile());

        $rheasyInit = $smarty->fetch($this->local_path . 'views/templates/front/rheasy_initialize.tpl');
        $rheasyTracking = $smarty->fetch($this->local_path . 'views/templates/front/rheasy_events_tracking.tpl');
        return $rheasyInit . $rheasyTracking;
    }

    public function hookActionCartSave($params)
    {
        if ((int)Tools::getValue("id_product") && Tools::getValue('add')) {
            $rhEasyCookieDto = $this->rhEasyCookieManager->loadRhEasyCookieDto(); //store new item into storage

            $newRhCartItemDto = $this->createRhEasyCartItemDto(); //get cart item from hook
            $rhEasyCookieDto->getRhEasyCartDto()->addItemToCart($newRhCartItemDto);

            $this->rhEasyCookieManager->saveRhEasyCookieDto($rhEasyCookieDto);
        }
    }

    private function roundPrice($price, $currency = null)
    {
        if (is_null($currency)) {
            $currency = Context::getContext()->currency;
        }
        $decimals = (int)$currency->decimals * _PS_PRICE_DISPLAY_PRECISION_;
        return Tools::ps_round($price, (int)$decimals);
    }

    public function hookBackOfficeHeader()
    {
        if (Tools::version_compare(_PS_VERSION_, '1.7', '<')) {
            $this->context->controller->addCSS($this->_path . 'views/css/back-for-1.6.css');
        } else {
            $this->context->controller->addCSS($this->_path . 'views/css/back-for-1.7.css');
            $this->context->controller->addJS($this->_path . 'views/js/back.js');
        }
    }

    public function hookDisplayBackOfficeHeader()
    {
        return $this->hookBackOfficeHeader();
    }

    private function useTax()
    {
        return true;
    }

    /************************** hooks end ******************************/

    /************************** controller start ******************************/

    public function getPluginType()
    {
        return 'rh-easy-prestashop-initial-message';
    }

    public function getStoreUrl($id_shop)
    {
        $shopUrl = new ShopUrl($id_shop);
        if (Configuration::get('PS_SSL_ENABLED')) {
            return 'https://'.$shopUrl->domain_ssl.$shopUrl->physical_uri;
        } else {
            return 'http://'.$shopUrl->domain.$shopUrl->physical_uri;
        }
    }

    /**
     * konkretni endpointy jsou
     * check.php
     * products.php
     * state.php
     * ... s paramatrem id_shop
     */
    public function getRhStateApiBaseUrl($id_shop)
    {
        return $this->getStoreUrl($id_shop) . 'modules/roihunter/';
    }

    public function getStoreName($id_shop)
    {
        $shop = new Shop($id_shop);
        return $shop->name;
    }

    public function getStoreCurrency($id_shop)
    {
        $id_currency = (int)Configuration::get('PS_CURRENCY_DEFAULT', null, null, $id_shop);
        $currency = new Currency($id_currency);
        if ($currency->active && !$currency->deleted) {
            return $currency->iso_code;
        }
    }

    public function getStoreLanguage($id_shop)
    {
        $id_language = (int)Configuration::get('PS_LANG_DEFAULT', null, null, $id_shop);
        $language = new Language($id_language);
        if ($language->active) {
            return $language->iso_code;
        }
    }

    public function getStoreCountry($id_shop)
    {
        $id_country = (int)Configuration::get('PS_COUNTRY_DEFAULT', null, null, $id_shop);
        $country = new Country($id_country);
        return $country->iso_code;
    }

    public function getPluginVersion()
    {
        return 'prestashop_' . $this->version;
    }

    public function getIframeUrl()
    {
        if ($this->roiHunterStorage->isActiveBeProfileProduction()) {
            return ROIHunterStorage::RH_FE_PRODUCTION_URL;
        } elseif ($this->roiHunterStorage->isActiveBeProfileStaging()) {
            return ROIHunterStorage::RH_FE_STAGING_URL;
        } else {
            throw new PrestaShopException("Cannot get iframe URL because active profile is not staging or production");
        }
    }

    /************************** controller end ******************************/

    public function getShopFromUrl($url)
    {
        $field = Configuration::get("PS_USE_SSL") ? 'domain_ssl' : 'domain';
        $sql = 'SELECT id_shop FROM ' . _DB_PREFIX_ . 'shop_url WHERE ' . $field . '="' . $url . '" AND active = 1';
        $id_shop = (int)Db::getInstance()->getValue($sql);
        if (!$id_shop && $field == 'domain_ssl') {
            $sql = 'SELECT id_shop FROM ' . _DB_PREFIX_ . 'shop_url WHERE ' . $field . '="' . $url . '" AND active = 1';
            $id_shop = (int)Db::getInstance()->getValue($sql);
        }
        if (!$id_shop && !Shop::isFeatureActive()) {
            $sql = 'SELECT MIN(id_shop) FROM    ' . _DB_PREFIX_ . 'shop_url  WHERE active = 1';
            $id_shop = (int)Db::getInstance()->getValue($sql);
        }
        return $id_shop;
    }

    /**
     * Load the configuration form
     */
    public function getContent()
    {
        $shop_content = self::getAdminShopContext();
        $id_shop = (int)$shop_content['id_shop'];
        $this->context->smarty->assign('shopContent', $shop_content);
        $this->context->smarty->assign('base', $this->getRhStateApiBaseUrl($id_shop));
        $this->context->smarty->assign('activeBeProfile', $this->roiHunterStorage->getActiveBeProfile());
        $this->context->smarty->assign('storageItems', $this->roiHunterStorage->getStorageWithoutTokens());

        return $this->context->smarty->fetch($this->local_path . 'views/templates/admin/configure.tpl');
    }

    private function installModuleTab()
    {
        if (Tools::version_compare(_PS_VERSION_, '1.7', '<')) {
            $this->v16InstallModuleTab();
        } else {
            $this->v17InstallModuleTab();
        }
    }

    private function v17InstallModuleTab()
    {
        $this->tabs = array(
            array(
                'name' => self::ROI_HUNTER_TAB_NAME,
                'class_name' => self::ROI_HUNTER_TAB_CLASS_NAME,
                'visible' => true,
                'parent_class_name' => 'IMPROVE'
            )
        );
    }

    private function v16InstallModuleTab()
    {
        $sql = 'SELECT id_tab FROM ' .
            _DB_PREFIX_ .
            'tab WHERE class_name ="' .
            pSQL(self::ROI_HUNTER_TAB_CLASS_NAME) .
            '"';
        $id_tab = Db::getInstance()->getValue($sql);
        if ((int)$id_tab) {
            $tab = new Tab($id_tab);
        } else {
            $tab = new Tab();
        }

        @copy(
            _PS_MODULE_DIR_ . $this->module->name . '/logo.gif',
            _PS_IMG_DIR_ . 't/' . self::ROI_HUNTER_TAB_CLASS_NAME . '.gif'
        );

        $tabNames = [];
        foreach (Language::getLanguages(false) as $language) {
            $tabNames[$language['id_lang']] = self::ROI_HUNTER_TAB_NAME;
        }
        $tab->name = $tabNames;
        $tab->class_name = self::ROI_HUNTER_TAB_CLASS_NAME;
        $tab->module = $this->name;
        $tab->id_parent = 0;
        if (!$tab->save()) {
            $this->messages[] = 'Failed save Tab ' . implode(',', $tabNames);
            return false;
        }
        if (Tools::version_compare(_PS_VERSION_, '1.7', '<')) {
            if (!Tab::initAccess($tab->id)) {
                $this->messages[] = 'Failed save init access ' . implode(',', $tabNames);
                return false;
            }
        }
        return true;
    }

    public function uninstallModuleTab()
    {
        $idTab = Tab::getIdFromClassName(self::ROI_HUNTER_TAB_CLASS_NAME);
        if ($idTab != 0) {
            $tab = new Tab($idTab);
            $tab->delete();
            return true;
        }
        return true; // true even on failed
    }

    public function getImageType()
    {
        return Configuration::get('ROIHUNTER_IMAGE_TYPE') ? Configuration::get('ROIHUNTER_IMAGE_TYPE') : '';
    }

    public static function getAdminShopContext()
    {
        $retval = [];
        if (Shop::isFeatureActive()) {
            $retval['multishop'] = true;
            switch (Shop::getContext()) {
                case Shop::CONTEXT_GROUP:
                    $retval['context'] = 'group';
                    break;
                case Shop::CONTEXT_SHOP:
                    $retval['context'] = 'shop';
                    break;
                case Shop::CONTEXT_ALL:
                    $retval['context'] = 'all';
                    break;
            }
            $retval['id_shop_group'] = (int)Shop::getContextShopGroupID();
        } else {
            $retval['multishop'] = false;
        }
        $retval['id_shop'] = (int)Context::getContext()->shop->id;

        return $retval;
    }

    private function getSecureToken()
    {
        if (function_exists('openssl_random_pseudo_bytes')) {
            $token = openssl_random_pseudo_bytes(32);
            return Tools::substr(bin2hex($token), 0, 32);
        } else {
            $token = sha1(mt_rand(1, 90000) . _COOKIE_KEY_);
            return $token;
        }
    }

    /**
     * Get module instance
     * @return Roihunter
     */
    public static function getModuleInstance()
    {
        $roihunterModule = parent::getInstanceByName(self::ROI_HUNTER_MODULE_NAME);
        if ($roihunterModule instanceof Roihunter) {
            return $roihunterModule;
        } else {
            throw new Error("Uninitialized prestashop module " . self::ROI_HUNTER_MODULE_NAME);
        }
    }

    /**
     * true if presta returned module instance
     * @return bool
     */
    public static function isModuleLoaded()
    {
        $roihunterModule = parent::getInstanceByName(self::ROI_HUNTER_MODULE_NAME);
        if ($roihunterModule instanceof Roihunter) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Get viewed product from DB based on ID in from $_POST
     * @param $refresh
     * @return RhEasyProductDto|null
     */
    private function createRhEasyProductDto($refresh)
    {
        $id_product = (int)Tools::getValue('id_product');
        if ($id_product) {
            $sql = 'SELECT name FROM ' .
                _DB_PREFIX_ .
                'product_lang WHERE id_product =' .
                (int)$id_product .
                ' AND id_lang =' .
                Context::getContext()->language->id;
            $name = Db::getInstance()->getValue($sql);

            $price = Product::getPriceStatic($id_product, $this->useTax());

            $currency = Context::getContext()->currency->iso_code;
            $variantId = $this->getProductVariantId($id_product, $refresh);

            return new RhEasyProductDto($id_product, $variantId, $name, $this->roundPrice($price), $currency);
        } else {
            return null;
        }
    }

    private function getProductVariantId($productId, $refresh)
    {
        if (Tools::version_compare(_PS_VERSION_, '1.7', '<')) {
            return $this->v16GetProductVariantId($productId);
        } else {
            if ($refresh) {
                return $this->v17GetVariantId($productId);
            } else {
                return Tools::getValue('id_product_attribute');
            }
        }
    }

    private function v16GetProductVariantId($idProduct)
    {
        $dbQuery = new DbQuery();
        $dbQuery->select('id_product_attribute');
        $dbQuery->from('product_attribute');
        $dbQuery->where('id_product = '.$idProduct);
        return Db::getInstance()->getValue($dbQuery);
    }

    private function createRhEasyCategoryDto()
    {
        $id_category = (int)Tools::getValue('id_category');
        if ($id_category) {
            $ref = new ReflectionObject(Context::getContext()->controller);

            if ($ref->hasProperty('cat_products')) {
                $prop = $ref->getProperty('cat_products');
                $prop->setAccessible(true);
                $products = $prop->getValue(Context::getContext()->controller);

                return RhEasyCategoryDto::fromPrestaShopCategoryProducts($id_category, $products);
            }
        }
        return null;
    }

    private function createRhEasyOrderDto()
    {
        $orderId = (int)Tools::getValue('id_order');
        if ($orderId) {
            $order = new Order($orderId);
            $currency = new Currency($order->id_currency);

            if ($this->useTax()) {
                $total_price = $order->total_products_wt; // $order->total_paid_tax_incl;
            } else {
                $total_price = $order->total_products;   // $order->total_paid_tax_excl;
            }

            return RhEasyOrderDto::fromPrestaShopOrderProducts(
                $orderId,
                $currency->iso_code,
                $order->getProducts(),
                $this->roundPrice($total_price)
            );
        }
        return null;
    }

    private function createRhEasyCartItemDto()
    {
        $productId = (int)Tools::getValue("id_product");
        $variantId = $this->getAddToCartVariantId($productId);
        $quantity = (int)Tools::getValue('qty');
        $price = Product::getPriceStatic($productId, $this->useTax(), $variantId);

        $compute_precision = defined('_PS_PRICE_COMPUTE_PRECISION_') ? _PS_PRICE_COMPUTE_PRECISION_ : 2;
        $roundedPrice = Tools::ps_round($price, $compute_precision);

        $id_currency = Context::getContext()->cart->id_currency;
        $currency = new Currency($id_currency);

        return new RhEasyCartItemDto(
            new RhEasyProductDto(
                $productId,
                $variantId,
                Product::getProductName($productId),
                $roundedPrice,
                $currency->iso_code
            ),
            $quantity
        );
    }

    private function getAddToCartVariantId($productId)
    {
        if (Tools::version_compare(_PS_VERSION_, '1.7', '<')) {
            return $this->v16GetAddToCartVariantId();
        } else {
            return $this->v17GetVariantId($productId);
        }
    }

    private function v17GetVariantId($productId)
    {
        if (!Tools::getValue("group")) {
            return null;
        }

        $allProductVariantsIds = $this->fetchAllVariantsIds($productId);
        // values of group array are attribute ids (not product attribute ids)
        // we need to find product attribute id of this product which is variant id in our case
        foreach (Tools::getValue("group") as $attributeId) {
            $productAttributeVariantIds = $this->fetchAllProductVariantIdsConnectedWithAttribute($attributeId);
            // on each iteration we exclude all product variants are not related with our product using intersect
            // and as the result of all iterations $allProductVariantsIds will contain only one variant we want to find
            $allProductVariantsIds = array_intersect($allProductVariantsIds, $productAttributeVariantIds);
        }

        if (count($allProductVariantsIds) == 1) {
            // array_intersect returns a map we need to get only value
            return array_values($allProductVariantsIds)[0];
        } else {
            return null;
        }
    }

    private function fetchAllProductVariantIdsConnectedWithAttribute($attributeId)
    {
        $dbQuery = new DbQuery();
        $column_name = 'id_product_attribute';
        $dbQuery->select($column_name);
        $dbQuery->from('product_attribute_combination');
        $dbQuery->where('id_attribute = '.$attributeId);
        return array_column(Db::getInstance()->executeS($dbQuery), $column_name);
    }

    private function fetchAllVariantsIds($productId)
    {
        $dbQuery = new DbQuery();
        $column_name = 'id_product_attribute';
        $dbQuery->select($column_name);
        $dbQuery->from('product_attribute');
        $dbQuery->where('id_product = '.$productId);
        return array_column(Db::getInstance()->executeS($dbQuery), $column_name);
    }

    private function v16GetAddToCartVariantId()
    {
        if (Tools::getValue("ipa")) {
            return (int)Tools::getValue("ipa");
        } else {
            return null;
        }
    }

    private function getRhEasyCartDtoFromCookie()
    {
        $rhEasyCookieDto = $this->rhEasyCookieManager->loadRhEasyCookieDto();
        $this->rhEasyCookieManager->clearStorage();

        return $rhEasyCookieDto->getRhEasyCartDto();
    }
}