Add a default value for user agent

landrok · Oct 29, 2020 · f44ba12 · f44ba12
1 parent c43e768
commit f44ba12
Show file tree

Hide file tree

Showing 5 changed files with 126 additions and 13 deletions.
diff --git a/docs/server/server-usage.md b/docs/server/server-usage.md
@@ -219,6 +219,23 @@ $server = new Server([
 ]);
 ```
 
+**agent**
+
+When talking to other federated servers, an instance
+uses the default user agent *ActivityPhp/x.y.z (+https://{host})*.
+
+It can be customized with agent parameter.
+
+```php
+use ActivityPhp\Server;
+
+$server = new Server([
+    'http'   => [
+        'agent' => 'MyCustomUserAgent'
+    ],
+]);
+```
+
 ________________________________________________________________________
 
 

diff --git a/src/ActivityPhp/Server.php b/src/ActivityPhp/Server.php
@@ -172,7 +172,7 @@ public function actor(string $handle)
     /**
      * Get server instance with a static call
      */
-    public static function singleton(array $settings = []): self
+    public static function server(array $settings = []): self
     {
         if (is_null(self::$singleton)) {
             self::$singleton = new self($settings);

diff --git a/src/ActivityPhp/Server/Configuration.php b/src/ActivityPhp/Server/Configuration.php
@@ -57,12 +57,12 @@ public function dispatchParameters(array $params): void
     {
         // Create default configuration for each component
         foreach ([
-                    'cache',
-                    'logger',
-                    'instance',
-                    'http',
-                    'dialects',
-                    'ontologies'
+                'cache',
+                'logger',
+                'instance',
+                'http',
+                'dialects',
+                'ontologies'
             ] as $config
         ) {
 

diff --git a/src/ActivityPhp/Server/Configuration/HttpConfiguration.php b/src/ActivityPhp/Server/Configuration/HttpConfiguration.php
@@ -12,17 +12,13 @@
 namespace ActivityPhp\Server\Configuration;
 
 use ActivityPhp\Server;
+use ActivityPhp\Version;
 
 /**
  * Server HTTP configuration stack
  */ 
 class HttpConfiguration extends AbstractConfiguration
 {
-    /**
-     * @var string default HTTP scheme
-     */
-    protected $scheme = 'https';
-
     /**
      * @var float|int HTTP timeout for request
      */
@@ -31,7 +27,7 @@ class HttpConfiguration extends AbstractConfiguration
     /**
      * @var string The User Agent.
      */
-    protected $agent = '';
+    protected $agent;
 
     /**
      * Dispatch configuration parameters
@@ -41,5 +37,42 @@ class HttpConfiguration extends AbstractConfiguration
     public function __construct(array $params = [])
     {
         parent::__construct($params);
+
+        // Configure a default value for user agent
+        if (is_null($this->agent)) {
+            $this->agent = $this->getUserAgent();
+        }
+    }
+
+    /**
+     * Prepare a default value for user agent
+     */
+    private function getUserAgent(): string
+    {
+        $scheme = Server::server()->config('instance.scheme');
+        $host = Server::server()->config('instance.host');
+        $port = Server::server()->config('instance.port');
+
+        if ($port == 443 && $scheme == 'https') {
+            $port = null;
+        }
+
+        if ($port == 80 && $scheme == 'http') {
+            $port = null;
+        }
+
+        $url = sprintf(
+            '%s://%s%s',
+            $scheme,
+            $host,
+            is_null($port) ? '' : ":{$port}"
+        );
+
+        return sprintf(
+            '%s/%s (+%s)',
+            Version::getRootNamespace(),
+            Version::getVersion(),
+            $url
+        );
     }
 }
diff --git a/tests/ActivityPhp/Server/ServerHttpTest.php b/tests/ActivityPhp/Server/ServerHttpTest.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace ActivityPhpTest\Server;
+
+use ActivityPhp\Server;
+use PHPUnit\Framework\TestCase;
+
+class ServerHttpTest extends TestCase
+{
+    public function testDefaultUserAgent()
+    {
+        $server = new Server([
+            'logger'    => [
+               'driver' => '\Psr\Log\NullLogger'
+            ],
+            'cache' => [
+                'enabled' => false,
+            ],
+            'http' => [],
+            'instance' => [
+                'host' => 'custom.federated',
+            ],
+        ]);
+
+        //
+        // PHPUnit >= 9
+        if (method_exists($this, 'assertMatchesRegularExpression')) {
+            $this->assertMatchesRegularExpression(
+                '/ActivityPhp\/\d.\d.\d \(\+https:\/\/custom.federated\)/',
+                Server::server()->config('http.agent')
+            );
+        // PHPUnit < 9
+        } else {
+            $this->assertRegExp(
+                '/ActivityPhp\/\d.\d.\d \(\+https:\/\/custom.federated\)/',
+                Server::server()->config('http.agent')
+            );
+        }
+    }
+
+    public function testUserAgentCustomization()
+    {
+        $server = new Server([
+            'logger'    => [
+               'driver' => '\Psr\Log\NullLogger'
+            ],
+            'cache' => [
+                'enabled' => false,
+            ],
+            'http' => [
+                'agent' => "MyUserAgent"
+            ],
+            'instance' => [
+                'host' => 'custom.federated',
+            ],
+        ]);
+
+        $this->assertEquals(
+            Server::server()->config('http.agent'),
+            "MyUserAgent"
+        );
+    }
+}