diff --git a/solid/lib/Controller/CalendarController.php b/solid/lib/Controller/CalendarController.php index f193a798..4a721aec 100644 --- a/solid/lib/Controller/CalendarController.php +++ b/solid/lib/Controller/CalendarController.php @@ -19,6 +19,7 @@ use Pdsinterop\Solid\Resources\Server as ResourceServer; class CalendarController extends Controller { + use GetServerUriTrait; use DpopFactoryTrait; /* @var IURLGenerator */ @@ -61,11 +62,7 @@ private function getFileSystem($userId) { // Create Formats objects $formats = new \Pdsinterop\Rdf\Formats(); - $serverParams = $this->rawRequest->getServerParams(); - $scheme = $serverParams['REQUEST_SCHEME']; - $domain = $serverParams['SERVER_NAME']; - $path = $serverParams['REQUEST_URI']; - $serverUri = "{$scheme}://{$domain}{$path}"; // FIXME: doublecheck that this is the correct url; + $serverUri = $this->getServerUri($this->request); // Create the RDF Adapter $rdfAdapter = new \Pdsinterop\Rdf\Flysystem\Adapter\Rdf( diff --git a/solid/lib/Controller/ContactsController.php b/solid/lib/Controller/ContactsController.php index 52c964f1..e9cf3c16 100644 --- a/solid/lib/Controller/ContactsController.php +++ b/solid/lib/Controller/ContactsController.php @@ -20,6 +20,7 @@ class ContactsController extends Controller { + use GetServerUriTrait; use DpopFactoryTrait; /* @var IURLGenerator */ @@ -62,11 +63,7 @@ private function getFileSystem($userId) { // Create Formats objects $formats = new \Pdsinterop\Rdf\Formats(); - $serverParams = $this->rawRequest->getServerParams(); - $scheme = $serverParams['REQUEST_SCHEME']; - $domain = $serverParams['SERVER_NAME']; - $path = $serverParams['REQUEST_URI']; - $serverUri = "{$scheme}://{$domain}{$path}"; // FIXME: doublecheck that this is the correct url; + $serverUri = $this->getServerUri($this->request); // Create the RDF Adapter $rdfAdapter = new \Pdsinterop\Rdf\Flysystem\Adapter\Rdf( diff --git a/solid/lib/Controller/GetServerUriTrait.php b/solid/lib/Controller/GetServerUriTrait.php new file mode 100644 index 00000000..2509b377 --- /dev/null +++ b/solid/lib/Controller/GetServerUriTrait.php @@ -0,0 +1,30 @@ +getServerProtocol(); + $host = $request->getServerHost(); + $path = $request->getRequestUri(); + + return "{$scheme}://{$host}{$path}"; + } +} diff --git a/solid/lib/Controller/ProfileController.php b/solid/lib/Controller/ProfileController.php index 35a3273a..035063ff 100644 --- a/solid/lib/Controller/ProfileController.php +++ b/solid/lib/Controller/ProfileController.php @@ -21,6 +21,7 @@ use Pdsinterop\Solid\Resources\Server as ResourceServer; class ProfileController extends Controller { + use GetServerUriTrait; use DpopFactoryTrait; use GetStorageUrlTrait; @@ -67,11 +68,7 @@ private function getFileSystem($userId) { // Create Formats objects $formats = new \Pdsinterop\Rdf\Formats(); - $serverParams = $this->rawRequest->getServerParams(); - $scheme = $serverParams['REQUEST_SCHEME']; - $domain = $serverParams['SERVER_NAME']; - $path = $serverParams['REQUEST_URI']; - $serverUri = "{$scheme}://{$domain}{$path}"; // FIXME: doublecheck that this is the correct url; + $serverUri = $this->getServerUri($this->request); // Create the RDF Adapter $rdfAdapter = new \Pdsinterop\Rdf\Flysystem\Adapter\Rdf( diff --git a/solid/lib/Controller/SolidWebhookController.php b/solid/lib/Controller/SolidWebhookController.php index 1b19dd4b..f2d8a6fe 100644 --- a/solid/lib/Controller/SolidWebhookController.php +++ b/solid/lib/Controller/SolidWebhookController.php @@ -23,6 +23,7 @@ use Pdsinterop\Solid\Auth\WAC as WAC; class SolidWebhookController extends Controller { + use GetServerUriTrait; use DpopFactoryTrait; use GetStorageUrlTrait; @@ -119,7 +120,7 @@ private function getFileSystem() { // Create Formats objects $formats = new \Pdsinterop\Rdf\Formats(); - $serverUri = "https://" . $this->rawRequest->getServerParams()["SERVER_NAME"] . $this->rawRequest->getServerParams()["REQUEST_URI"]; // FIXME: doublecheck that this is the correct url; + $serverUri = $this->getServerUri($this->request); // Create the RDF Adapter $rdfAdapter = new \Pdsinterop\Rdf\Flysystem\Adapter\Rdf( diff --git a/solid/lib/Controller/StorageController.php b/solid/lib/Controller/StorageController.php index 7d4650ee..c01ef039 100644 --- a/solid/lib/Controller/StorageController.php +++ b/solid/lib/Controller/StorageController.php @@ -23,6 +23,7 @@ class StorageController extends Controller { + use GetServerUriTrait; use BearerFactoryTrait; use DpopFactoryTrait; use GetStorageUrlTrait; @@ -64,11 +65,7 @@ private function getFileSystem() { // Create Formats objects $formats = new \Pdsinterop\Rdf\Formats(); - $serverParams = $this->rawRequest->getServerParams(); - $scheme = $serverParams['REQUEST_SCHEME']; - $domain = $serverParams['SERVER_NAME']; - $path = $serverParams['REQUEST_URI']; - $serverUri = "{$scheme}://{$domain}{$path}"; // FIXME: doublecheck that this is the correct url; + $serverUri = $this->getServerUri($this->request); // Create the RDF Adapter $rdfAdapter = new \Pdsinterop\Rdf\Flysystem\Adapter\Rdf( diff --git a/solid/tests/Unit/Controller/GetServerUriTraitTest.php b/solid/tests/Unit/Controller/GetServerUriTraitTest.php new file mode 100644 index 00000000..048045d9 --- /dev/null +++ b/solid/tests/Unit/Controller/GetServerUriTraitTest.php @@ -0,0 +1,84 @@ +trait = new class { + use GetServerUriTrait; + }; + } + + /////////////////////////////////// TESTS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ + + /** + * @testdox GetServerUriTrait should build the request URI from the protocol, host and path that Nextcloud reports + * @covers ::getServerUri + */ + public function testGetServerUri(): void + { + $request = $this->getMockRequest('https', 'cloud.example.com', '/apps/solid/~alice/storage/.acl'); + + $actual = $this->trait->getServerUri($request); + + $this->assertEquals('https://cloud.example.com/apps/solid/~alice/storage/.acl', $actual); + } + + /** + * @testdox GetServerUriTrait should keep a non-default port that is part of the server host + * @covers ::getServerUri + */ + public function testGetServerUriWithPort(): void + { + $request = $this->getMockRequest('https', 'cloud.example.com:8443', '/apps/solid/~alice/profile/card'); + + $actual = $this->trait->getServerUri($request); + + $this->assertEquals('https://cloud.example.com:8443/apps/solid/~alice/profile/card', $actual); + } + + /** + * @testdox GetServerUriTrait should not read the scheme or host from $_SERVER, which describe the internal hop behind a TLS-terminating proxy + * @covers ::getServerUri + */ + public function testGetServerUriIgnoresInternalServerVariables(): void + { + $backup = $_SERVER; + $_SERVER['REQUEST_SCHEME'] = 'http'; + $_SERVER['SERVER_NAME'] = 'internal-container-name'; + + try { + $request = $this->getMockRequest('https', 'cloud.example.com', '/apps/solid/~alice/storage/'); + $actual = $this->trait->getServerUri($request); + } finally { + $_SERVER = $backup; + } + + $this->assertEquals('https://cloud.example.com/apps/solid/~alice/storage/', $actual); + } + + ////////////////////////////// MOCKS AND STUBS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ + + private function getMockRequest(string $protocol, string $host, string $path): IRequest|MockObject + { + $request = $this->createMock(IRequest::class); + $request->method('getServerProtocol')->willReturn($protocol); + $request->method('getServerHost')->willReturn($host); + $request->method('getRequestUri')->willReturn($path); + + return $request; + } +}