OCA\FaceRecognition\Helper\MemoryLimits

Complexity

Total Complexity

13

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getTotalMemoryLinux()	0	13	3
A	returnBytes()	0	18	5
A	getAvailableMemory()	0	22	5

<?php
/**
 * @copyright Copyright (c) 2017, Matias De lellis <mati86dl@gmail.com>
 * @copyright Copyright (c) 2018, Branko Kokanovic <branko@kokanovic.org>
 *
 * @author Branko Kokanovic <branko@kokanovic.org>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\FaceRecognition\Helper;

/**
 * Tries to get total amount of memory on the host, given to PHP.
 */
class MemoryLimits {

	/**
	 * Tries to get memory available to PHP. This is highly speculative business.
	 * It will first try reading value of "memory_limit" and if it is -1, it will
	 * try to get 1/2 memory of host system. In case of any error, it will return
	 * negative value. Note that negative here doesn't mean "unlimited"! This
	 * function doesn't care if PHP is being used in CLI or FPM mode.
	 *
	 * @return int Total memory available to PHP, in bytes, or negative if
	 * we don't know any better
	 */
	public static function getAvailableMemory(): int {
		// Try first to get from php.ini
		try {
			$value = MemoryLimits::returnBytes(ini_get('memory_limit'));
			if ($value > 0) {
				return $value;
			}
		} catch (\Exception $e) {
			return -1;
		}

		// php.ini says that memory_limit is -1, which means unlimited.
		//We need to get memory from system (if system is supported here).
		// Only linux is currently supported.
		if (php_uname("s") === "Linux") {
			$linuxMemory = MemoryLimits::getTotalMemoryLinux();
			if ($linuxMemory <= 0) {
				return -3;
			}
			return intval($linuxMemory / 2);
		} else {
			return -2;
		}
	}

	private static function getTotalMemoryLinux(): int {
		$fh = fopen('/proc/meminfo','r');
		$mem = 0;
		while ($line = fgets($fh)) {

It seems like $fh can also be of type false; however, parameter $handle of fgets() does only seem to accept resource, maybe add an additional type check?

			$pieces = array();
			if (preg_match('/^MemTotal:\s+(\d+)\skB$/', $line, $pieces)) {
				$mem = $pieces[1];
				break;
			}
		}
		fclose($fh);

It seems like $fh can also be of type false; however, parameter $handle of fclose() does only seem to accept resource, maybe add an additional type check?

		$memKb = intval($mem);
		return $memKb * 1024;
	}

	/**
	 * Converts shorthand memory notation value to bytes
	 * From http://php.net/manual/en/function.ini-get.php
	 *
	 * @param string val Memory size shorthand notation string

The type OCA\FaceRecognition\Helper\val was not found. Maybe you did not declare it correctly or list all dependencies?

	 *
	 * @return int Value in integers (bytes)
	 */
	private static function returnBytes(string $val): int {
		$val = trim($val);
		if ($val === "") {
			return 0;
		}

		$last = strtolower($val[strlen($val)-1]);
		switch($last) {
			// Fallthrough on purpose
			case 'g':
				$val *= 1024;

Consider adding a comment if this fall-through is intended.

			case 'm':
				$val *= 1024;

Consider adding a comment if this fall-through is intended.

			case 'k':
				$val *= 1024;
		}

		return $val;

The expression return $val returns the type string which is incompatible with the type-hinted return integer.

	}
}