2022-03-19 17:48:44 +01:00

228 lines
7.1 KiB
PHP

<?php
/* μlogger
*
* Copyright(C) 2017 Bartek Fabiszewski (www.fabiszewski.net)
*
* This is free software; you can redistribute it and/or modify it under
* the terms of the GNU 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
/**
* Various util functions
*/
class uUtils {
/**
* Calculate maximum allowed size of uploaded file
* for current PHP settings
*
* @return int Number of bytes
*/
public static function getSystemUploadLimit() {
$upload_max_filesize = self::iniGetBytes('upload_max_filesize');
$post_max_size = self::iniGetBytes('post_max_size');
// post_max_size = 0 means unlimited size
if ($post_max_size === 0) { $post_max_size = $upload_max_filesize; }
$memory_limit = self::iniGetBytes('memory_limit');
// memory_limit = -1 means no limit
if ($memory_limit < 0) { $memory_limit = $post_max_size; }
return min($upload_max_filesize, $post_max_size, $memory_limit);
}
/**
* @param $path string Path
* @return bool True if is absolute
*/
public static function isAbsolutePath($path) {
return $path[0] === '/' || $path[0] === '\\' || preg_match('/^[a-zA-Z]:\\\\/', $path);
}
/**
* Get number of bytes from ini parameter.
* Optionally parses shorthand byte values (G, M, B)
*
* @param string $iniParam Ini parameter name
* @return int Bytes
* @noinspection PhpMissingBreakStatementInspection
*/
private static function iniGetBytes($iniParam) {
$iniStr = ini_get($iniParam);
$val = (float) $iniStr;
$suffix = substr(trim($iniStr), -1);
if (ctype_alpha($suffix)) {
switch (strtolower($suffix)) {
case 'g':
$val *= 1024;
case 'm':
$val *= 1024;
case 'k':
$val *= 1024;
}
}
return (int) $val;
}
/**
* Exit with error message
*
* @param string $errorMessage Message
* @param array|null $extra Optional array of extra parameters
*/
public static function exitWithError($errorMessage, $extra = null) {
$extra['message'] = $errorMessage;
self::exitWithStatus(true, $extra);
}
/**
* Exit with successful status code
*
* @param array|null $extra Optional array of extra parameters
*/
public static function exitWithSuccess($extra = null) {
self::exitWithStatus(false, $extra);
}
/**
* Exit with xml response
* @param boolean $isError Error if true
* @param array|null $extra Optional array of extra parameters
*/
private static function exitWithStatus($isError, $extra = null) {
$output = [];
if ($isError) {
$output["error"] = true;
}
if (!empty($extra)) {
foreach ($extra as $key => $value) {
$output[$key] = $value;
}
}
header("Content-type: application/json");
echo json_encode($output);
exit;
}
/**
* Calculate app base URL
* Returned URL has trailing slash.
*
* @return string URL
*/
public static function getBaseUrl() {
$proto = (!isset($_SERVER["HTTPS"]) || $_SERVER["HTTPS"] === "" || $_SERVER["HTTPS"] === "off") ? "http://" : "https://";
// Check if we are behind an https proxy
if (isset($_SERVER["HTTP_X_FORWARDED_PROTO"]) && $_SERVER["HTTP_X_FORWARDED_PROTO"] === "https") {
$proto = "https://";
}
$host = isset($_SERVER["HTTP_HOST"]) ? $_SERVER["HTTP_HOST"] : "";
if (realpath($_SERVER["SCRIPT_FILENAME"])) {
$scriptPath = substr(dirname(realpath($_SERVER["SCRIPT_FILENAME"])), strlen(ROOT_DIR));
} else {
// for phpunit
$scriptPath = substr(dirname($_SERVER["SCRIPT_FILENAME"]), strlen(ROOT_DIR));
}
$self = dirname($_SERVER["PHP_SELF"]);
$path = str_replace("\\", "/", substr($self, 0, strlen($self) - strlen($scriptPath)));
return $proto . str_replace("//", "/", $host . $path . "/");
}
public static function postFloat($name, $default = null) {
return self::requestValue($name, $default, INPUT_POST, FILTER_VALIDATE_FLOAT);
}
public static function getFloat($name, $default = null) {
return self::requestValue($name, $default, INPUT_GET, FILTER_VALIDATE_FLOAT);
}
public static function postPass($name, $default = null) {
return self::requestValue($name, $default, INPUT_POST);
}
public static function postString($name, $default = null) {
return self::requestString($name, $default, INPUT_POST);
}
public static function getString($name, $default = null) {
return self::requestString($name, $default, INPUT_GET);
}
public static function postBool($name, $default = null) {
$input = filter_input(INPUT_POST, $name, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
return $input !== null ? (bool) $input : $default;
}
public static function getBool($name, $default = null) {
$input = filter_input(INPUT_GET, $name, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
return $input !== null ? (bool) $input : $default;
}
public static function postInt($name, $default = null) {
return self::requestInt($name, $default, INPUT_POST);
}
public static function getInt($name, $default = null) {
return self::requestInt($name, $default, INPUT_GET);
}
public static function requestFile($name, $default = null) {
if (isset($_FILES[$name])) {
$files = $_FILES[$name];
if (isset($files["name"], $files["type"], $files["size"], $files["tmp_name"])) {
return $_FILES[$name];
}
}
return $default;
}
public static function postArray($name, $default = null) {
return ((isset($_POST[$name]) && is_array($_POST[$name])) ? $_POST[$name] : $default);
}
/**
* @param string $name Input name
* @param boolean $checkMime Optionally check mime with known types
* @return array File metadata array
* @throws Exception Upload exception
* @throws ErrorException Internal server exception
*/
public static function requireFile($name, $checkMime = false) {
return uUpload::sanitizeUpload($_FILES[$name], $checkMime);
}
private static function requestString($name, $default, $type) {
if (is_string(($val = self::requestValue($name, $default, $type)))) {
return trim($val);
}
return $val;
}
private static function requestInt($name, $default, $type) {
if (is_float(($val = self::requestValue($name, $default, $type, FILTER_VALIDATE_FLOAT)))) {
return (int) round($val);
}
return self::requestValue($name, $default, $type, FILTER_VALIDATE_INT);
}
private static function requestValue($name, $default, $type, $filters = FILTER_DEFAULT, $flags = []) {
$input = filter_input($type, $name, $filters, $flags);
if ($input !== false && $input !== null) {
return $input;
}
return $default;
}
}
?>