Skip to content

Allow usage of environment variables in PHP ini settings that contain byte size values #544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 3.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/Io/IniUtil.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ public static function iniSizeToBytes($size)
return (int)$size;
}

// ini size values might be specified via environment variables, e.g.: memory_limit=${PHP_MEMORY_LIMIT}
$matches = [];
$envVarUsed = preg_match('#^\$(?|(\w+)|\{(\w+)})$#', $size, $matches);
$envVarName = $matches[1] ?? false;
if ($envVarUsed && $envVarName && array_key_exists($envVarName, $_ENV)) {
$size = (string)$_ENV[$envVarName];
}

$suffix = \strtoupper(\substr($size, -1));
$strippedSize = \substr($size, 0, -1);

Expand Down
44 changes: 44 additions & 0 deletions tests/Io/IniUtilTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,48 @@ public function testInvalidInputIniSizeToBytes($input)
$this->expectException(\InvalidArgumentException::class);
IniUtil::iniSizeToBytes($input);
}

public function testIniSizeViaEnvVariableWorks()
{
self::assertArrayNotHasKey('INIUTIL_ENV_VAR_WITH_PHP_SIZE_VALUE', $_ENV);
$_ENV['INIUTIL_ENV_VAR_WITH_PHP_SIZE_VALUE'] = '23M';
$this->assertSame(23 * 1024 * 1024, IniUtil::iniSizeToBytes('${INIUTIL_ENV_VAR_WITH_PHP_SIZE_VALUE}'));
}

public function testIniSizeViaSimpleEnvVariableWorks()
{
self::assertArrayNotHasKey('INIUTIL_SIMPLE_ENV_VAR_WITH_PHP_SIZE_VALUE', $_ENV);
$_ENV['INIUTIL_SIMPLE_ENV_VAR_WITH_PHP_SIZE_VALUE'] = '42M';
$this->assertSame(42 * 1024 * 1024, IniUtil::iniSizeToBytes('$INIUTIL_SIMPLE_ENV_VAR_WITH_PHP_SIZE_VALUE'));
}

public function testIniSizeViaEnvVariableFailsForNonSizeValue()
{
self::assertArrayNotHasKey('INIUTIL_ENV_VAR_WITHOUT_PHP_SIZE_VALUE', $_ENV);
$_ENV['INIUTIL_ENV_VAR_WITHOUT_PHP_SIZE_VALUE'] = 'no-size';
$this->expectException(\InvalidArgumentException::class);
IniUtil::iniSizeToBytes('${INIUTIL_ENV_VAR_WITHOUT_PHP_SIZE_VALUE}');
}

public function testIniSizeViaEnvVariableIgnoresInvalidSizeModifier()
{
self::assertArrayNotHasKey('INIUTIL_ENV_VAR_WITH_PHP_SIZE_VALUE_AND_INVALID_MODIFIER', $_ENV);
$_ENV['INIUTIL_ENV_VAR_WITH_PHP_SIZE_VALUE_AND_INVALID_MODIFIER'] = '1337V';
$this->assertSame(1337, IniUtil::iniSizeToBytes('${INIUTIL_ENV_VAR_WITH_PHP_SIZE_VALUE_AND_INVALID_MODIFIER}'));
}

public function testIniSizeViaEnvVariableFailsForNonNumericValue()
{
self::assertArrayNotHasKey('INIUTIL_ENV_VAR_WITH_NON_NUMERIC_PHP_SIZE_VALUE', $_ENV);
$_ENV['INIUTIL_ENV_VAR_WITH_NON_NUMERIC_PHP_SIZE_VALUE'] = 'V1337V';
$this->expectException(\InvalidArgumentException::class);
IniUtil::iniSizeToBytes('${INIUTIL_ENV_VAR_WITH_NON_NUMERIC_PHP_SIZE_VALUE}');
}

public function testIniSizeViaMissingEnvVariableFails()
{
self::assertArrayNotHasKey('INIUTIL_ENV_VAR_MISSING_WITH_NON_NUMERIC_PHP_SIZE_VALUE', $_ENV);
$this->expectException(\InvalidArgumentException::class);
IniUtil::iniSizeToBytes('${INIUTIL_ENV_VAR_MISSING_WITH_NON_NUMERIC_PHP_SIZE_VALUE}');
}
}
Loading