Update with get address method and utf8 bom replacer

Release: v9.14.0
HTML::htmlent and HTML::checked method updates
2024-09-03 12:12:11 +09:00 · 2024-08-05 13:34:05 +09:00 · 2024-08-05 13:28:11 +09:00 · 2024-07-29 16:34:07 +09:00 · 2024-07-29 16:32:45 +09:00 · 2024-07-29 16:14:37 +09:00
11 changed files with 153 additions and 27 deletions
--- a/publish/last.published
+++ b/publish/last.published
@@ -1 +1 @@
-9.13.0
+9.14.0
--- a/src/Convert/Html.php
+++ b/src/Convert/Html.php
@@ -16,16 +16,22 @@ class Html
 	/**
 	 * full wrapper for html entities
 	 *
+	 * uses default params as: ENT_QUOTES | ENT_HTML5
+	 * switches from ENT_HTML401 to ENT_HTML5 as we assume all our pages have <!DOCTYPE html>
+	 * removed: ENT_SUBSTITUTE -> wrong characters will be replaced with space
+	 * encodes in UTF-8
+	 * does not double encode
+	 *
 	 * @param  mixed $string string to html encode
+	 * @param  int   $flags [default: ENT_QUOTES | ENT_HTML5]
 	 * @return mixed         if string, encoded, else as is (eg null)
 	 */
-	public static function htmlent(mixed $string): mixed
+	public static function htmlent(mixed $string, int $flags = ENT_QUOTES | ENT_HTML5): mixed
 	{
 		if (is_string($string)) {
-			return htmlentities($string, ENT_COMPAT | ENT_HTML401, 'UTF-8', false);
-		} else {
-			return $string;
+			return htmlentities($string, $flags, 'UTF-8', false);
 		}
+		return $string;
 	}

 	/**
@@ -54,14 +60,10 @@ class Html
 	 */
 	public static function checked(array|string $haystack, string $needle, int $type = 0): ?string
 	{
-		if (is_array($haystack)) {
-			if (in_array($needle, $haystack)) {
-				return $type ? 'checked' : 'selected';
-			}
-		} else {
-			if ($haystack == $needle) {
-				return $type ? 'checked' : 'selected';
-			}
+		if (is_array($haystack) && in_array($needle, $haystack)) {
+			return $type ? 'checked' : 'selected';
+		} elseif (!is_array($haystack) && $haystack == $needle) {
+			return $type ? 'checked' : 'selected';
 		}
 		return null;
 	}
--- a/src/Convert/Strings.php
+++ b/src/Convert/Strings.php
@@ -134,6 +134,18 @@ class Strings
 			$path
 		) ?? $path;
 	}
+
+	/**
+	 * Remove UTF8 BOM Byte string from line
+	 * Note: this is often found in CSV files exported from Excel at the first row, first element
+	 *
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function stripUTF8BomBytes(string $text): string
+	{
+		return trim($text, pack('H*', 'EFBBBF'));
+	}
 }

 // __END__
--- a/src/DB/IO.php
+++ b/src/DB/IO.php
@@ -1324,8 +1324,12 @@ class IO
 		// /s for matching new line in . list
 		// [disabled, we don't used ^ or $] /m for multi line match
 		// Matches in 1:, must be array_filtered to remove empty, count with array_unique
+		$query_split = '[(=,?-]|->|->>|#>|#>>|@>|<@|\?\|\?\&|\|\||#-';
 		preg_match_all(
-			'/(?:\'.*?\')?\s*(?:\?\?|<>|[(=,])\s*(?:\d+|(?:\'.*?\')|(\$[1-9]{1}(?:[0-9]{1,})?))/s',
+			'/'
+			. '(?:\'.*?\')?\s*(?:\?\?|<>|' . $query_split . ')\s*'
+			. '(?:\d+|(?:\'.*?\')|(\$[1-9]{1}(?:[0-9]{1,})?))'
+			. '/s',
 			$query,
 			$match
 		);
@@ -2398,7 +2402,7 @@ class IO
 				// flag if we have cache data stored at the moment
 				'cached' => false,
 				// when fetch array or cache read returns false
-				// in loop read that means dbReturn retuns false without erro
+				// in loop read that means dbReturn retuns false without error
 				'finished' => false,
 				 // read from cache/db (pos == rows)
 				'read_finished' => false,
--- a/src/Get/System.php
+++ b/src/Get/System.php
@@ -116,6 +116,29 @@ class System
 			3
 		) === 'cli' ? true : false;
 	}
+
+	/**
+	 * Collect all IP addresses
+	 * REMOTE_ADDR, HTTP_X_FORWARD_FOR, CLIENT_IP
+	 * and retuns them in an array with index of io source
+	 * if address source has addresses with "," will add "-array" with these as array block
+	 *
+	 * @return array<string,string|array<string>>
+	 */
+	public static function getIpAddresses(): array
+	{
+		$ip_addr = [];
+		foreach (['REMOTE_ADDR', 'HTTP_X_FORWARDED_FOR', 'CLIENT_IP'] as $_ip_source) {
+			if (!empty($_SERVER[$_ip_source])) {
+				$ip_addr[$_ip_source] = $_SERVER[$_ip_source];
+				// same level as ARRAY IF there is a , inside
+				if (strstr($_SERVER[$_ip_source], ',') !== false) {
+					$ip_addr[$_ip_source . '-array'] = explode(',', $_SERVER[$_ip_source]);
+				}
+			}
+		}
+		return $ip_addr;
+	}
 }

 // __END__
