* @copyright 2013 Akeneo SAS (http://www.akeneo.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
class PimRequirements
{
const REQUIRED_PHP_VERSION = '8.1.0';
const REQUIRED_GD_VERSION = '2.0';
const REQUIRED_GHOSTSCRIPT_VERSION = '9.53';
const REQUIRED_CURL_VERSION = '7.74';
const REQUIRED_ICU_VERSION = '67.1';
const LOWEST_REQUIRED_MYSQL_VERSION = '8.0.30';
const GREATEST_REQUIRED_MYSQL_VERSION = '8.1.0';
const REQUIRED_EXTENSIONS = [
'apcu',
'bcmath',
'curl',
'fileinfo',
'gd',
'intl',
'pdo_mysql',
'xml',
'zip',
'exif',
'imagick',
'mbstring',
'openssl',
];
/**
* Generate the requirements by executing test and providing the result and the
* associated messages
*
* @return Requirement[]
*/
public function getRequirements(): array
{
$phpVersion = phpversion();
$gdVersion = defined('GD_VERSION') ? GD_VERSION : null;
$curlVersion = function_exists('curl_version') ? curl_version() : null;
$icuVersion = Intl::getIcuVersion();
$requirements = [];
$requirements[] = new Requirement(
version_compare($phpVersion, self::REQUIRED_PHP_VERSION, '>='),
sprintf('PHP version must be at least %s (%s installed)', self::REQUIRED_PHP_VERSION, $phpVersion),
sprintf(
'You are running PHP version "%s", but needs at least PHP "%s" to run.
Before using, upgrade your PHP installation, preferably to the latest version.',
$phpVersion,
self::REQUIRED_PHP_VERSION
)
);
foreach (self::REQUIRED_EXTENSIONS as $requiredExtension) {
$requirements[] = new Requirement(
extension_loaded($requiredExtension),
sprintf('%s extension should be available', $requiredExtension),
sprintf('Install and enable the %s extension.', $requiredExtension)
);
}
$requirements[] = new Requirement(
null !== $gdVersion && version_compare($gdVersion, self::REQUIRED_GD_VERSION, '>='),
'GD extension must be at least ' . self::REQUIRED_GD_VERSION,
'Install and enable the GD extension at least ' . self::REQUIRED_GD_VERSION . ' version'
);
$isGhostScriptInstalled = !empty(shell_exec('which gs'));
$isGhostScriptVersionSupported = $this->isGhostScriptVersionSupported();
$requirements[] = new Requirement(
$isGhostScriptInstalled && $isGhostScriptVersionSupported,
'Ghostscript executable must be at least ' . self::REQUIRED_GHOSTSCRIPT_VERSION,
'Install the Ghostscript executable at least ' . self::REQUIRED_GHOSTSCRIPT_VERSION . ' version'
);
$isAspellInstalled = !empty(shell_exec('which aspell'));
$requirements[] = new Requirement(
$isAspellInstalled,
'Aspell executable must be available',
'Install the Aspell executable'
);
$requirements[] = new Requirement(
null !== $icuVersion && version_compare($icuVersion, self::REQUIRED_ICU_VERSION, '>='),
'icu library must be at least ' . self::REQUIRED_ICU_VERSION,
'Install and enable the icu library at least ' . self::REQUIRED_ICU_VERSION . ' version'
);
$requirements[] = new Requirement(
null !== $curlVersion && version_compare($curlVersion['version'], self::REQUIRED_CURL_VERSION, '>='),
'cURL extension must be at least ' . self::REQUIRED_CURL_VERSION,
'Install and enable the cURL extension at least ' . self::REQUIRED_CURL_VERSION . ' version',
null,
true
);
$mem = $this->getBytes(ini_get('memory_limit'));
$requirements[] = new Requirement(
$mem >= 512 * 1024 * 1024 || -1 == $mem,
'memory_limit should be at least 512M',
'Set the "memory_limit" setting in php.ini* to at least "512M".'
);
$currentMySQLVersion = $this->getMySQLVersion();
$requirements[] = new Requirement(
version_compare($currentMySQLVersion, self::LOWEST_REQUIRED_MYSQL_VERSION, '>=') &&
version_compare($currentMySQLVersion, self::GREATEST_REQUIRED_MYSQL_VERSION, '<'),
sprintf(
'MySQL version must be greater or equal to %s and lower than %s',
self::LOWEST_REQUIRED_MYSQL_VERSION,
self::GREATEST_REQUIRED_MYSQL_VERSION
),
sprintf(
'Install MySQL greater or equal to %s and lower than %s (installed version is %s)',
self::LOWEST_REQUIRED_MYSQL_VERSION,
self::GREATEST_REQUIRED_MYSQL_VERSION,
$currentMySQLVersion
)
);
$innodbPageSize = (int) $this->getMySQLVariableValue("innodb_page_size");
$requirements[] = new Requirement(
$innodbPageSize >= 8192,
'Check support for correct innodb_page_size for utf8mb4 support',
sprintf(
'In order for the PIM to implement full UTF8 support via MySQL utf8mb4 charset,'.
' MySQL must have innodb_page_size >= 8KB.'.
' Current innodb_page_size is at "%s".'.
' Please change your MySQL server configuration to use the correct settings'.
' (innodb_page_size is at 16KB by default on MySQL 5.7)',
$innodbPageSize
)
);
$requirements[] = new Requirement(
function_exists('exec'),
'The exec() function should be enabled in order to run jobs',
'Make sure the exec() function is not disabled in php.ini'
);
$requirements[] = new Requirement(
ini_get('apc.enable_cli') == 1,
'APCu should be enabled in CLI to get better performances',
'Set apc.enable_cli to 1',
null,
true
);
return $requirements;
}
/**
* Returns a global MySQL configuration variable value
*/
protected function getMySQLVariableValue(string $variableName) : string|int|null
{
$stmt = $this->getConnection()->query(
sprintf("SELECT @@GLOBAL.%s", $variableName)
);
$variableValue = $stmt->fetchColumn();
if (false === $variableValue) {
$variableValue = null;
}
return $variableValue;
}
/**
* Gets the MySQL server version thanks to a PDO connection.
*
* It can accept version with suffix
* @see https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_version
*/
protected function getMySQLVersion(): string
{
$mysqlVersion = $this->getConnection()->getAttribute(PDO::ATTR_SERVER_VERSION);
if (strpos($mysqlVersion, '-')) {
$mysqlVersion = substr($mysqlVersion, 0, strpos($mysqlVersion, '-'));
}
return $mysqlVersion;
}
/**
* If it exits, an attempt to connect is done, and can result in an exception
* if no connection is reached.
*/
protected function getConnection(): PDO
{
return new PDO(
sprintf(
'mysql:port=%s;host=%s',
$_ENV['APP_DATABASE_PORT'],
$_ENV['APP_DATABASE_HOST']
),
$_ENV['APP_DATABASE_USER'],
$_ENV['APP_DATABASE_PASSWORD']
);
}
protected function getBytes(string $val): float
{
if (empty($val)) {
return (float) 0;
}
preg_match('/([\-0-9]+)[\s]*([a-z]*)$/i', trim($val), $matches);
if (isset($matches[1])) {
$val = (int) $matches[1];
}
switch (strtolower($matches[2])) {
case 'g':
case 'gb':
$val *= 1024;
// no break
case 'm':
case 'mb':
$val *= 1024;
// no break
case 'k':
case 'kb':
$val *= 1024;
}
return (float) $val;
}
private function isGhostScriptVersionSupported(): bool
{
$currentGhostScriptVersion = shell_exec('gs --version');
if (null === $currentGhostScriptVersion) {
return false;
}
return version_compare(
trim($currentGhostScriptVersion),
self::REQUIRED_GHOSTSCRIPT_VERSION,
'>='
);
}
}