512 lines
11 KiB
PHP
512 lines
11 KiB
PHP
|
<?php
|
||
|
|
||
|
namespace Safe;
|
||
|
|
||
|
use Safe\Exceptions\InfoException;
|
||
|
|
||
|
/**
|
||
|
* Sets the process title visible in tools such as top and
|
||
|
* ps. This function is available only in
|
||
|
* CLI mode.
|
||
|
*
|
||
|
* @param string $title The new title.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function cli_set_process_title(string $title): void
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \cli_set_process_title($title);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Loads the PHP extension given by the parameter
|
||
|
* library.
|
||
|
*
|
||
|
* Use extension_loaded to test whether a given
|
||
|
* extension is already available or not. This works on both built-in
|
||
|
* extensions and dynamically loaded ones (either through php.ini or
|
||
|
* dl).
|
||
|
*
|
||
|
* @param string $library This parameter is only the filename of the
|
||
|
* extension to load which also depends on your platform. For example,
|
||
|
* the sockets extension (if compiled
|
||
|
* as a shared module, not the default!) would be called
|
||
|
* sockets.so on Unix platforms whereas it is called
|
||
|
* php_sockets.dll on the Windows platform.
|
||
|
*
|
||
|
* The directory where the extension is loaded from depends on your
|
||
|
* platform:
|
||
|
*
|
||
|
* Windows - If not explicitly set in the php.ini, the extension is
|
||
|
* loaded from C:\php5\ by default.
|
||
|
*
|
||
|
* Unix - If not explicitly set in the php.ini, the default extension
|
||
|
* directory depends on
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* whether PHP has been built with --enable-debug
|
||
|
* or not
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* whether PHP has been built with (experimental) ZTS (Zend Thread Safety)
|
||
|
* support or not
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* the current internal ZEND_MODULE_API_NO (Zend
|
||
|
* internal module API number, which is basically the date on which a
|
||
|
* major module API change happened, e.g. 20010901)
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* Taking into account the above, the directory then defaults to
|
||
|
* <install-dir>/lib/php/extensions/ <debug-or-not>-<zts-or-not>-ZEND_MODULE_API_NO,
|
||
|
* e.g.
|
||
|
* /usr/local/php/lib/php/extensions/debug-non-zts-20010901
|
||
|
* or
|
||
|
* /usr/local/php/lib/php/extensions/no-debug-zts-20010901.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function dl(string $library): void
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \dl($library);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Gets the time of the last modification of the main script of execution.
|
||
|
*
|
||
|
* If you're interested in getting the last modification time
|
||
|
* of a different file, consider using filemtime.
|
||
|
*
|
||
|
* @return int Returns the time of the last modification of the current
|
||
|
* page. The value returned is a Unix timestamp, suitable for
|
||
|
* feeding to date.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function getlastmod(): int
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \getlastmod();
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
*
|
||
|
*
|
||
|
* @return int Returns the group ID of the current script.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function getmygid(): int
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \getmygid();
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Gets the inode of the current script.
|
||
|
*
|
||
|
* @return int Returns the current script's inode as an integer.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function getmyinode(): int
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \getmyinode();
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Gets the current PHP process ID.
|
||
|
*
|
||
|
* @return int Returns the current PHP process ID.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function getmypid(): int
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \getmypid();
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
*
|
||
|
*
|
||
|
* @return int Returns the user ID of the current script.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function getmyuid(): int
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \getmyuid();
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Parses options passed to the script.
|
||
|
*
|
||
|
* @param string $options
|
||
|
* @param array $longopts
|
||
|
* @param int|null $optind
|
||
|
* @return array|array|array This function will return an array of option / argument pairs.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function getopt(string $options, array $longopts = null, ?int &$optind = null): array
|
||
|
{
|
||
|
error_clear_last();
|
||
|
if ($optind !== null) {
|
||
|
$result = \getopt($options, $longopts, $optind);
|
||
|
} elseif ($longopts !== null) {
|
||
|
$result = \getopt($options, $longopts);
|
||
|
} else {
|
||
|
$result = \getopt($options);
|
||
|
}
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Returns the value of the configuration option on success.
|
||
|
*
|
||
|
* @param string $varname The configuration option name.
|
||
|
* @return string Returns the value of the configuration option as a string on success, or an
|
||
|
* empty string for null values. Returns FALSE if the
|
||
|
* configuration option doesn't exist.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function ini_get(string $varname): string
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \ini_get($varname);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Sets the value of the given configuration option. The configuration option
|
||
|
* will keep this new value during the script's execution, and will be restored
|
||
|
* at the script's ending.
|
||
|
*
|
||
|
* @param string $varname Not all the available options can be changed using
|
||
|
* ini_set. There is a list of all available options
|
||
|
* in the appendix.
|
||
|
* @param string|int|float|bool $newvalue The new value for the option.
|
||
|
* @return string Returns the old value on success, FALSE on failure.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function ini_set(string $varname, $newvalue): string
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \ini_set($varname, $newvalue);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* This function prints out the credits listing the PHP developers,
|
||
|
* modules, etc. It generates the appropriate HTML codes to insert
|
||
|
* the information in a page.
|
||
|
*
|
||
|
* @param int $flag To generate a custom credits page, you may want to use the
|
||
|
* flag parameter.
|
||
|
*
|
||
|
*
|
||
|
* Pre-defined phpcredits flags
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* name
|
||
|
* description
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_ALL
|
||
|
*
|
||
|
* All the credits, equivalent to using: CREDITS_DOCS +
|
||
|
* CREDITS_GENERAL + CREDITS_GROUP +
|
||
|
* CREDITS_MODULES + CREDITS_FULLPAGE.
|
||
|
* It generates a complete stand-alone HTML page with the appropriate tags.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_DOCS
|
||
|
* The credits for the documentation team
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_FULLPAGE
|
||
|
*
|
||
|
* Usually used in combination with the other flags. Indicates
|
||
|
* that a complete stand-alone HTML page needs to be
|
||
|
* printed including the information indicated by the other
|
||
|
* flags.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_GENERAL
|
||
|
*
|
||
|
* General credits: Language design and concept, PHP authors
|
||
|
* and SAPI module.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_GROUP
|
||
|
* A list of the core developers
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_MODULES
|
||
|
*
|
||
|
* A list of the extension modules for PHP, and their authors
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* CREDITS_SAPI
|
||
|
*
|
||
|
* A list of the server API modules for PHP, and their authors
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function phpcredits(int $flag = CREDITS_ALL): void
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \phpcredits($flag);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Outputs a large amount of information about the current state of PHP.
|
||
|
* This includes information about PHP compilation options and extensions,
|
||
|
* the PHP version, server information and environment (if compiled as a
|
||
|
* module), the PHP environment, OS version information, paths, master and
|
||
|
* local values of configuration options, HTTP headers, and the PHP License.
|
||
|
*
|
||
|
* Because every system is setup differently, phpinfo is
|
||
|
* commonly used to check configuration settings and for available
|
||
|
* predefined variables
|
||
|
* on a given system.
|
||
|
*
|
||
|
* phpinfo is also a valuable debugging tool as it
|
||
|
* contains all EGPCS (Environment, GET, POST, Cookie, Server) data.
|
||
|
*
|
||
|
* @param int $what The output may be customized by passing one or more of the
|
||
|
* following constants bitwise values summed
|
||
|
* together in the optional what parameter.
|
||
|
* One can also combine the respective constants or bitwise values
|
||
|
* together with the bitwise or operator.
|
||
|
*
|
||
|
*
|
||
|
* phpinfo options
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* Name (constant)
|
||
|
* Value
|
||
|
* Description
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_GENERAL
|
||
|
* 1
|
||
|
*
|
||
|
* The configuration line, php.ini location, build date, Web
|
||
|
* Server, System and more.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_CREDITS
|
||
|
* 2
|
||
|
*
|
||
|
* PHP Credits. See also phpcredits.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_CONFIGURATION
|
||
|
* 4
|
||
|
*
|
||
|
* Current Local and Master values for PHP directives. See
|
||
|
* also ini_get.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_MODULES
|
||
|
* 8
|
||
|
*
|
||
|
* Loaded modules and their respective settings. See also
|
||
|
* get_loaded_extensions.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_ENVIRONMENT
|
||
|
* 16
|
||
|
*
|
||
|
* Environment Variable information that's also available in
|
||
|
* $_ENV.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_VARIABLES
|
||
|
* 32
|
||
|
*
|
||
|
* Shows all
|
||
|
* predefined variables from EGPCS (Environment, GET,
|
||
|
* POST, Cookie, Server).
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_LICENSE
|
||
|
* 64
|
||
|
*
|
||
|
* PHP License information. See also the license FAQ.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* INFO_ALL
|
||
|
* -1
|
||
|
*
|
||
|
* Shows all of the above.
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
*
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function phpinfo(int $what = INFO_ALL): void
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \phpinfo($what);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Adds setting to the server environment. The
|
||
|
* environment variable will only exist for the duration of the current
|
||
|
* request. At the end of the request the environment is restored to its
|
||
|
* original state.
|
||
|
*
|
||
|
* @param string $setting The setting, like "FOO=BAR"
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function putenv(string $setting): void
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \putenv($setting);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Sets the include_path
|
||
|
* configuration option for the duration of the script.
|
||
|
*
|
||
|
* @param string $new_include_path The new value for the include_path
|
||
|
* @return string Returns the old include_path on
|
||
|
* success.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function set_include_path(string $new_include_path): string
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \set_include_path($new_include_path);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
return $result;
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Set the number of seconds a script is allowed to run. If this is reached,
|
||
|
* the script returns a fatal error. The default limit is 30 seconds or, if
|
||
|
* it exists, the max_execution_time value defined in the
|
||
|
* php.ini.
|
||
|
*
|
||
|
* When called, set_time_limit restarts the timeout
|
||
|
* counter from zero. In other words, if the timeout is the default 30
|
||
|
* seconds, and 25 seconds into script execution a call such as
|
||
|
* set_time_limit(20) is made, the script will run for a
|
||
|
* total of 45 seconds before timing out.
|
||
|
*
|
||
|
* @param int $seconds The maximum execution time, in seconds. If set to zero, no time limit
|
||
|
* is imposed.
|
||
|
* @throws InfoException
|
||
|
*
|
||
|
*/
|
||
|
function set_time_limit(int $seconds): void
|
||
|
{
|
||
|
error_clear_last();
|
||
|
$result = \set_time_limit($seconds);
|
||
|
if ($result === false) {
|
||
|
throw InfoException::createFromPhpError();
|
||
|
}
|
||
|
}
|