Add Check Color class
checks html/css color string for valid eg, hex #, hex alpha #, rgb/rgba, hsl/hsla
This commit is contained in:
Clemens Schwaighofer
123
www/admin/class_test.check.colors.php
Normal file
123
www/admin/class_test.check.colors.php
Normal file
@@ -0,0 +1,123 @@
|
||||
<?php // phpcs:ignore warning
|
||||
|
||||
/**
|
||||
* @phan-file-suppress PhanTypeSuspiciousStringExpression
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
$DEBUG_ALL_OVERRIDE = 0; // set to 1 to debug on live/remote server locations
|
||||
$DEBUG_ALL = 1;
|
||||
$PRINT_ALL = 1;
|
||||
$DB_DEBUG = 1;
|
||||
|
||||
if ($DEBUG_ALL) {
|
||||
error_reporting(E_ALL | E_STRICT | E_ERROR | E_WARNING | E_PARSE | E_COMPILE_ERROR);
|
||||
}
|
||||
|
||||
ob_start();
|
||||
|
||||
// basic class test file
|
||||
define('USE_DATABASE', false);
|
||||
// sample config
|
||||
require 'config.php';
|
||||
// define log file id
|
||||
$LOG_FILE_ID = 'classTest-check-colors';
|
||||
ob_end_flush();
|
||||
|
||||
use CoreLibs\Check\Colors;
|
||||
// use CoreLibs\Debug\Support as DgS;
|
||||
|
||||
$log = new CoreLibs\Debug\Logging([
|
||||
'log_folder' => BASE . LOG,
|
||||
'file_id' => $LOG_FILE_ID,
|
||||
// add file date
|
||||
'print_file_date' => true,
|
||||
// set debug and print flags
|
||||
'debug_all' => $DEBUG_ALL ?? false,
|
||||
'echo_all' => $ECHO_ALL ?? false,
|
||||
'print_all' => $PRINT_ALL ?? false,
|
||||
]);
|
||||
|
||||
$PAGE_NAME = 'TEST CLASS: CHECK COLORS';
|
||||
print "<!DOCTYPE html>";
|
||||
print "<html><head><title>" . $PAGE_NAME . "</title><head>";
|
||||
print "<body>";
|
||||
print '<div><a href="class_test.php">Class Test Master</a></div>';
|
||||
print '<div><h1>' . $PAGE_NAME . '</h1></div>';
|
||||
|
||||
// list of colors to check
|
||||
$css_colors = [
|
||||
// base hex
|
||||
'#ab12cd',
|
||||
'#ab12cd12',
|
||||
// rgb
|
||||
'rgb(255, 10, 20)',
|
||||
'rgb(100%, 10%, 20%)',
|
||||
'rgba(255, 10, 20)',
|
||||
'rgba(100%, 10%, 20%)',
|
||||
'rgba(255, 10, 20, 0.5)',
|
||||
'rgba(100%, 10%, 20%, 0.5)',
|
||||
'rgba(255, 10, 20, 50%)',
|
||||
'rgba(100%, 10%, 20%, 50%)',
|
||||
// hsl
|
||||
'hsl(100, 50%, 60%)',
|
||||
'hsl(100, 50.5%, 60.5%)',
|
||||
'hsla(100, 50%, 60%)',
|
||||
'hsla(100, 50.5%, 60.5%)',
|
||||
'hsla(100, 50%, 60%, 0.5)',
|
||||
'hsla(100, 50.5%, 60.5%, 0.5)',
|
||||
'hsla(100, 50%, 60%, 50%)',
|
||||
'hsla(100, 50.5%, 60.5%, 50%)',
|
||||
// invalid here
|
||||
'invalid string',
|
||||
'(hsla(100, 100, 100))',
|
||||
'hsla(100, 100, 100',
|
||||
// invalid numbers
|
||||
'#zzab99',
|
||||
'#abcdef0',
|
||||
'rgb(255%, 100, 100)',
|
||||
'rgb(255%, 100, -10)',
|
||||
'rgb(100%, 100, -10)',
|
||||
'hsl(370, 100, 10)',
|
||||
'hsl(200, 100%, 160%)',
|
||||
];
|
||||
|
||||
foreach ($css_colors as $color) {
|
||||
$check = Colors::validateColor($color);
|
||||
print "Color check: $color with (" . Colors::ALL . "): ";
|
||||
if ($check) {
|
||||
print '<span style="color: green;">OK</span>';
|
||||
} else {
|
||||
print '<span style="color: red;">ERROR</span>';
|
||||
}
|
||||
print "<br>";
|
||||
}
|
||||
|
||||
echo "<hr>";
|
||||
|
||||
// valid rgb/hsl checks
|
||||
$color = 'hsla(360, 100%, 60%, 0.556)';
|
||||
$check = Colors::validateColor($color);
|
||||
print "Color check: $color with (" . Colors::ALL . "): ";
|
||||
if ($check) {
|
||||
print '<span style="color: green;">OK</span>';
|
||||
} else {
|
||||
print '<span style="color: red;">ERROR</span>';
|
||||
}
|
||||
|
||||
// invalid flag
|
||||
echo "<hr>";
|
||||
try {
|
||||
$check = Colors::validateColor('#ab12cd', 99);
|
||||
print "No Exception";
|
||||
} catch (\Exception $e) {
|
||||
print "ERROR: " . $e->getCode() . ": " . $e->getMessage() . "<br>";
|
||||
}
|
||||
|
||||
// error message
|
||||
print $log->printErrorMsg();
|
||||
|
||||
print "</body></html>";
|
||||
|
||||
// __END__
|
||||
@@ -22,7 +22,7 @@ define('USE_DATABASE', false);
|
||||
// sample config
|
||||
require 'config.php';
|
||||
// define log file id
|
||||
$LOG_FILE_ID = 'classTest-colors';
|
||||
$LOG_FILE_ID = 'classTest-convert-colors';
|
||||
ob_end_flush();
|
||||
|
||||
use CoreLibs\Convert\Colors;
|
||||
@@ -40,7 +40,7 @@ $log = new CoreLibs\Debug\Logging([
|
||||
]);
|
||||
$color_class = 'CoreLibs\Convert\Colors';
|
||||
|
||||
$PAGE_NAME = 'TEST CLASS: COLORS';
|
||||
$PAGE_NAME = 'TEST CLASS: CONVERT COLORS';
|
||||
print "<!DOCTYPE html>";
|
||||
print "<html><head><title>" . $PAGE_NAME . "</title><head>";
|
||||
print "<body>";
|
||||
@@ -55,7 +55,8 @@ print "<body>";
|
||||
|
||||
print '<div><a href="class_test.db.php">Class Test: DB</a></div>';
|
||||
print '<div><a href="class_test.db.dbReturn.php">Class Test: DB dbReturn</a></div>';
|
||||
print '<div><a href="class_test.colors.php">Class Test: COLORS</a></div>';
|
||||
print '<div><a href="class_test.convert.colors.php">Class Test: CONVERT COLORS</a></div>';
|
||||
print '<div><a href="class_test.check.colors.php">Class Test: CHECK COLORS</a></div>';
|
||||
print '<div><a href="class_test.mime.php">Class Test: MIME</a></div>';
|
||||
print '<div><a href="class_test.json.php">Class Test: JSON</a></div>';
|
||||
print '<div><a href="class_test.token.php">Class Test: FORM TOKEN</a></div>';
|
||||
|
||||
@@ -690,6 +690,7 @@ class Login
|
||||
// rgb(), rgba(), hsl(), hsla()
|
||||
// rgb: nnn.n for each
|
||||
// hsl: nnn.n for first, nnn.n% for 2nd, 3rd
|
||||
// Check\Colors::validateColor()
|
||||
$_SESSION['LANG'] = $res['locale'] ?? 'en';
|
||||
$_SESSION['DEFAULT_CHARSET'] = $res['encoding'] ?? 'UTF-8';
|
||||
$_SESSION['DEFAULT_LOCALE'] = $_SESSION['LANG']
|
||||
|
||||
187
www/lib/CoreLibs/Check/Colors.php
Normal file
187
www/lib/CoreLibs/Check/Colors.php
Normal file
@@ -0,0 +1,187 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* valid checks for css/html based colors
|
||||
* # hex
|
||||
* # hex + alpha
|
||||
* rgb
|
||||
* rgba
|
||||
* hsl
|
||||
* hsla
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace CoreLibs\Check;
|
||||
|
||||
use Exception;
|
||||
|
||||
class Colors
|
||||
{
|
||||
/** @var int 1 for HEX rgb */
|
||||
public const HEX_RGB = 1;
|
||||
/** @var int 2 for HEX rgb with alpha */
|
||||
public const HEX_RGBA = 2;
|
||||
/** @var int 4 for rgb() */
|
||||
public const RGB = 4;
|
||||
/** @var int 8 for rgba() */
|
||||
public const RGBA = 8;
|
||||
/** @var int 16 for hsl() */
|
||||
public const HSL = 16;
|
||||
/** @var int 32 for hsla() */
|
||||
public const HSLA = 32;
|
||||
/** @var int 63 for all bits set (sum of above) */
|
||||
public const ALL = 63;
|
||||
|
||||
/**
|
||||
* check rgb/hsl content values in detail
|
||||
* will abort and return false on first error found
|
||||
*
|
||||
* @param string $color html/css tring to check
|
||||
* @param int|false $rgb_flag flag to check for rgb
|
||||
* @param int|false $hsl_flag flag to check for hsl type
|
||||
* @return bool True if no error, False if error
|
||||
*/
|
||||
private static function rgbHslContentCheck(string $color, $rgb_flag, $hsl_flag): bool
|
||||
{
|
||||
// extract string between () and split into elements
|
||||
preg_match("/\((.*)\)/", $color, $matches);
|
||||
if (
|
||||
!is_array($color_list = preg_split("/,\s*/", $matches[1] ?? ''))
|
||||
) {
|
||||
throw new \Exception("Could not extract color list from rgg/hsl", 3);
|
||||
}
|
||||
// based on rgb/hsl settings check that entries are valid
|
||||
// rgb: either 0-255 OR 0-100%
|
||||
// hsl: first: 0-360
|
||||
foreach ($color_list as $pos => $color_check) {
|
||||
if (empty($color_check)) {
|
||||
return false;
|
||||
}
|
||||
$percent_check = false;
|
||||
if (strrpos($color_check, '%', -1) !== false) {
|
||||
$percent_check = true;
|
||||
$color_check = str_replace('%', '', $color_check);
|
||||
}
|
||||
// first three normal percent or valid number
|
||||
if ($rgb_flag !== false) {
|
||||
if ($percent_check === true) {
|
||||
// for ALL pos
|
||||
if ($color_check < 0 || $color_check > 100) {
|
||||
return false;
|
||||
}
|
||||
} elseif (
|
||||
$pos < 3 &&
|
||||
($color_check < 0 || $color_check > 255)
|
||||
) {
|
||||
return false;
|
||||
} elseif (
|
||||
// RGBA set pos 3 if not percent
|
||||
$pos == 3 &&
|
||||
($color_check < 0 || $color_check > 1)
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
} elseif ($hsl_flag !== false) {
|
||||
// pos 0: 0-360
|
||||
// pos 1,2: %
|
||||
// pos 3: % or 0-1 (float)
|
||||
if (
|
||||
$pos == 0 &&
|
||||
($color_check < 0 || $color_check > 360)
|
||||
) {
|
||||
return false;
|
||||
} elseif (
|
||||
// if pos 1/2 are not percent
|
||||
($pos == 1 || $pos == 2) &&
|
||||
($percent_check != true ||
|
||||
($color_check < 0 || $color_check > 100))
|
||||
) {
|
||||
return false;
|
||||
} elseif (
|
||||
// 3 is either percent or 0~1
|
||||
$pos == 3 &&
|
||||
(
|
||||
($percent_check == false &&
|
||||
($color_check < 0 || $color_check > 1)) ||
|
||||
($percent_check === true &&
|
||||
($color_check < 0 || $color_check > 100))
|
||||
)
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* check if html/css color string is valid
|
||||
* @param string $color A color string of any format
|
||||
* @param int $flags defaults to ALL, else use | to combined from
|
||||
* HEX_RGB, HEX_RGBA, RGB, RGBA, HSL, HSLA
|
||||
* @return bool True if valid, False if not
|
||||
* @throws Exception 1: no valid flag set
|
||||
*/
|
||||
public static function validateColor(string $color, int $flags = self::ALL): bool
|
||||
{
|
||||
// blocks for each check
|
||||
$regex_blocks = [];
|
||||
// set what to check
|
||||
if ($flags & self::HEX_RGB) {
|
||||
$regex_blocks[] = '#[\dA-Fa-f]{6}';
|
||||
}
|
||||
if ($flags & self::HEX_RGBA) {
|
||||
$regex_blocks[] = '#[\dA-Fa-f]{8}';
|
||||
}
|
||||
if ($flags & self::RGB) {
|
||||
$regex_blocks[] = 'rgb\(\d{1,3}%?,\s*\d{1,3}%?,\s*\d{1,3}%?\)';
|
||||
}
|
||||
if ($flags & self::RGBA) {
|
||||
$regex_blocks[] = 'rgba\(\d{1,3}%?,\s*\d{1,3}%?,\s*\d{1,3}%?(,\s*(0\.\d{1,2}|1(\.0)?|\d{1,3}%))?\)';
|
||||
}
|
||||
if ($flags & self::HSL) {
|
||||
$regex_blocks[] = 'hsl\(\d{1,3},\s*\d{1,3}(\.\d{1})?%,\s*\d{1,3}(\.\d{1})?%\)';
|
||||
}
|
||||
if ($flags & self::HSLA) {
|
||||
$regex_blocks[] = 'hsla\(\d{1,3},\s*\d{1,3}(\.\d{1})?%,\s*\d{1,3}'
|
||||
. '(\.\d{1})?%(,\s*(0\.\d{1,2}|1(\.0)?|\d{1,3}%))?\)';
|
||||
}
|
||||
// wrong flag set
|
||||
if ($flags > self::ALL) {
|
||||
throw new \Exception("Invalid flags parameter: $flags", 1);
|
||||
}
|
||||
if (!count($regex_blocks)) {
|
||||
throw new \Exception("No regex blocks set: $flags", 2);
|
||||
}
|
||||
|
||||
// build regex
|
||||
$regex = '^('
|
||||
. join('|', $regex_blocks)
|
||||
// close regex
|
||||
. ')$';
|
||||
// print "C: $color, F: $flags, R: $regex\n";
|
||||
|
||||
if (preg_match("/$regex/", $color)) {
|
||||
// if valid regex, we now need to check if the content is actually valid
|
||||
// only for rgb/hsl type
|
||||
/** @var int|false */
|
||||
$rgb_flag = strpos($color, 'rgb');
|
||||
/** @var int|false */
|
||||
$hsl_flag = strpos($color, 'hsl');
|
||||
// if both not match, return true
|
||||
if (
|
||||
$rgb_flag === false &&
|
||||
$hsl_flag === false
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
// run detaul rgb/hsl content check
|
||||
return self::rgbHslContentCheck($color, $rgb_flag, $hsl_flag);
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// __END__
|
||||
1
www/vendor/composer/autoload_classmap.php
vendored
1
www/vendor/composer/autoload_classmap.php
vendored
@@ -12,6 +12,7 @@ return array(
|
||||
'CoreLibs\\Admin\\Backend' => $baseDir . '/lib/CoreLibs/Admin/Backend.php',
|
||||
'CoreLibs\\Admin\\EditBase' => $baseDir . '/lib/CoreLibs/Admin/EditBase.php',
|
||||
'CoreLibs\\Basic' => $baseDir . '/lib/CoreLibs/Basic.php',
|
||||
'CoreLibs\\Check\\Colors' => $baseDir . '/lib/CoreLibs/Check/Colors.php',
|
||||
'CoreLibs\\Check\\Email' => $baseDir . '/lib/CoreLibs/Check/Email.php',
|
||||
'CoreLibs\\Check\\Encoding' => $baseDir . '/lib/CoreLibs/Check/Encoding.php',
|
||||
'CoreLibs\\Check\\File' => $baseDir . '/lib/CoreLibs/Check/File.php',
|
||||
|
||||
1
www/vendor/composer/autoload_static.php
vendored
1
www/vendor/composer/autoload_static.php
vendored
@@ -45,6 +45,7 @@ class ComposerStaticInit10fe8fe2ec4017b8644d2b64bcf398b9
|
||||
'CoreLibs\\Admin\\Backend' => __DIR__ . '/../..' . '/lib/CoreLibs/Admin/Backend.php',
|
||||
'CoreLibs\\Admin\\EditBase' => __DIR__ . '/../..' . '/lib/CoreLibs/Admin/EditBase.php',
|
||||
'CoreLibs\\Basic' => __DIR__ . '/../..' . '/lib/CoreLibs/Basic.php',
|
||||
'CoreLibs\\Check\\Colors' => __DIR__ . '/../..' . '/lib/CoreLibs/Check/Colors.php',
|
||||
'CoreLibs\\Check\\Email' => __DIR__ . '/../..' . '/lib/CoreLibs/Check/Email.php',
|
||||
'CoreLibs\\Check\\Encoding' => __DIR__ . '/../..' . '/lib/CoreLibs/Check/Encoding.php',
|
||||
'CoreLibs\\Check\\File' => __DIR__ . '/../..' . '/lib/CoreLibs/Check/File.php',
|
||||
|
||||
Reference in New Issue
Block a user