interface/modules/zend_modules/library/Zend/Captcha/Image.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Captcha;
  11
  12 use DirectoryIterator;
  13 use Zend\Stdlib\ErrorHandler;
  14
  15 /**
  16  * Image-based captcha element
  17  *
  18  * Generates image displaying random word
  19  */
  20 class Image extends AbstractWord
  21 {
  22     /**
  23      * Directory for generated images
  24      *
  25      * @var string
  26      */
  27     protected $imgDir = "public/images/captcha/";
  28
  29     /**
  30      * URL for accessing images
  31      *
  32      * @var string
  33      */
  34     protected $imgUrl = "/images/captcha/";
  35
  36     /**
  37      * Image's alt tag content
  38      *
  39      * @var string
  40      */
  41     protected $imgAlt = "";
  42
  43     /**
  44      * Image suffix (including dot)
  45      *
  46      * @var string
  47      */
  48     protected $suffix = ".png";
  49
  50     /**
  51      * Image width
  52      *
  53      * @var int
  54      */
  55     protected $width = 200;
  56
  57     /**
  58      * Image height
  59      *
  60      * @var int
  61      */
  62     protected $height = 50;
  63
  64     /**
  65      * Font size
  66      *
  67      * @var int
  68      */
  69     protected $fsize = 24;
  70
  71     /**
  72      * Image font file
  73      *
  74      * @var string
  75      */
  76     protected $font;
  77
  78     /**
  79      * Image to use as starting point
  80      * Default is blank image. If provided, should be PNG image.
  81      *
  82      * @var string
  83      */
  84     protected $startImage;
  85
  86     /**
  87      * How frequently to execute garbage collection
  88      *
  89      * @var int
  90      */
  91     protected $gcFreq = 10;
  92
  93     /**
  94      * How long to keep generated images
  95      *
  96      * @var int
  97      */
  98     protected $expiration = 600;
  99
 100     /**
 101      * Number of noise dots on image
 102      * Used twice - before and after transform
 103      *
 104      * @var int
 105      */
 106     protected $dotNoiseLevel = 100;
 107
 108     /**
 109      * Number of noise lines on image
 110      * Used twice - before and after transform
 111      *
 112      * @var int
 113      */
 114     protected $lineNoiseLevel = 5;
 115
 116     /**
 117      * Constructor
 118      *
 119      * @param  array|\Traversable $options
 120      * @throws Exception\ExtensionNotLoadedException
 121      */
 122     public function __construct($options = null)
 123     {
 124         if (!extension_loaded("gd")) {
 125             throw new Exception\ExtensionNotLoadedException("Image CAPTCHA requires GD extension");
 126         }
 127
 128         if (!function_exists("imagepng")) {
 129             throw new Exception\ExtensionNotLoadedException("Image CAPTCHA requires PNG support");
 130         }
 131
 132         if (!function_exists("imageftbbox")) {
 133             throw new Exception\ExtensionNotLoadedException("Image CAPTCHA requires FT fonts support");
 134         }
 135
 136         parent::__construct($options);
 137     }
 138
 139     /**
 140      * @return string
 141      */
 142     public function getImgAlt()
 143     {
 144         return $this->imgAlt;
 145     }
 146
 147     /**
 148      * @return string
 149      */
 150     public function getStartImage()
 151     {
 152         return $this->startImage;
 153     }
 154
 155     /**
 156      * @return int
 157      */
 158     public function getDotNoiseLevel()
 159     {
 160         return $this->dotNoiseLevel;
 161     }
 162
 163     /**
 164      * @return int
 165      */
 166     public function getLineNoiseLevel()
 167     {
 168         return $this->lineNoiseLevel;
 169     }
 170
 171     /**
 172      * Get captcha expiration
 173      *
 174      * @return int
 175      */
 176     public function getExpiration()
 177     {
 178         return $this->expiration;
 179     }
 180
 181     /**
 182      * Get garbage collection frequency
 183      *
 184      * @return int
 185      */
 186     public function getGcFreq()
 187     {
 188         return $this->gcFreq;
 189     }
 190
 191     /**
 192      * Get font to use when generating captcha
 193      *
 194      * @return string
 195      */
 196     public function getFont()
 197     {
 198         return $this->font;
 199     }
 200
 201     /**
 202      * Get font size
 203      *
 204      * @return int
 205      */
 206     public function getFontSize()
 207     {
 208         return $this->fsize;
 209     }
 210
 211     /**
 212      * Get captcha image height
 213      *
 214      * @return int
 215      */
 216     public function getHeight()
 217     {
 218         return $this->height;
 219     }
 220
 221     /**
 222      * Get captcha image directory
 223      *
 224      * @return string
 225      */
 226     public function getImgDir()
 227     {
 228         return $this->imgDir;
 229     }
 230
 231     /**
 232      * Get captcha image base URL
 233      *
 234      * @return string
 235      */
 236     public function getImgUrl()
 237     {
 238         return $this->imgUrl;
 239     }
 240
 241     /**
 242      * Get captcha image file suffix
 243      *
 244      * @return string
 245      */
 246     public function getSuffix()
 247     {
 248         return $this->suffix;
 249     }
 250
 251     /**
 252      * Get captcha image width
 253      *
 254      * @return int
 255      */
 256     public function getWidth()
 257     {
 258         return $this->width;
 259     }
 260
 261     /**
 262      * @param string $startImage
 263      * @return Image
 264      */
 265     public function setStartImage($startImage)
 266     {
 267         $this->startImage = $startImage;
 268         return $this;
 269     }
 270
 271     /**
 272      * @param int $dotNoiseLevel
 273      * @return Image
 274      */
 275     public function setDotNoiseLevel($dotNoiseLevel)
 276     {
 277         $this->dotNoiseLevel = $dotNoiseLevel;
 278         return $this;
 279     }
 280
 281     /**
 282      * @param int $lineNoiseLevel
 283      * @return Image
 284      */
 285     public function setLineNoiseLevel($lineNoiseLevel)
 286     {
 287         $this->lineNoiseLevel = $lineNoiseLevel;
 288         return $this;
 289     }
 290
 291     /**
 292      * Set captcha expiration
 293      *
 294      * @param  int $expiration
 295      * @return Image
 296      */
 297     public function setExpiration($expiration)
 298     {
 299         $this->expiration = $expiration;
 300         return $this;
 301     }
 302
 303     /**
 304      * Set garbage collection frequency
 305      *
 306      * @param  int $gcFreq
 307      * @return Image
 308      */
 309     public function setGcFreq($gcFreq)
 310     {
 311         $this->gcFreq = $gcFreq;
 312         return $this;
 313     }
 314
 315     /**
 316      * Set captcha font
 317      *
 318      * @param  string $font
 319      * @return Image
 320      */
 321     public function setFont($font)
 322     {
 323         $this->font = $font;
 324         return $this;
 325     }
 326
 327     /**
 328      * Set captcha font size
 329      *
 330      * @param  int $fsize
 331      * @return Image
 332      */
 333     public function setFontSize($fsize)
 334     {
 335         $this->fsize = $fsize;
 336         return $this;
 337     }
 338
 339     /**
 340      * Set captcha image height
 341      *
 342      * @param  int $height
 343      * @return Image
 344      */
 345     public function setHeight($height)
 346     {
 347         $this->height = $height;
 348         return $this;
 349     }
 350
 351     /**
 352      * Set captcha image storage directory
 353      *
 354      * @param  string $imgDir
 355      * @return Image
 356      */
 357     public function setImgDir($imgDir)
 358     {
 359         $this->imgDir = rtrim($imgDir, "/\\") . '/';
 360         return $this;
 361     }
 362
 363     /**
 364      * Set captcha image base URL
 365      *
 366      * @param  string $imgUrl
 367      * @return Image
 368      */
 369     public function setImgUrl($imgUrl)
 370     {
 371         $this->imgUrl = rtrim($imgUrl, "/\\") . '/';
 372         return $this;
 373     }
 374
 375     /**
 376      * @param string $imgAlt
 377      * @return Image
 378      */
 379     public function setImgAlt($imgAlt)
 380     {
 381         $this->imgAlt = $imgAlt;
 382         return $this;
 383     }
 384
 385     /**
 386      * Set captcha image filename suffix
 387      *
 388      * @param  string $suffix
 389      * @return Image
 390      */
 391     public function setSuffix($suffix)
 392     {
 393         $this->suffix = $suffix;
 394         return $this;
 395     }
 396
 397     /**
 398      * Set captcha image width
 399      *
 400      * @param  int $width
 401      * @return Image
 402      */
 403     public function setWidth($width)
 404     {
 405         $this->width = $width;
 406         return $this;
 407     }
 408
 409     /**
 410      * Generate random frequency
 411      *
 412      * @return float
 413      */
 414     protected function randomFreq()
 415     {
 416         return mt_rand(700000, 1000000) / 15000000;
 417     }
 418
 419     /**
 420      * Generate random phase
 421      *
 422      * @return float
 423      */
 424     protected function randomPhase()
 425     {
 426         // random phase from 0 to pi
 427         return mt_rand(0, 3141592) / 1000000;
 428     }
 429
 430     /**
 431      * Generate random character size
 432      *
 433      * @return int
 434      */
 435     protected function randomSize()
 436     {
 437         return mt_rand(300, 700) / 100;
 438     }
 439
 440     /**
 441      * Generate captcha
 442      *
 443      * @return string captcha ID
 444      */
 445     public function generate()
 446     {
 447         $id    = parent::generate();
 448         $tries = 5;
 449
 450         // If there's already such file, try creating a new ID
 451         while ($tries-- && file_exists($this->getImgDir() . $id . $this->getSuffix())) {
 452             $id = $this->generateRandomId();
 453             $this->setId($id);
 454         }
 455         $this->generateImage($id, $this->getWord());
 456
 457         if (mt_rand(1, $this->getGcFreq()) == 1) {
 458             $this->gc();
 459         }
 460
 461         return $id;
 462     }
 463
 464     /**
 465      * Generate image captcha
 466      *
 467      * Override this function if you want different image generator
 468      * Wave transform from http://www.captcha.ru/captchas/multiwave/
 469      *
 470      * @param string $id Captcha ID
 471      * @param string $word Captcha word
 472      * @throws Exception\NoFontProvidedException if no font was set
 473      * @throws Exception\ImageNotLoadableException if start image cannot be loaded
 474      */
 475     protected function generateImage($id, $word)
 476     {
 477         $font = $this->getFont();
 478
 479         if (empty($font)) {
 480             throw new Exception\NoFontProvidedException('Image CAPTCHA requires font');
 481         }
 482
 483         $w     = $this->getWidth();
 484         $h     = $this->getHeight();
 485         $fsize = $this->getFontSize();
 486
 487         $imgFile   = $this->getImgDir() . $id . $this->getSuffix();
 488
 489         if (empty($this->startImage)) {
 490             $img = imagecreatetruecolor($w, $h);
 491         } else {
 492             // Potential error is change to exception
 493             ErrorHandler::start();
 494             $img   = imagecreatefrompng($this->startImage);
 495             $error = ErrorHandler::stop();
 496             if (!$img || $error) {
 497                 throw new Exception\ImageNotLoadableException(
 498                     "Can not load start image '{$this->startImage}'",
 499                     0,
 500                     $error
 501                 );
 502             }
 503             $w = imagesx($img);
 504             $h = imagesy($img);
 505         }
 506
 507         $textColor = imagecolorallocate($img, 0, 0, 0);
 508         $bgColor   = imagecolorallocate($img, 255, 255, 255);
 509         imagefilledrectangle($img, 0, 0, $w-1, $h-1, $bgColor);
 510         $textbox = imageftbbox($fsize, 0, $font, $word);
 511         $x = ($w - ($textbox[2] - $textbox[0])) / 2;
 512         $y = ($h - ($textbox[7] - $textbox[1])) / 2;
 513         imagefttext($img, $fsize, 0, $x, $y, $textColor, $font, $word);
 514
 515         // generate noise
 516         for ($i=0; $i < $this->dotNoiseLevel; $i++) {
 517             imagefilledellipse($img, mt_rand(0, $w), mt_rand(0, $h), 2, 2, $textColor);
 518         }
 519         for ($i=0; $i < $this->lineNoiseLevel; $i++) {
 520             imageline($img, mt_rand(0, $w), mt_rand(0, $h), mt_rand(0, $w), mt_rand(0, $h), $textColor);
 521         }
 522
 523         // transformed image
 524         $img2     = imagecreatetruecolor($w, $h);
 525         $bgColor = imagecolorallocate($img2, 255, 255, 255);
 526         imagefilledrectangle($img2, 0, 0, $w-1, $h-1, $bgColor);
 527
 528         // apply wave transforms
 529         $freq1 = $this->randomFreq();
 530         $freq2 = $this->randomFreq();
 531         $freq3 = $this->randomFreq();
 532         $freq4 = $this->randomFreq();
 533
 534         $ph1 = $this->randomPhase();
 535         $ph2 = $this->randomPhase();
 536         $ph3 = $this->randomPhase();
 537         $ph4 = $this->randomPhase();
 538
 539         $szx = $this->randomSize();
 540         $szy = $this->randomSize();
 541
 542         for ($x = 0; $x < $w; $x++) {
 543             for ($y = 0; $y < $h; $y++) {
 544                 $sx = $x + (sin($x*$freq1 + $ph1) + sin($y*$freq3 + $ph3)) * $szx;
 545                 $sy = $y + (sin($x*$freq2 + $ph2) + sin($y*$freq4 + $ph4)) * $szy;
 546
 547                 if ($sx < 0 || $sy < 0 || $sx >= $w - 1 || $sy >= $h - 1) {
 548                     continue;
 549                 } else {
 550                     $color   = (imagecolorat($img, $sx, $sy) >> 16)         & 0xFF;
 551                     $colorX  = (imagecolorat($img, $sx + 1, $sy) >> 16)     & 0xFF;
 552                     $colorY  = (imagecolorat($img, $sx, $sy + 1) >> 16)     & 0xFF;
 553                     $colorXY = (imagecolorat($img, $sx + 1, $sy + 1) >> 16) & 0xFF;
 554                 }
 555
 556                 if ($color == 255 && $colorX == 255 && $colorY == 255 && $colorXY == 255) {
 557                     // ignore background
 558                     continue;
 559                 } elseif ($color == 0 && $colorX == 0 && $colorY == 0 && $colorXY == 0) {
 560                     // transfer inside of the image as-is
 561                     $newcolor = 0;
 562                 } else {
 563                     // do antialiasing for border items
 564                     $fracX  = $sx - floor($sx);
 565                     $fracY  = $sy - floor($sy);
 566                     $fracX1 = 1 - $fracX;
 567                     $fracY1 = 1 - $fracY;
 568
 569                     $newcolor = $color   * $fracX1 * $fracY1
 570                               + $colorX  * $fracX  * $fracY1
 571                               + $colorY  * $fracX1 * $fracY
 572                               + $colorXY * $fracX  * $fracY;
 573                 }
 574
 575                 imagesetpixel($img2, $x, $y, imagecolorallocate($img2, $newcolor, $newcolor, $newcolor));
 576             }
 577         }
 578
 579         // generate noise
 580         for ($i=0; $i<$this->dotNoiseLevel; $i++) {
 581             imagefilledellipse($img2, mt_rand(0, $w), mt_rand(0, $h), 2, 2, $textColor);
 582         }
 583
 584         for ($i=0; $i<$this->lineNoiseLevel; $i++) {
 585             imageline($img2, mt_rand(0, $w), mt_rand(0, $h), mt_rand(0, $w), mt_rand(0, $h), $textColor);
 586         }
 587
 588         imagepng($img2, $imgFile);
 589         imagedestroy($img);
 590         imagedestroy($img2);
 591     }
 592
 593     /**
 594      * Remove old files from image directory
 595      *
 596      */
 597     protected function gc()
 598     {
 599         $expire = time() - $this->getExpiration();
 600         $imgdir = $this->getImgDir();
 601         if (!$imgdir || strlen($imgdir) < 2) {
 602             // safety guard
 603             return;
 604         }
 605
 606         $suffixLength = strlen($this->suffix);
 607         foreach (new DirectoryIterator($imgdir) as $file) {
 608             if (!$file->isDot() && !$file->isDir()) {
 609                 if (file_exists($file->getPathname()) && $file->getMTime() < $expire) {
 610                     // only deletes files ending with $this->suffix
 611                     if (substr($file->getFilename(), -($suffixLength)) == $this->suffix) {
 612                         unlink($file->getPathname());
 613                     }
 614                 }
 615             }
 616         }
 617     }
 618
 619     /**
 620      * Get helper name used to render captcha
 621      *
 622      * @return string
 623      */
 624     public function getHelperName()
 625     {
 626         return 'captcha/image';
 627     }
 628 }