SubscriptionHandler.php 4.27 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Analytics\Model\Config\Backend\Enabled;

use Magento\Analytics\Model\AnalyticsToken;
use Magento\Analytics\Model\Config\Backend\CollectionTime;
use Magento\Framework\App\Config\ReinitableConfigInterface;
use Magento\Framework\App\Config\Storage\WriterInterface;
use Magento\Framework\FlagManager;

/**
 * Class for processing of activation/deactivation MBI subscription.
 */
class SubscriptionHandler
{
    /**
     * Flag code for reserve counter of attempts to subscribe.
     */
    const ATTEMPTS_REVERSE_COUNTER_FLAG_CODE = 'analytics_link_attempts_reverse_counter';

    /**
     * Config path for schedule setting of subscription handler.
     */
    const CRON_STRING_PATH = 'crontab/default/jobs/analytics_subscribe/schedule/cron_expr';

    /**
     * Config value for schedule setting of subscription handler.
     */
    const CRON_EXPR_ARRAY = [
        '0',                    # Minute
        '*',                    # Hour
        '*',                    # Day of the Month
        '*',                    # Month of the Year
        '*',                    # Day of the Week
    ];

    /**
     * Max value for reserve counter of attempts to subscribe.
     *
     * @var int
     */
    private $attemptsInitValue = 24;

    /**
     * Service which allows to write values into config.
     *
     * @var WriterInterface
     */
    private $configWriter;

    /**
     * Flag Manager.
     *
     * @var FlagManager
     */
    private $flagManager;

    /**
     * Model for handling Magento BI token value.
     *
     * @var AnalyticsToken
     */
    private $analyticsToken;

    /**
     * @var ReinitableConfigInterface
     */
    private $reinitableConfig;

    /**
     * @param WriterInterface $configWriter
     * @param FlagManager $flagManager
     * @param AnalyticsToken $analyticsToken
     * @param ReinitableConfigInterface $reinitableConfig
     */
    public function __construct(
        WriterInterface $configWriter,
        FlagManager $flagManager,
        AnalyticsToken $analyticsToken,
        ReinitableConfigInterface $reinitableConfig
    ) {
        $this->configWriter = $configWriter;
        $this->flagManager = $flagManager;
        $this->analyticsToken = $analyticsToken;
        $this->reinitableConfig = $reinitableConfig;
    }

    /**
     * Processing of activation MBI subscription.
     *
     * Activate process of subscription handling if Analytics token is not received.
     *
     * @return bool
     */
    public function processEnabled()
    {
        if (!$this->analyticsToken->isTokenExist()) {
            $this->setCronSchedule();
            $this->setAttemptsFlag();
            $this->reinitableConfig->reinit();
        }

        return true;
    }

    /**
     * Set cron schedule setting into config for activation of subscription process.
     *
     * @return bool
     */
    private function setCronSchedule()
    {
        $this->configWriter->save(self::CRON_STRING_PATH, join(' ', self::CRON_EXPR_ARRAY));
        return true;
    }

    /**
     * Set flag as reserve counter of attempts subscription operation.
     *
     * @return bool
     */
    private function setAttemptsFlag()
    {
        return $this->flagManager
            ->saveFlag(self::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE, $this->attemptsInitValue);
    }

    /**
     * Processing of deactivation MBI subscription.
     *
     * Disable data collection
     * and interrupt subscription handling if Analytics token is not received.
     *
     * @return bool
     */
    public function processDisabled()
    {
        $this->disableCollectionData();

        if (!$this->analyticsToken->isTokenExist()) {
            $this->unsetAttemptsFlag();
        }

        return true;
    }

    /**
     * Unset flag of attempts subscription operation.
     *
     * @return bool
     */
    private function unsetAttemptsFlag()
    {
        return $this->flagManager
            ->deleteFlag(self::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE);
    }

    /**
     * Unset schedule of collection data cron.
     *
     * @return bool
     */
    private function disableCollectionData()
    {
        $this->configWriter->delete(CollectionTime::CRON_SCHEDULE_PATH);

        return true;
    }
}