nextcloud/lib/private/MemoryInfo.php

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OC;

use OCP\Util;

/**
 * Helper class that covers memory info.
 */
class MemoryInfo {
	public const RECOMMENDED_MEMORY_LIMIT = 512 * 1024 * 1024;

	/**
	 * Tests if the memory limit is greater or equal the recommended value.
	 *
	 * @return bool
	 */
	public function isMemoryLimitSufficient(): bool {
		$memoryLimit = $this->getMemoryLimit();
		return $memoryLimit === -1 || $memoryLimit >= self::RECOMMENDED_MEMORY_LIMIT;
	}

	/**
	 * Returns the php memory limit.
	 *
	 * @return int|float The memory limit in bytes.
	 */
	public function getMemoryLimit(): int|float {
		$iniValue = trim(ini_get('memory_limit'));
		if ($iniValue === '-1') {
			return -1;
		} elseif (is_numeric($iniValue)) {
			return Util::numericToNumber($iniValue);
		} else {
			return $this->memoryLimitToBytes($iniValue);
		}
	}

	/**
	 * Converts the ini memory limit to bytes.
	 *
	 * @param string $memoryLimit The "memory_limit" ini value
	 */
	private function memoryLimitToBytes(string $memoryLimit): int|float {
		$last = strtolower(substr($memoryLimit, -1));
		$number = substr($memoryLimit, 0, -1);
		if (is_numeric($number)) {
			$memoryLimit = Util::numericToNumber($number);
		} else {
			throw new \InvalidArgumentException($number.' is not a valid numeric string (in memory_limit ini directive)');
		}

		// intended fall through
		switch ($last) {
			case 'g':
				$memoryLimit *= 1024;
				// no break
			case 'm':
				$memoryLimit *= 1024;
				// no break
			case 'k':
				$memoryLimit *= 1024;
		}

		return $memoryLimit;
	}
}