feat(translations): Add translation provider API

Signed-off-by: Julius Härtl <[email protected]>

Author: juliusknorr

core/Controller/TranslationApiController.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2022 Julius Härtl <[email protected]>
+ *
+ * @author Julius Härtl <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+namespace OC\Core\Controller;
+
+use OCP\AppFramework\Http\DataResponse;
+use OCP\IRequest;
+use OCP\Translation\ITranslationManager;
+use OCP\Translation\ITranslationProvider;
+
+class TranslationApiController extends \OCP\AppFramework\OCSController {
+
+	private ITranslationManager $provider;
+
+	public function __construct($appName, IRequest $request, ITranslationManager $provider) {
+		parent::__construct($appName, $request);
+
+		$this->provider = $provider;
+	}
+
+	public function languages(): DataResponse {
+		return new DataResponse([
+			'languages' => $this->provider->getLanguages()
+		]);
+	}
+
+	public function translate(string $text, string $fromLanguage, string $toLanguage): DataResponse {
+		return new DataResponse([
+			'text' => $this->provider->translate($text, $fromLanguage, $toLanguage)
+		]);
+	}
+
+}

core/routes.php

@@ -143,6 +143,8 @@
 		['root' => '/search', 'name' => 'UnifiedSearch#getProviders', 'url' => '/providers', 'verb' => 'GET'],
 		['root' => '/search', 'name' => 'UnifiedSearch#search', 'url' => '/providers/{providerId}/search', 'verb' => 'GET'],
 
+		['root' => '/translation', 'name' => 'TranslationApi#languages', 'url' => '/languages', 'verb' => 'GET'],
+		['root' => '/translation', 'name' => 'TranslationApi#translate', 'url' => '/translate', 'verb' => 'POST'],
 	],
 ]);
 

lib/private/Server.php

@@ -149,6 +149,7 @@
 use OC\Tagging\TagMapper;
 use OC\Talk\Broker;
 use OC\Template\JSCombiner;
+use OC\Translation\TranslationManager;
 use OC\User\DisplayNameCache;
 use OC\User\Listeners\BeforeUserDeletedListener;
 use OC\User\Listeners\UserChangedListener;
@@ -244,6 +245,7 @@
 use OCP\SystemTag\ISystemTagManager;
 use OCP\SystemTag\ISystemTagObjectMapper;
 use OCP\Talk\IBroker;
+use OCP\Translation\ITranslationManager;
 use OCP\User\Events\BeforePasswordUpdatedEvent;
 use OCP\User\Events\BeforeUserDeletedEvent;
 use OCP\User\Events\BeforeUserLoggedInEvent;
@@ -1453,6 +1455,8 @@ public function __construct($webRoot, \OC\Config $config) {
 
 		$this->registerAlias(\OCP\Share\IPublicShareTemplateFactory::class, \OC\Share20\PublicShareTemplateFactory::class);
 
+		$this->registerAlias(ITranslationManager::class, TranslationManager::class);
+
 		$this->connectDispatcher();
 	}
 

lib/private/Translation/TranslationManager.php

@@ -0,0 +1,61 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Julius Härtl <[email protected]>
+ *
+ * @author Julius Härtl <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+namespace OC\Translation;
+
+use OCP\Translation\ITranslationManager;
+use OCP\Translation\ITranslationProvider;
+
+class TranslationManager implements ITranslationManager {
+
+	/** @var ITranslationProvider[] */
+	private array $providers = [];
+
+	public function __construct() {
+	}
+
+	public function registerProvider(ITranslationProvider $provider) {
+		$this->providers[] = $provider;
+	}
+
+	public function getLanguages(): array {
+		$languages = [];
+		foreach ($this->providers as $provider) {
+			$languages = array_merge($languages, $provider->getAvailableLanguages());
+		}
+		return $languages;
+	}
+
+	public function translate(string $text, string $fromLanguage, string $toLanguage): string {
+		foreach ($this->providers as $provider) {
+			return $provider->translate($fromLanguage, $toLanguage, $text) ?? 'no translation';
+		}
+		return 'no provider';
+	}
+
+	public function hasProviders(): bool {
+		return !empty($this->providers);
+	}
+}

lib/public/Translation/ITranslationManager.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Julius Härtl <[email protected]>
+ *
+ * @author Julius Härtl <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+namespace OCP\Translation;
+
+/**
+ * @since 26.0.0
+ */
+interface ITranslationManager {
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function hasProviders(): bool;
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function getLanguages(): array;
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function translate(string $text, string $fromLanguage, string $toLanguage): string;
+}

lib/public/Translation/ITranslationProvider.php

@@ -0,0 +1,52 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2022 Julius Härtl <[email protected]>
+ *
+ * @author Julius Härtl <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+namespace OCP\Translation;
+
+/**
+ * @since 26.0.0
+ */
+interface ITranslationProvider {
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function getName(): string;
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function getAvailableLanguages(): array;
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function detectLanguage(string $text): ?string;
+
+	/**
+	 * @since 26.0.0
+	 */
+	public function translate(?string $fromLanguage, string $toLanguage, string $text): string;
+}