--- a/src/Template/HtmlBuilder/Block.php
+++ b/src/Template/HtmlBuilder/Block.php
@@ -19,7 +19,7 @@ use CoreLibs\Template\HtmlBuilder\General\HtmlBuilderExcpetion;
 class Block
 {
 	/**
-	 * Undocumented function
+	 * Create Element
 	 *
 	 * @param  string $tag
 	 * @param  string $id
@@ -86,7 +86,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Add multiple elements to the base element
 	 *
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $base
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} ...$attach
@@ -101,7 +101,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Add multiple sub elements to the base element
 	 *
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $sub
@@ -117,7 +117,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Remove all sub element entries
 	 *
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
 	 * @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
@@ -131,7 +131,7 @@ class Block
 	// CSS Elements

 	/**
-	 * Undocumented function
+	 * Add css entry to the css entries
 	 *
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
 	 * @param  string ...$css
@@ -144,7 +144,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Remove a css entry entry from the css array
 	 *
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
 	 * @param  string ...$css
@@ -157,7 +157,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Switch CSS entries
 	 * scssel (switch) is not supported
 	 * use rcssel -> acssel
 	 *
@@ -175,7 +175,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Build HTML from the content tree
 	 * alias phfo
 	 *
 	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $tree
@@ -231,7 +231,19 @@ class Block
 	}

 	/**
-	 * Undocumented function
+	 * Alias for phfo
+	 *
+	 * @param  array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $tree
+	 * @param  bool         $add_nl [default=false]
+	 * @return string
+	 */
+	public static function phfo(array $tree, bool $add_nl = false): string
+	{
+		return self::buildHtml($tree, $add_nl);
+	}
+
+	/**
+	 * Build HTML elements from an array of elements
 	 * alias phfa
 	 *
 	 * @param  array<array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}> $list
@@ -248,8 +260,7 @@ class Block
 	}

 	/**
-	 * Undocumented function
-	 * wrapper for buildHtmlFromList
+	 * alias for buildHtmlFromList
 	 *
 	 * @param  array<array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}> $list                   array of Elements to build string from
 	 * @param  bool           $add_nl [default=false] Optional output string line break
--- a/src/Template/SmartyExtend.php
+++ b/src/Template/SmartyExtend.php
@@ -203,7 +203,8 @@ class SmartyExtend extends \Smarty
 		_bind_textdomain_codeset($this->domain, $this->encoding);

 		// register smarty variable
-		$this->registerPlugin('modifier', 'getvar', [&$this, 'getTemplateVars']);
+		// $this->registerPlugin(\Smarty\Smarty::PLUGIN_MODIFIER, 'getvar', [&$this, 'getTemplateVars']);
+		$this->registerPlugin(self::PLUGIN_MODIFIER, 'getvar', [&$this, 'getTemplateVars']);

 		$this->page_name = \CoreLibs\Get\System::getPageName();

--- a/test/phpunit/Convert/CoreLibsConvertStringsTest.php
+++ b/test/phpunit/Convert/CoreLibsConvertStringsTest.php
@@ -13,6 +13,8 @@ use PHPUnit\Framework\TestCase;
 */
 final class CoreLibsConvertStringsTest extends TestCase
 {
+	private const DATA_FOLDER = __DIR__ . DIRECTORY_SEPARATOR . 'data' . DIRECTORY_SEPARATOR;
+
 	/**
 	 * Undocumented function
 	 *
@@ -330,6 +332,52 @@ final class CoreLibsConvertStringsTest extends TestCase
 			\CoreLibs\Convert\Strings::stripMultiplePathSlashes($input)
 		);
 	}
+
+	/**
+	 * Undocumented function
+	 *
+	 * @return array
+	 */
+	public function providerStripUTF8BomBytes(): array
+	{
+		return [
+			"utf8-bom" => [
+				"file" => "UTF8BOM.csv",
+				"expect" => "Asset Type,Epic,File Name\n",
+			],
+			"utf8" => [
+				"file" => "UTF8.csv",
+				"expect" => "Asset Type,Epic,File Name\n",
+			],
+		];
+	}
+
+	/**
+	 * test utf8 bom remove
+	 *
+	 * @covers ::stripUTF8BomBytes
+	 * @dataProvider providerStripUTF8BomBytes
+	 * @testdox stripUTF8BomBytes $file will be $expected [$_dataName]
+	 *
+	 * @param  string $file
+	 * @param  string $expected
+	 * @return void
+	 */
+	public function testStripUTF8BomBytes(string $file, string $expected): void
+	{
+		// load sample file
+		if (!is_file(self::DATA_FOLDER . $file)) {
+			$this->markTestSkipped('File: ' . $file . ' could not be opened');
+		}
+		$file = file_get_contents(self::DATA_FOLDER . $file);
+		if ($file === false) {
+			$this->markTestSkipped('File: ' . $file . ' could not be read');
+		}
+		$this->assertEquals(
+			$expected,
+			\CoreLibs\Convert\Strings::stripUTF8BomBytes($file)
+		);
+	}
 }

 // __END__
--- a/test/phpunit/Convert/data/UTF8.csv
+++ b/test/phpunit/Convert/data/UTF8.csv
@@ -0,0 +1 @@
+Asset Type,Epic,File Name
--- a/test/phpunit/Convert/data/UTF8BOM.csv
+++ b/test/phpunit/Convert/data/UTF8BOM.csv
@@ -0,0 +1 @@
+Asset Type,Epic,File Name
--- a/test/phpunit/Get/CoreLibsGetSystemTest.php
+++ b/test/phpunit/Get/CoreLibsGetSystemTest.php
@@ -216,6 +216,29 @@ final class CoreLibsGetSystemTest extends TestCase
 			);
 		}
 	}
