Support inclusion of configuration

nichtich · nichtich · commit a039d07dc27c · 2023-03-07T17:31:59.000+01:00
This adds repeatable configuration property `skosmos:includeConfig` to include configuration from file or URL. The configuration is cached as usual, based on modification time of `config.ttl` only. See #1403 for discussion.
diff --git a/model/GlobalConfig.php b/model/GlobalConfig.php
@@ -13,7 +13,7 @@
 EasyRdf\RdfNamespace::set('wdt', 'http://www.wikidata.org/prop/direct/');
 
 /**
- * GlobalConfig provides access to the Skosmos configuration in config.ttl.
+ * GlobalConfig provides access to the Skosmos configuration.
  */
 class GlobalConfig extends BaseConfig {
 
@@ -59,7 +59,7 @@ public function getConfigModifiedTime()
     }
 
     /**
-     * Initialize configuration, reading the configuration file from the disk,
+     * Initialize configuration, reading the configuration file from disk or URL,
      * and creating the graph and resources objects. Uses a cache if available,
      * in order to avoid re-loading the complete configuration on each request.
      */
@@ -78,7 +78,9 @@ private function initializeConfig()
                 $nskey = "namespaces of " . $key;
                 $this->graph = $this->cache->fetch($key);
                 $this->namespaces = $this->cache->fetch($nskey);
-                if ($this->graph === false || $this->namespaces === false) { // was not found in cache
+                if ($this->graph && $this->namespaces) { // found in cache
+                    $this->resource = $this->configResource($this->graph, "cache");
+                } else {
                     $this->parseConfig($this->filePath);
                     $this->cache->store($key, $this->graph);
                     $this->cache->store($nskey, $this->namespaces);
@@ -88,31 +90,89 @@ private function initializeConfig()
                 $this->parseConfig($this->filePath);
             }
 
-            $configResources = $this->graph->allOfType("skosmos:Configuration");
-            if (is_null($configResources) || !is_array($configResources) || count($configResources) !== 1) {
-                throw new Exception("config.ttl must have exactly one skosmos:Configuration");
-            }
-
-            $this->resource = $configResources[0];
             $this->initializeNamespaces();
         } catch (Exception $e) {
             echo "Error: " . $e->getMessage();
         }      
     }
 
     /**
-     * Parses configuration from the config.ttl file
-     * @param string $filename path to config.ttl file
+     * Ensure there is exactely one skosmos:Configuration and return it.
+     */
+    private function configResource($graph, $source) {
+        $configResources = $graph->allOfType("skosmos:Configuration");
+        if (is_null($configResources) || !is_array($configResources) || count($configResources) !== 1) {
+            throw new Exception("$source must have exactly one skosmos:Configuration");
+        }
+        return $configResources[0];
+    }
+
+    /**
+     * Retrieves and parses configuration with optional inclusion.
+     * @param string file or URL of configuration in Turtle syntax.
+     * @param int inclusion depth (0 for root configuration)
      * @throws \EasyRdf\Exception
      */
-    private function parseConfig($filename)
-    {
-        $this->graph = new EasyRdf\Graph();
+    private function parseConfig($location, $depth=0) {
+        if (str_starts_with($location, "http://") || str_starts_with($location, "https://")) {
+            $ch = curl_init($location);
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+            curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-type: text/turtle'));
+            $turtle = curl_exec($ch);
+            $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+            if ($httpCode != 200 && $httpCode != 303) {
+                throw new Exception("Failed to include configuration from $location");
+            }
+            curl_close($ch);
+        } else {
+            if (file_exists($location)) {
+                $turtle = file_get_contents($location);
+            } else {
+                throw new Exception("Config file $location does not exist!");
+            }
+        }
+
         $parser = new SkosmosTurtleParser();
-        $parser->parse($this->graph, file_get_contents($filename), 'turtle', $filename);
-        $this->namespaces = $parser->getNamespaces();
-    }
+        try {
+            $graph = $parser->parseGraph($turtle, $location);
+            $namespaces = $parser->getNamespaces();
+        } catch (Exception $e) {
+            throw new Exception("Failed to parse $location: " . $e->getMessage());
+        }
+
+        $configResource = $this->configResource($graph, $location);
+
+        if ($depth === 0) {
+            $this->graph = $graph;
+            $this->namespaces = $namespaces;
+            $this->resource = $configResource;
+        } else {
+            // Add triples to existing configuration
+            foreach($graph->resources() as $resource) {
+                $subject = $resource == $configResource ? $this->resource : $resource;
+                foreach($graph->properties($resource) as $property) {
+                    foreach($resource->all($property) as $value) {
+                        $this->graph->add($subject, $property, $value);
+                    }
+                }
+            }
+            // Add namespaces unless prefix has been defined
+            foreach ($namespaces as $prefix => $fullUri) {
+                if (!isset($this->namespaces[$prefix])) {
+                    $this->namespaces[$prefix] = $fullUri;
+                }
+            }
+        }
 
+        // only include up to four levels
+        if ($depth < 4) {
+            $includes = $this->graph->allResources($this->resource, "skosmos:includeConfig");
+            foreach($includes as $location) {
+                $this->parseConfig($location->getUri(), $depth+1);
+            }
+        }
+    }
+   
     /**
      * Returns the graph created after parsing the configuration file.
      * @return \EasyRdf\Graph
diff --git a/model/SkosmosTurtleParser.php b/model/SkosmosTurtleParser.php
@@ -11,4 +11,14 @@ public function getNamespaces()
         return $this->namespaces;
     }
 
+    /**
+     * Parse Turtle into a new Graph and return it.
+     * @return EasyRdf\Graph
+     */
+    public function parseGraph($data, $baseUri)
+    {
+        $graph = new EasyRdf\Graph();
+        $this->parse($graph, $data, 'turtle', $baseUri);
+        return $graph;
+    }
 }
