Elep

<?php
/**
 * Created by PhpStorm.
 * User: turgutsaricam
 * Date: 26/10/2018
 * Time: 23:29
 */

namespace WPCCrawler\Objects\OptionsBox\Boxes\Def;

use Exception;
use WPCCrawler\Exceptions\StopSavingException;
use WPCCrawler\Objects\Enums\ShortCodeName;
use WPCCrawler\Objects\Informing\Informer;
use WPCCrawler\Objects\OptionsBox\Boxes\Base\BaseOptionsBoxApplier;
use WPCCrawler\Objects\ShortCode\ShortCodeApplier;
use WPCCrawler\Objects\StringCalculator;
use WPCCrawler\Objects\Traits\FindAndReplaceTrait;
use WPCCrawler\Utils;

class DefaultOptionsBoxApplier extends BaseOptionsBoxApplier {

use FindAndReplaceTrait;

// TODO: We need a wildcard in the dot notation used to get values from JSON. When a wildcard is provided, we should
    //  get all items. Hence, there will be an array of values.

/**
     * @var string Stores the resultant value. This will be used as the final value. It will also be used to replace
     *      [wcc-item] short code
     */
    private $finalValue;

/**
     * @var mixed This can either be array or string. If the item is parsed to JSON, this stores the array version of
     *      the JSON.
     */
    private $arrayValue;

/*
     *
     */

/** @var bool */
    private $shouldApplyGeneralOptions      = true;

/** @var bool */
    private $shouldApplyFindReplaceOptions  = true;

/** @var bool */
    private $shouldApplyTemplateOptions     = true;

/** @var bool */
    private $shouldApplyCalculationOptions  = true;

/*
     *
     */

/** @var StringCalculator|null */
    private $stringCalculator = null;

/** @var bool True if the item should be treated as JSON. */
    private $isTreatAsJson = false;

/**
     * Applies the options configured in options box to the given value
     * @param mixed $value
     * @return mixed|null $modifiedValue Null, if the item should be removed. Otherwise, the modified value.
     */
    protected function onApply($value) {
        if (!$this->dataExists() || is_object($value) || is_array($value)) return $value;

$this->finalValue = $value;

try {
            $this->applyFindReplaceOptions();
            $this->applyGeneralOptions();
            $this->applyCalculationOptions();
            $this->applyTemplateOptions();

} catch(StopSavingException $e) {
            return null;
        }

return $this->finalValue;
    }

/*
     * APPLIER CONFIGURATION METHODS
     */

/**
     * @param bool $apply True if the general options should be applied. Otherwise, false.
     * @return DefaultOptionsBoxApplier
     */
    public function setApplyGeneralOptions($apply): self {
        $this->shouldApplyGeneralOptions = $apply;
        return $this;
    }

/**
     * @param bool $apply True if the find-replace options should be applied. Otherwise, false.
     * @return DefaultOptionsBoxApplier
     * @noinspection PhpUnused
     */
    public function setApplyFindReplaceOptions(bool $apply): self {
        $this->shouldApplyFindReplaceOptions = $apply;
        return $this;
    }

/**
     * @param bool $apply True if the calculation options should be applied. Otherwise, false.
     * @return DefaultOptionsBoxApplier
     */
    public function setApplyCalculationOptions(bool $apply): self {
        $this->shouldApplyCalculationOptions = $apply;
        return $this;
    }

/**
     * @param bool $apply True if the template options should be applied. Otherwise, false.
     * @return DefaultOptionsBoxApplier
     */
    public function setApplyTemplateOptions(bool $apply): self {
        $this->shouldApplyTemplateOptions = $apply;
        return $this;
    }

/*
     *
     */

/**
     * Replaces [wcc-item dot.key] short code in a string, considering whether the value is being treated as JSON.
     *
     * @param string $haystack A string that is searched for wcc-item short code and replaced with value.
     */
    public function replaceItemDotNotationShortCode(&$haystack): void {
        // Match wcc-item short codes in the haystack.
        $regexShortCode = sprintf('/\[%1$s[^\]\[]*\]/u', ShortCodeName::WCC_ITEM);
        $result = preg_match_all($regexShortCode, $haystack, $matches);

// If there is no match, return.
        if ($result === false || !$matches) return;

// Replace the short codes
        foreach($matches[0] as $shortCode) {
            $shortCodeLength = mb_strlen($shortCode);

// Remove the brackets, which are the first and the last chars
            $withoutBrackets = mb_substr($shortCode, 1, $shortCodeLength - 2);

// Explode the short code from spaces. We need the first index. It must store the dot key.
            $parts = explode(' ', $withoutBrackets);
            if ($parts && isset($parts[1])) { // @phpstan-ignore-line
                $key = $parts[1];

// Get the short code value from the parsed JSON if the item is treated as JSON
                if ($this->isTreatAsJson) {
                    $shortCodeValue = Utils::array_get($this->arrayValue, $key, '');
                    if (is_string($shortCodeValue)) {
                        $shortCodeValue = html_entity_decode($shortCodeValue);
                    }

// Otherwise, replace it with the final value.
                } else {
                    $shortCodeValue = $this->finalValue;
                }

// Make sure the value is string.
                if (is_array($shortCodeValue)) {
                    $shortCodeValue = json_encode($shortCodeValue);
                }

} else {
                // If there is no key, replace the short code with an empty string.
                $shortCodeValue = $this->isTreatAsJson ? '' : $this->finalValue;
            }

// Replace it
            $haystack = str_replace($shortCode, $shortCodeValue, $haystack);
        }

}

/**
     * @return bool See {@link $isTreatAsJson}
     */
    public function isTreatAsJson(): bool {
        return $this->isTreatAsJson;
    }

/*
     * APPLIER METHODS
     */

/**
     * Applies the find-replace options if they should be applied.
     */
    private function applyFindReplaceOptions(): void {
        // Stop if the find-replace options should not be applied.
        if (!$this->shouldApplyFindReplaceOptions) return;

$frOptions = $this->getData()->getFindReplaceOptions();
        if (!$frOptions) return;

$this->finalValue = $this->findAndReplace($frOptions, $this->finalValue);
    }

/**
     * Applies general options if they should be applied.
     *
     * @throws StopSavingException
     */
    private function applyGeneralOptions(): void {
        if (!$this->shouldApplyGeneralOptions) return;

$generalOptions = $this->getData()->getGeneralOptions();
        if (!$generalOptions) return;

// If the item should be treated as JSON, parse it.
        if ($generalOptions->isTreatAsJson()) {
            $this->isTreatAsJson = true;

// If there is no value, stop.
            if (!$this->finalValue) throw new StopSavingException();

// Parse the JSON as array
            $this->arrayValue = json_decode($this->finalValue, true);

// If parsing was not successful, stop.
            if ($this->arrayValue === null) {
                Informer::addError(sprintf(_wpcc('JSON could not be parsed. JSON string: %1$s'), $this->finalValue))
                    ->addAsLog();

throw new StopSavingException();
            }
        }

}

/**
     * Applies the calculation options if they should be applied.
     * @throws StopSavingException If the value is not numeric and the item should be removed completely.
     */
    private function applyCalculationOptions(): void {
        if(!$this->shouldApplyCalculationOptions) return;

$calculationOptions = $this->getData()->getCalculationOptions();
        if (!$calculationOptions) return;

// Get the formulas. If there is no formula, stop.
        $formulas = $calculationOptions->getFormulas();
        if (!$formulas) {
            // If the value is not numeric and it should be removed when it is not numeric, throw an exception, which
            // indicates that the item should be removed.
            if ($calculationOptions->isRemoveIfNotNumeric() && !is_numeric($this->finalValue)) {
                throw new StopSavingException();
            }

return;
        }

// Get the calculator
        $calculator = $this->getStringCalculator();
        if (!$calculator) return;

// Select a random formula
        $formula = $formulas[array_rand($formulas, 1)];

// Apply calculation options
        try {
            // Replace the wcc-item short codes if the value is array.
            $this->replaceItemDotNotationShortCode($formula);

// If there is an array value, it means the user wants to use JSON. Hence, in this case, final value is not
            // intended to be used as a number. So, the user must not use X in the formula. He/she must use [wcc-item]
            // short code with a dot notation.
            $this->finalValue = $calculator->calculateForX($formula, is_array($this->arrayValue) ? 0 : $this->finalValue);

} catch (Exception $e) {
            $this->finalValue = '';

if ($calculationOptions->isRemoveIfNotNumeric()) {
                throw new StopSavingException();
            }
        }
    }

/**
     * Applies the template options if they should be applied.
     *
     * @throws StopSavingException
     */
    private function applyTemplateOptions(): void {
        if (!$this->shouldApplyTemplateOptions) return;

// Get the templates. If there is no template, stop.
        $templateOptions = $this->getData()->getTemplateOptions();
        if (!$templateOptions) return;

// Stop saving if the item is empty and the user wants to remove it.
        if ($templateOptions->isRemoveIfEmpty() && !$this->finalValue) {
            throw new StopSavingException();
        }

// Select a random template
        $templates = $templateOptions->getTemplates();
        if (!$templates) return;

$template = $templates[array_rand($templates, 1)];

// Replace only the item short code in the template.
        $shortCodeApplier = (new ShortCodeApplier([
            ShortCodeName::WCC_ITEM => $this->finalValue
        ]))
            ->setCustomAppliersDisabled(true)

// Inject the short code values into the generative short code templates, because the short code values are
            // not available anywhere else. Those values are specific to the item. So, this is the only place where
            // those short code values can be injected.
            ->setInjectValuesToCustomAppliers(true)

// Replace the wcc-item short codes if the reference value is an array
            ->setOnModifyTemplateCallback(function(string $template): string {
                $this->replaceItemDotNotationShortCode($template);
                return $template;
            });

// Set the value as template whose item short code has just been replaced
        $this->finalValue = $shortCodeApplier->apply($template);
    }

/*
     * HELPERS
     */

/**
     * Get string calculator configured for this options box
     * @return StringCalculator|null
     */
    private function getStringCalculator(): ?StringCalculator {
        if (!$this->stringCalculator) {
            $options = $this->getData()->getCalculationOptions();
            if (!$options) {
                return null;
            }

$this->stringCalculator = new StringCalculator(
                $options->getDecimalSeparatorAfter(),
                $options->getPrecision(),
                $options->isUseThousandsSeparator()
            );
        }

return $this->stringCalculator;
    }

/**
     * @return DefaultOptionsBoxData
     * @since 1.8.0
     */
    public function getData(): DefaultOptionsBoxData {
        $data = parent::getData();
        return $data instanceof DefaultOptionsBoxData
            ? $data
            : new DefaultOptionsBoxData([]);
    }

}