From 6321899e02aad119d72456dd93c340ed804b5358 Mon Sep 17 00:00:00 2001 From: osaajani <> Date: Sun, 25 Feb 2024 11:04:45 +0100 Subject: [PATCH] Update descartes framework to improve env.php constants handling --- VERSION | 2 +- descartes/ApiController.php | 8 ++++---- descartes/Controller.php | 2 +- descartes/Router.php | 4 ++++ descartes/env.php | 23 ++++++++--------------- descartes/load-environment.php | 29 +++++++++++++++++++---------- env.php.dist | 20 +++++++++++--------- 7 files changed, 48 insertions(+), 40 deletions(-) diff --git a/VERSION b/VERSION index 6a39225..5b3a517 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v3.8.3 +v3.8.4 diff --git a/descartes/ApiController.php b/descartes/ApiController.php index feaa303..da738d3 100644 --- a/descartes/ApiController.php +++ b/descartes/ApiController.php @@ -91,21 +91,21 @@ /** * Cette fonction permet de faire un retour sous forme de json - * @param array $data : Les données à retourner sous forme de json + * @param array $datas : Les données à retourner sous forme de json * @param boolean $secure : Défini si l'affichage doit être sécurisé contre les XSS, par défaut true * @return ApiController : On retourne l'API controlleur lui meme pour pouvoir chainer */ - public function json ($data, $secure = true) + public function json ($datas, $secure = true) { header('Content-Type: application/json'); if ($secure) { - echo htmlspecialchars(json_encode($data), ENT_NOQUOTES); + echo htmlspecialchars(json_encode($datas), ENT_NOQUOTES); } else { - echo json_encode($data); + echo json_encode($datas); } return $this; diff --git a/descartes/Controller.php b/descartes/Controller.php index 7c2caf9..1d7832a 100644 --- a/descartes/Controller.php +++ b/descartes/Controller.php @@ -24,7 +24,7 @@ if (!is_readable($template_path)) { - throw new DescartesTemplateNotReadableException('Template ' . $template_path . ' is not readable.'); + throw new exceptions\DescartesExceptionTemplateNotReadable('Template ' . $template_path . ' is not readable.'); } require $template_path; diff --git a/descartes/Router.php b/descartes/Router.php index a88bea4..5b78a05 100644 --- a/descartes/Router.php +++ b/descartes/Router.php @@ -72,6 +72,10 @@ protected static function clean_url (string $url) { $to_remove = parse_url(HTTP_PWD, PHP_URL_PATH); + if ($to_remove === null) + { + return $url; + } $url = mb_strcut($url, mb_strlen($to_remove)); $url = parse_url($url, PHP_URL_PATH); diff --git a/descartes/env.php b/descartes/env.php index c512901..7b5428c 100644 --- a/descartes/env.php +++ b/descartes/env.php @@ -4,7 +4,7 @@ /* * Define Descartes env */ - $http_dir_path = '/raspisms'; //Path we need to put after servername in url to access app + $http_dir_path = ''; //Path we need to put after servername in url to access app $https = $_SERVER['HTTPS'] ?? 0; // Check for proxy forward @@ -27,10 +27,9 @@ $port = $proxy ? '' : $port; $http_server_port = $port ? ':' . $port : ''; - + $pwd = substr(__DIR__, 0, strrpos(__DIR__, '/')); - $http_pwd = $http_protocol . $http_server_name . $http_server_port . $http_dir_path; - + $env = [ //Global http and file path @@ -39,31 +38,25 @@ 'HTTP_SERVER_NAME' => $http_server_name, 'HTTP_SERVER_PORT' => $http_server_port, 'PWD' => $pwd, - 'HTTP_PWD' => $http_pwd, - + //path of back resources 'PWD_CONTROLLER' => $pwd . '/controllers', //Controllers dir 'PWD_MODEL' => $pwd . '/models', //Models dir 'PWD_TEMPLATES' => $pwd . '/templates', //Templates dir //path of front resources - 'PWD_ASSETS' => $pwd . '/assets', //Assets dir - 'HTTP_PWD_ASSETS' => $http_pwd . '/assets', //HTTP path of asset dir + 'PWD_ASSETS' => $pwd . '/assets', //Assets dir //images 'PWD_IMG' => $pwd . '/assets' . '/img', - 'HTTP_PWD_IMG' => $http_pwd . '/assets' . '/img', - + //css 'PWD_CSS' => $pwd . '/assets' . '/css', - 'HTTP_PWD_CSS' => $http_pwd . '/assets' . '/css', - + //javascript 'PWD_JS' => $pwd . '/assets' . '/js', - 'HTTP_PWD_JS' => $http_pwd . '/assets' . '/js', - + //fonts 'PWD_FONT' => $pwd . '/assets' . '/font', - 'HTTP_PWD_FONT' => $http_pwd . '/assets' . '/font', ]; diff --git a/descartes/load-environment.php b/descartes/load-environment.php index a4ce6c7..2bae0bf 100644 --- a/descartes/load-environment.php +++ b/descartes/load-environment.php @@ -21,6 +21,7 @@ $environment = []; $env = []; + // Load descartes base env require_once(__DIR__ . '/env.php'); $environment = array_merge($environment, $env); @@ -31,11 +32,8 @@ $environment = array_merge($environment, $env); } - //Define all Descartes constants - define_array($environment); - ### GLOBAL ENV ### - $environment = []; + //Load global app env $env = []; if (file_exists(__DIR__ . '/../env.php')) { @@ -43,19 +41,30 @@ $environment = array_merge($environment, $env); } - define_array($environment); - ### SPECIFIC ENV ### - $environment = []; + // Load specific environment env $env = []; - - if (defined('ENV') && file_exists(__DIR__ . '/../env.' . ENV . '.php')) + if (isset($environment['ENV']) && file_exists(__DIR__ . '/../env.' . $environment['ENV'] . '.php')) { - require_once(__DIR__ . '/../env.' . ENV . '.php'); + require_once(__DIR__ . '/../env.' . $environment['ENV'] . '.php'); $environment = array_merge($environment, $env); } + ### BUILD HTTP PWD CONSTS ### + // We compute http pwd at last minute to allow for simple overriding by user + // by simply defining custom HTTP_* (PROTOCOL, SERVER_NAME, SERVER_PORT, DIR_PATH) + $http_pwd = $environment['HTTP_PROTOCOL'] . $environment['HTTP_SERVER_NAME'] . $environment['HTTP_SERVER_PORT'] . $environment['HTTP_DIR_PATH']; + $env = [ + "HTTP_PWD" => $http_pwd, + 'HTTP_PWD_ASSETS' => $http_pwd . '/assets', //HTTP path of asset dir + 'HTTP_PWD_IMG' => $http_pwd . '/assets' . '/img', + 'HTTP_PWD_CSS' => $http_pwd . '/assets' . '/css', + 'HTTP_PWD_JS' => $http_pwd . '/assets' . '/js', + 'HTTP_PWD_FONT' => $http_pwd . '/assets' . '/font', + ]; + $environment = array_merge($environment, $env); + define_array($environment); } diff --git a/env.php.dist b/env.php.dist index afd6dd5..dcae872 100644 --- a/env.php.dist +++ b/env.php.dist @@ -2,23 +2,25 @@ /* This file define constants and options for the app */ - + $dir_path = '/raspisms'; + $http_pwd = $environment['HTTP_PROTOCOL'] . $dir_path . $environment['HTTP_SERVER_PORT'] . $environment['HTTP_DIR_PATH']; $env = [ 'ENV' => '%APP_ENV%', #env name (probably 'dev' or 'prod'), this value is used to get the env.XXX.php.dist matching env file 'SESSION_NAME' => 'raspisms', + 'HTTP_DIR_PATH' => $dir_path, // Override default dir path //RaspiSMS settings 'WEBSITE_TITLE' => 'RaspiSMS', 'WEBSITE_DESCRIPTION' => '', 'WEBSITE_AUTHOR' => 'Raspberry Pi FR', - 'PWD_SCRIPTS' => PWD . '/scripts', - 'PWD_RECEIVEDS' => PWD . '/receiveds', - 'HTTP_PWD_SOUND' => HTTP_PWD_ASSETS . '/sounds', - 'PWD_ADAPTERS' => PWD . '/adapters', - 'PWD_DATA' => PWD . '/data', - 'HTTP_PWD_DATA' => HTTP_PWD . '/data', - 'PWD_DATA_PUBLIC' => PWD . '/data/public', - 'HTTP_PWD_DATA_PUBLIC' => HTTP_PWD . '/data/public', + 'PWD_SCRIPTS' => $environment['PWD'] . '/scripts', + 'PWD_RECEIVEDS' => $environment['PWD'] . '/receiveds', + 'HTTP_PWD_SOUND' => $http_pwd . '/assets' . '/sounds', + 'PWD_ADAPTERS' => $environment['PWD'] . '/adapters', + 'PWD_DATA' => $environment['PWD'] . '/data', + 'HTTP_PWD_DATA' => $http_pwd . '/data', + 'PWD_DATA_PUBLIC' => $environment['PWD'] . '/data/public', + 'HTTP_PWD_DATA_PUBLIC' => $http_pwd . '/data/public', 'PWD_LOGS' => '/var/log/raspisms', 'PWD_PID' => '/var/run/raspisms', 'APP_SECRET' => '%APP_SECRET%',