File "ImageMagick.php"
Full Path: /var/www/html/wordpress/wp-content/plugins/wp-optimize/vendor/rosell-dk/webp-convert/src/Convert/Converters/ImageMagick.php
File size: 9.53 KB
MIME-type: text/x-php
Charset: utf-8
<?php
namespace WebPConvert\Convert\Converters;
use ExecWithFallback\ExecWithFallback;
use LocateBinaries\LocateBinaries;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\ExecTrait;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Options\OptionFactory;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp by calling imagemagick binary.
*
* @package WebPConvert
* @author Bjørn Rosell <[email protected]>
* @since Class available since Release 2.0.0
*/
class ImageMagick extends AbstractConverter
{
use ExecTrait;
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'size-in-percentage',
];
}
/**
* Get the options unique for this converter
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
self::niceOption(),
['try-common-system-paths', 'boolean', [
'title' => 'Try locating ImageMagick in common system paths',
'description' =>
'If set, the converter will look for a ImageMagick binaries residing in common system locations ' .
'such as "/usr/bin/convert". ' .
'If such exist, it is assumed that they are valid ImageMagick binaries. ',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
]);
}
// To futher improve this converter, I could check out:
// https://github.com/Orbitale/ImageMagickPHP
private function getPath()
{
if (defined('WEBPCONVERT_IMAGEMAGICK_PATH')) {
return constant('WEBPCONVERT_IMAGEMAGICK_PATH');
}
if (!empty(getenv('WEBPCONVERT_IMAGEMAGICK_PATH'))) {
return getenv('WEBPCONVERT_IMAGEMAGICK_PATH');
}
if ($this->options['try-common-system-paths']) {
$binaries = LocateBinaries::locateInCommonSystemPaths('convert');
if (!empty($binaries)) {
return $binaries[0];
}
}
return 'convert';
}
private function getVersion()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
if (($returnCode == 0) && isset($output[0])) {
return $output[0];
} else {
return 'unknown';
}
}
public function isInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
return ($returnCode == 0);
}
// Check if webp delegate is installed
public function isWebPDelegateInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -list delegate 2>&1', $output, $returnCode);
foreach ($output as $line) {
if (preg_match('#webp\\s*=#i', $line)) {
return true;
}
}
// try other command
ExecWithFallback::exec($this->getPath() . ' -list configure 2>&1', $output, $returnCode);
foreach ($output as $line) {
if (preg_match('#DELEGATE.*webp#i', $line)) {
return true;
}
}
return false;
// PS, convert -version does not output delegates on travis, so it is not reliable
}
/**
* Check (general) operationality of imagack converter executable
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
$this->checkOperationalityExecTrait();
if (!$this->isInstalled()) {
throw new SystemRequirementsNotMetException(
'imagemagick is not installed (cannot execute: "' . $this->getPath() . '")'
);
}
if (!$this->isWebPDelegateInstalled()) {
throw new SystemRequirementsNotMetException('webp delegate missing');
}
}
/**
* Build command line options
*
* @param string $versionNumber. Ie "6.9.10-23"
* @return string
*/
private function createCommandLineOptions($versionNumber = 'unknown')
{
// Available webp options for imagemagick are documented here:
// - https://imagemagick.org/script/webp.php
// - https://github.com/ImageMagick/ImageMagick/blob/main/coders/webp.c
// We should perhaps implement low-memory. Its already in cwebp, it
// could perhaps be promoted to a general option
$commandArguments = [];
if ($this->isQualityDetectionRequiredButFailing()) {
// quality:auto was specified, but could not be determined.
// we cannot apply the max-quality logic, but we can provide auto quality
// simply by not specifying the quality option.
} else {
$commandArguments[] = '-quality ' . escapeshellarg($this->getCalculatedQuality());
}
$options = $this->options;
if (!is_null($options['preset'])) {
// "image-hint" is at least available from 6.9.4-0 (I can't see further back)
if ($options['preset'] != 'none') {
$imageHint = $options['preset'];
switch ($imageHint) {
case 'drawing':
case 'icon':
case 'text':
$imageHint = 'graph';
$this->logLn(
'The "preset" value was mapped to "graph" because imagemagick does not support "drawing",' .
' "icon" and "text", but grouped these into one option: "graph".'
);
}
$commandArguments[] = '-define webp:image-hint=' . escapeshellarg($imageHint);
}
}
if ($options['encoding'] == 'lossless') {
// lossless is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:lossless=true';
}
if ($options['low-memory']) {
// low-memory is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:low-memory=true';
}
if ($options['auto-filter'] === true) {
// auto-filter is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:auto-filter=true';
}
if ($options['metadata'] == 'none') {
$commandArguments[] = '-strip';
}
if ($options['alpha-quality'] !== 100) {
// alpha-quality is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:alpha-quality=' . strval($options['alpha-quality']);
}
if ($options['sharp-yuv'] === true) {
if (version_compare($versionNumber, '7.0.8-26', '>=')) {
$commandArguments[] = '-define webp:use-sharp-yuv=true';
} else {
$this->logLn(
'Note: "sharp-yuv" option is not supported in your version of ImageMagick. ' .
'ImageMagic >= 7.0.8-26 is required',
'italic'
);
}
}
if ($options['near-lossless'] != 100) {
if (version_compare($versionNumber, '7.0.10-54', '>=')) { // #299
$commandArguments[] = '-define webp:near-lossless=' . escapeshellarg($options['near-lossless']);
} else {
$this->logLn(
'Note: "near-lossless" option is not supported in your version of ImageMagick. ' .
'ImageMagic >= 7.0.10-54 is required',
'italic'
);
}
}
// "method" is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:method=' . $options['method'];
$commandArguments[] = escapeshellarg($this->source);
$commandArguments[] = escapeshellarg('webp:' . $this->destination);
return implode(' ', $commandArguments);
}
protected function doActualConvert()
{
$version = $this->getVersion();
$this->logLn($version);
preg_match('#\d+\.\d+\.\d+[\d\.\-]+#', $version, $matches);
$versionNumber = (isset($matches[0]) ? $matches[0] : 'unknown');
$this->logLn('Extracted version number: ' . $versionNumber);
$command = $this->getPath() . ' ' . $this->createCommandLineOptions($versionNumber) . ' 2>&1';
$useNice = ($this->options['use-nice'] && $this->checkNiceSupport());
if ($useNice) {
$command = 'nice ' . $command;
}
$this->logLn('Executing command: ' . $command);
ExecWithFallback::exec($command, $output, $returnCode);
$this->logExecOutput($output);
if ($returnCode == 0) {
$this->logLn('success');
} else {
$this->logLn('return code: ' . $returnCode);
}
if ($returnCode == 127) {
throw new SystemRequirementsNotMetException('imagemagick is not installed');
}
if ($returnCode != 0) {
throw new SystemRequirementsNotMetException('The exec call failed');
}
}
}