CaptchaBundle/Generator/ImageFileHandler.php

97 lines
2.2 KiB
PHP
Raw Permalink Normal View History

<?php
declare(strict_types=1);
namespace Gregwar\CaptchaBundle\Generator;
use Symfony\Component\Finder\Finder;
/**
2020-01-03 00:12:44 +01:00
* Handles actions related to captcha image files including saving and garbage collection.
2012-12-04 01:02:43 +01:00
*
* @author Gregwar <g.passault@gmail.com>
* @author Jeremy Livingston <jeremy@quizzle.com>
*/
class ImageFileHandler
{
/**
2020-01-03 00:12:44 +01:00
* Name of folder for captcha images.
*
* @var string
*/
protected $imageFolder;
/**
2020-01-03 00:12:44 +01:00
* Absolute path to public web folder.
*
* @var string
*/
protected $webPath;
/**
2020-01-03 00:12:44 +01:00
* Frequency of garbage collection in fractions of 1.
*
* @var int
*/
protected $gcFreq;
/**
2020-01-03 00:12:44 +01:00
* Maximum age of images in minutes.
*
* @var int
*/
protected $expiration;
/**
* @param string $imageFolder
* @param string $webPath
* @param string $gcFreq
* @param string $expiration
*/
public function __construct(string $imageFolder, string $webPath, string $gcFreq, string $expiration)
{
$this->imageFolder = $imageFolder;
2020-01-03 00:12:44 +01:00
$this->webPath = $webPath;
$this->gcFreq = $gcFreq;
$this->expiration = $expiration;
}
2020-01-03 00:12:44 +01:00
public function saveAsFile($contents): string
{
$this->createFolderIfMissing();
2020-01-03 00:12:44 +01:00
$filename = md5(uniqid()).'.jpg';
$filePath = $this->webPath.'/'.$this->imageFolder.'/'.$filename;
imagejpeg($contents, $filePath, 15);
2020-01-03 00:12:44 +01:00
return '/'.$this->imageFolder.'/'.$filename;
}
public function collectGarbage(): bool
{
2020-01-03 00:12:44 +01:00
if (1 == !mt_rand(1, $this->gcFreq)) {
return false;
}
$this->createFolderIfMissing();
$finder = new Finder();
$criteria = sprintf('<= now - %s minutes', $this->expiration);
2020-01-03 00:12:44 +01:00
$finder->in($this->webPath.'/'.$this->imageFolder)
->date($criteria);
2020-01-03 00:12:44 +01:00
foreach ($finder->files() as $file) {
unlink($file->getPathname());
}
return true;
}
protected function createFolderIfMissing(): void
{
2020-01-03 00:12:44 +01:00
if (!file_exists($this->webPath.'/'.$this->imageFolder)) {
mkdir($this->webPath.'/'.$this->imageFolder, 0755);
}
}
}