Keep config directory as user config, move system config elsewhere

closes #1822
galette · Apr 30, 2024 · 850588d · 850588d
1 parent 84bc07e
commit 850588d
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 18 deletions.
diff --git a/.composer-require-checker.config.json b/.composer-require-checker.config.json
@@ -30,6 +30,7 @@
     "GALETTE_CARD_ROWS",
     "GALETTE_CARD_WIDTH",
     "GALETTE_COMPAT_VERSION",
+    "GALETTE_SYSCONFIG_PATH",
     "GALETTE_CONFIG_PATH",
     "GALETTE_DATA_PATH",
     "GALETTE_DB_VERSION",

diff --git a/bin/release b/bin/release
@@ -142,7 +142,7 @@ def is_version_bumped(ver):
     global repo, tag_commit
 
     versions_file = repo.git.execute(
-        ["git", "show", f"{tag_commit}:{os.path.join('galette', 'config', 'versions.inc.php')}"])
+        ["git", "show", f"{tag_commit}:{os.path.join('galette', 'includes', 'sys_config', 'versions.inc.php')}"])
     file_version = re.search("^define\\('GALETTE_VERSION', 'v(?P<version>.+)'\\)", versions_file, re.MULTILINE)
     if file_version.group('version') != ver:
         print_err('Trying to release %s, but bumped version is %s!' % (ver, file_version.group('version')))
@@ -387,7 +387,7 @@ def add_libs(rel_name, galette_archive):
     galette.close()
 
     # set galette nightly version
-    config_dir = os.path.join(src_dir, rel_name, 'galette', 'config')
+    config_dir = os.path.join(src_dir, rel_name, 'galette', 'includes', 'sys_config')
     if nightly_version != None:
         sed_cmd = 'sed -e "s/GALETTE_NIGHTLY\', false/GALETTE_NIGHTLY\', \'%s\'/" -i versions.inc.php' % nightly_version
         print(sed_cmd)

diff --git a/galette/includes/galette.inc.php b/galette/includes/galette.inc.php
@@ -24,8 +24,8 @@
     define('GALETTE_ROOT', __DIR__ . '/../');
 }
 
-require_once GALETTE_ROOT . 'config/versions.inc.php';
-require_once GALETTE_ROOT . 'config/paths.inc.php';
+require_once GALETTE_ROOT . '/includes/sys_config/versions.inc.php';
+require_once GALETTE_ROOT . '/includes/sys_config/paths.inc.php';
 
 // check required PHP version...
 if (version_compare(PHP_VERSION, GALETTE_PHP_MIN, '<')) {

diff --git a/galette/config/exports.yaml → galette/includes/sys_config/exports.yaml b/galette/config/exports.yaml → galette/includes/sys_config/exports.yaml
diff --git a/galette/config/galette_tcpdf_config.php → ...ludes/sys_config/galette_tcpdf_config.php b/galette/config/galette_tcpdf_config.php → ...ludes/sys_config/galette_tcpdf_config.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright © 2003-2024 The Galette Team
  *

diff --git a/galette/config/paths.inc.php → galette/includes/sys_config/paths.inc.php b/galette/config/paths.inc.php → galette/includes/sys_config/paths.inc.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright © 2003-2024 The Galette Team
  *
@@ -41,9 +42,11 @@
 }
 
 //Galette paths
+const GALETTE_SYSCONFIG_PATH = GALETTE_ROOT . 'includes/sys_config/';
 if (!defined('GALETTE_CONFIG_PATH')) {
     define('GALETTE_CONFIG_PATH', GALETTE_ROOT . 'config/');
 }
+
 if (!defined('GALETTE_PLUGINS_PATH')) {
     define('GALETTE_PLUGINS_PATH', GALETTE_ROOT . 'plugins/');
 }

diff --git a/galette/config/versions.inc.php → galette/includes/sys_config/versions.inc.php b/galette/config/versions.inc.php → galette/includes/sys_config/versions.inc.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright © 2003-2024 The Galette Team
  *
@@ -32,4 +33,4 @@
 define('GALETTE_NIGHTLY', false);
 define('GALETTE_VERSION', 'v1.1.0-dev');
 define('GALETTE_COMPAT_VERSION', '1.1.0');
-define('GALETTE_DB_VERSION', '1.100');
+define('GALETTE_DB_VERSION', '1.100');
diff --git a/galette/lib/Galette/Common/XHProf.php b/galette/lib/Galette/Common/XHProf.php
@@ -30,7 +30,7 @@
  *
  * Install the pecl/xhprof extension
  *
