grprestashop.php

<?php
/**
 * This module integrate GetResponse and PrestaShop. Allows to subscribe via checkout page and export your contacts.
 *
 * @author Getresponse <grintegrations@getresponse.com>
 * @copyright GetResponse
 * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
 *  International Registered Trademark & Property of PrestaShop SA
 */
if (!defined('_PS_VERSION_')) {
    exit;
}

include_once _PS_MODULE_DIR_ . '/grprestashop/vendor/autoload.php';
include_once _PS_MODULE_DIR_ . '/grprestashop/classes/WebserviceSpecificManagementGetresponseModule.php';

class GrPrestashop extends Module
{
    private $usedHooks = [
        'displayLeftColumn',
        'displayRightColumn',
        'displayHeader',
        'displayFooter',
        'displayTop',
        'displayHome',
        'addWebserviceResources',
        'displayBackOfficeHeader',
        'actionCustomerAccountAdd',
        'actionProductAdd',
        'actionProductUpdate',
        'actionObjectCustomerUpdateAfter',
        'actionCartSave',
        'actionOrderEdited',
        'actionOrderStatusUpdate',
        'actionOrderStatusPostUpdate',
        'actionNewsletterRegistrationAfter',
        'actionObjectAddressUpdateAfter',
        'actionObjectAddressAddAfter',
    ];

    public function __construct()
    {
        $this->name = 'grprestashop';
        $this->tab = 'emailing';
        $this->version = '1.5.0';
        $this->author = 'GetResponse';
        $this->need_instance = 0;
        $this->module_key = '311ef191c3135b237511d18c4bc27369';
        $this->ps_versions_compliancy = ['min' => '1.6', 'max' => '8.1.7'];
        $this->displayName = $this->l('GetResponse');
        $this->description = 'Add your Prestashop contacts to GetResponse.';
        $this->confirmUninstall = $this->l('Are you sure you want to uninstall?');
        $this->bootstrap = true;

        parent::__construct();

        if (!function_exists('curl_init')) {
            $this->context->smarty->assign([
                'flash_message' => [
                    'message' => $this->l('Curl library not found'),
                    'status' => 'danger',
                ],
            ]);
        }
    }

    public function hookAddWebserviceResources()
    {
        return [
            'getresponse_module' => [
                'description' => 'Getresponse Integration',
                'specific_management' => true,
                'resources' => [
                    'getresponse_settings' => [
                        'description' => 'GetResponse Settings',
                        'class' => 'GetResponseSettingsCore',
                    ],
                ],
            ],
        ];
    }

    public function hookDisplayHome()
    {
        $currentShopId = $this->context->shop->id;
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configuration = $configurationReadModel->getConfigurationForShop($currentShopId);

        return $this->getGrWebFormSnippet(
            $configuration,
            GetResponse\Configuration\SharedKernel\WebFormPosition::HOME
        );
    }

    public function hookDisplayTop()
    {
        $currentShopId = $this->context->shop->id;
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configuration = $configurationReadModel->getConfigurationForShop($currentShopId);

        return $this->getGrWebFormSnippet(
            $configuration,
            GetResponse\Configuration\SharedKernel\WebFormPosition::TOP
        );
    }

    public function hookDisplayLeftColumn()
    {
        $currentShopId = $this->context->shop->id;
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configuration = $configurationReadModel->getConfigurationForShop($currentShopId);

        return $this->getGrWebFormSnippet(
            $configuration,
            GetResponse\Configuration\SharedKernel\WebFormPosition::LEFT
        );
    }

    public function hookDisplayRightColumn()
    {
        $currentShopId = $this->context->shop->id;
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configuration = $configurationReadModel->getConfigurationForShop($currentShopId);

        return $this->getGrWebFormSnippet(
            $configuration,
            GetResponse\Configuration\SharedKernel\WebFormPosition::RIGHT
        );
    }

    public function hookDisplayFooter()
    {
        $currentShopId = $this->context->shop->id;
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configuration = $configurationReadModel->getConfigurationForShop($currentShopId);

        return $this->getGrWebFormSnippet(
            $configuration,
            GetResponse\Configuration\SharedKernel\WebFormPosition::FOOTER
        );
    }

    public function hookDisplayBackOfficeHeader()
    {
        $this->context->controller->addCss($this->_path . 'views/css/tab.css');
    }