diff --git a/tests/GlobalConfigTest.php b/tests/GlobalConfigTest.php
@@ -116,6 +116,13 @@ public function testGetUiLanguageDropdown()
         $this->assertEquals(true, $this->config->getUiLanguageDropdown());
     }
 
+    public function testGetGlobalPlugins()
+    {
+        $this->assertEquals(["alpha", "Bravo", "charlie"], $this->config->getGlobalPlugins());
+    }
+
+    // included from testconfig-included.ttl
+
     public function testGetHoneypotEnabled()
     {
         $this->assertEquals(false, $this->config->getHoneypotEnabled());
@@ -126,17 +133,25 @@ public function testGetHoneypotTime()
         $this->assertEquals(2, $this->config->getHoneypotTime());
     }
 
-    public function testGetGlobalPlugins()
-    {
-        $this->assertEquals(["alpha", "Bravo", "charlie"], $this->config->getGlobalPlugins());
+    public function testVocabularyExists() {
+        $this->assertEquals(4, count($this->config->getGraph()->allOfType('skos:Concept')));
+    }
+
+    // --- test inclusion from URL
+
+    public function testInclusionFromURL() {
+        $conf = new GlobalConfig("/../tests/testconfig-include.ttl");
+        $this->assertEquals(2, $conf->getHoneypotTime());
     }
 
     // --- tests for the exception paths
 
     public function testInitializeConfigWithoutGraph()
     {
-        $this->expectOutputString('Error: config.ttl must have exactly one skosmos:Configuration');
-        $conf = new GlobalConfig('/../tests/testconfig-nograph.ttl');
+        $file = '/../tests/testconfig-nograph.ttl';
+        $filepath = realpath( dirname(__FILE__) . $file );
+        $this->expectOutputString("Error: $filepath must have exactly one skosmos:Configuration");
+        $conf = new GlobalConfig($file);
         $this->assertNotNull($conf);
     }
 
diff --git a/tests/init_fuseki.sh b/tests/init_fuseki.sh
@@ -33,5 +33,7 @@ for fn in ../test-vocab-data/*.ttl; do
     $(./bin/s-put http://localhost:13030/skosmos-test/data "http://www.skosmos.skos/$name/" "$fn")
 done
 
+$(./bin/s-put http://localhost:13030/skosmos-test/data "http://skosmos.config/" "../testconfig-included.ttl")
+
 cd ..
 
diff --git a/tests/testconfig-include.ttl b/tests/testconfig-include.ttl
@@ -0,0 +1,8 @@
+@prefix skosmos: <http://purl.org/net/skosmos#> .
+@prefix : <http://base/#> .
+
+:config a skosmos:Configuration ;
+ 
+    # include configuration from from URL
+    skosmos:includeConfig <http://localhost:13030/skosmos-test/data?graph=http://skosmos.config/> .
+
diff --git a/tests/testconfig-included.ttl b/tests/testconfig-included.ttl
@@ -0,0 +1,14 @@
+@prefix skosmos: <http://purl.org/net/skosmos#> .
+@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
+
+# This configuration is being included from file
+
+<http://example.org/> a skosmos:Configuration ;
+ 
+    # whether to enable the spam honey pot or not, enabled by default
+    skosmos:uiHoneypotEnabled false ;
+
+    # default time a user must wait before submitting a form
+    skosmos:uiHoneypotTime 2 .
+
+<whatever> a skos:Concept .
diff --git a/tests/testconfig.ttl b/tests/testconfig.ttl
@@ -59,12 +59,11 @@
     skosmos:feedbackEnvelopeSender "skosmos tests" ;
     # whether to display the ui language selection as a dropdown (useful for cases where there are more than 3 languages) 
     skosmos:uiLanguageDropdown true ;
-    # whether to enable the spam honey pot or not, enabled by default
-    skosmos:uiHoneypotEnabled false ;
-    # default time a user must wait before submitting a form
-    skosmos:uiHoneypotTime 2 ;
     # plugins to activate for the whole installation (including all vocabularies)
-    skosmos:globalPlugins ("alpha" "Bravo" "charlie") .
+    skosmos:globalPlugins ("alpha" "Bravo" "charlie") ;
+
+    # include another config file
+    skosmos:includeConfig <testconfig-included.ttl> .
 
 # Skosmos vocabularies
 

Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,14 @@ public function getNamespaces()`
`11`	`11`	`return $this->namespaces;`
`12`	`12`	`}`
`13`	`13`
	`14`	`+ /**`
	`15`	`+ * Parse Turtle into a new Graph and return it.`
	`16`	`+ * @return EasyRdf\Graph`
	`17`	`+ */`
	`18`	`+ public function parseGraph($data, $baseUri)`
	`19`	`+ {`
	`20`	`+ $graph = new EasyRdf\Graph();`
	`21`	`+ $this->parse($graph, $data, 'turtle', $baseUri);`
	`22`	`+ return $graph;`
	`23`	`+ }`
`14`	`24`	`}`