- * Add XHPROF_PATH and XHPROF_URL in config/config_path.php (if needed)
+ * Add XHPROF_PATH and XHPROF_URL in config/local_paths.inc.php (if needed)
  *
  * Before the code
  *    $prof = new XHProf("something useful");

diff --git a/galette/lib/Galette/IO/CsvOut.php b/galette/lib/Galette/IO/CsvOut.php
@@ -38,7 +38,6 @@ class CsvOut extends Csv
 {
     public const DEFAULT_DIRECTORY = GALETTE_EXPORTS_PATH;
 
-    private string $parameted_path;
     private string $legacy_parameted_file = 'exports.xml';
     private string $parameted_file = 'exports.yaml';
 
@@ -48,9 +47,12 @@ class CsvOut extends Csv
     public function __construct()
     {
         parent::__construct(self::DEFAULT_DIRECTORY);
-        $this->parameted_path = GALETTE_CONFIG_PATH;
-        $this->parameted_file = $this->parameted_path . $this->parameted_file;
-        $this->legacy_parameted_file = $this->parameted_path . $this->legacy_parameted_file;
+        if (file_exists(GALETTE_CONFIG_PATH . $this->parameted_file)) {
+            $this->parameted_file = GALETTE_CONFIG_PATH . $this->parameted_file;
+        } else {
+            $this->parameted_file = GALETTE_SYSCONFIG_PATH . $this->parameted_file;
+        }
+        $this->legacy_parameted_file = GALETTE_CONFIG_PATH . $this->legacy_parameted_file;
     }
 
     /**

diff --git a/galette/lib/Galette/IO/Pdf.php b/galette/lib/Galette/IO/Pdf.php
@@ -31,7 +31,7 @@
 /*
  * TCPDF configuration file for Galette
  */
-require_once GALETTE_CONFIG_PATH . 'galette_tcpdf_config.php';
+require_once GALETTE_SYSCONFIG_PATH . 'galette_tcpdf_config.php';
 
 /**
  * PDF class for galette

diff --git a/galette/webroot/compat_test.php b/galette/webroot/compat_test.php
@@ -20,8 +20,8 @@
  */
 
 define('GALETTE_ROOT', __DIR__ . '/../');
-require_once GALETTE_ROOT . 'config/versions.inc.php';
-require_once GALETTE_ROOT . 'config/paths.inc.php';
+require_once GALETTE_ROOT . 'includes/sys_config/versions.inc.php';
+require_once GALETTE_ROOT . 'includes/sys_config/paths.inc.php';
 
 $phpok = !version_compare(PHP_VERSION, GALETTE_PHP_MIN, '<');
 $php_message = PHP_VERSION;

diff --git a/galette/webroot/index.php b/galette/webroot/index.php
@@ -27,7 +27,7 @@
 define('GALETTE_ROOT', __DIR__ . '/../');
 
 // check PHP version
-require_once GALETTE_ROOT . 'config/versions.inc.php';
+require_once GALETTE_ROOT . 'includes/sys_config/versions.inc.php';
 if (version_compare(PHP_VERSION, GALETTE_PHP_MIN, '<')) {
     header('location: ' . GALETTE_BASE_PATH . 'compat_test.php');
     die(1);

diff --git a/galette/webroot/installer.php b/galette/webroot/installer.php
@@ -35,7 +35,7 @@
 
 // check PHP modules
 require_once GALETTE_ROOT . '/vendor/autoload.php';
-require_once GALETTE_ROOT . 'config/versions.inc.php';
+require_once GALETTE_ROOT . 'includes/sys_config/versions.inc.php';
 
 if (version_compare(PHP_VERSION, GALETTE_PHP_MIN, '<') || !extension_loaded('intl')) {
     header('location: compat_test.php');

diff --git a/phpstan.neon b/phpstan.neon
@@ -5,10 +5,10 @@ parameters:
     paths:
         - galette/lib/
     scanFiles:
-        - galette/config/paths.inc.php
-        - galette/config/versions.inc.php
+        - galette/includes/sys_config/paths.inc.php
+        - galette/includes/sys_config/versions.inc.php
         - galette/config/config.inc.php.dist
-        - galette/config/galette_tcpdf_config.php
+        - galette/includes/sys_config/galette_tcpdf_config.php
     scanDirectories:
         - galette/includes/
     dynamicConstantNames: