Update DB\IO with fixed regex for query params detection

.phan/config.php

@@ -360,10 +360,7 @@ return [
 	'directory_list' => [
 		'src',
 		'vendor/egrajp/smarty-extended/src',
-		'vendor/phan/phan/src/Phan',
-		'vendor/phpunit/phpunit/src',
 		'vendor/psr/log/src',
-		'vendor/vimeo/psalm/src/Psalm',
 		'vendor/gullevek/dotenv',
 	],
 

.phive/phars.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phive xmlns="https://phar.io/phive">
+  <phar name="phpunit" version="^9.6" installed="9.6.13" location="./tools/phpunit" copy="false"/>
+  <phar name="phpcs" version="^3.7.2" installed="3.7.2" location="./tools/phpcs" copy="false"/>
+  <phar name="phpcbf" version="^3.7.2" installed="3.7.2" location="./tools/phpcbf" copy="false"/>
+  <phar name="psalm" version="^5.15.0" installed="5.15.0" location="./tools/psalm" copy="false"/>
+  <phar name="phpstan" version="^1.10.37" installed="1.10.37" location="./tools/phpstan" copy="false"/>
+  <phar name="phan" version="^5.4.2" installed="5.4.2" location="./tools/phan" copy="false"/>
+</phive>

ReadMe.md

@@ -23,3 +23,21 @@ Alternative setup composer local zip file repot:
 ## Install package
 
 `composer require egrajp/corelibs-composer-all:^8.0`
+
+## Tests
+
+All tests must be run from the base folder
+
+### phan
+
+`phan --progress-bar -C --analyze-twic`
+
+### phpstan
+
+`phpstan`
+
+### phpunit
+
+PHP unit is installed via "phiev"
+
+`tools/phpunit test/phpunit`

composer.json

@@ -20,11 +20,7 @@
         "psr/log": "^3.0@dev"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.10",
-        "phan/phan": "v5.x-dev",
-        "phpunit/phpunit": "^9",
         "egrajp/smarty-extended": "^4.3",
-        "vimeo/psalm": "^5.0@dev",
         "gullevek/dotenv": "dev-master"
     },
     "repositories": {

phpunit.xml

@@ -2,5 +2,6 @@
 	cacheResultFile="/tmp/phpunit-corelibs-composer.result.cache"
 	colors="true"
 	verbose="true"
+	bootstrap="test/phpunit/bootstrap.php"
 >
 </phpunit>

publish/last.published

@@ -1 +1 @@
-9.7.8
+9.8.1

src/DB/IO.php

@@ -281,12 +281,6 @@ class IO
 	public const NO_CACHE = 3;
 	/** @var string default hash type */
 	public const ERROR_HASH_TYPE = 'adler32';
-	/**
-	 * @var string regex for params: only stand alone $number allowed
-	 *             never allowed to start with '
-	 *             must be after space/tab, =, (
-	*/
-	public const REGEX_PARAMS = '/[^\'][\s(=](\$[0-9]{1,})/';
 	/** @var string regex to get returning with matches at position 1 */
 	public const REGEX_RETURNING = '/\s+returning\s+(.+\s*(?:.+\s*)+);?$/i';
 	// REGEX_SELECT
@@ -1264,6 +1258,32 @@ class IO
 		return $return;
 	}
 
