UrlRequest curl class added

src/UrlRequests/CurlTrait.php

@@ -0,0 +1,152 @@
+<?php
+
+/**
+ * AUTHOR: Clemens Schwaighofer
+ * CREATED: 2024/10/29
+ * DESCRIPTION:
+ * Curl Client Trait for get/post/put/delete requests through the php curl inteface
+ *
+ * For anything more complex use guzzlehttp/http
+ * https://docs.guzzlephp.org/en/stable/index.html
+*/
+
+// phpcs:disable Generic.Files.LineLength
+
+declare(strict_types=1);
+
+namespace CoreLibs\UrlRequests;
+
+trait CurlTrait
+{
+	/**
+	 * Set the array block that is sent to the request call
+	 * Make sure that if headers is set as key but null it stays null and set to empty array
+	 * if headers key is missing
+	 * "get" calls do not set any body
+	 *
+	 * @param  string $type if set as get do not add body, else add body
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Request options
+	 * @return array{auth?:array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool}
+	 */
+	private function setOptions(string $type, array $options): array
+	{
+		$base = [
+			"auth" => !array_key_exists('auth', $options) ? [] : $options['auth'],
+			"headers" => !array_key_exists('headers', $options) ? [] : $options['headers'],
+			"query" => $options['query'] ?? null,
+			"http_errors" => !array_key_exists('http_errors', $options) ? null : $options['http_errors'],
+		];
+		if ($type != "get") {
+			$base["body"] =  $options['body'] ?? null;
+		}
+		return $base;
+	}
+
+	/**
+	 * combined set call for any type of request with options type parameters
+	 * The following options can be set:
+	 * header: as array string:string
+	 * query as string or array string:string
+	 * body as string or array of any type
+	 *
+	 * @param  string $type What type of request we send, will throw exception if not a valid one
+	 * @param  string $url  The url to send
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Request options
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} [default=[]] Result code, headers and content as array, content is json
+	 * @throws \UnexpectedValueException on missing body data when body data is needed
+	 */
+	abstract public function request(string $type, string $url, array $options = []): array;
+
+	/**
+	 * Makes an request to the target url via curl: GET
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} [default=[]] Result code, headers and content as array, content is json
+	 */
+	public function get(string $url, array $options = []): array
+	{
+		return $this->request(
+			"get",
+			$url,
+			$this->setOptions('get', $options),
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: POST
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 */
+	public function post(string $url, array $options): array
+	{
+		return $this->request(
+			"post",
+			$url,
+			$this->setOptions('post', $options),
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: PUT
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 */
+	public function put(string $url, array $options): array
+	{
+		return $this->request(
+			"put",
+			$url,
+			$this->setOptions('put', $options),
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: PATCH
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 */
+	public function patch(string $url, array $options): array
+	{
+		return $this->request(
+			"patch",
+			$url,
+			$this->setOptions('patch', $options),
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: DELETE
+	 * Returns result as string (json)
+	 * Note that DELETE body is optional
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} [default=[]] Result code, headers and content as array, content is json
+	 */
+	public function delete(string $url, array $options = []): array
+	{
+		return $this->request(
+			"delete",
+			$url,
+			$this->setOptions('delete', $options),
+		);
+	}
+}
+
+// __END__

src/UrlRequests/Interface/RequestsInterface.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * AUTHOR: Clemens Schwaighofer
+ * CREATED: 2024/9/20
+ * DESCRIPTION:
+ * URL Requests client interface
+*/
+
+namespace CoreLibs\UrlRequests\Interface;
+
+interface RequestsInterface
+{
+	/**
+	 * get the config array with all settings
+	 *
+	 * @return array<string,mixed> all current config settings
+	 */
+	public function getConfig(): array;
+
+	/**
+	 * Return the full url as it was sent
+	 *
+	 * @return string url sent
+	 */
+	public function getUrlSent(): string;
+
+	/**
+	 * get the parsed url
+	 *
+	 * @return array{scheme?:string,user?:string,host?:string,port?:string,path?:string,query?:string,fragment?:string,pass?:string}
+	 */
+	public function getUrlParsedSent(): array;
+
+	/**
+	 * Return the full headers as they where sent
+	 *
+	 * @return array<string,string>
+	 */
+	public function getHeadersSent(): array;
+
+	/**
+	 * set, add or overwrite header
+	 * On default this will overwrite header, and not set
+	 *
+	 * @param  array<string,string|array<string>> $header
+	 * @param  bool                               $add [default=false] if set will add header to existing value
+	 * @return void
+	 */
+	public function setHeaders(array $header, bool $add = false): void;
+
+	/**
+	 * remove header entry
+	 * if key is only set then match only key, if both are set both sides must match
+	 *
+	 * @param  array<string,string> $remove_headers
+	 * @return void
+	 */
+	public function removeHeaders(array $remove_headers): void;
+
+	/**
+	 * Update the base url set, if empty will unset the base url
+	 *
+	 * @param  string $base_uri
+	 * @return void
+	 */
+	public function setBaseUri(string $base_uri): void;
+
+	/**
+	 * combined set call for any type of request with options type parameters
+	 *
+	 * phpcs:disable Generic.Files.LineLength
+	 * @param  string $type
+	 * @param  string $url
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 * @throws \UnexpectedValueException on missing body data when body data is needed
+	 * phpcs:enable Generic.Files.LineLength
+	 */
+	public function request(string $type, string $url, array $options = []): array;
+}
+
+// __END__

test/configs/config.master.php

@@ -100,27 +100,6 @@ define('DEFAULT_ACL_LEVEL', 80);
 /************* LOGOUT ********************/
 // logout target
 define('LOGOUT_TARGET', '');
-// password change allowed
-define('PASSWORD_CHANGE', false);
-define('PASSWORD_FORGOT', false);
-// min/max password length
-define('PASSWORD_MIN_LENGTH', 9);
-define('PASSWORD_MAX_LENGTH', 255);
-// defines allowed special characters
-define('PASSWORD_SPECIAL_RANGE', '@$!%*?&');
-// password must have upper case, lower case, number, special
-// comment out for not mandatory
-define('PASSWORD_LOWER', '(?=.*[a-z])');
-define('PASSWORD_UPPER', '(?=.*[A-Z])');
-define('PASSWORD_NUMBER', '(?=.*\d)');
-define('PASSWORD_SPECIAL', "(?=.*[" . PASSWORD_SPECIAL_RANGE . "])");
-// define full regex
-define('PASSWORD_REGEX', "/^"
-	. (defined('PASSWORD_LOWER') ? PASSWORD_LOWER : '')
-	. (defined('PASSWORD_UPPER') ? PASSWORD_UPPER : '')
-	. (defined('PASSWORD_NUMBER') ? PASSWORD_NUMBER : '')
-	. (defined('PASSWORD_SPECIAL') ? PASSWORD_SPECIAL : '')
-	. "[A-Za-z\d" . PASSWORD_SPECIAL_RANGE . "]{" . PASSWORD_MIN_LENGTH . "," . PASSWORD_MAX_LENGTH . "}$/");
 
 /************* AJAX / ACCESS *************/
 // ajax request type
@@ -161,13 +140,6 @@ define('DEFAULT_LOCALE', 'en_US.UTF-8');
 // default web page encoding setting
 define('DEFAULT_ENCODING', 'UTF-8');
 
-/************* LOGGING *******************/
-// below two can be defined here, but they should be
-// defined in either the header file or the file itself
-// as $LOG_FILE_ID which takes presence over LOG_FILE_ID
-// see Basic class constructor
-define('LOG_FILE_ID', BASE_NAME);
-
 /************* QUEUE TABLE *************/
 // if we have a dev/live system
 // set_live is a per page/per item
@@ -291,22 +263,4 @@ if (file_exists(BASE . CONFIGS . 'config.other.php')) {
 	require BASE . CONFIGS . 'config.other.php';
 }
 
-/************* DEBUG *******************/
-// turn off debug if debug flag is OFF
-if (defined('DEBUG') && DEBUG == false) {
-	$ECHO_ALL = false;
-	$DEBUG_ALL = false;
-	$PRINT_ALL = false;
-	$DB_DEBUG = false;
-	$ENABLE_ERROR_HANDLING = false;
-	$DEBUG_ALL_OVERRIDE = false;
-} else {
-	$ECHO_ALL = false;
-	$DEBUG_ALL = true;
-	$PRINT_ALL = true;
-	$DB_DEBUG = true;
-	$ENABLE_ERROR_HANDLING = false;
-	$DEBUG_ALL_OVERRIDE = false;
-}
-
 // __END__

test/configs/config.path.php

@@ -0,0 +1,28 @@
+<?php // phpcs:ignore PSR1.Files.SideEffects
+
+/********************************************************************
+* AUTHOR: Clemens Schwaighofer
+* CREATED: 2018/10/11
+* SHORT DESCRIPTION:
+* configuration file for core path settings
+* CSV target paths, and other download access URLS or paths needed
+* HISTORY:
+*********************************************************************/
+
+declare(strict_types=1);
+
+// find trigger name "admin/" or "frontend/" in the getcwd() folder
+$folder = '';
+foreach (['admin', 'frontend'] as $_folder) {
+	if (strstr(getcwd() ?: '', DIRECTORY_SEPARATOR . $_folder)) {
+		$folder = $_folder;
+		break;
+	}
+}
+// if content path is empty, fallback is default
+if (empty($folder)) {
+	$folder = 'default';
+}
+define('CONTENT_PATH', $folder . DIRECTORY_SEPARATOR);
+
+// __END__

test/configs/config.php

@@ -53,19 +53,6 @@ for (
 		\gullevek\dotEnv\DotEnv::readEnvFile(
 			$__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH
 		);
-		// find trigger name "admin/" or "frontend/" in the getcwd() folder
-		$folder = '';
-		foreach (['admin', 'frontend'] as $_folder) {
-			if (strstr(getcwd() ?: '', DIRECTORY_SEPARATOR . $_folder)) {
-				$folder = $_folder;
-				break;
-			}
-		}
-		// if content path is empty, fallback is default
-		if (empty($folder)) {
-			$folder = 'default';
-		}
-		define('CONTENT_PATH', $folder . DIRECTORY_SEPARATOR);
 		// load master config file that loads all other config files
 		require $__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH . 'config.master.php';
 		break;

test/index.php

@@ -4,4 +4,7 @@ require "../vendor/autoload.php";
 
 print "Bytes: " . CoreLibs\Convert\Byte::humanReadableByteFormat(123414) . "<br>";
 
+$curl = new CoreLibs\UrlRequests\Curl();
+print "Config: " . print_r($curl->getConfig(), true) . "<br>";
+
 // __END__

test/phpunit/AAASetupData/requests/http_requests.php

@@ -0,0 +1,51 @@
+<?php // phpcs:ignore PSR1.Files.SideEffects
+
+/**
+ * AUTHOR: Clemens Schwaighofer
+ * CREATED: Ymd
+ * DESCRIPTION:
+ * DescriptionHere
+*/
+
+declare(strict_types=1);
+
+/**
+ * build return json
+ *
+ * @param  array<string,mixed> $http_headers
+ * @param  string $body
+ * @return string
+ */
+function buildContent(array $http_headers, string $body): string
+{
+	return json_encode([
+		'HEADERS' => $http_headers,
+		"REQUEST_TYPE" => $_SERVER['REQUEST_METHOD'],
+		"PARAMS" => $_GET,
+		"BODY" => json_decode($body, true)
+	]);
+}
+
+$http_headers = array_filter($_SERVER, function ($value, $key) {
+	if (str_starts_with($key, 'HTTP_')) {
+		return true;
+	}
+}, ARRAY_FILTER_USE_BOTH);
+
+header("Content-Type: application/json; charset=UTF-8");
+
+// if the header has Authorization and RunAuthTest then exit with 401
+if (!empty($http_headers['HTTP_AUTHORIZATION']) && !empty($http_headers['HTTP_RUNAUTHTEST'])) {
+	header("HTTP/1.1 401 Unauthorized");
+	print buildContent($http_headers, '{"code": 401, "content": {"Error": "Not Authorized"}}');
+	exit;
+}
+
+if (($file_get = file_get_contents('php://input')) === false) {
+	header("HTTP/1.1 404 Not Found");
+	print buildContent($http_headers, '{"code": 404, "content": {"Error": "file_get_contents failed"}}');
+	exit;
+}
+print buildContent($http_headers, $file_get);
+
+// __END__

test/phpunit/DB/CoreLibsDBExtendedArrayIOTest.php

@@ -10,7 +10,6 @@ use PHPUnit\Framework\TestCase;
  * Test class for DB\Extended\ArrayIO
  * This will only test the PgSQL parts
  * @coversDefaultClass \CoreLibs\DB\Extended\ArrayIO
- * @coversDefaultClass \CoreLibs\DB\Extended\ArrayIO
  * @testdox \CoreLibs\Extended\ArrayIO method tests for extended DB interface
  */
 final class CoreLibsDBExtendedArrayIOTest extends TestCase