De-depricate the ACL Login loginCheckEditAccessId method

This is still used a lot, and there is no reason to deprecate it so early. First all the other logic should be brought in to make this an easy conversion.
Fix ACL Login cuid <-> id pk lookups
2025-01-17 14:43:13 +09:00 · 2025-01-17 14:34:41 +09:00 · 2025-01-17 12:48:46 +09:00 · 2025-01-17 09:59:39 +09:00 · 2025-01-17 09:58:02 +09:00 · 2025-01-17 09:33:05 +09:00
7 changed files with 191 additions and 11 deletions
--- a/4dev/tests/Logging/CoreLibsLoggingLoggingTest.php
+++ b/4dev/tests/Logging/CoreLibsLoggingLoggingTest.php
@@ -395,7 +395,7 @@ final class CoreLibsLoggingLoggingTest extends TestCase
 		}
 		$per_run_id = $log->getLogUniqueId();
 		$this->assertMatchesRegularExpression(
-			"/^\d{4}-\d{2}-\d{2}_\d{6}_U_[a-z0-9]{8}$/",
+			"/^\d{4}-\d{2}-\d{2}_\d{6}\.U_[a-z0-9]{8}$/",
 			$per_run_id,
 			'assert per log run id 1st'
 		);
@@ -403,7 +403,7 @@ final class CoreLibsLoggingLoggingTest extends TestCase
 			$log->setLogUniqueId(true);
 			$per_run_id_2nd = $log->getLogUniqueId();
 			$this->assertMatchesRegularExpression(
-				"/^\d{4}-\d{2}-\d{2}_\d{6}_U_[a-z0-9]{8}$/",
+				"/^\d{4}-\d{2}-\d{2}_\d{6}\.U_[a-z0-9]{8}$/",
 				$per_run_id_2nd,
 				'assert per log run id 2nd'
 			);
@@ -824,13 +824,13 @@ final class CoreLibsLoggingLoggingTest extends TestCase
 		$this->assertTrue($log_ok, 'assert ::log (debug) OK');
 		$this->assertEquals(
 			$log->getLogFile(),
-			$log->getLogFileId() . '_DEBUG.log'
+			$log->getLogFileId() . '.DEBUG.log'
 		);
 		$log_ok = $log->log(Level::Info, 'INFO', group_id: 'GROUP_ID', prefix: 'PREFIX:');
 		$this->assertTrue($log_ok, 'assert ::log (info) OK');
 		$this->assertEquals(
 			$log->getLogFile(),
-			$log->getLogFileId() . '_INFO.log'
+			$log->getLogFileId() . '.INFO.log'
 		);
 	}