+	/**
+	 * count $ leading parameters only
+	 *
+	 * @param  string $query Query to check
+	 * @return int           Number of parameters found
+	 */
+	private function __dbCountQueryParams(string $query): int
+	{
+		$match = [];
+		// regex for params: only stand alone $number allowed
+		// exclude all '' enclosed strings, ignore all numbers [note must start with digit]
+		// can have space/tab/new line
+		// must have = , ( [equal, comma, opening round bracket]
+		// can have space/tab/new line
+		// $ number with 1-9 for first and 0-9 for further digits
+		// /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
+		preg_match_all(
+			'/(?:\'.*?\')?\s*(?:\?\?|[(=,])\s*(?:\d+|(?:\'.*?\')|(\$[1-9]{1}(?:[0-9]{1,})?))/s',
+			$query,
+			$match
+		);
+		return count(array_unique(array_filter($match[1])));
+	}
+
 	/**
 	 * Checks if the placeholder count in the query matches the params given
 	 * on call
@@ -1274,10 +1294,7 @@ class IO
 	 */
 	private function __dbCheckQueryParams(string $query, int $params_count): bool
 	{
-		// search for $1, $2, in the query and push it into the control array
-		// skip counts for same eg $1, $1, $2 = 2 and not 3
-		preg_match_all(self::REGEX_PARAMS, $query, $match);
-		$placeholder_count = count(array_unique($match[1]));
+		$placeholder_count = $this->__dbCountQueryParams($query);
 		if ($params_count != $placeholder_count) {
 			$this->__dbError(
 				23,
@@ -1384,6 +1401,9 @@ class IO
 		) {
 			$this->returning_id = true;
 		}
+		// import protection, hash needed
+		$query_hash = $this->dbGetQueryHash($this->query, $this->params);
+
 		// $this->debug('DB IO', 'Q: ' . $this->query . ', RETURN: ' . $this->returning_id);
 		// for DEBUG, only on first time ;)
 		$this->__dbDebug(
@@ -1395,8 +1415,6 @@ class IO
 			'__dbPrepareExec',
 			($this->params === [] ? 'Q' : 'Qp')
 		);
-		// import protection, hash needed
-		$query_hash = $this->dbGetQueryHash($this->query, $this->params);
 		// if the array index does not exists set it 0
 		if (!array_key_exists($query_hash, $this->query_called)) {
 			$this->query_called[$query_hash] = 0;
@@ -2943,11 +2961,8 @@ class IO
 					$this->prepare_cursor[$stm_name]['pk_name'] = $pk_name;
 				}
 			}
-			$match = [];
-			// search for $1, $2, in the query and push it into the control array
-			// skip counts for same eg $1, $1, $2 = 2 and not 3
-			preg_match_all(self::REGEX_PARAMS, $query, $match);
-			$this->prepare_cursor[$stm_name]['count'] = count(array_unique($match[1]));
+			// check prepared curser parameter count
+			$this->prepare_cursor[$stm_name]['count'] = $this->__dbCountQueryParams($query);
 			$this->prepare_cursor[$stm_name]['query'] = $query;
 			$result = $this->db_functions->__dbPrepare($stm_name, $query);
 			if ($result) {

src/Logging/ErrorMessage.php

@@ -17,6 +17,8 @@ class ErrorMessage
 {
 	/** @var array<int,array{id:string,level:string,str:string,target:string,target_style:string,highlight:string[]}> */
 	private array $error_str = [];
+	/** @var array<string,array{info:string,level:string}> */
+	private array $jump_targets = [];
 	/** @var \CoreLibs\Logging\Logging $log */
 	public \CoreLibs\Logging\Logging $log;
 
@@ -61,6 +63,8 @@ class ErrorMessage
 	 *                   highlight is a list of other target points to highlight
 	 *                   for highlight targets css names are $level without a prefix and should be
 	 *                   nested in the target element "input .error { ... }"
+	 * jump_target: a target id for to jump and message, is stored in separate jump array
+	 *              where the target is unique, first one set is used for info message
 	 * target_style: if not set uses 'error-' $level as css style. applies to targets or main only
 	 *
 	 * @param  string        $error_id     Any internal error ID for this error
@@ -70,6 +74,9 @@ class ErrorMessage
 	 * @param  string        $target_style Alternate color style for the error message
 	 * @param  array<string> $highlight    Any additional error data as error OR
 	 *                                     highlight points for field highlights
+	 * @param  array{}|array{target:string,info?:string} $jump_target with "target" for where to jump and
+	 *                                     "info" for string to show in jump list
+	 *                                     target must be set, if info not set, default message used
 	 * @param  string|null   $message      If abort/crash, non localized $str
 	 * @param  array<mixed>  $context      Additionl info for abort/crash messages
 	 * @param  bool|null     $log_error    [=null] log level 'error' to error, if null use global,
@@ -82,6 +89,7 @@ class ErrorMessage
 		string $target = '',
 		string $target_style = '',
 		array $highlight = [],
+		array $jump_target = [],
 		?string $message = null,
 		array $context = [],
 		?bool $log_error = null,
@@ -103,6 +111,8 @@ class ErrorMessage
 			'target_style' => $target_style,
 			'highlight' => $highlight,
 		];
+		// set a jump target
+		$this->setJumpTarget($jump_target['target'] ?? null, $jump_target['info'] ?? null, $level);
 		// write to log for abort/crash
 		switch ($level) {
 			case 'notice':
@@ -152,6 +162,9 @@ class ErrorMessage
 	 * @param  string        $target_style Alternate color style for the error message
 	 * @param  array<string> $highlight    Any additional error data as error OR
 	 *                                     highlight points for field highlights
+	 * @param  array{}|array{target:string,info?:string} $jump_target with "target" for where to jump and
+	 *                                     "info" for string to show in jump list
+	 *                                     target must be set, if info not set, default message used
 	 * @param  string|null   $message      If abort/crash, non localized $str
 	 * @param  array<mixed>  $context      Additionl info for abort/crash messages
 	 * @param  bool|null     $log_error    [=null] log level 'error' to error, if null use global,
@@ -164,6 +177,7 @@ class ErrorMessage
 		string $target = '',
 		string $target_style = '',
 		array $highlight = [],
+		array $jump_target = [],
 		?string $message = null,
 		array $context = [],
 		?bool $log_error = null,
@@ -175,12 +189,45 @@ class ErrorMessage
 			$target,
 			$target_style,
 			$highlight,
+			$jump_target,
 			$message,
 			$context,
 			$log_error
 		);
 	}
 
+	/**
+	 * Set a jump target. This can be used to jump directly a frontend html block
+	 * with the target id set
+	 *
+	 * @param  string|null $target
+	 * @param  string|null $info
+	 * @param  string      $level [='error']
+	 * @return void
+	 */
+	public function setJumpTarget(
+		?string $target,
+		?string $info,
+		string $level = 'error',
+	): void {
+		if (
+			empty($target) ||
+			array_key_exists($target, $this->jump_targets)
+			// !empty($this->jump_targets[$target])
+			// also check if this is an alphanumeric string? css id compatible?
+		) {
+			return;
+		}
+		if (empty($info)) {
+			$info = 'Jump to: ' . $target;
+		}
+		$level = MessageLevel::fromName($level)->name;
+		$this->jump_targets[$target] = [
+			'info' => $info,
+			'level' => $level,
+		];
+	}
+
 	// *********************************************************************
 	// GETTERS
 	// *********************************************************************
@@ -223,6 +270,26 @@ class ErrorMessage
 		];
 	}
 
