init

vendor/yiisoft/yii2/captcha/Captcha.php

@@ -0,0 +1,177 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\captcha;
+
+use Yii;
+use yii\base\InvalidConfigException;
+use yii\helpers\Html;
+use yii\helpers\Json;
+use yii\helpers\Url;
+use yii\widgets\InputWidget;
+
+/**
+ * Captcha renders a CAPTCHA image and an input field that takes user-entered verification code.
+ *
+ * Captcha is used together with [[CaptchaAction]] to provide [CAPTCHA](http://en.wikipedia.org/wiki/Captcha) - a way
+ * of preventing website spamming.
+ *
+ * The image element rendered by Captcha will display a CAPTCHA image generated by
+ * an action whose route is specified by [[captchaAction]]. This action must be an instance of [[CaptchaAction]].
+ *
+ * When the user clicks on the CAPTCHA image, it will cause the CAPTCHA image
+ * to be refreshed with a new CAPTCHA.
+ *
+ * You may use [[\yii\captcha\CaptchaValidator]] to validate the user input matches
+ * the current CAPTCHA verification code.
+ *
+ * The following example shows how to use this widget with a model attribute:
+ *
+ * ```php
+ * echo Captcha::widget([
+ *     'model' => $model,
+ *     'attribute' => 'captcha',
+ * ]);
+ * ```
+ *
+ * The following example will use the name property instead:
+ *
+ * ```php
+ * echo Captcha::widget([
+ *     'name' => 'captcha',
+ * ]);
+ * ```
+ *
+ * You can also use this widget in an [[\yii\widgets\ActiveForm|ActiveForm]] using the [[\yii\widgets\ActiveField::widget()|widget()]]
+ * method, for example like this:
+ *
+ * ```php
+ * <?= $form->field($model, 'captcha')->widget(\yii\captcha\Captcha::classname(), [
+ *     // configure additional widget properties here
+ * ]) ?>
+ * ```
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class Captcha extends InputWidget
+{
+    /**
+     * @var string|array the route of the action that generates the CAPTCHA images.
+     * The action represented by this route must be an action of [[CaptchaAction]].
+     * Please refer to [[\yii\helpers\Url::toRoute()]] for acceptable formats.
+     */
+    public $captchaAction = 'site/captcha';
+    /**
+     * @var array HTML attributes to be applied to the CAPTCHA image tag.
+     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
+     */
+    public $imageOptions = [];
+    /**
+     * @var string the template for arranging the CAPTCHA image tag and the text input tag.
+     * In this template, the token `{image}` will be replaced with the actual image tag,
+     * while `{input}` will be replaced with the text input tag.
+     */
+    public $template = '{image} {input}';
+    /**
+     * @var array the HTML attributes for the input tag.
+     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
+     */
+    public $options = ['class' => 'form-control'];
+
+
+    /**
+     * Initializes the widget.
+     */
+    public function init()
+    {
+        parent::init();
+
+        static::checkRequirements();
+
+        if (!isset($this->imageOptions['id'])) {
+            $this->imageOptions['id'] = $this->options['id'] . '-image';
+        }
+    }
+
+    /**
+     * Renders the widget.
+     */
+    public function run()
+    {
+        $this->registerClientScript();
+        $input = $this->renderInputHtml('text');
+        $route = $this->captchaAction;
+        if (is_array($route)) {
+            $route['v'] = uniqid('', true);
+        } else {
+            $route = [$route, 'v' => uniqid('', true)];
+        }
+        $image = Html::img($route, $this->imageOptions);
+        echo strtr($this->template, [
+            '{input}' => $input,
+            '{image}' => $image,
+        ]);
+    }
+
+    /**
+     * Registers the needed JavaScript.
+     */
+    public function registerClientScript()
+    {
+        $options = $this->getClientOptions();
+        $options = empty($options) ? '' : Json::htmlEncode($options);
+        $id = $this->imageOptions['id'];
+        $view = $this->getView();
+        CaptchaAsset::register($view);
+        $view->registerJs("jQuery('#$id').yiiCaptcha($options);");
+    }
+
+    /**
+     * Returns the options for the captcha JS widget.
+     * @return array the options
+     */
+    protected function getClientOptions()
+    {
+        $route = $this->captchaAction;
+        if (is_array($route)) {
+            $route[CaptchaAction::REFRESH_GET_VAR] = 1;
+        } else {
+            $route = [$route, CaptchaAction::REFRESH_GET_VAR => 1];
+        }
+
+        $options = [
+            'refreshUrl' => Url::toRoute($route),
+            'hashKey' => 'yiiCaptcha/' . trim($route[0], '/'),
+        ];
+
+        return $options;
+    }
+
+    /**
+     * Checks if there is graphic extension available to generate CAPTCHA images.
+     * This method will check the existence of ImageMagick and GD extensions.
+     * @return string the name of the graphic extension, either "imagick" or "gd".
+     * @throws InvalidConfigException if neither ImageMagick nor GD is installed.
+     */
+    public static function checkRequirements()
+    {
+        if (extension_loaded('imagick')) {
+            $imagickFormats = (new \Imagick())->queryFormats('PNG');
+            if (in_array('PNG', $imagickFormats, true)) {
+                return 'imagick';
+            }
+        }
+        if (extension_loaded('gd')) {
+            $gdInfo = gd_info();
+            if (!empty($gdInfo['FreeType Support'])) {
+                return 'gd';
+            }
+        }
+        throw new InvalidConfigException('Either GD PHP extension with FreeType support or ImageMagick PHP extension with PNG support is required.');
+    }
+}