--- a/www/admin/class_test.deprecated.helper.php
+++ b/www/admin/class_test.deprecated.helper.php
@@ -0,0 +1,62 @@
+<?php // phpcs:ignore warning
+
+/**
+ * @phan-file-suppress PhanTypeSuspiciousStringExpression
+ */
+
+declare(strict_types=1);
+
+error_reporting(E_ALL | 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-phpv';
+ob_end_flush();
+
+$log = new CoreLibs\Logging\Logging([
+	'log_folder' => BASE . LOG,
+	'log_file_id' => $LOG_FILE_ID,
+	'log_per_date' => true,
+]);
+$_phpv = new CoreLibs\Check\PhpVersion();
+$phpv_class = 'CoreLibs\Check\PhpVersion';
+
+$PAGE_NAME = 'TEST CLASS: PHP VERSION';
+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>';
+
+// fputcsv
+print "<h3>\CoreLibs\DeprecatedHelper\Deprecated84::fputcsv()</h3>";
+$test_csv = BASE . TMP . 'DeprecatedHelper.test.csv';
+print "File: $test_csv<br>";
+
+$fp = fopen($test_csv, "w");
+if (!is_resource($fp)) {
+	die("Cannot open file: $test_csv");
+}
+\CoreLibs\DeprecatedHelper\Deprecated84::fputcsv($fp, ["A", "B", "C"]);
+fclose($fp);
+
+$fp = fopen($test_csv, "r");
+if (!is_resource($fp)) {
+	die("Cannot open file: $test_csv");
+}
+while ($entry = \CoreLibs\DeprecatedHelper\Deprecated84::fgetcsv($fp)) {
+	print "fgetcsv: <pre>" . print_r($entry, true) . "</pre>";
+}
+fclose($fp);
+
+$out = \CoreLibs\DeprecatedHelper\Deprecated84::str_getcsv("A,B,C");
+print "str_getcsv: <pre>" . print_r($out, true) . "</pre>";
+
+print "</body></html>";
+
+// __END__
--- a/www/admin/class_test.login.php
+++ b/www/admin/class_test.login.php
@@ -117,7 +117,7 @@ if (isset($login->loginGetAcl()['unit'])) {
 	if ($login->loginCheckEditAccessCuid($edit_access_cuid)) {
 		print "Set new:" . $edit_access_cuid . "<br>";
 	} else {
-		print "Load default unit id: " . $login->loginGetAcl()['unit_id'] . "<br>";
+		print "Load default unit id: " . $login->loginGetAcl()['unit_cuid'] . "<br>";
 	}
 } else {
 	print "Something went wrong with the login<br>";
@@ -140,4 +140,14 @@ $login->writeLog(
 	write_type:'JSON'
 );

+echo "<hr>";
+print "<h3>Legacy Lookups</h3>";
+
+$edit_access_id = 1;
+$edit_access_cuid = $login->loginGetEditAccessCuidFromId($edit_access_id);
+$edit_access_id_rev = $login->loginGetEditAccessIdFromCuid($edit_access_cuid);
+print "EA ID: " . $edit_access_id . "<br>";
+print "EA CUID: " . $edit_access_cuid . "<br>";
+print "REV EA CUID: " . $edit_access_id_rev . "<br>";
+
 print "</body></html>";
--- a/www/admin/class_test.php
+++ b/www/admin/class_test.php
@@ -141,6 +141,7 @@ $test_files = [
 	'class_test.error_msg.php' => 'Class Test: ERROR MSG',
 	'class_test.url-requests.curl.php' => 'Class Test: URL REQUESTS: CURL',
 	'subfolder/class_test.config.direct.php' => 'Class Test: CONFIG DIRECT SUB',
+	'class_test.deprecated.helper.php' => 'Class Test: DEPRECATED HELPERS',
 ];

 asort($test_files);
--- a/www/admin/class_test.phpv.php
+++ b/www/admin/class_test.phpv.php
@@ -28,8 +28,6 @@ $log = new CoreLibs\Logging\Logging([
 $_phpv = new CoreLibs\Check\PhpVersion();
 $phpv_class = 'CoreLibs\Check\PhpVersion';

-// define a list of from to color sets for conversion test
-
 $PAGE_NAME = 'TEST CLASS: PHP VERSION';
 print "<!DOCTYPE html>";
 print "<html><head><title>" . $PAGE_NAME . "</title></head>";
--- a/www/lib/CoreLibs/ACL/Login.php
+++ b/www/lib/CoreLibs/ACL/Login.php
@@ -1532,7 +1532,7 @@ class Login
 			$this->acl['page'] = $_SESSION['LOGIN_PAGES_ACL_LEVEL'][$this->page_name];
 		}

-		$this->acl['unit_id'] = null;
+		$this->acl['unit_cuid'] = null;
 		$this->acl['unit_name'] = null;
 		$this->acl['unit_uid'] = null;
 		$this->acl['unit'] = [];
@@ -3217,7 +3217,7 @@ HTML;
 	 * @return int|null                 same edit access id if ok
 	 *                                  or the default edit access id
 	 *                                  if given one is not valid
-	 * @deprecated Please switch to using edit access cuid check with ->loginCheckEditAccessValidCuid()
+	 * @#deprecated Please switch to using edit access cuid check with ->loginCheckEditAccessValidCuid()
 	 */
 	public function loginCheckEditAccessId(?int $edit_access_id): ?int
 	{
@@ -3290,10 +3290,24 @@ HTML;
 	 */
 	public function loginGetEditAccessCuidFromId(int $id): string|false
 	{
-		if (!isset($_SESSION['LOGIN_UNIT_ACL_LEVEL'][$id])) {
+		if (!isset($_SESSION['LOGIN_UNIT_LEGACY'][$id])) {
 			return false;
 		}
-		return (string)$_SESSION['LOGIN_UNIT_ACL_LEVEL'][$id]['cuid'];
+		return (string)$_SESSION['LOGIN_UNIT_LEGACY'][$id]['cuid'];
+	}
+
+	/**
+	 * This is a Legacy lookup from the edit access id to cuid for further lookups in the normal list
+	 *
+	 * @param  string    $cuid edit access cuid
+	 * @return int|false       false on not found or edit access id PK
+	 */
+	public function loginGetEditAccessIdFromCuid(string $cuid): int|false
+	{
+		if (!isset($_SESSION['LOGIN_UNIT'][$cuid])) {
+			return false;
+		}
+		return $_SESSION['LOGIN_UNIT'][$cuid]['id'];
 	}

 	/**
--- a/www/lib/CoreLibs/DeprecatedHelper/Deprecated84.php
+++ b/www/lib/CoreLibs/DeprecatedHelper/Deprecated84.php
@@ -0,0 +1,95 @@
+<?php
+
+/**
+ * AUTHOR: Clemens Schwaighofer
+ * CREATED: 2025/1/17
+ * DESCRIPTION:
+ * Deprecated helper for fputcsv
+*/
+
+declare(strict_types=1);
+
+namespace CoreLibs\DeprecatedHelper;
+
+use InvalidArgumentException;
+
+class Deprecated84
+{
+	/**
+	 * This is a wrapper for fputcsv to fix deprecated warning for $escape parameter
+	 * See: https://www.php.net/manual/en/function.fputcsv.php
+	 * escape parameter deprecation and recommend to set to "" for compatible with PHP 9.0
+	 *
+	 * @param mixed $stream
+	 * @param array<mixed> $fields
+	 * @param string $separator
+	 * @param string $enclosure
+	 * @param string $escape
+	 * @param string $eol
+	 * @return int|false
+	 * @throws InvalidArgumentException
+	 */
+	public static function fputcsv(
+		mixed $stream,
+		array $fields,
+		string $separator = ",",
+		string $enclosure = '"',
+		string $escape = '', // set to empty for future compatible
+		string $eol = PHP_EOL
+	): int | false {
+		if (!is_resource($stream)) {
+			throw new \InvalidArgumentException("fputcsv stream parameter must be a resrouce");
+		}
+		return fputcsv($stream, $fields, $separator, $enclosure, $escape, $eol);
+	}
+
+	/**
+	 * This is a wrapper for fgetcsv to fix deprecated warning for $escape parameter
+	 * See: https://www.php.net/manual/en/function.fgetcsv.php
+	 * escape parameter deprecation and recommend to set to "" for compatible with PHP 9.0
+	 *
+	 * @param mixed $stream
+	 * @param null|int<0,max> $length
+	 * @param string $separator
+	 * @param string $enclosure
+	 * @param string $escape
+	 * @return array<mixed>|false
+	 * @throws InvalidArgumentException
+	 */
+	public static function fgetcsv(
+		mixed $stream,
+		?int $length = null,
+		string $separator = ',',
+		string $enclosure = '"',
+		string $escape = '' // set to empty for future compatible
+	): array | false {
+		if (!is_resource($stream)) {
+			throw new \InvalidArgumentException("fgetcsv stream parameter must be a resrouce");
+		}
+		return fgetcsv($stream, $length, $separator, $enclosure, $escape);
+	}
+
+	/**
+	 * This is a wrapper for str_getcsv to fix deprecated warning for $escape parameter
+	 * See: https://www.php.net/manual/en/function.str-getcsv.php
+	 * escape parameter deprecation and recommend to set to "" for compatible with PHP 9.0
+	 *
+	 * @param string $string
+	 * @param string $separator
+	 * @param string $enclosure
+	 * @param string $escape
+	 * @return array<mixed>
+	 */
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName
+	public static function str_getcsv(
+		string $string,
+		string $separator = ",",
+		string $enclosure = '"',
+		string $escape = '' // set to empty for future compatible
+	): array {
+		return str_getcsv($string, $separator, $enclosure, $escape);
+	}
+	// phpcs:enable PSR1.Methods.CamelCapsMethodName
+}
+
+// __END__
Author	SHA1	Message	Date
Clemens Schwaighofer	a345d71306	De-depricate the ACL Login loginCheckEditAccessId method This is still used a lot, and there is no reason to deprecate it so early. First all the other logic should be brought in to make this an easy conversion.	2025-01-17 14:43:13 +09:00
Clemens Schwaighofer	0ff6294faa	Fix ACL Login cuid <-> id pk lookups Used the wrong SESSION var for lookup	2025-01-17 14:34:41 +09:00
Clemens Schwaighofer	757d7ae01d	ACL Login fixes for legacy id lookups add an edit access id lookup to cuid Fix unit_cuid not initialized, only old unit_id	2025-01-17 12:48:46 +09:00
Clemens Schwaighofer	4e78b21c67	phpstan fix for fegetcsv param $length	2025-01-17 09:59:39 +09:00
Clemens Schwaighofer	d7e6434808	New DeprecatedHelper namespace For temporary wrapper functions for deprecated calls that need this PHP 8.4 fputcsv/fgetcsv/str_getcsv encoding default change deprecated warning Note this does not cover the SqlFileInfo class as this is not used in our code	2025-01-17 09:58:02 +09:00
Clemens Schwaighofer	443cc2751d	Update Logging file name change unit tests	2025-01-17 09:33:05 +09:00