+
+	/**
+	 * Undocumented function
+	 *
+	 * @covers ::getIpAddresses
+	 * @testdox getIpAddresses check
+	 *
+	 * @return void
+	 */
+	public function testGetIpAddresses()
+	{
+		// response must have "REMOTE_ADDR" entry, others are optional
+		// NOTE: we have no IP addresses on command line
+		$this->assertTrue(
+			true,
+			"We do not have REMOTE_ADDR on command line"
+		);
+		// $this->assertContains(
+		// 	'REMOTE_ADDR',
+		// 	array_keys(\CoreLibs\Get\System::getIpAddresses()),
+		// 	'failed REMOTE_ADDR assert'
+		// );
+	}
 }

 // __END__
Author	SHA1	Message	Date
Clemens Schwaighofer	561be4bce6	Update with get address method and utf8 bom replacer	2024-09-03 12:12:11 +09:00
Clemens Schwaighofer	51fef30364	Release: v9.14.0	2024-08-05 13:34:05 +09:00
Clemens Schwaighofer	89a4b4cf3e	HTML::htmlent and HTML::checked method updates	2024-08-05 13:28:11 +09:00
Clemens Schwaighofer	3eb1229590	Release: v9.13.2	2024-07-29 16:34:07 +09:00
Clemens Schwaighofer	f174e9ec34	DB-IO fix for JSON/JSONB operators when checking for placeholders	2024-07-29 16:32:45 +09:00
Clemens Schwaighofer	928369cff7	Release: v9.13.1	2024-07-29 16:14:37 +09:00
@@ -1 +1 @@
 .13.0
 .14.0