refactor: migrate OC_EventSource to dependency injection

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
nextcloud · May 26, 2023 · 22e5898 · 22e5898
1 parent 3e293b7
commit 22e5898
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 27 deletions.
diff --git a/core/ajax/update.php b/core/ajax/update.php
@@ -52,7 +52,7 @@
 
 $l = \OC::$server->getL10N('core');
 
-$eventSource = \OC::$server->createEventSource();
+$eventSource = \OC::$server->get(IEventSource::class);
 // need to send an initial message to force-init the event source,
 // which will then trigger its own CSRF check and produces its own CSRF error
 // message

diff --git a/lib/private/Server.php b/lib/private/Server.php
@@ -211,6 +211,7 @@
 use OCP\IDateTimeFormatter;
 use OCP\IDateTimeZone;
 use OCP\IDBConnection;
+use OCP\IEventSource;
 use OCP\IGroupManager;
 use OCP\IInitialStateService;
 use OCP\IL10N;
@@ -1467,6 +1468,12 @@ public function __construct($webRoot, \OC\Config $config) {
 
 		$this->registerAlias(ISpeechToTextManager::class, SpeechToTextManager::class);
 
+		$this->registerService(IEventSource::class, function (ContainerInterface $c) {
+			return new \OC_EventSource(
+				$c->get(IRequest::class)
+			);
+		}, false);
+
 		$this->connectDispatcher();
 	}
 
@@ -1928,16 +1935,6 @@ public function getHTTPClientService() {
 		return $this->get(IClientService::class);
 	}
 
-	/**
-	 * Create a new event source
-	 *
-	 * @return \OCP\IEventSource
-	 * @deprecated 20.0.0
-	 */
-	public function createEventSource() {
-		return new \OC_EventSource();
-	}
-
 	/**
 	 * Get the active event logger
 	 *

diff --git a/lib/private/legacy/OC_EventSource.php b/lib/private/legacy/OC_EventSource.php
@@ -1,4 +1,7 @@
 <?php
+
+use OCP\IRequest;
+
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -42,6 +45,12 @@ class OC_EventSource implements \OCP\IEventSource {
 	 */
 	private $started = false;
 
+	private IRequest $request;
+
+	public function __construct(IRequest $request) {
+		$this->request = $request;
+	}
+
 	protected function init() {
 		if ($this->started) {
 			return;
@@ -71,11 +80,11 @@ protected function init() {
 		} else {
 			header("Content-Type: text/event-stream");
 		}
-		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+		if (!$this->request->passesStrictCookieCheck()) {
 			header('Location: '.\OC::$WEBROOT);
 			exit();
 		}
-		if (!\OC::$server->getRequest()->passesCSRFCheck()) {
+		if (!$this->request->passesCSRFCheck()) {
 			$this->send('error', 'Possible CSRF attack. Connection will be closed.');
 			$this->close();
 			exit();

diff --git a/lib/public/IServerContainer.php b/lib/public/IServerContainer.php
@@ -395,15 +395,6 @@ public function getSearch();
 	 */
 	public function getCertificateManager();
 
-	/**
-	 * Create a new event source
-	 *
-	 * @return \OCP\IEventSource
-	 * @since 8.0.0
-	 * @deprecated 20.0.0 have it injected or fetch it through \Psr\Container\ContainerInterface::get
-	 */
-	public function createEventSource();
-
 	/**
 	 * Returns an instance of the HTTP client service
 	 *

diff --git a/tests/lib/ServerTest.php b/tests/lib/ServerTest.php
@@ -26,6 +26,7 @@
 
 use OC\App\AppStore\Fetcher\AppFetcher;
 use OC\App\AppStore\Fetcher\CategoryFetcher;
+use OCP\IEventSource;
 
 /**
  * Class Server
@@ -179,11 +180,6 @@ public function testGetCertificateManager() {
 		$this->assertInstanceOf('\OCP\ICertificateManager', $this->server->getCertificateManager(), 'service returned by "getCertificateManager" did not return the right class');
 	}
 
-	public function testCreateEventSource() {
-		$this->assertInstanceOf('\OC_EventSource', $this->server->createEventSource(), 'service returned by "createEventSource" did not return the right class');
-		$this->assertInstanceOf('\OCP\IEventSource', $this->server->createEventSource(), 'service returned by "createEventSource" did not return the right class');
-	}
-
 	public function testOverwriteDefaultCommentsManager() {
 		$config = $this->server->getConfig();
 		$defaultManagerFactory = $config->getSystemValue('comments.managerFactory', '\OC\Comments\ManagerFactory');
@@ -195,4 +191,14 @@ public function testOverwriteDefaultCommentsManager() {
 
 		$config->setSystemValue('comments.managerFactory', $defaultManagerFactory);
 	}
+
+	public function testEventSource(): void {
+		$a = $this->server->get(IEventSource::class);
+		$b = $this->server->get(IEventSource::class);
+
+		$this->assertInstanceOf(IEventSource::class, $a);
+		$this->assertInstanceOf(IEventSource::class, $b);
+
+		$this->assertNotSame($a, $b);
+	}
 }