vendor/liip/imagine-bundle/Imagine/Filter/PostProcessor/AbstractPostProcessor.php line 37

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the `liip/LiipImagineBundle` project.
  5. *
  6. * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
  7. *
  8. * For the full copyright and license information, please view the LICENSE.md
  9. * file that was distributed with this source code.
  10. */
  12. namespace Liip\ImagineBundle\Imagine\Filter\PostProcessor;
  14. use Liip\ImagineBundle\Binary\BinaryInterface;
  15. use Liip\ImagineBundle\Binary\FileBinaryInterface;
  16. use Symfony\Component\Filesystem\Exception\IOException;
  17. use Symfony\Component\Filesystem\Filesystem;
  18. use Symfony\Component\Process\Process;
  20. abstract class AbstractPostProcessor implements PostProcessorInterface
  21. {
  22. /**
  23. * @var string
  24. */
  25. protected $executablePath;
  27. /**
  28. * @var string|null
  29. */
  30. protected $temporaryRootPath;
  32. /**
  33. * @var Filesystem
  34. */
  35. private $filesystem;
  37. public function __construct(string $executablePath, string $temporaryRootPath = null)
  38. {
  39. $this->executablePath = $executablePath;
  40. $this->temporaryRootPath = $temporaryRootPath;
  41. $this->filesystem = new Filesystem();
  42. }
  44. protected function createProcess(array $arguments = [], array $options = []): Process
  45. {
  46. $process = new Process($arguments);
  48. if (!isset($options['process'])) {
  49. return $process;
  50. }
  52. if (isset($options['process']['timeout'])) {
  53. $process->setTimeout($options['process']['timeout']);
  54. }
  56. if (isset($options['process']['working_directory'])) {
  57. $process->setWorkingDirectory($options['process']['working_directory']);
  58. }
  60. if (isset($options['process']['environment_variables']) && \is_array($options['process']['environment_variables'])) {
  61. $process->setEnv($options['process']['environment_variables']);
  62. }
  64. return $process;
  65. }
  67. protected function isBinaryTypeJpgImage(BinaryInterface $binary): bool
  68. {
  69. return $this->isBinaryTypeMatch($binary, ['image/jpeg', 'image/jpg']);
  70. }
  72. protected function isBinaryTypePngImage(BinaryInterface $binary): bool
  73. {
  74. return $this->isBinaryTypeMatch($binary, ['image/png']);
  75. }
  77. protected function isBinaryTypeMatch(BinaryInterface $binary, array $types): bool
  78. {
  79. return \in_array($binary->getMimeType(), $types, true);
  80. }
  82. protected function writeTemporaryFile(BinaryInterface $binary, array $options = [], string $prefix = null): string
  83. {
  84. $temporary = $this->acquireTemporaryFilePath($options, $prefix);
  86. if ($binary instanceof FileBinaryInterface) {
  87. $this->filesystem->copy($binary->getPath(), $temporary, true);
  88. } else {
  89. $this->filesystem->dumpFile($temporary, $binary->getContent());
  90. }
  92. return $temporary;
  93. }
  95. protected function acquireTemporaryFilePath(array $options, string $prefix = null): string
  96. {
  97. $root = $options['temp_dir'] ?? $this->temporaryRootPath ?: sys_get_temp_dir();
  99. if (!is_dir($root)) {
  100. try {
  101. $this->filesystem->mkdir($root);
  102. } catch (IOException $exception) {
  103. // ignore failure as "tempnam" function will revert back to system default tmp path as last resort
  104. }
  105. }
  107. if (false === $file = @tempnam($root, $prefix ?: 'post-processor')) {
  108. throw new \RuntimeException(sprintf('Temporary file cannot be created in "%s"', $root));
  109. }
  111. return $file;
  112. }
  114. /**
  115. * @param int[] $validReturns
  116. * @param string[] $errors
  117. */
  118. protected function isSuccessfulProcess(Process $process, array $validReturns = [0], array $errors = ['ERROR']): bool
  119. {
  120. if (\count($validReturns) > 0 && !\in_array($process->getExitCode(), $validReturns, true)) {
  121. return false;
  122. }
  124. foreach ($errors as $string) {
  125. if (false !== mb_strpos($process->getOutput(), $string)) {
  126. return false;
  127. }
  128. }
  130. return true;
  131. }
  133. protected function triggerSetterMethodDeprecation(string $method): void
  134. {
  135. @trigger_error(sprintf('The %s() method was deprecated in 2.2 and will be removed in 3.0. You must '
  136. .'setup the class state via its __construct() method. You can still pass filter-specific options to the '.
  137. 'process() method to overwrite behavior.', $method), E_USER_DEPRECATED);
  138. }
  139. }