Smile-SA/elasticsuite

<?php
/**
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Smile ElasticSuite to newer
 * versions in the future.
 *
 * @category  Smile
 * @package   Smile\ElasticsuiteTracker
 * @author    Romain Ruaud <romain.ruaud@smile.fr>
 * @copyright 2020 Smile
 * @license   Open Software License ("OSL") v. 3.0
 */
namespace Smile\ElasticsuiteTracker\Helper;

use Magento\Store\Model\ScopeInterface;

/**
 * Smile Tracker helper
 *
 * @category Smile
 * @package  Smile\ElasticsuiteTracker
 * @author   Romain Ruaud <romain.ruaud@smile.fr>
 */
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
    /**
     * Module status configuration path
     * @var string
     */
    const CONFIG_IS_ENABLED_XPATH = 'smile_elasticsuite_tracker/general/enabled';

    /**
     * Coookie configuration configuration path
     * @var string
     */
    const CONFIG_COOKIE           = 'smile_elasticsuite_tracker/session';

    /**
     * Anonymization status configuration path
     * @var string
     */
    const CONFIG_IS_ANONYMIZATION_ENABLED_XPATH = 'smile_elasticsuite_tracker/anonymization/enabled';

    /**
     * Anonymization delay configuration path
     * @var string
     */
    const CONFIG_ANONYMIZATION_DELAY_XPATH      = 'smile_elasticsuite_tracker/anonymization/delay';

    /**
     * Module retention delay configuration path
     * @var string
     */
    const CONFIG_RETENTION_DELAY_XPATH = 'smile_elasticsuite_tracker/general/retention_delay';

    /**
     * Event queue cleanup retention delay
     * @var string
     */
    const CONFIG_QUEUE_CLEANUP_DELAY_XPATH = 'smile_elasticsuite_tracker/queue_cleanup/delay';

    /**
     * Using API instead of invisible pixel configuration path
     * @var string
     */
    const CONFIG_IS_USING_API_XPATH = 'smile_elasticsuite_tracker/general/use_api';

    /**
     * Headless mode configuration path
     * @var string
     */
    const CONFIG_IS_HEADLESS_MODE_XPATH = 'smile_elasticsuite_tracker/general/is_headless_mode';

    /**
     * Anonymization status configuration path
     * @var string
     */
    const CONFIG_IS_TELEMETRY_ENABLED_XPATH = 'smile_elasticsuite_telemetry/telemetry/enabled';

    /**
     * Module retention delay configuration path
     * @var string
     */
    const CONFIG_TELEMETRY_URL_XPATH = 'smile_elasticsuite_telemetry/telemetry/url';

    /**
     * Magento Configuration
     *
     * @var \Magento\Framework\App\Config\ScopeConfigInterface
     */
    protected $scopeConfig;

    /**
     * Magento Store Manager
     *
     * @var \Magento\Framework\App\Config\ScopeConfigInterface
     */
    private $storeManager;

    /**
     * @var \Magento\Framework\UrlInterface
     */
    private $urlBuilder;

    /**
     * @var \Magento\Framework\Session\SessionManagerInterface
     */
    private $sessionManager;

    /**
     * @var \Magento\Framework\Stdlib\CookieManagerInterface
     */
    private $cookieManager;

    /**
     * PHP Constructor
     *
     * @param \Magento\Framework\App\Helper\Context              $context        The current context
     * @param \Magento\Store\Model\StoreManagerInterface         $storeManager   The Store Manager
     * @param \Magento\Framework\Session\SessionManagerInterface $sessionManager Session Manager
     * @param \Magento\Framework\Stdlib\CookieManagerInterface   $cookieManager  Cookie manager
     */
    public function __construct(
        \Magento\Framework\App\Helper\Context $context,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        \Magento\Framework\Session\SessionManagerInterface $sessionManager,
        \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager
    ) {
        $this->urlBuilder     = $context->getUrlBuilder();
        $this->storeManager   = $storeManager;
        $this->sessionManager = $sessionManager;
        $this->cookieManager  = $cookieManager;
        parent::__construct($context);
    }

    /**
     * Return the module activation status
     *
     * @return bool
     */
    public function isEnabled()
    {
        return (bool) $this->scopeConfig->getValue(self::CONFIG_IS_ENABLED_XPATH, ScopeInterface::SCOPE_WEBSITE);
    }

    /**
     * Return the tracking base URL (params are added later)
     *
     * @return string
     */
    public function getBaseUrl()
    {
        return trim($this->urlBuilder->getUrl('elasticsuite/tracker/hit', ['image' => 'h.png']), '/');
    }

    /**
     * Return the tracking Rest endpoint URL
     *
     * @return string
     */
    public function getRestBaseUrl()
    {
        return $this->urlBuilder->getDirectUrl('rest/V1/elasticsuite-tracker/hit');
    }

    /**
     * Return true if the tracker should use the (Rest) API to push its data to Magento
     *
     * @return bool
     */
    public function isUsingAPI()
    {
        return $this->scopeConfig->isSetFlag(self::CONFIG_IS_USING_API_XPATH, ScopeInterface::SCOPE_STORE);
    }

    /**
     * Return true if the headless mode is enabled
     *
     * @return bool
     */
    public function isHeadlessMode()
    {
        return $this->scopeConfig->isSetFlag(self::CONFIG_IS_HEADLESS_MODE_XPATH, ScopeInterface::SCOPE_STORE);
    }

    /**
     * Return an array containing the cookie configuration
     *
     * @return array
     */
    public function getCookieConfig()
    {
        $config           = $this->scopeConfig->getValue(self::CONFIG_COOKIE);
        $config['domain'] = $this->sessionManager->getCookieDomain();
        $config['path']   = $this->sessionManager->getCookiePath();

        return $config;
    }

    /**
     * Retrieve current store Id
     *
     * @return int
     */
    public function getStoreId()
    {
        return $this->storeManager->getStore()->getId();
    }


    /**
     * Check if Anonymization is enabled.
     *
     * @return bool
     */
    public function isAnonymizationEnabled()
    {
        return $this->scopeConfig->isSetFlag(self::CONFIG_IS_ANONYMIZATION_ENABLED_XPATH);
    }

    /**
     * Retrieve anonymization delay (in days).
     *
     * @return int
     */
    public function getAnonymizationDelay()
    {
        return (int) $this->scopeConfig->getValue(self::CONFIG_ANONYMIZATION_DELAY_XPATH);
    }

    /**
     * Return the tracking data retention delay, in months
     *
     * @return int
     */
    public function getRetentionDelay()
    {
        return (int) $this->scopeConfig->getValue(self::CONFIG_RETENTION_DELAY_XPATH);
    }

    /**
     * Return the tracking data purge delay, in days
     *
     * @return int
     */
    public function getEventsQueueCleanupDelay()
    {
        return (int) $this->scopeConfig->getValue(self::CONFIG_QUEUE_CLEANUP_DELAY_XPATH);
    }

    /**
     * Return the current tracker visitor id
     *
     * @return null|string
     */
    public function getCurrentVisitorId()
    {
        $visitorId = null;

        $cookieConfig = $this->getCookieConfig();
        if (array_key_exists('visitor_cookie_name', $cookieConfig)) {
            $visitorCookieName = $cookieConfig['visitor_cookie_name'];
            $visitorId = $this->cookieManager->getCookie($visitorCookieName);
        }

        return $visitorId;
    }

    /**
     * Return the current tracker session id
     *
     * @return null|string
     */
    public function getCurrentSessionId()
    {
        $visitorId = null;

        $cookieConfig = $this->getCookieConfig();
        if (array_key_exists('visit_cookie_name', $cookieConfig)) {
            $sessionCookieName = $cookieConfig['visit_cookie_name'];
            $visitorId = $this->cookieManager->getCookie($sessionCookieName);
        }

        return $visitorId;
    }

    /**
     * Return the telemetry url.
     *
     * @return string
     */
    public function getTelemetryUrl()
    {
        return (string) $this->scopeConfig->getValue(self::CONFIG_TELEMETRY_URL_XPATH);
    }

    /**
     * Is telemetry enabled ?
     *
     * @return bool
     */
    public function isTelemetryEnabled()
    {
        return (bool) $this->scopeConfig->getValue(self::CONFIG_IS_TELEMETRY_ENABLED_XPATH);
    }
}