feat: Allow to register a class implementing IGlobalScaleService

Signed-off-by: Carl Schwan <carl@carlschwan.eu>

Author: CarlSchwan

lib/composer/composer/autoload_classmap.php

@@ -1046,7 +1046,6 @@
     'OCP\\User\\Backend\\IGetDisplayNameBackend' => $baseDir . '/lib/public/User/Backend/IGetDisplayNameBackend.php',
     'OCP\\User\\Backend\\IGetHomeBackend' => $baseDir . '/lib/public/User/Backend/IGetHomeBackend.php',
     'OCP\\User\\Backend\\IGetRealUIDBackend' => $baseDir . '/lib/public/User/Backend/IGetRealUIDBackend.php',
-    'OCP\\User\\Backend\\IGlobalScaleExtraDataBackend' => $baseDir . '/lib/public/User/Backend/IGlobalScaleExtraDataBackend.php',
     'OCP\\User\\Backend\\ILimitAwareCountUsersBackend' => $baseDir . '/lib/public/User/Backend/ILimitAwareCountUsersBackend.php',
     'OCP\\User\\Backend\\IPasswordConfirmationBackend' => $baseDir . '/lib/public/User/Backend/IPasswordConfirmationBackend.php',
     'OCP\\User\\Backend\\IPasswordHashBackend' => $baseDir . '/lib/public/User/Backend/IPasswordHashBackend.php',

lib/composer/composer/autoload_static.php

@@ -1087,7 +1087,6 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\User\\Backend\\IGetDisplayNameBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IGetDisplayNameBackend.php',
         'OCP\\User\\Backend\\IGetHomeBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IGetHomeBackend.php',
         'OCP\\User\\Backend\\IGetRealUIDBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IGetRealUIDBackend.php',
-        'OCP\\User\\Backend\\IGlobalScaleExtraDataBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IGlobalScaleExtraDataBackend.php',
         'OCP\\User\\Backend\\ILimitAwareCountUsersBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ILimitAwareCountUsersBackend.php',
         'OCP\\User\\Backend\\IPasswordConfirmationBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IPasswordConfirmationBackend.php',
         'OCP\\User\\Backend\\IPasswordHashBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IPasswordHashBackend.php',

lib/private/AppFramework/Bootstrap/RegistrationContext.php

@@ -28,6 +28,7 @@
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Conversion\IConversionProvider;
 use OCP\Files\Template\ICustomTemplateProvider;
+use OCP\GlobalScale\IGlobalScaleService;
 use OCP\Http\WellKnown\IHandler;
 use OCP\Mail\Provider\IProvider as IMailProvider;
 use OCP\Notification\INotifier;
@@ -166,6 +167,9 @@ class RegistrationContext {
 	/** @var ServiceRegistration<IMailProvider>[] */
 	private $mailProviders = [];
 
+	/** @var class-string<IGlobalScaleService>|null */
+	private ?string $globalScaleService = null;
+
 	public function __construct(
 		private LoggerInterface $logger,
 	) {
@@ -490,6 +494,13 @@ public function registerConfigLexicon(string $configLexiconClass): void {
 					$configLexiconClass
 				);
 			}
+
+			#[\Override]
+			public function registerGlobalScaleService(string $globalScaleServiceClass): void {
+				$this->context->registerGlobalScaleService(
+					$globalScaleServiceClass
+				);
+			}
 		};
 	}
 
@@ -708,6 +719,13 @@ public function registerConfigLexicon(string $appId, string $configLexiconClass)
 		$this->configLexiconClasses[$appId] = $configLexiconClass;
 	}
 
+	/**
+	 * @param class-string<IGlobalScaleService> $class
+	 */
+	public function registerGlobalScaleService(string $class): void {
+		$this->globalScaleService = $class;
+	}
+
 	/**
 	 * @param App[] $apps
 	 */
@@ -1089,4 +1107,11 @@ public function getConfigLexicon(string $appId): ?ILexicon {
 
 		return Server::get($this->configLexiconClasses[$appId]);
 	}
+
+	/**
+	 * @return ?class-string<IGlobalScaleService>
+	 */
+	public function getGlobalScaleService(): ?string {
+		return $this->globalScaleService;
+	}
 }

lib/private/Server.php

@@ -209,6 +209,7 @@
 use OCP\Files\Template\ITemplateManager;
 use OCP\FilesMetadata\IFilesMetadataManager;
 use OCP\FullTextSearch\IFullTextSearchManager;
+use OCP\GlobalScale\IGlobalScaleService;
 use OCP\Group\ISubAdmin;
 use OCP\Http\Client\IClientService;
 use OCP\IAppConfig;
@@ -1327,6 +1328,17 @@ public function __construct(
 		$this->registerAlias(ISnowflakeDecoder::class, SnowflakeDecoder::class);
 		$this->registerAlias(IJobRuns::class, JobRuns::class);
 
+		$this->registerService(IGlobalScaleService::class, function (ContainerInterface $c): IGlobalScaleService {
+			/** @var Coordinator $coordinator */
+			$coordinator = $c->get(Coordinator::class);
+			$registrationContext = $coordinator->getRegistrationContext();
+			$globalScaleServiceClass = $registrationContext->getGlobalScaleService();
+			if ($globalScaleServiceClass === null) {
+				throw new ServiceUnavailableException('The app providing the global scale service is not enabled');
+			}
+			return $c->get($globalScaleServiceClass);
+		});
+
 		$this->connectDispatcher();
 	}
 

lib/private/ServiceUnavailableException.php

@@ -9,5 +9,7 @@
  */
 namespace OC;
 
-class ServiceUnavailableException extends \Exception {
+use Psr\Container\ContainerExceptionInterface;
+
+class ServiceUnavailableException extends \Exception implements ContainerExceptionInterface {
 }

lib/public/AppFramework/Bootstrap/IRegistrationContext.php

@@ -16,6 +16,7 @@
 use OCP\Collaboration\Reference\IReferenceProvider;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Template\ICustomTemplateProvider;
+use OCP\GlobalScale\IGlobalScaleService;
 use OCP\IContainer;
 use OCP\Mail\Provider\IProvider as IMailProvider;
 use OCP\Notification\INotifier;
@@ -459,4 +460,12 @@ public function registerMailProvider(string $class): void;
 	 * @since 31.0.0
 	 */
 	public function registerConfigLexicon(string $configLexiconClass): void;
+
+	/**
+	 * Register an implementation of {@see IGlobalScaleService}.
+	 *
+	 * @param class-string<IGlobalScaleService> $globalScaleServiceClass
+	 * @since 34.0.3
+	 */
+	public function registerGlobalScaleService(string $globalScaleServiceClass): void;
 }

lib/public/GlobalScale/IGlobalScaleService.php

@@ -26,10 +26,11 @@ interface IGlobalScaleService {
 	 * be decoded on the receiving end with {@see IGlobalScaleService::decodePayload()}.
 	 *
 	 * @param non-empty-string $path
+	 * @return string The url of the secondary
 	 * @throws \Exception When unable to send the payload.
 	 * @since 34.0.3
 	 */
-	public function sendToSecondary(IUser $user, string $path, array $payload): void;
+	public function sendToSecondary(IUser $user, string $path, array $payload): string;
 
 	/**
 	 * Decode a receiving payload.