carono\checksum\Request

Complexity

Total Complexity

21

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	5

Importance

Changes	5
Bugs	0	Features	2

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getChecksumKey()	0	4	2
A	setChecksumKey()	0	4	1
A	init()	0	7	2
A	checksumIsEnabled()	0	4	1
B	validateCsrfToken()	0	19	5
A	getStackKey()	0	4	1
A	stackField()	0	7	1
A	clearStack()	0	11	2
A	getStack()	0	6	2
A	getStackByChecksum()	0	10	4

<?php


namespace carono\checksum;

use yii\helpers\ArrayHelper;

/**
 * Class Request
 *
 * @property mixed checksumKey
 * @package carono\checksum
 */
class Request extends \yii\web\Request
{
    public $checksumParam = '_checksum';
    public $enableChecksumValidation = true;
    public $redefineActiveField = true;
    protected $_checksumKey;

    public function getChecksumKey()
    {
        return $this->_checksumKey ?: hash("sha256", $this->cookieValidationKey);
    }

    public function setChecksumKey($value)
    {
        $this->_checksumKey = $value;
    }

    public function init()
    {
        parent::init();
        if ($this->redefineActiveField) {
            \Yii::$container->set('yii\widgets\ActiveField', 'carono\checksum\ActiveField');
        }
    }

    public function checksumIsEnabled()
    {
        return $this->enableChecksumValidation;
    }

    /**
     * @param null $clientSuppliedToken
     * @return bool
     */
    public function validateCsrfToken($clientSuppliedToken = null)
    {
        if ($this->isPost && $this->checksumIsEnabled()) {
            $post = $this->post();
            $checksum = ArrayHelper::remove($post, $this->checksumParam);
            $stack = $this->getStackByChecksum($checksum);
            $postPartials = Checksum::formKeyPartials($post);
            $stackPartials = Checksum::formKeyPartials($stack);
            foreach (array_diff($stackPartials, $postPartials) as $lostPartial) {
                list($formName, $attribute) = explode('=', $lostPartial);
                $post[$formName][$attribute] = '';
            }
            if (!Checksum::validate($post, $checksum, $this->checksumKey)) {
                return false;
            }
        }
        $this->clearStack();
        return parent::validateCsrfToken($clientSuppliedToken);
    }

    /**
     * @return string
     */
    protected function getStackKey()
    {
        return self::className() . $this->checksumParam;
    }

    /**
     * @param $widgetId
     * @param $modelName
     * @param $fieldName
     */
    public function stackField($widgetId, $modelName, $fieldName)
    {
        $key = $this->getStackKey();
        $data = $this->getStack();
        $data[$widgetId][$modelName][] = $fieldName;
        return \Yii::$app->session->set($key, $data);
    }

    /**
     * @param null $widgetId
     */
    public function clearStack($widgetId = null)
    {
        $key = $this->getStackKey();
        $data = $this->getStack();
        if (!is_null($widgetId)) {
            unset($data[$widgetId]);
        } else {
            $data = [];
        }
        return \Yii::$app->session->set($key, $data);
    }

    /**
     * @param null $widgetId
     * @return mixed
     */
    public function getStack($widgetId = null)
    {
        $key = self::getStackKey();
        $data = \Yii::$app->session->get($key, []);
        return is_null($widgetId) ? $data : ArrayHelper::getValue($data, $widgetId);
    }

    /**
     * @param $checksum
     * @return array
     */
    public function getStackByChecksum($checksum)
    {
        foreach ($this->getStack() as $item) {
            if (($value = ArrayHelper::getValue($item, $this->checksumParam . '.0')) && $value == $checksum) {
                unset($item[$this->checksumParam]);
                return $item;
            }
        }
        return [];
    }
}