Add parent_config_name directive to YAML reader (#4930)

Author: ThoWagen

config/vufind/searchspecs.yaml

@@ -227,14 +227,22 @@
 #
 # "@parent_yaml": "/path/to/my/file.yaml"
 #
-# Only sections not found in this file will be loaded in from the parent file.
+# If @parent_yaml cannot be accessed as an absolute path, it will also be tried
+# relative to the path of the file defining it.
+
+# You can also use "@parent_config_name" instead, to use another configuration as
+# parent. The whole configuration directory stack will be searched for this configuration
+# instead of just using a specific file. For example:
+#
+# "@parent_config_name": "myconfig"
+#
+# Only one of the parent directives can be used at a time.
+#
+# In both cases, only sections not found in this file will be loaded in from the parent file.
 # In some complex scenarios, this can be a useful way of sharing settings
 # between multiple configured VuFind instances. You can create a chain of parent
 # files if necessary.
 #
-# If @parent_yaml cannot be accessed as an absolute path, it will also be tried
-# relative to the path of the file defining it.
-#
 #-----------------------------------------------------------------------------------
 
 # These searches use Dismax when possible:

config/vufind/searchspecs2.yaml

@@ -1,3 +1,3 @@
 # This is the search configuration for the secondary search handler.
 # By default, it simply inherits rules from the parent handler.
-"@parent_yaml": "searchspecs.yaml"
+"@parent_yaml": "searchspecs.yaml"

module/VuFind/src/VuFind/Config/YamlReader.php

@@ -99,7 +99,8 @@ public function get($filename, $useLocalConfig = true, $forceReload = false)
             $baseConfigPath = $this->pathResolver->getBaseConfigPath($filename);
             $this->files[$filename] = $this->getFromPaths(
                 $baseConfigPath,
-                $localConfigPath
+                $localConfigPath,
+                $useLocalConfig
             );
         }
 
@@ -109,13 +110,14 @@ public function get($filename, $useLocalConfig = true, $forceReload = false)
     /**
      * Given core and local filenames, retrieve the configuration data.
      *
-     * @param string $defaultFile Full path to file containing default YAML
-     * @param string $customFile  Full path to file containing local customizations
+     * @param string $defaultFile    Full path to file containing default YAML
+     * @param string $customFile     Full path to file containing local customizations
      * (may be null if no local file exists).
+     * @param bool   $useLocalConfig Use local configuration if available
      *
      * @return array
      */
-    protected function getFromPaths($defaultFile, $customFile = null)
+    protected function getFromPaths($defaultFile, $customFile = null, $useLocalConfig = true)
     {
         // Connect to the cache:
         $cache = (null !== $this->cacheManager)
@@ -139,7 +141,7 @@ protected function getFromPaths($defaultFile, $customFile = null)
 
         // Generate data if not found in cache:
         if ($cache === false || !($results = $cache->getItem($cacheKey))) {
-            $results = $this->parseYaml($customFile, $defaultFile);
+            $results = $this->parseYaml($customFile, $defaultFile, $useLocalConfig);
             if ($cache !== false) {
                 $cache->setItem($cacheKey, $results);
             }
@@ -151,20 +153,28 @@ protected function getFromPaths($defaultFile, $customFile = null)
     /**
      * Process a YAML file (and its parent, if necessary).
      *
-     * @param string $file          YAML file to load (will evaluate to null
+     * @param string $file           YAML file to load (will evaluate to null
      * if file does not exist).
-     * @param string $defaultParent Parent YAML file from which $file should
+     * @param string $defaultParent  Parent YAML file from which $file should
      * inherit (unless overridden by a specific directive in $file). None by
      * default.
+     * @param bool   $useLocalConfig Use local configuration if available
      *
      * @return array
      */
-    protected function parseYaml($file, $defaultParent = null)
+    protected function parseYaml($file, $defaultParent = null, $useLocalConfig = true)
     {
         // First load current file:
         $results = (!empty($file) && file_exists($file))
             ? Yaml::parse(file_get_contents($file)) : [];
 
+        if (isset($results['@parent_yaml']) && isset($results['@parent_config_name'])) {
+            error_log(
+                'Cannot use both directives @parent_yaml and '
+                . '@parent_config_name at the same time in one file.'
+            );
+        }
+
         // Override default parent with explicitly-defined parent, if present:
         if (isset($results['@parent_yaml'])) {
             // First try parent as absolute path, then as relative:
@@ -178,6 +188,22 @@ protected function parseYaml($file, $defaultParent = null)
             // Swallow the directive after processing it:
             unset($results['@parent_yaml']);
         }
+        // Override default parent with a named configuration, if present:
+        if (isset($results['@parent_config_name'])) {
+            $parentConfigName = $results['@parent_config_name'] . '.yaml';
+            $defaultParent = $useLocalConfig
+                ? $this->pathResolver->getLocalConfigPath($parentConfigName)
+                : null;
+            if ($defaultParent === null || !file_exists($defaultParent)) {
+                $defaultParent = $this->pathResolver->getBaseConfigPath($parentConfigName);
+            }
+            if (!file_exists($defaultParent)) {
+                $defaultParent = null;
+                error_log('Cannot find parent config: ' . $parentConfigName);
+            }
+            // Swallow the directive after processing it:
+            unset($results['@parent_config_name']);
+        }
         // Check for sections to merge instead of overriding:
         $mergedSections = [];
         if (isset($results['@merge_sections'])) {

module/VuFind/tests/fixtures/configs/yaml/baseDir/base_child_base_parent.yaml

@@ -0,0 +1,3 @@
+"@parent_config_name": "base_parent"
+All: base-child
+ChildOnly: base-child

module/VuFind/tests/fixtures/configs/yaml/baseDir/base_child_local_parent.yaml

@@ -0,0 +1,3 @@
+"@parent_config_name": "local_parent"
+All: base-child
+ChildOnly: base-child

module/VuFind/tests/fixtures/configs/yaml/baseDir/base_parent.yaml

@@ -0,0 +1,2 @@
+All: Will not exist
+ParentOnly: base-parent

module/VuFind/tests/fixtures/configs/yaml/baseDir/local_child_base_parent.yaml

@@ -0,0 +1,3 @@
+"@parent_config_name": "base_parent"
+All: Will not exist
+ChildOnly: Will not exist

module/VuFind/tests/fixtures/configs/yaml/baseDir/local_child_local_parent.yaml

@@ -0,0 +1,3 @@
+"@parent_config_name": "local_parent"
+All: Will not exist
+ChildOnly: Will not exist

module/VuFind/tests/fixtures/configs/yaml/baseDir/local_parent.yaml

@@ -0,0 +1,2 @@
+All: Will not exist
+ParentOnly: Will not exist

module/VuFind/tests/fixtures/configs/yaml/localDir/local_child_base_parent.yaml

@@ -0,0 +1,3 @@
+"@parent_config_name": "base_parent"
+All: local-child
+ChildOnly: local-child