-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(translations): Add translation provider API
Signed-off-by: Julius Härtl <jus@bitgrid.net>
- Loading branch information
1 parent
93e703b
commit 012ef6d
Showing
12 changed files
with
458 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net> | ||
| * | ||
| * @author Julius Härtl <jus@bitgrid.net> | ||
| * | ||
| * @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 InvalidArgumentException; | ||
| use OCP\AppFramework\Http; | ||
| use OCP\AppFramework\Http\DataResponse; | ||
| use OCP\IRequest; | ||
| use OCP\PreConditionNotMetException; | ||
| use OCP\Translation\ITranslationManager; | ||
| use RuntimeException; | ||
|
|
||
| class TranslationApiController extends \OCP\AppFramework\OCSController { | ||
| private ITranslationManager $translationManager; | ||
|
|
||
| public function __construct($appName, IRequest $request, ITranslationManager $translationManager) { | ||
| parent::__construct($appName, $request); | ||
|
|
||
| $this->translationManager = $translationManager; | ||
| } | ||
|
|
||
| public function languages(): DataResponse { | ||
| return new DataResponse([ | ||
| 'languages' => $this->translationManager->getLanguages(), | ||
| 'languageDetection' => $this->translationManager->canDetectLanguage(), | ||
| ]); | ||
| } | ||
|
|
||
| public function translate(string $text, ?string $fromLanguage, string $toLanguage): DataResponse { | ||
| try { | ||
| return new DataResponse([ | ||
| 'text' => $this->translationManager->translate($text, $fromLanguage, $toLanguage) | ||
| ]); | ||
| } catch (PreConditionNotMetException) { | ||
| return new DataResponse(['message' => 'No translation provider available'], Http::STATUS_PRECONDITION_FAILED); | ||
| } catch (InvalidArgumentException) { | ||
| return new DataResponse(['message' => 'Could not detect language', Http::STATUS_NOT_FOUND]); | ||
| } catch (RuntimeException) { | ||
| return new DataResponse(['message' => 'Unable to translate', Http::STATUS_INTERNAL_SERVER_ERROR]); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net> | ||
| * | ||
| * @author Julius Härtl <jus@bitgrid.net> | ||
| * | ||
| * @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 InvalidArgumentException; | ||
| use OC\AppFramework\Bootstrap\Coordinator; | ||
| use OCP\IServerContainer; | ||
| use OCP\PreConditionNotMetException; | ||
| use OCP\Translation\IDetectLanguageProvider; | ||
| use OCP\Translation\ITranslationManager; | ||
| use OCP\Translation\ITranslationProvider; | ||
| use Psr\Container\ContainerExceptionInterface; | ||
| use Psr\Container\NotFoundExceptionInterface; | ||
| use Psr\Log\LoggerInterface; | ||
| use RuntimeException; | ||
| use Throwable; | ||
|
|
||
| class TranslationManager implements ITranslationManager { | ||
| /** @var ?ITranslationProvider[] */ | ||
| private ?array $providers = null; | ||
|
|
||
| public function __construct( | ||
| private IServerContainer $serverContainer, | ||
| private Coordinator $coordinator, | ||
| private LoggerInterface $logger, | ||
| ) { | ||
| } | ||
|
|
||
| public function getLanguages(): array { | ||
| $languages = []; | ||
| foreach ($this->getProviders() as $provider) { | ||
| $languages = array_merge($languages, $provider->getAvailableLanguages()); | ||
| } | ||
| return $languages; | ||
| } | ||
|
|
||
| public function translate(string $text, ?string $fromLanguage, string $toLanguage): string { | ||
| if (!$this->hasProviders()) { | ||
| throw new PreConditionNotMetException('No translation providers available'); | ||
| } | ||
|
|
||
| foreach ($this->getProviders() as $provider) { | ||
| if ($fromLanguage === null && $provider instanceof IDetectLanguageProvider) { | ||
| $fromLanguage = $provider->detectLanguage($text); | ||
| } | ||
|
|
||
| if ($fromLanguage === null) { | ||
| throw new InvalidArgumentException('Could not detect language'); | ||
| } | ||
|
|
||
| try { | ||
| return $provider->translate($fromLanguage, $toLanguage, $text); | ||
| } catch (RuntimeException $e) { | ||
| $this->logger->warning("Failed translate from {$fromLanguage} to {$toLanguage}", ['exception' => $e]); | ||
| } | ||
| } | ||
|
|
||
| throw new RuntimeException('Could not translate text'); | ||
| } | ||
|
|
||
| public function getProviders(): array { | ||
| $context = $this->coordinator->getRegistrationContext(); | ||
|
|
||
| if ($this->providers !== null) { | ||
| return $this->providers; | ||
| } | ||
|
|
||
| $this->providers = []; | ||
| foreach ($context->getTranslationProviders() as $provider) { | ||
| $class = $provider->getService(); | ||
| try { | ||
| $this->providers[$class] = $this->serverContainer->get($class); | ||
| } catch (NotFoundExceptionInterface|ContainerExceptionInterface|Throwable $e) { | ||
| $this->logger->error('Failed to load translation provider ' . $class, [ | ||
| 'exception' => $e | ||
| ]); | ||
| } | ||
| } | ||
|
|
||
| return $this->providers; | ||
| } | ||
|
|
||
| public function hasProviders(): bool { | ||
| $context = $this->coordinator->getRegistrationContext(); | ||
| return !empty($context->getTranslationProviders()); | ||
| } | ||
|
|
||
| public function canDetectLanguage(): bool { | ||
| foreach ($this->getProviders() as $provider) { | ||
| if ($provider instanceof IDetectLanguageProvider) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.