+	/**
+	 * Return the jump target list
+	 *
+	 * @return array{}|array<int,array{target:string,info:string,level:string}> List of jump targets with info text,
+	 *                                                                          or empty array if not set
+	 */
+	public function getJumpTarget(): array
+	{
+		$_jump_target = [];
+		foreach ($this->jump_targets as $target => $jump) {
+			$_jump_target[] = array_merge(
+				$jump,
+				[
+					'target' => $target,
+				]
+			);
+		}
+		return $_jump_target;
+	}
+
 	// *********************************************************************
 	// FLAG SETTERS
 	// *********************************************************************

test/phpunit/DB/CoreLibsDBIOTest.php

@@ -3907,7 +3907,8 @@ final class CoreLibsDBIOTest extends TestCase
 					'id' => '51',
 					'error' => 'Max query call needs to be set to at least 1',
 					// run:: can be +1 if called in set and not direct
-					'source' => "/^include::main::run::run::run::run::run::run::(run::)?runBare::runTest::testDbErrorHandling::dbSetMaxQueryCall$/",
+					// 'main::run::run::run::run::run::run::run::runBare::runTest::testDbErrorHandling::dbSetMaxQueryCall
+					'source' => "/^(include::)?main::(run::)+runBare::runTest::testDbErrorHandling::dbSetMaxQueryCall$/",
 					'pg_error' => '',
 					'msg' => '',
 				]

test/phpunit/Debug/CoreLibsDebugSupportTest.php

