Merge pull request #1914 from NatLibFi/set-user-agent-version

Include version number and website URL in HTTP User-Agent header

Author: osma

src/model/Model.php

@@ -103,6 +103,17 @@ public function getVersion(): string
         return $ver;
     }
 
+    /**
+     * Return a User-Agent header for this Skosmos installation, including the
+     * name of the software (Skosmos), the version number and URL.
+     * @return string userAgent
+     */
+    public function getUserAgent(): string
+    {
+        $version = $this->getVersion();
+        return "Skosmos/$version (https://skosmos.org/)";
+    }
+
     /**
      * Return all the vocabularies available.
      * @param boolean $categories whether you want everything included in a subarray of

src/model/resolver/LOCResource.php

@@ -12,7 +12,7 @@ public function resolve(int $timeout): ?EasyRdf\Resource
 
         try {
             $opts = array('http' => array('method' => 'HEAD',
-                                          'user_agent' => 'Skosmos',
+                                          'user_agent' => $this->model->getUserAgent(),
                                           'timeout' => $timeout));
             $context  = stream_context_create($opts);
             $fd = fopen($this->uri, 'rb', false, $context);

src/model/resolver/LinkedDataResource.php

@@ -7,7 +7,7 @@ public function resolve(int $timeout): ?EasyRdf\Resource
         try {
             // change the timeout setting for external requests
             $httpclient = EasyRdf\Http::getDefaultHttpClient();
-            $httpclient->setConfig(array('timeout' => $timeout, 'useragent' => 'Skosmos'));
+            $httpclient->setConfig(array('timeout' => $timeout, 'useragent' => $this->model->getUserAgent()));
             EasyRdf\Http::setDefaultHttpClient($httpclient);
 
             $graph = EasyRdf\Graph::newAndLoad(EasyRdf\Utils::removeFragmentFromUri($this->uri));

src/model/resolver/WDQSResource.php

@@ -9,7 +9,7 @@ public function resolve(int $timeout): ?EasyRdf\Resource
         try {
             // change the timeout setting for external requests
             $httpclient = EasyRdf\Http::getDefaultHttpClient();
-            $httpclient->setConfig(array('timeout' => $timeout, 'useragent' => 'Skosmos'));
+            $httpclient->setConfig(array('timeout' => $timeout, 'useragent' => $this->model->getUserAgent()));
             $httpclient->setHeaders('Accept', 'text/turtle');
             EasyRdf\Http::setDefaultHttpClient($httpclient);
 

src/model/sparql/GenericSparql.php

@@ -155,7 +155,7 @@ protected function initializeHttpClient()
         // configure the HTTP client used by EasyRdf\Sparql\Client
         $httpclient = EasyRdf\Http::getDefaultHttpClient();
         $httpclient->setConfig(array('timeout' => $this->model->getConfig()->getSparqlTimeout(),
-                                     'useragent' => 'Skosmos'));
+                                     'useragent' => $this->model->getUserAgent()));
 
         // if special cache control (typically no-cache) was requested by the
         // client, set the same type of cache control headers also in subsequent

tests/ModelTest.php

@@ -48,6 +48,17 @@ public function testGetVersion()
         );
     }
 
+    /**
+     * @covers Model::getUserAgent
+     */
+    public function testGetUserAgent()
+    {
+        $userAgent = $this->model->getUserAgent();
+        $version = $this->model->getVersion();
+        $expected = "Skosmos/$version (https://skosmos.org/)";
+        $this->assertEquals($expected, $userAgent);
+    }
+
     /**
      * @covers Model::getVocabularyList
      */