380 lines
9.6 KiB
PHP
380 lines
9.6 KiB
PHP
<?php
|
|
/**
|
|
* Controller: Constants.
|
|
*
|
|
* Constants class file.
|
|
*
|
|
* @since 4.5
|
|
*
|
|
* @package wsal
|
|
* @subpackage controllers
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace WSAL\Controllers;
|
|
|
|
// Exit if accessed directly.
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
if ( ! class_exists( '\WSAL\Controllers\Constants' ) ) {
|
|
/**
|
|
* Provides logging functionality for the comments.
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
class Constants {
|
|
public const WSAL_SEVERITIES = array(
|
|
0 => 'E_UNKNOWN',
|
|
500 => 'WSAL_CRITICAL',
|
|
400 => 'WSAL_HIGH',
|
|
300 => 'WSAL_MEDIUM',
|
|
250 => 'WSAL_LOW',
|
|
200 => 'WSAL_INFORMATIONAL',
|
|
);
|
|
|
|
/**
|
|
* Same array as above, but names are keys - for speeding up the checks
|
|
*/
|
|
public const WSAL_SEVERITIES_NAMES = array(
|
|
'E_UNKNOWN' => 0,
|
|
'WSAL_CRITICAL' => 500,
|
|
'WSAL_HIGH' => 400,
|
|
'WSAL_MEDIUM' => 300,
|
|
'WSAL_LOW' => 250,
|
|
'WSAL_INFORMATIONAL' => 200,
|
|
);
|
|
|
|
|
|
/**
|
|
* Holds the array with all the severities for the plugin.
|
|
*
|
|
* @var array
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
private static $wsal_constants = array();
|
|
|
|
/**
|
|
* If the search is unsuccessful - that is needed because of the legacy behavior of the plugin. Currently we can not get rid of that functionality - so that is the reason for that flag.
|
|
*
|
|
* @var bool
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
private static $not_found = false;
|
|
|
|
/**
|
|
* Inits the class variables.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function init() {
|
|
self::$not_found = false;
|
|
|
|
// Declaring the global legacy constants.
|
|
defined( 'E_CRITICAL' ) || define( 'E_CRITICAL', 'E_CRITICAL' );
|
|
defined( 'E_WARNING' ) || define( 'E_WARNING', 'E_WARNING' );
|
|
defined( 'E_NOTICE' ) || define( 'E_NOTICE', 'E_NOTICE' );
|
|
defined( 'E_UNKNOWN' ) || define( 'E_UNKNOWN', 'E_UNKNOWN' );
|
|
defined( 'WSAL_CRITICAL' ) || define( 'WSAL_CRITICAL', 'WSAL_CRITICAL' );
|
|
defined( 'WSAL_HIGH' ) || define( 'WSAL_HIGH', 'WSAL_HIGH' );
|
|
defined( 'WSAL_MEDIUM' ) || define( 'WSAL_MEDIUM', 'WSAL_MEDIUM' );
|
|
defined( 'WSAL_LOW' ) || define( 'WSAL_LOW', 'WSAL_LOW' );
|
|
defined( 'WSAL_INFORMATIONAL' ) || define( 'WSAL_INFORMATIONAL', 'WSAL_INFORMATIONAL' );
|
|
|
|
self::$wsal_constants = array(
|
|
array(
|
|
'name' => 'E_CRITICAL',
|
|
'css' => 'wsal_critical',
|
|
'value' => 500,
|
|
'text' => __( 'Critical', 'wp-security-audit-log' ),
|
|
'description' => '',
|
|
),
|
|
array(
|
|
'name' => 'E_WARNING',
|
|
'css' => 'wsal_medium',
|
|
'value' => 300,
|
|
'text' => __( 'Medium', 'wp-security-audit-log' ),
|
|
'description' => '',
|
|
),
|
|
array(
|
|
'name' => 'E_NOTICE',
|
|
'css' => 'wsal_informational',
|
|
'value' => 100,
|
|
'text' => __( 'Notification', 'wp-security-audit-log' ),
|
|
'description' => '',
|
|
),
|
|
array(
|
|
'name' => 'E_UNKNOWN',
|
|
'css' => 'e_unknown',
|
|
'value' => 0,
|
|
'text' => __( 'Unknown', 'wp-security-audit-log' ),
|
|
'description' => __( 'Unknown error code.', 'wp-security-audit-log' ),
|
|
),
|
|
500 => array(
|
|
'name' => 'WSAL_CRITICAL',
|
|
'css' => 'wsal_critical',
|
|
'value' => 500,
|
|
'text' => __( 'Critical', 'wp-security-audit-log' ),
|
|
'description' => esc_html__( 'Critical severity events.', 'wp-security-audit-log' ),
|
|
),
|
|
400 => array(
|
|
'name' => 'WSAL_HIGH',
|
|
'css' => 'wsal_high',
|
|
'value' => 400,
|
|
'text' => __( 'High', 'wp-security-audit-log' ),
|
|
'description' => esc_html__( 'High severity events.', 'wp-security-audit-log' ),
|
|
),
|
|
300 => array(
|
|
'name' => 'WSAL_MEDIUM',
|
|
'css' => 'wsal_medium',
|
|
'value' => 300,
|
|
'text' => __( 'Medium', 'wp-security-audit-log' ),
|
|
'description' => esc_html__( 'Medium severity events.', 'wp-security-audit-log' ),
|
|
),
|
|
250 => array(
|
|
'name' => 'WSAL_LOW',
|
|
'css' => 'wsal_low',
|
|
'value' => 250,
|
|
'text' => __( 'Low', 'wp-security-audit-log' ),
|
|
'description' => esc_html__( 'Low severity events.', 'wp-security-audit-log' ),
|
|
),
|
|
200 => array(
|
|
'name' => 'WSAL_INFORMATIONAL',
|
|
'css' => 'wsal_informational',
|
|
'value' => 200,
|
|
'text' => __( 'Informational', 'wp-security-audit-log' ),
|
|
'description' => esc_html__( 'Informational events.', 'wp-security-audit-log' ),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Adds severity to the class.
|
|
*
|
|
* @param string $name - The name of the constant.
|
|
* @param mixed $value - The value of the constant.
|
|
* @param string $description - The description of the constant.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @throws \Exception - If the constant is already defined.
|
|
*/
|
|
public static function add_constant( $name, $value, $description = '' ) {
|
|
if ( empty( self::$wsal_constants ) ) {
|
|
self::init();
|
|
}
|
|
|
|
foreach ( self::$wsal_constants as $constant ) {
|
|
if ( $constant['name'] === $name ) {
|
|
throw new \Exception( 'Constant already defined with a different value.' );
|
|
}
|
|
}
|
|
|
|
self::$wsal_constants[] = array(
|
|
'name' => $name,
|
|
'value' => constant( $name ),
|
|
'description' => $description,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Checks the defined constants and returns its Name.
|
|
*
|
|
* @param int $code - The code to check for constants.
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function get_constant_name( $code ) {
|
|
if ( isset( self::WSAL_SEVERITIES[ $code ] ) ) {
|
|
return self::WSAL_SEVERITIES[ $code ];
|
|
}
|
|
|
|
return 'E_UNKNOWN';
|
|
}
|
|
|
|
/**
|
|
* Returns the constant code by given name.
|
|
*
|
|
* @param string $constant - The name of the constant.
|
|
*
|
|
* @return int
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function get_constant_code( $constant ) {
|
|
if ( isset( self::WSAL_SEVERITIES_NAMES[ $constant ] ) ) {
|
|
return self::WSAL_SEVERITIES_NAMES[ $constant ];
|
|
}
|
|
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Checks the constants and returns the value of the given one (could be number or string).
|
|
*
|
|
* @param string $constant_name - The name od the constant to search for.
|
|
*
|
|
* @return mixed
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function get_constant_value( string $constant_name ) {
|
|
self::$not_found = false;
|
|
|
|
if ( empty( self::$wsal_constants ) ) {
|
|
self::init();
|
|
}
|
|
|
|
foreach ( self::$wsal_constants as $constant ) {
|
|
if ( $constant['name'] === $constant_name ) {
|
|
if ( isset( $constant['value'] ) ) {
|
|
return $constant['value'];
|
|
}
|
|
}
|
|
}
|
|
self::$not_found = true;
|
|
|
|
return 'Unknown';
|
|
}
|
|
|
|
/**
|
|
* Returns the WSAL constants array
|
|
*
|
|
* @param boolean $remove_old - Should we remove old constants from the array.
|
|
*
|
|
* @return array
|
|
*
|
|
* @since 4.5.0
|
|
* @since 4.6.0 - $remove_old is added
|
|
*/
|
|
public static function get_wsal_constants( bool $remove_old = false ): array {
|
|
if ( empty( self::$wsal_constants ) ) {
|
|
self::init();
|
|
}
|
|
|
|
if ( $remove_old ) {
|
|
return array_slice( self::$wsal_constants, 4 );
|
|
}
|
|
|
|
return self::$wsal_constants;
|
|
}
|
|
|
|
/**
|
|
* Checks the constants and returns the description of the given one.
|
|
*
|
|
* @param string $constant_name - The name of the constant to check.
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function get_constant_description( string $constant_name ): string {
|
|
self::$not_found = false;
|
|
|
|
if ( empty( self::$wsal_constants ) ) {
|
|
self::init();
|
|
}
|
|
|
|
foreach ( self::$wsal_constants as $constant ) {
|
|
if ( $constant['name'] === $constant_name ) {
|
|
if ( isset( $constant['description'] ) ) {
|
|
return $constant['description'];
|
|
}
|
|
}
|
|
}
|
|
self::$not_found = true;
|
|
|
|
return 'Unknown error code.';
|
|
}
|
|
|
|
/**
|
|
* Returns the class flag after the last operation.
|
|
*
|
|
* @return bool
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function is_found() {
|
|
return ! self::$not_found;
|
|
}
|
|
|
|
/**
|
|
* Returns the severity array by the given code. The code could be either value or name (value is checked first)
|
|
*
|
|
* @param int $code - The code to search for.
|
|
*
|
|
* @return array
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public static function get_severity_by_code( $code ) {
|
|
self::$not_found = false;
|
|
|
|
if ( empty( self::$wsal_constants ) ) {
|
|
self::init();
|
|
}
|
|
|
|
foreach ( self::$wsal_constants as $constant ) {
|
|
if ( $constant['value'] === $code ) {
|
|
return $constant;
|
|
}
|
|
if ( $constant['name'] === $code ) {
|
|
return $constant;
|
|
}
|
|
}
|
|
self::$not_found = true;
|
|
|
|
return array(
|
|
'name' => 'E_UNKNOWN',
|
|
'css' => 'e_unknown',
|
|
'value' => 0,
|
|
'text' => __( 'Unknown', 'wp-security-audit-log' ),
|
|
'description' => __( 'Unknown error code.', 'wp-security-audit-log' ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Fast search for code in the severities constants. It uses key to search for and if that fails it fall back into the row by row search.
|
|
*
|
|
* @param int|string $code - The code to search for.
|
|
*
|
|
* @return array
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public static function fast_severity_by_code( $code ): array {
|
|
if ( empty( self::$wsal_constants ) ) {
|
|
self::init();
|
|
}
|
|
|
|
if ( isset( self::$wsal_constants[ $code ] ) ) {
|
|
return self::$wsal_constants[ $code ];
|
|
} else {
|
|
return self::get_severity_by_code( $code );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the code name (human readable) by code number.
|
|
*
|
|
* @param int $code - The code number to get the human readable name.
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public static function get_severity_name_by_code( $code ) {
|
|
return self::fast_severity_by_code( (int) $code )['text'];
|
|
}
|
|
|
|
}
|
|
}
|