vendor/yiisoft/yii2/captcha/CaptchaAction.php

@@ -0,0 +1,367 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\captcha;
+
+use Yii;
+use yii\base\Action;
+use yii\base\InvalidConfigException;
+use yii\helpers\Url;
+use yii\web\Response;
+
+/**
+ * CaptchaAction renders a CAPTCHA image.
+ *
+ * CaptchaAction is used together with [[Captcha]] and [[\yii\captcha\CaptchaValidator]]
+ * to provide the [CAPTCHA](http://en.wikipedia.org/wiki/Captcha) feature.
+ *
+ * By configuring the properties of CaptchaAction, you may customize the appearance of
+ * the generated CAPTCHA images, such as the font color, the background color, etc.
+ *
+ * Note that CaptchaAction requires either GD2 extension or ImageMagick PHP extension.
+ *
+ * Using CAPTCHA involves the following steps:
+ *
+ * 1. Override [[\yii\web\Controller::actions()]] and register an action of class CaptchaAction with ID 'captcha'
+ * 2. In the form model, declare an attribute to store user-entered verification code, and declare the attribute
+ *    to be validated by the 'captcha' validator.
+ * 3. In the controller view, insert a [[Captcha]] widget in the form.
+ *
+ * @property string $verifyCode The verification code. This property is read-only.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class CaptchaAction extends Action
+{
+    /**
+     * The name of the GET parameter indicating whether the CAPTCHA image should be regenerated.
+     */
+    const REFRESH_GET_VAR = 'refresh';
+
+    /**
+     * @var int how many times should the same CAPTCHA be displayed. Defaults to 3.
+     * A value less than or equal to 0 means the test is unlimited (available since version 1.1.2).
+     */
+    public $testLimit = 3;
+    /**
+     * @var int the width of the generated CAPTCHA image. Defaults to 120.
+     */
+    public $width = 120;
+    /**
+     * @var int the height of the generated CAPTCHA image. Defaults to 50.
+     */
+    public $height = 50;
+    /**
+     * @var int padding around the text. Defaults to 2.
+     */
+    public $padding = 2;
+    /**
+     * @var int the background color. For example, 0x55FF00.
+     * Defaults to 0xFFFFFF, meaning white color.
+     */
+    public $backColor = 0xFFFFFF;
+    /**
+     * @var int the font color. For example, 0x55FF00. Defaults to 0x2040A0 (blue color).
+     */
+    public $foreColor = 0x2040A0;
+    /**
+     * @var bool whether to use transparent background. Defaults to false.
+     */
+    public $transparent = false;
+    /**
+     * @var int the minimum length for randomly generated word. Defaults to 6.
+     */
+    public $minLength = 6;
+    /**
+     * @var int the maximum length for randomly generated word. Defaults to 7.
+     */
+    public $maxLength = 7;
+    /**
+     * @var int the offset between characters. Defaults to -2. You can adjust this property
+     * in order to decrease or increase the readability of the captcha.
+     */
+    public $offset = -2;
+    /**
+     * @var string the TrueType font file. This can be either a file path or [path alias](guide:concept-aliases).
+     */
+    public $fontFile = '@yii/captcha/SpicyRice.ttf';
+    /**
+     * @var string the fixed verification code. When this property is set,
+     * [[getVerifyCode()]] will always return the value of this property.
+     * This is mainly used in automated tests where we want to be able to reproduce
+     * the same verification code each time we run the tests.
+     * If not set, it means the verification code will be randomly generated.
+     */
+    public $fixedVerifyCode;
+    /**
+     * @var string the rendering library to use. Currently supported only 'gd' and 'imagick'.
+     * If not set, library will be determined automatically.
+     * @since 2.0.7
+     */
+    public $imageLibrary;
+
+
+    /**
+     * Initializes the action.
+     * @throws InvalidConfigException if the font file does not exist.
+     */
+    public function init()
+    {
+        $this->fontFile = Yii::getAlias($this->fontFile);
+        if (!is_file($this->fontFile)) {
+            throw new InvalidConfigException("The font file does not exist: {$this->fontFile}");
+        }
+    }
+
+    /**
+     * Runs the action.
+     */
+    public function run()
+    {
+        if (Yii::$app->request->getQueryParam(self::REFRESH_GET_VAR) !== null) {
+            // AJAX request for regenerating code
+            $code = $this->getVerifyCode(true);
+            Yii::$app->response->format = Response::FORMAT_JSON;
+            return [
+                'hash1' => $this->generateValidationHash($code),
+                'hash2' => $this->generateValidationHash(strtolower($code)),
+                // we add a random 'v' parameter so that FireFox can refresh the image
+                // when src attribute of image tag is changed
+                'url' => Url::to([$this->id, 'v' => uniqid('', true)]),
+            ];
+        }
+
+        $this->setHttpHeaders();
+        Yii::$app->response->format = Response::FORMAT_RAW;
+
+        return $this->renderImage($this->getVerifyCode());
+    }
+
+    /**
+     * Generates a hash code that can be used for client-side validation.
+     * @param string $code the CAPTCHA code
+     * @return string a hash code generated from the CAPTCHA code
+     */
+    public function generateValidationHash($code)
+    {
+        for ($h = 0, $i = strlen($code) - 1; $i >= 0; --$i) {
+            $h += ord($code[$i]);
+        }
+
+        return $h;
+    }
+
+    /**
+     * Gets the verification code.
+     * @param bool $regenerate whether the verification code should be regenerated.
+     * @return string the verification code.
+     */
+    public function getVerifyCode($regenerate = false)
+    {
+        if ($this->fixedVerifyCode !== null) {
+            return $this->fixedVerifyCode;
+        }
+
+        $session = Yii::$app->getSession();
+        $session->open();
+        $name = $this->getSessionKey();
+        if ($session[$name] === null || $regenerate) {
+            $session[$name] = $this->generateVerifyCode();
+            $session[$name . 'count'] = 1;
+        }
+
+        return $session[$name];
+    }
+
+    /**
+     * Validates the input to see if it matches the generated code.
+     * @param string $input user input
+     * @param bool $caseSensitive whether the comparison should be case-sensitive
+     * @return bool whether the input is valid
+     */
+    public function validate($input, $caseSensitive)
+    {
+        $code = $this->getVerifyCode();
+        $valid = $caseSensitive ? ($input === $code) : strcasecmp($input, $code) === 0;
+        $session = Yii::$app->getSession();
+        $session->open();
+        $name = $this->getSessionKey() . 'count';
+        $session[$name] += 1;
+        if ($valid || $session[$name] > $this->testLimit && $this->testLimit > 0) {
+            $this->getVerifyCode(true);
+        }
+
+        return $valid;
+    }
+
+    /**
+     * Generates a new verification code.
+     * @return string the generated verification code
+     */
+    protected function generateVerifyCode()
+    {
+        if ($this->minLength > $this->maxLength) {
+            $this->maxLength = $this->minLength;
+        }
+        if ($this->minLength < 3) {
+            $this->minLength = 3;
+        }
+        if ($this->maxLength > 20) {
+            $this->maxLength = 20;
+        }
+        $length = mt_rand($this->minLength, $this->maxLength);
+
+        $letters = 'bcdfghjklmnpqrstvwxyz';
+        $vowels = 'aeiou';
+        $code = '';
+        for ($i = 0; $i < $length; ++$i) {
+            if ($i % 2 && mt_rand(0, 10) > 2 || !($i % 2) && mt_rand(0, 10) > 9) {
+                $code .= $vowels[mt_rand(0, 4)];
+            } else {
+                $code .= $letters[mt_rand(0, 20)];
+            }
+        }
+
+        return $code;
+    }
+
+    /**
+     * Returns the session variable name used to store verification code.
+     * @return string the session variable name
+     */
+    protected function getSessionKey()
+    {
+        return '__captcha/' . $this->getUniqueId();
+    }
+
+    /**
+     * Renders the CAPTCHA image.
+     * @param string $code the verification code
+     * @return string image contents
+     * @throws InvalidConfigException if imageLibrary is not supported
+     */
+    protected function renderImage($code)
+    {
+        if (isset($this->imageLibrary)) {
+            $imageLibrary = $this->imageLibrary;
+        } else {
+            $imageLibrary = Captcha::checkRequirements();
+        }
+        if ($imageLibrary === 'gd') {
+            return $this->renderImageByGD($code);
+        } elseif ($imageLibrary === 'imagick') {
+            return $this->renderImageByImagick($code);
+        }
+
+        throw new InvalidConfigException("Defined library '{$imageLibrary}' is not supported");
+    }
+
+    /**
+     * Renders the CAPTCHA image based on the code using GD library.
+     * @param string $code the verification code
+     * @return string image contents in PNG format.
+     */
+    protected function renderImageByGD($code)
+    {
+        $image = imagecreatetruecolor($this->width, $this->height);
+
+        $backColor = imagecolorallocate(
+            $image,
+            (int) ($this->backColor % 0x1000000 / 0x10000),
+            (int) ($this->backColor % 0x10000 / 0x100),
+            $this->backColor % 0x100
+        );
+        imagefilledrectangle($image, 0, 0, $this->width - 1, $this->height - 1, $backColor);
+        imagecolordeallocate($image, $backColor);
+
+        if ($this->transparent) {
+            imagecolortransparent($image, $backColor);
+        }
+
+        $foreColor = imagecolorallocate(
+            $image,
+            (int) ($this->foreColor % 0x1000000 / 0x10000),
+            (int) ($this->foreColor % 0x10000 / 0x100),
+            $this->foreColor % 0x100
+        );
+
+        $length = strlen($code);
+        $box = imagettfbbox(30, 0, $this->fontFile, $code);
+        $w = $box[4] - $box[0] + $this->offset * ($length - 1);
+        $h = $box[1] - $box[5];
+        $scale = min(($this->width - $this->padding * 2) / $w, ($this->height - $this->padding * 2) / $h);
+        $x = 10;
+        $y = round($this->height * 27 / 40);
+        for ($i = 0; $i < $length; ++$i) {
+            $fontSize = (int) (mt_rand(26, 32) * $scale * 0.8);
+            $angle = mt_rand(-10, 10);
+            $letter = $code[$i];
+            $box = imagettftext($image, $fontSize, $angle, $x, $y, $foreColor, $this->fontFile, $letter);
+            $x = $box[2] + $this->offset;
+        }
+
+        imagecolordeallocate($image, $foreColor);
+
+        ob_start();
+        imagepng($image);
+        imagedestroy($image);
+
+        return ob_get_clean();
+    }
+
+    /**
+     * Renders the CAPTCHA image based on the code using ImageMagick library.
+     * @param string $code the verification code
+     * @return string image contents in PNG format.
+     */
+    protected function renderImageByImagick($code)
+    {
+        $backColor = $this->transparent ? new \ImagickPixel('transparent') : new \ImagickPixel('#' . str_pad(dechex($this->backColor), 6, 0, STR_PAD_LEFT));
+        $foreColor = new \ImagickPixel('#' . str_pad(dechex($this->foreColor), 6, 0, STR_PAD_LEFT));
+
+        $image = new \Imagick();
+        $image->newImage($this->width, $this->height, $backColor);
+
+        $draw = new \ImagickDraw();
+        $draw->setFont($this->fontFile);
+        $draw->setFontSize(30);
+        $fontMetrics = $image->queryFontMetrics($draw, $code);
+
+        $length = strlen($code);
+        $w = (int) $fontMetrics['textWidth'] - 8 + $this->offset * ($length - 1);
+        $h = (int) $fontMetrics['textHeight'] - 8;
+        $scale = min(($this->width - $this->padding * 2) / $w, ($this->height - $this->padding * 2) / $h);
+        $x = 10;
+        $y = round($this->height * 27 / 40);
+        for ($i = 0; $i < $length; ++$i) {
+            $draw = new \ImagickDraw();
+            $draw->setFont($this->fontFile);
+            $draw->setFontSize((int) (mt_rand(26, 32) * $scale * 0.8));
+            $draw->setFillColor($foreColor);
+            $image->annotateImage($draw, $x, $y, mt_rand(-10, 10), $code[$i]);
+            $fontMetrics = $image->queryFontMetrics($draw, $code[$i]);
+            $x += (int) $fontMetrics['textWidth'] + $this->offset;
+        }
+
+        $image->setImageFormat('png');
+        return $image->getImageBlob();
+    }
+
+    /**
+     * Sets the HTTP headers needed by image response.
+     */
+    protected function setHttpHeaders()
+    {
+        Yii::$app->getResponse()->getHeaders()
+            ->set('Pragma', 'public')
+            ->set('Expires', '0')
+            ->set('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
+            ->set('Content-Transfer-Encoding', 'binary')
+            ->set('Content-type', 'image/png');
+    }
+}

