CaptchaAction.php 10.3 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\captcha;
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

use Yii;
use yii\base\Action;
use yii\base\InvalidConfigException;

/**
 * CaptchaAction renders a CAPTCHA image.
 *
 * CaptchaAction is used together with [[Captcha]] and [[\yii\validators\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.
 *
32
 * @property string $verifyCode The verification code. This property is read-only.
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
 * @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 integer 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 integer the width of the generated CAPTCHA image. Defaults to 120.
	 */
	public $width = 120;
	/**
	 * @var integer the height of the generated CAPTCHA image. Defaults to 50.
	 */
	public $height = 50;
	/**
	 * @var integer padding around the text. Defaults to 2.
	 */
	public $padding = 2;
	/**
	 * @var integer the background color. For example, 0x55FF00.
	 * Defaults to 0xFFFFFF, meaning white color.
	 */
	public $backColor = 0xFFFFFF;
	/**
	 * @var integer the font color. For example, 0x55FF00. Defaults to 0x2040A0 (blue color).
	 */
	public $foreColor = 0x2040A0;
	/**
	 * @var boolean whether to use transparent background. Defaults to false.
	 */
	public $transparent = false;
	/**
	 * @var integer the minimum length for randomly generated word. Defaults to 6.
	 */
	public $minLength = 6;
	/**
	 * @var integer the maximum length for randomly generated word. Defaults to 7.
	 */
	public $maxLength = 7;
	/**
	 * @var integer 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.
	 */
Qiang Xue committed
89
	public $fontFile = '@yii/captcha/SpicyRice.ttf';
90
	/**
91
	 * @var string the fixed verification code. When this property is set,
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
	 * [[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;


	/**
	 * 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 (isset($_GET[self::REFRESH_GET_VAR])) {
			// AJAX request for regenerating code
			$code = $this->getVerifyCode(true);
Qiang Xue committed
120 121
			/** @var \yii\web\Controller $controller */
			$controller = $this->controller;
Alexander Makarov committed
122
			return json_encode([
123 124 125 126
				'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
Alexander Makarov committed
127 128
				'url' => $controller->createUrl($this->id, ['v' => uniqid()]),
			]);
129
		} else {
130 131
			$this->setHttpHeaders();
			return $this->renderImage($this->getVerifyCode());
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
		}
	}

	/**
	 * 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 boolean $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;
		}

Qiang Xue committed
159
		$session = Yii::$app->getSession();
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
		$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 boolean $caseSensitive whether the comparison should be case-sensitive
	 * @return boolean whether the input is valid
	 */
	public function validate($input, $caseSensitive)
	{
		$code = $this->getVerifyCode();
		$valid = $caseSensitive ? ($input === $code) : strcasecmp($input, $code) === 0;
179
		$session = Yii::$app->getSession();
180 181 182
		$session->open();
		$name = $this->getSessionKey() . 'count';
		$session[$name] = $session[$name] + 1;
183
		if ($valid || $session[$name] > $this->testLimit && $this->testLimit > 0) {
184 185 186 187 188 189 190 191 192 193 194
			$this->getVerifyCode(true);
		}
		return $valid;
	}

	/**
	 * Generates a new verification code.
	 * @return string the generated verification code
	 */
	protected function generateVerifyCode()
	{
195 196 197
		if ($this->minLength > $this->maxLength) {
			$this->maxLength = $this->minLength;
		}
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
		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
232
	 * @return string image contents
233 234 235 236
	 */
	protected function renderImage($code)
	{
		if (Captcha::checkRequirements() === 'gd') {
237
			return $this->renderImageByGD($code);
238
		} else {
239
			return $this->renderImageByImagick($code);
240 241 242 243 244 245
		}
	}

	/**
	 * Renders the CAPTCHA image based on the code using GD library.
	 * @param string $code the verification code
246
	 * @return string image contents
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
	 */
	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, $this->height, $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)(rand(26, 32) * $scale * 0.8);
			$angle = 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);

285
		ob_start();
286 287
		imagepng($image);
		imagedestroy($image);
288
		return ob_get_clean();
289 290 291 292 293
	}

	/**
	 * Renders the CAPTCHA image based on the code using ImageMagick library.
	 * @param string $code the verification code
294
	 * @return \Imagick image instance. Can be used as string. In this case it will contain image contents.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
	 */
	protected function renderImageByImagick($code)
	{
		$backColor = $this->transparent ? new \ImagickPixel('transparent') : new \ImagickPixel('#' . dechex($this->backColor));
		$foreColor = new \ImagickPixel('#' . dechex($this->foreColor));

		$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)(rand(26, 32) * $scale * 0.8));
			$draw->setFillColor($foreColor);
			$image->annotateImage($draw, $x, $y, rand(-10, 10), $code[$i]);
			$fontMetrics = $image->queryFontMetrics($draw, $code[$i]);
			$x += (int)($fontMetrics['textWidth']) + $this->offset;
		}

		$image->setImageFormat('png');
326
		return $image;
Qiang Xue committed
327 328 329
	}

	/**
330
	 * Sets the HTTP headers needed by image response.
Qiang Xue committed
331
	 */
332
	protected function setHttpHeaders()
Qiang Xue committed
333
	{
334
		Yii::$app->getResponse()->getHeaders()
Qiang Xue committed
335 336 337 338 339
			->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');
340 341
	}
}