    /**
     * @return string
     */
    public function hookDisplayHeader()
    {
        $currentShopId = $this->context->shop->id;
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configuration = $configurationReadModel->getConfigurationForShop($currentShopId);

        $isWebConnectActive = $configuration->isGetResponseWebTrackingActive();

        if ($isWebConnectActive) {
            $this->smarty->assign('web_connect', $configuration->getGetResponseWebTrackingSnippet());
            $this->smarty->assign('user_email', $this->context->customer->email);

            $getresponseShopId = $configuration->getGetresponseShopId();

            if ($_SERVER['REQUEST_METHOD'] === 'GET') {
                $sessionStorage = new \GetResponse\SharedKernel\Session\StorageFactory();
                $storage = $sessionStorage->create();
                $session = new GetResponse\TrackingCode\DomainModel\TrackingCodeBufferService($storage);
                $cartService = new GetResponse\TrackingCode\Application\CartService($configurationReadModel, $session);

                $cart = $cartService->getCartFromBuffer($currentShopId);

                if (null !== $cart) {
                    $cartPresenter = new GetResponse\TrackingCode\Presenter\CartPresenter($cart);
                    $this->smarty->assign('buffered_cart', json_encode($cartPresenter->present()));
                }

                if (isset($this->context->controller->php_self) && $this->context->controller->php_self === 'order-confirmation') {
                    $orderService = new GetResponse\TrackingCode\Application\OrderService($configurationReadModel, $session);
                    $order = $orderService->getOrderFromBuffer($currentShopId);

                    if (null !== $order) {
                        $orderPresenter = new GetResponse\TrackingCode\Presenter\OrderPresenter($order);
                        $this->smarty->assign('buffered_order', json_encode($orderPresenter->present()));
                    }
                }
            }

            if (null !== $getresponseShopId) {
                $this->smarty->assign('shop_id', $getresponseShopId);

                if (isset($this->context->controller->php_self) && $this->context->controller->php_self === 'product') {
                    $this->smarty->assign('include_view_item', true);
                }

                if (isset($this->context->controller->php_self) && $this->context->controller->php_self === 'category') {
                    $this->smarty->assign('include_view_category', true);
                }
            }
        }

        $this->smarty->assign('facebook_pixel_snippet', $configuration->getFacebookPixelSnippet());
        $this->smarty->assign('facebook_ads_pixel_snippet', $configuration->getFacebookAdsPixelSnippet());
        $this->smarty->assign('facebook_business_extension_snippet', $configuration->getFacebookBusinessExtensionSnippet());
        $this->smarty->assign('getresponse_chat_snippet', $configuration->getGetResponseChatSnippet());

        $this->assignRecommendationObject($configuration->getGetResponseRecommendationSnippet());

        return $this->display(__FILE__, 'views/templates/front/head_snippet.tpl');
    }

    /**
     * @throws PrestaShopException
     */
    public function getContent()
    {
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );

        $context = Context::getContext();
        $shopContext = Shop::getContext();
        if ($shopContext === Shop::CONTEXT_SHOP) {
            $contextId = (int) $context->shop->getContextShopID();
        } elseif ($shopContext === Shop::CONTEXT_GROUP) {
            $contextId = (int) $context->shop->getContextShopGroupID();
        } else {
            $contextId = null;
        }

        $viewData = [];

        $shops = Shop::getShops();

        foreach ($shops as $shop) {
            $configuration = $configurationReadModel->getConfigurationForShop($shop['id_shop']);

            $viewData['getresponse_settings'][$shop['name']] = [
                'fb_pixel' => !empty($configuration->getFacebookPixelSnippet()),
                'fb_ads_pixel' => !empty($configuration->getFacebookAdsPixelSnippet()),
                'fbe' => !empty($configuration->getFacebookBusinessExtensionSnippet()),
                'gr_tracking' => !empty($configuration->getGetResponseWebTrackingSnippet()),
                'web_form' => $configuration->hasWebForm(),
                'live_synchronization' => $configuration->hasLiveSynchronization(),
            ];
        }

        Shop::setContext($shopContext, $contextId);

        $this->smarty->assign($viewData);