@@ -460,8 +460,8 @@ final class CoreLibsDebugSupportTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @cover ::getCallerFileLine
-	 * @testWith ["vendor/phpunit/phpunit/src/Framework/TestCase.php:"]
-	 * @testdox getCallerFileLine check based on regex /[\w\-\/]/vendor/phpunit/phpunit/src/Framework/TestCase.php:\d+ [$_dataName]
+	 * @testWith ["vendor/phpunit/phpunit/src/Framework/TestCase.php:6434","phar:///home/clemens/.phive/phars/phpunit-9.6.13.phar/phpunit/Framework/TestCase.php:6434"]
+	 * @testdox getCallerFileLine check based on regex .../Framework/TestCase.php:\d+ [$_dataName]
 	 *
 	 * @param  string $expected
 	 * @return void
@@ -469,7 +469,14 @@ final class CoreLibsDebugSupportTest extends TestCase
 	public function testGetCallerFileLine(): void
 	{
 		// regex prefix with path "/../" and then fixed vendor + \d+
-		$regex = "/^\/[\w\-\/]+\/vendor\/phpunit\/phpunit\/src\/Framework\/TestCase.php:\d+$/";
+		// or phar start if phiev installed
+		// phar:///home/clemens/.phive/phars/phpunit-9.6.13.phar/phpunit/Framework/TestCase.php
+		$regex = "/^("
+			. "\/.*\/vendor\/phpunit\/phpunit\/src"
+			. "|"
+			. "phar:\/\/\/.*\.phive\/phars\/phpunit-\d+\.\d+\.\d+\.phar\/phpunit"
+			. ")"
+			. "\/Framework\/TestCase.php:\d+$/";
 		$this->assertMatchesRegularExpression(
 			$regex,
 			Support::getCallerFileLine()
@@ -514,27 +521,30 @@ final class CoreLibsDebugSupportTest extends TestCase
 				// add nothing
 				$this->assertEquals(
 					$expected,
-					Support::getCallerMethodList(),
+					$compare,
 					'assert expected 10'
 				);
 				break;
 			case 11:
-				// add one "run" before "runBare"
-				// array_splice(
-				// 	$expected,
-				// 	7,
-				// 	0,
-				// 	['run']
-				// );
-				array_splice(
-					$expected,
-					0,
-					0,
-					['include']
-				);
+				if ($compare[0] == 'include') {
+					// add include at first
+					array_splice(
+						$expected,
+						0,
+						0,
+						['include']
+					);
+				} else {
+					array_splice(
+						$expected,
+						6,
+						0,
+						['run']
+					);
+				}
 				$this->assertEquals(
 					$expected,
-					Support::getCallerMethodList(),
+					$compare,
 					'assert expected 11'
 				);
 				break;
@@ -554,7 +564,7 @@ final class CoreLibsDebugSupportTest extends TestCase
 				);
 				$this->assertEquals(
 					$expected,
-					Support::getCallerMethodList(),
+					$compare,
 					'assert expected 12'
 				);
 				break;

test/phpunit/Get/CoreLibsGetSystemTest.php

@@ -99,7 +99,7 @@ final class CoreLibsGetSystemTest extends TestCase
 				1 => 'phpunit',
 				2 => 'phpunit',
 				// NOTE: this can change, so it is a regex check
-				3 => "/^(\/?.*\/?)?vendor\/bin\/phpunit$/",
+				3 => "/^(\/?.*\/?)?(vendor\/bin|tools)\/phpunit$/",
 			],
 			'some path with extension' => [
 				0 => '/some/path/to/file.txt',

test/phpunit/Logging/CoreLibsLoggingErrorMessagesTest.php

@@ -421,6 +421,84 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 			);
 		}
 	}
