CHIEFSOFT\ameye
434 lines
14 KiB
PHP
434 lines
14 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file includes/functions.php
|
|
*
|
|
* Copyright (c) 2014-2021 Simon Fraser University
|
|
* Copyright (c) 2000-2021 John Willinsky
|
|
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
|
|
*
|
|
* @ingroup index
|
|
*
|
|
* @brief Contains definitions for common functions used system-wide.
|
|
* Any frequently-used functions that cannot be put into an appropriate class should be added here.
|
|
*/
|
|
|
|
use PKP\config\Config;
|
|
use PKP\core\Registry;
|
|
|
|
/*
|
|
* Constants for expressing human-readable data sizes in their respective number of bytes.
|
|
*/
|
|
define('KB_IN_BYTES', 1024);
|
|
define('MB_IN_BYTES', 1024 * KB_IN_BYTES);
|
|
define('GB_IN_BYTES', 1024 * MB_IN_BYTES);
|
|
define('TB_IN_BYTES', 1024 * GB_IN_BYTES);
|
|
define('PB_IN_BYTES', 1024 * TB_IN_BYTES);
|
|
define('EB_IN_BYTES', 1024 * PB_IN_BYTES);
|
|
define('ZB_IN_BYTES', 1024 * EB_IN_BYTES);
|
|
define('YB_IN_BYTES', 1024 * ZB_IN_BYTES);
|
|
|
|
/**
|
|
* Emulate a Java-style import statement.
|
|
* Simply includes the associated PHP file (using require_once so multiple calls to include the same file have no effect).
|
|
*
|
|
* @deprecated 3.4.0 pkp/pkp-lib#8186
|
|
*
|
|
* @param string $class the complete name of the class to be imported (e.g. 'lib.pkp.classes.core.Core')
|
|
*/
|
|
if (!function_exists('import')) {
|
|
function import($class)
|
|
{
|
|
$filePathPart = BASE_SYS_DIR . '/' . str_replace('.', '/', $class);
|
|
$filePath = $filePathPart . '.php';
|
|
if (file_exists($filePath)) {
|
|
// Load .php suffix
|
|
require_once($filePath);
|
|
} else {
|
|
// Fallback: Try .inc.php suffix
|
|
// This behaviour is DEPRECATED as of 3.4.0.
|
|
require_once($filePathPart . '.inc.php');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Wrapper around exit() to pretty-print an error message with an optional stack trace.
|
|
*/
|
|
function fatalError($reason)
|
|
{
|
|
// Because this method may be called when checking the value of the show_stacktrace
|
|
// configuration string, we need to ensure that we don't get stuck in an infinite loop.
|
|
static $isErrorCondition = null;
|
|
static $showStackTrace = false;
|
|
|
|
if ($isErrorCondition === null) {
|
|
$isErrorCondition = true;
|
|
$showStackTrace = Config::getVar('debug', 'show_stacktrace');
|
|
$isErrorCondition = false;
|
|
}
|
|
|
|
echo '<h1>' . htmlspecialchars($reason) . '</h1>';
|
|
|
|
if ($showStackTrace) {
|
|
echo "<h4>Stack Trace:</h4>\n";
|
|
$trace = debug_backtrace();
|
|
|
|
// Remove the call to fatalError from the call trace.
|
|
array_shift($trace);
|
|
|
|
// Back-trace pretty-printer adapted from the following URL:
|
|
// http://ca3.php.net/manual/en/function.debug-backtrace.php
|
|
// Thanks to diz at ysagoon dot com
|
|
|
|
// FIXME: Is there any way to localize this when the localization
|
|
// functions may have caused the failure in the first place?
|
|
foreach ($trace as $bt) {
|
|
$args = '';
|
|
if (isset($bt['args'])) {
|
|
foreach ($bt['args'] as $a) {
|
|
if (!empty($args)) {
|
|
$args .= ', ';
|
|
}
|
|
switch (gettype($a)) {
|
|
case 'integer':
|
|
case 'double':
|
|
$args .= $a;
|
|
break;
|
|
case 'string':
|
|
$a = htmlspecialchars(substr($a, 0, 64)) . ((strlen($a) > 64) ? '...' : '');
|
|
$args .= "\"{$a}\"";
|
|
break;
|
|
case 'array':
|
|
$args .= 'Array(' . count($a) . ')';
|
|
break;
|
|
case 'object':
|
|
$args .= 'Object(' . get_class($a) . ')';
|
|
break;
|
|
case 'resource':
|
|
$args .= 'Resource(' . strstr($a, '#') . ')';
|
|
break;
|
|
case 'boolean':
|
|
$args .= $a ? 'True' : 'False';
|
|
break;
|
|
case 'NULL':
|
|
$args .= 'Null';
|
|
break;
|
|
default:
|
|
$args .= 'Unknown';
|
|
}
|
|
}
|
|
}
|
|
$class = $bt['class'] ?? '';
|
|
$type = $bt['type'] ?? '';
|
|
$function = $bt['function'] ?? '';
|
|
$file = $bt['file'] ?? '(unknown)';
|
|
$line = $bt['line'] ?? '(unknown)';
|
|
|
|
echo "<strong>File:</strong> {$file} line {$line}<br />\n";
|
|
echo "<strong>Function:</strong> {$class}{$type}{$function}({$args})<br />\n";
|
|
echo "<br/>\n";
|
|
}
|
|
}
|
|
|
|
// Determine the application name. Use defensive code so that we
|
|
// can handle errors during early application initialization.
|
|
$application = null;
|
|
if (class_exists('Registry')) {
|
|
$application = Registry::get('application', true, null);
|
|
}
|
|
$applicationName = '';
|
|
if (!is_null($application)) {
|
|
$applicationName = $application->getName() . ': ';
|
|
}
|
|
|
|
error_log($applicationName . $reason);
|
|
|
|
if (defined('DONT_DIE_ON_ERROR') && DONT_DIE_ON_ERROR == true) {
|
|
// trigger an error to be catched outside the application
|
|
trigger_error($reason);
|
|
return;
|
|
}
|
|
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Instantiates an object for a given fully qualified
|
|
* class name after executing several checks on the class.
|
|
*
|
|
* The checks prevent certain vulnerabilities when
|
|
* instantiating classes generically.
|
|
*
|
|
* NB: We currently only support one constructor
|
|
* argument. If we need arbitrary arguments later
|
|
* we can do that via func_get_args() which allows us
|
|
* to handle an arbitrary number of optional
|
|
* constructor arguments. The $constructorArg
|
|
* parameter needs to be last in the parameter list
|
|
* to be forward compatible with this potential use
|
|
* case.
|
|
*
|
|
* @deprecated 3.4.0 pkp/pkp-lib#8186
|
|
*
|
|
* @param string $fullyQualifiedClassName
|
|
* @param string|array $expectedTypes the class
|
|
* must conform to at least one of the given types.
|
|
* @param string|array $expectedPackages the class
|
|
* must be part of at least one of the given packages.
|
|
* @param string|array $expectedMethods names of methods
|
|
* that must all be present for the requested class.
|
|
* @param mixed $constructorArg constructor argument
|
|
*
|
|
* @return object|boolean the instantiated object or false
|
|
* if the class instantiation didn't result in the expected
|
|
* type.
|
|
*/
|
|
function &instantiate($fullyQualifiedClassName, $expectedTypes = null, $expectedPackages = null, $expectedMethods = null, $constructorArg = null)
|
|
{
|
|
$errorFlag = false;
|
|
// Validate the class name
|
|
if (!preg_match('/^[a-zA-Z0-9_.]+$/', $fullyQualifiedClassName)) {
|
|
return $errorFlag;
|
|
}
|
|
|
|
// Validate the class package
|
|
if (!is_null($expectedPackages)) {
|
|
if (is_scalar($expectedPackages)) {
|
|
$expectedPackages = [$expectedPackages];
|
|
}
|
|
$validPackage = false;
|
|
foreach ($expectedPackages as $expectedPackage) {
|
|
// No need to use String class here as class names are always US-ASCII
|
|
if (substr($fullyQualifiedClassName, 0, strlen($expectedPackage) + 1) == $expectedPackage . '.') {
|
|
$validPackage = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Raise a fatal error if the class does not belong
|
|
// to any of the expected packages. This is to prevent
|
|
// certain types of code inclusion attacks.
|
|
if (!$validPackage) {
|
|
// Construct meaningful error message.
|
|
$expectedPackageCount = count($expectedPackages);
|
|
$separator = '';
|
|
$expectedPackageString = '';
|
|
foreach ($expectedPackages as $expectedPackageIndex => $expectedPackage) {
|
|
if ($expectedPackageIndex > 0) {
|
|
$separator = ($expectedPackageIndex == $expectedPackageCount - 1 ? ' or ' : ', ');
|
|
}
|
|
$expectedPackageString .= $separator . '"' . $expectedPackage . '"';
|
|
}
|
|
throw new Exception('Trying to instantiate class "' . $fullyQualifiedClassName . '" which is not in any of the expected packages ' . $expectedPackageString . '.');
|
|
}
|
|
}
|
|
|
|
// Import the requested class
|
|
import($fullyQualifiedClassName);
|
|
|
|
// Identify the class name
|
|
$fullyQualifiedClassNameParts = explode('.', $fullyQualifiedClassName);
|
|
$className = array_pop($fullyQualifiedClassNameParts);
|
|
|
|
// Type check I: The requested class should be declared by now.
|
|
if (!class_exists($className)) {
|
|
throw new Exception('Cannot instantiate class. Class "' . $className . '" is not declared in "' . $fullyQualifiedClassName . '".');
|
|
}
|
|
|
|
// Ensure all expected methods are declared.
|
|
$expectedMethods = (array) $expectedMethods; // Possibly scalar or null; ensure array
|
|
$declaredMethods = get_class_methods($className);
|
|
if (count(array_intersect($expectedMethods, $declaredMethods)) != count($expectedMethods)) {
|
|
return $errorFlag;
|
|
}
|
|
|
|
// Instantiate the requested class
|
|
if (is_null($constructorArg)) {
|
|
$classInstance = new $className();
|
|
} else {
|
|
$classInstance = new $className($constructorArg);
|
|
}
|
|
|
|
// Type check II: The object must conform to the given interface (if any).
|
|
if (!is_null($expectedTypes)) {
|
|
if (is_scalar($expectedTypes)) {
|
|
$expectedTypes = [$expectedTypes];
|
|
}
|
|
$validType = false;
|
|
foreach ($expectedTypes as $expectedType) {
|
|
if (is_a($classInstance, $expectedType)) {
|
|
$validType = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!$validType) {
|
|
return $errorFlag;
|
|
}
|
|
}
|
|
|
|
return $classInstance;
|
|
}
|
|
|
|
/**
|
|
* Recursively strip HTML from a (multidimensional) array.
|
|
*
|
|
* @param array $values
|
|
*
|
|
* @return array the cleansed array
|
|
*/
|
|
function stripAssocArray($values)
|
|
{
|
|
foreach ($values as $key => $value) {
|
|
if (is_scalar($value)) {
|
|
$values[$key] = strip_tags($values[$key]);
|
|
} else {
|
|
$values[$key] = stripAssocArray($values[$key]);
|
|
}
|
|
}
|
|
return $values;
|
|
}
|
|
|
|
/**
|
|
* Perform a code-safe strtolower, i.e. one that doesn't behave differently
|
|
* based on different locales. (tr_TR, I'm looking at you.)
|
|
*
|
|
* @param string $str Input string
|
|
*
|
|
* @return string
|
|
*/
|
|
function strtolower_codesafe($str)
|
|
{
|
|
return strtr($str, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz');
|
|
}
|
|
|
|
/**
|
|
* Perform a code-safe strtoupper, i.e. one that doesn't behave differently
|
|
* based on different locales. (tr_TR, I'm looking at you.)
|
|
*
|
|
* @param string $str Input string
|
|
*
|
|
* @return string
|
|
*/
|
|
function strtoupper_codesafe($str)
|
|
{
|
|
return strtr($str, 'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
|
|
}
|
|
|
|
/**
|
|
* Perform a code-safe lcfirst, i.e. one that doesn't behave differently
|
|
* based on different locales. (tr_TR, I'm looking at you.)
|
|
*
|
|
* @param string $str Input string
|
|
*
|
|
* @return string
|
|
*/
|
|
function lcfirst_codesafe($str)
|
|
{
|
|
return strtolower_codesafe(substr($str, 0, 1)) . substr($str, 1);
|
|
}
|
|
|
|
/**
|
|
* Perform a code-safe ucfirst, i.e. one that doesn't behave differently
|
|
* based on different locales. (tr_TR, I'm looking at you.)
|
|
*
|
|
* @param string $str Input string
|
|
*
|
|
* @return string
|
|
*/
|
|
function ucfirst_codesafe($str)
|
|
{
|
|
return strtoupper_codesafe(substr($str, 0, 1)) . substr($str, 1);
|
|
}
|
|
|
|
/**
|
|
* @copydoc Core::cleanFileVar
|
|
* Warning: Call this function from Core class. It is only exposed here to make
|
|
* it available early in bootstrapping.
|
|
*/
|
|
function cleanFileVar($var)
|
|
{
|
|
return preg_replace('/[^\w\-]/u', '', $var);
|
|
}
|
|
|
|
/**
|
|
* Translates a pluralized locale key
|
|
*/
|
|
function __p(string $key, int $number, array $replace = [], ?string $locale = null): string
|
|
{
|
|
return trans_choice($key, $number, $replace, $locale);
|
|
}
|
|
|
|
/**
|
|
* Check if run on CLI
|
|
*/
|
|
if (!function_exists('runOnCLI')) {
|
|
function runOnCLI(string $scriptPath = null): bool
|
|
{
|
|
if (php_sapi_name() && strtolower(php_sapi_name()) === 'cli') {
|
|
return true;
|
|
}
|
|
|
|
if ($scriptPath) {
|
|
$serverVars = $_SERVER;
|
|
|
|
if (isset($serverVars['SCRIPT_NAME']) && strpos(strtolower($serverVars['SCRIPT_NAME']), strtolower($scriptPath)) !== false) {
|
|
return true;
|
|
}
|
|
|
|
if (isset($serverVars['SCRIPT_FILENAME']) && strpos(strtolower($serverVars['SCRIPT_FILENAME']), strtolower($scriptPath)) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Converts a shorthand byte value to an integer byte value.
|
|
*
|
|
* @link https://secure.php.net/manual/en/function.ini-get.php
|
|
* @link https://secure.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
|
|
*
|
|
* @param string A (PHP ini) byte value, either shorthand or ordinary.
|
|
*
|
|
* @return int An integer byte value.
|
|
*/
|
|
if (!function_exists('convertHrToBytes')) {
|
|
function convertHrToBytes(string $value): int
|
|
{
|
|
$value = strtolower(trim($value));
|
|
$bytes = (int) $value;
|
|
|
|
if (false !== strpos($value, 'g')) {
|
|
$bytes *= GB_IN_BYTES;
|
|
} elseif (false !== strpos($value, 'm')) {
|
|
$bytes *= MB_IN_BYTES;
|
|
} elseif (false !== strpos($value, 'k')) {
|
|
$bytes *= KB_IN_BYTES;
|
|
}
|
|
|
|
// Deal with large (float) values which run into the maximum integer size.
|
|
return min($bytes, PHP_INT_MAX);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if valid JSON
|
|
*
|
|
* @param mixed $data
|
|
*
|
|
* @return bool
|
|
*/
|
|
if (!function_exists('isValidJson')) {
|
|
function isValidJson(mixed $data): bool
|
|
{
|
|
if (!empty($data)) {
|
|
@json_decode($data);
|
|
return (json_last_error() === JSON_ERROR_NONE);
|
|
}
|
|
return false;
|
|
}
|
|
}
|