vendor/yiisoft/yii2/captcha/CaptchaAsset.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\captcha;
+
+use yii\web\AssetBundle;
+
+/**
+ * This asset bundle provides the javascript files needed for the [[Captcha]] widget.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class CaptchaAsset extends AssetBundle
+{
+    public $sourcePath = '@yii/assets';
+    public $js = [
+        'yii.captcha.js',
+    ];
+    public $depends = [
+        'yii\web\YiiAsset',
+    ];
+}

vendor/yiisoft/yii2/captcha/CaptchaValidator.php

@@ -0,0 +1,117 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\captcha;
+
+use Yii;
+use yii\base\InvalidConfigException;
+use yii\validators\ValidationAsset;
+use yii\validators\Validator;
+
+/**
+ * CaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA.
+ *
+ * CaptchaValidator should be used together with [[CaptchaAction]].
+ *
+ * Note that once CAPTCHA validation succeeds, a new CAPTCHA will be generated automatically. As a result,
+ * CAPTCHA validation should not be used in AJAX validation mode because it may fail the validation
+ * even if a user enters the same code as shown in the CAPTCHA image which is actually different from the latest CAPTCHA code.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class CaptchaValidator extends Validator
+{
+    /**
+     * @var bool whether to skip this validator if the input is empty.
+     */
+    public $skipOnEmpty = false;
+    /**
+     * @var bool whether the comparison is case sensitive. Defaults to false.
+     */
+    public $caseSensitive = false;
+    /**
+     * @var string the route of the controller action that renders the CAPTCHA image.
+     */
+    public $captchaAction = 'site/captcha';
+
+
+    /**
+     * {@inheritdoc}
+     */
+    public function init()
+    {
+        parent::init();
+        if ($this->message === null) {
+            $this->message = Yii::t('yii', 'The verification code is incorrect.');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function validateValue($value)
+    {
+        $captcha = $this->createCaptchaAction();
+        $valid = !is_array($value) && $captcha->validate($value, $this->caseSensitive);
+
+        return $valid ? null : [$this->message, []];
+    }
+
+    /**
+     * Creates the CAPTCHA action object from the route specified by [[captchaAction]].
+     * @return \yii\captcha\CaptchaAction the action object
+     * @throws InvalidConfigException
+     */
+    public function createCaptchaAction()
+    {
+        $ca = Yii::$app->createController($this->captchaAction);
+        if ($ca !== false) {
+            /* @var $controller \yii\base\Controller */
+            list($controller, $actionID) = $ca;
+            $action = $controller->createAction($actionID);
+            if ($action !== null) {
+                return $action;
+            }
+        }
+        throw new InvalidConfigException('Invalid CAPTCHA action ID: ' . $this->captchaAction);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clientValidateAttribute($model, $attribute, $view)
+    {
+        ValidationAsset::register($view);
+        $options = $this->getClientOptions($model, $attribute);
+
+        return 'yii.validation.captcha(value, messages, ' . json_encode($options, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) . ');';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getClientOptions($model, $attribute)
+    {
+        $captcha = $this->createCaptchaAction();
+        $code = $captcha->getVerifyCode(false);
+        $hash = $captcha->generateValidationHash($this->caseSensitive ? $code : strtolower($code));
+        $options = [
+            'hash' => $hash,
+            'hashKey' => 'yiiCaptcha/' . $captcha->getUniqueId(),
+            'caseSensitive' => $this->caseSensitive,
+            'message' => Yii::$app->getI18n()->format($this->message, [
+                'attribute' => $model->getAttributeLabel($attribute),
+            ], Yii::$app->language),
+        ];
+        if ($this->skipOnEmpty) {
+            $options['skipOnEmpty'] = 1;
+        }
+
+        return $options;
+    }
+}

vendor/yiisoft/yii2/captcha/SpicyRice.md

@@ -0,0 +1,11 @@
+## Spicy Rice font
+
+* **Author:** Brian J. Bonislawsky, Astigmatic (AOETI, Astigmatic One Eye Typographic Institute)
+* **License:** SIL Open Font License (OFL), version 1.1, [notes and FAQ](http://scripts.sil.org/OFL)
+
+## Links
+
+* [Astigmatic](http://www.astigmatic.com/)
+* [Google WebFonts](http://www.google.com/webfonts/specimen/Spicy+Rice)
+* [fontsquirrel.com](http://www.fontsquirrel.com/fonts/spicy-rice)
+* [fontspace.com](http://www.fontspace.com/astigmatic-one-eye-typographic-institute/spicy-rice)