+
+	/**
+	 * Undocumented function
+	 *
+	 * @testdox Test jump target set and reporting
+	 *
+	 * @return void
+	 */
+	public function testJumpTarget(): void
+	{
+		$log = new \CoreLibs\Logging\Logging([
+			'log_file_id' => 'testErrorMessagesLogDebug',
+			'log_folder' => self::LOG_FOLDER,
+			'log_level' => Level::Debug,
+			'log_per_run' => true
+		]);
+		$em = new \CoreLibs\Logging\ErrorMessage($log);
+		$em->setJumpTarget(
+			'target-f',
+			'Target text'
+		);
+		$this->assertEquals(
+			[
+				['target' => 'target-f', 'info' => 'Target text', 'level' => 'error']
+			],
+			$em->getJumpTarget()
+		);
+		// set same target, keep as before
+		$em->setJumpTarget(
+			'target-f',
+			'Other text'
+		);
+		$this->assertEquals(
+			[
+				['target' => 'target-f', 'info' => 'Target text', 'level' => 'error']
+			],
+			$em->getJumpTarget()
+		);
+		// add new now two messages
+		$em->setJumpTarget(
+			'target-s',
+			'More text'
+		);
+		$this->assertEquals(
+			[
+				['target' => 'target-f', 'info' => 'Target text', 'level' => 'error'],
+				['target' => 'target-s', 'info' => 'More text', 'level' => 'error'],
+			],
+			$em->getJumpTarget()
+		);
+		// add empty info
+		$em->setJumpTarget(
+			'target-e',
+			''
+		);
+		$this->assertEquals(
+			[
+				['target' => 'target-f', 'info' => 'Target text', 'level' => 'error'],
+				['target' => 'target-s', 'info' => 'More text', 'level' => 'error'],
+				['target' => 'target-e', 'info' => 'Jump to: target-e', 'level' => 'error'],
+			],
+			$em->getJumpTarget()
+		);
+		// add through message
+		$em->setErrorMsg('E-101', 'abort', 'Abort message', jump_target:[
+			'target' => 'abort-target',
+			'info' => 'Abort error'
+		]);
+		$this->assertEquals(
+			[
+				['target' => 'target-f', 'info' => 'Target text', 'level' => 'error'],
+				['target' => 'target-s', 'info' => 'More text', 'level' => 'error'],
+				['target' => 'target-e', 'info' => 'Jump to: target-e', 'level' => 'error'],
+				['target' => 'abort-target', 'info' => 'Abort error', 'level' => 'abort'],
+			],
+			$em->getJumpTarget()
+		);
+	}
 }
 
 // __END__

test/phpunit/Logging/CoreLibsLoggingLoggingTest.php

@@ -20,7 +20,7 @@ final class CoreLibsLoggingLoggingTest extends TestCase
 	private const LOG_FOLDER = __DIR__ . DIRECTORY_SEPARATOR . 'log' . DIRECTORY_SEPARATOR;
 	private const REGEX_BASE = "\[[\d\-\s\.:]+\]\s{1}" // date
 		. "\[[\w\.]+(:\d+)?\]\s{1}" // host:port
-		. "\[[\w\-\.\/]+:\d+\]\s{1}" // folder/file
+		. "\[(phar:\/\/)?[\w\-\.\/]+:\d+\]\s{1}" // folder/file [note phar:// is for phpunit]
 		. "\[\w+\]\s{1}" // run id
 		. "{[\w\\\\]+((::|->)\w+)?}\s{1}"; // class
 

test/phpunit/bootstrap.php

@@ -0,0 +1,15 @@
+<?php
+
+$set = 0;
+foreach (['/../../www', '/../www', '/../..', '/..', '/../../src', '/../src'] as $src) {
+	if (is_file(dirname(__DIR__) . $src . '/vendor/autoload.php')) {
+		require dirname(__DIR__) . $src . '/vendor/autoload.php';
+		$set = 1;
+		break;
+	}
+}
+if (!$set) {
+	die("Cannot find /vendor/autoload.php in reference to: " . dirname(__DIR__));
+}
+
+// __END__

tools/phan

@@ -0,0 +1 @@
+/home/clemens/.phive/phars/phan-5.4.2.phar

tools/phpcbf

@@ -0,0 +1 @@
+/home/clemens/.phive/phars/phpcbf-3.7.2.phar

tools/phpcs

@@ -0,0 +1 @@
+/home/clemens/.phive/phars/phpcs-3.7.2.phar

tools/phpstan

@@ -0,0 +1 @@
+/home/clemens/.phive/phars/phpstan-1.10.37.phar

tools/phpunit

@@ -0,0 +1 @@
+/home/clemens/.phive/phars/phpunit-9.6.13.phar

tools/psalm

@@ -0,0 +1 @@
+/home/clemens/.phive/phars/psalm-5.15.0.phar