        return $this->display(__FILE__, 'views/templates/admin/main.tpl');
    }

    /**
     * @return bool
     *
     * @throws PrestaShopDatabaseException
     * @throws PrestaShopException
     */
    public function install()
    {
        if (!parent::install() || !$this->installTab()) {
            return false;
        }

        foreach ($this->usedHooks as $hook) {
            if (!$this->registerHook($hook)) {
                return false;
            }
        }

        // Update Version Number
        if (!Configuration::updateValue('GR_VERSION', $this->version)) {
            return false;
        }

        return true;
    }

    /**
     * @return bool
     */
    public function installTab()
    {
        $tab = new Tab();
        $tab->active = 1;
        $tab->class_name = 'AdminGetresponse';
        $tab->name = [];
        $tab->id_parent = strpos(_PS_VERSION_, '1.6') === 0 ? 0 : (int) Tab::getIdFromClassName('AdminAdmin');
        $tab->module = $this->name;
        foreach (Language::getLanguages(true) as $lang) {
            $tab->name[$lang['id_lang']] = 'GetResponse';
            $tab->icon = 'track_changes';
        }
        $tab->add();

        return true;
    }

    /**
     * @return bool
     *
     * @throws PrestaShopDatabaseException
     * @throws PrestaShopException
     */
    public function uninstall()
    {
        if (!parent::uninstall() || !$this->uninstallTab()) {
            return false;
        }

        foreach ($this->usedHooks as $hook) {
            if (!$this->unregisterHook($hook)) {
                return false;
            }
        }

        $configurationService = new GetResponse\Configuration\Application\ConfigurationService(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );
        $configurationService->deleteAllConfigurations();

        if (!Configuration::deleteByName('GR_VERSION')) {
            return false;
        }

        return true;
    }

    /**
     * @return bool
     *
     * @throws PrestaShopDatabaseException
     * @throws PrestaShopException
     */
    public function uninstallTab()
    {
        $idTab = (int) Tab::getIdFromClassName('AdminGetresponse');
        if (empty($idTab)) {
            return false;
        }

        $tab = new Tab($idTab);

        return $tab->delete();
    }

    public function hookActionNewsletterRegistrationAfter($params)
    {
        try {
            $email = $params['email'];
            $name = isset($_POST['name']) ? $_POST['name'] : null;

            if (null !== $email) {
                $shop = new Shop($this->context->shop->id);
                $contactService = new GetResponse\Contact\Application\ContactService(
                    new GetResponse\MessageSender\Application\MessageSenderService(
                        new GetResponse\MessageSender\Infrastructure\HttpClient($shop->getBaseURL())
                    ),
                    new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
                        new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
                    )
                );

                $contactService->upsertSubscriber(
                    new GetResponse\Contact\Application\Command\UpsertSubscriber($email, true, $shop->id, $name)
                );
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionObjectCustomerUpdateAfter($params)
    {
        try {
            /** @var Customer $customer */
            $customer = $params['object'];

            if (null !== $customer) {
                $this->upsertCustomer($customer);
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionCustomerAccountAdd($params)
    {
        try {
            /** @var Customer $customer */
            $customer = $params['newCustomer'];

            if (null !== $customer) {
                $this->upsertCustomer($customer);
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionCartSave($params)
    {
        if (null === $this->context->cart) {
            return;
        }

        try {
            /** @var Cart $cart */
            $cart = $params['cart'];

            // sometimes it happens
            if (null === $cart) {
                return;
            }

            $shop = new Shop($cart->id_shop);

            $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
                new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
            );

            $cartService = new GetResponse\Ecommerce\Application\CartService(
                new GetResponse\MessageSender\Application\MessageSenderService(
                    new GetResponse\MessageSender\Infrastructure\HttpClient($shop->getBaseURL())
                ),
                $configurationReadModel
            );
            $cartService->upsertCart(new GetResponse\Ecommerce\Application\Command\UpsertCart($cart->id, $shop->id));

            $sessionStorage = new \GetResponse\SharedKernel\Session\StorageFactory();
            $storage = $sessionStorage->create();
            $trackingCodeCartService = new GetResponse\TrackingCode\Application\CartService(
                $configurationReadModel,
                new GetResponse\TrackingCode\DomainModel\TrackingCodeBufferService($storage)
            );
            $trackingCodeCartService->addCartToBuffer($cart->id, $shop->id);
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionObjectAddressUpdateAfter($params)
    {
        try {
            /** @var Address $address */
            $address = $params['object'];

            if (null !== $address && null !== $address->id_customer) {
                $this->upsertCustomer(new Customer($address->id_customer));
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionObjectAddressAddAfter($params)
    {
        try {
            /** @var Address $address */
            $address = $params['object'];

            if (null !== $address && null !== $address->id_customer) {
                $this->upsertCustomer(new Customer($address->id_customer));
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionProductAdd($params)
    {
        try {
            /** @var Product $product */
            $product = $params['product'];

            if (null !== $product) {
                $this->upsertProduct($product);
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionProductUpdate($params)
    {
        try {
            /** @var Product $product */
            $product = $params['product'];

            if (null !== $product) {
                $this->upsertProduct($product);
            }
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionOrderStatusUpdate($params)
    {
        try {
            /** @var Order $order */
            $order = isset($params['order']) ? $params['order'] : null;

            if (null === $order) {
                return;
            }

            $this->upsertOrder($order);
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        } catch (Exception $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionOrderStatusPostUpdate($params)
    {
        try {
            if (null === $params['id_order']) {
                return;
            }

            $order = new Order($params['id_order']);

            $this->upsertOrder($order);
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        } catch (Exception $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    public function hookActionOrderEdited($params)
    {
        try {
            /** @var Order $order */
            $order = $params['order'];

            if (null === $order) {
                return;
            }

            $this->upsertOrder($order);
        } catch (GetResponse\MessageSender\Application\MessageSenderException $e) {
            $this->logGetResponseError($e->getMessage());
        } catch (Exception $e) {
            $this->logGetResponseError($e->getMessage());
        }
    }

    /**
     * @param string $message
     */
    private function logGetResponseError($message)
    {
        PrestaShopLoggerCore::addLog($message, 2, null, 'GetResponse', 'GetResponse');
    }

    /**
     * @param GetResponse\Configuration\ReadModel\ConfigurationDto $configuration
     * @param string $position
     *
     * @return false|string|null
     */
    private function getGrWebFormSnippet($configuration, $position)
    {
        if (!$configuration->hasWebForm() || $configuration->getGetResponseWebFormPosition() !== $position) {
            return null;
        }

        $templateVars = [
            'webformUrl' => $configuration->getGetResponseWebFormUrl(),
            'position' => $configuration->getGetResponseWebFormPosition(),
        ];

        $this->smarty->assign($templateVars);

        return $this->display(__FILE__, 'views/templates/front/webform_snippet.tpl');
    }

    /**
     * @param Customer $customer
     *
     * @throws GetResponse\MessageSender\Application\MessageSenderException
     */
    private function upsertCustomer(Customer $customer)
    {
        $shop = new Shop($customer->id_shop);
        $contactService = new GetResponse\Contact\Application\ContactService(
            new GetResponse\MessageSender\Application\MessageSenderService(
                new GetResponse\MessageSender\Infrastructure\HttpClient($shop->getBaseURL())
            ),
            new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
                new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
            )
        );

        $contactService->upsertCustomer(
            new GetResponse\Contact\Application\Command\UpsertCustomer($customer->id, $shop->id)
        );
    }

    /**
     * @param Product $product
     *
     * @throws GetResponse\MessageSender\Application\MessageSenderException
     */
    private function upsertProduct(Product $product)
    {
        if (null === ShopCore::getContextShopID()) {
            return;
        }

        $languageId = Configuration::get('PS_LANG_DEFAULT');
        $shops = $product->getAssociatedShops();

        foreach ($shops as $shopId) {
            $shop = new Shop($shopId);

            $productService = new GetResponse\Ecommerce\Application\ProductService(
                new GetResponse\MessageSender\Application\MessageSenderService(
                    new GetResponse\MessageSender\Infrastructure\HttpClient($shop->getBaseURL())
                ),
                new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
                    new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
                )
            );

            $productService->upsertProduct(
                new GetResponse\Ecommerce\Application\Command\UpsertProduct(
                    (int) $shopId,
                    $product->id,
                    (int) $languageId
                )
            );
        }
    }

    /**
     * @param Order $order
     *
     * @throws GetResponse\MessageSender\Application\MessageSenderException
     */
    private function upsertOrder(Order $order)
    {
        $shop = new Shop($order->id_shop);
        $configurationReadModel = new GetResponse\Configuration\ReadModel\ConfigurationReadModel(
            new GetResponse\Configuration\Infrastructure\ConfigurationRepository()
        );

        $orderService = new GetResponse\Ecommerce\Application\OrderService(
            new GetResponse\MessageSender\Application\MessageSenderService(
                new GetResponse\MessageSender\Infrastructure\HttpClient($shop->getBaseURL())
            ),
            $configurationReadModel
        );

        $orderService->upsertOrder(
            new GetResponse\Ecommerce\Application\Command\UpsertOrder($order->id, $order->id_shop)
        );

        $sessionStorage = new \GetResponse\SharedKernel\Session\StorageFactory();
        $storage = $sessionStorage->create();

        $trackingCodeOrderService = new GetResponse\TrackingCode\Application\OrderService(
            $configurationReadModel,
            new GetResponse\TrackingCode\DomainModel\TrackingCodeBufferService($storage)
        );

        $trackingCodeOrderService->addOrderToBuffer($order->id, $order->id_shop);
    }

    private function assignRecommendationObject($recommendationSnippet)
    {
        $service = new GetResponse\Ecommerce\Application\RecommendationService(
            new GetResponse\Ecommerce\Application\Adapter\ProductAdapter()
        );
        $pageType = $service->getPageType($this->context->controller->php_self);

        if ($pageType === null || empty($recommendationSnippet)) {
            return;
        }

        $this->smarty->assign('getresponse_recommendation_snippet', $recommendationSnippet);

        $pageData = [];

        if ($pageType === 'product') {
            $command = new GetResponse\Ecommerce\Application\Command\RecommendedProductCommand(
                Tools::getValue('id_product'),
                Configuration::get('PS_LANG_DEFAULT')
            );
            $product = $service->createRecommendedProduct($command);
            $pageData = $product !== null ? $product->toArray() : [];
        }

        $this->smarty->assign(
            'getresponse_recommendation_object',
            json_encode(['pageType' => $pageType, 'pageData' => $pageData])
        );
    }
}