diff options
| -rw-r--r-- | core/Controller/TranslationApiController.php | 12 | ||||
| -rw-r--r-- | lib/composer/composer/autoload_classmap.php | 1 | ||||
| -rw-r--r-- | lib/composer/composer/autoload_static.php | 1 | ||||
| -rw-r--r-- | lib/private/Translation/TranslationManager.php | 19 | ||||
| -rw-r--r-- | lib/public/Translation/CouldNotTranslateException.php | 47 | ||||
| -rw-r--r-- | lib/public/Translation/ITranslationManager.php | 5 |
6 files changed, 73 insertions, 12 deletions
diff --git a/core/Controller/TranslationApiController.php b/core/Controller/TranslationApiController.php index a09f7e6aba9..2d47d99e654 100644 --- a/core/Controller/TranslationApiController.php +++ b/core/Controller/TranslationApiController.php @@ -32,8 +32,8 @@ use OCP\AppFramework\Http\DataResponse; use OCP\IL10N; use OCP\IRequest; use OCP\PreConditionNotMetException; +use OCP\Translation\CouldNotTranslateException; use OCP\Translation\ITranslationManager; -use RuntimeException; class TranslationApiController extends \OCP\AppFramework\OCSController { private ITranslationManager $translationManager; @@ -68,15 +68,19 @@ class TranslationApiController extends \OCP\AppFramework\OCSController { */ public function translate(string $text, ?string $fromLanguage, string $toLanguage): DataResponse { try { + $translation = $this->translationManager->translate($text, $fromLanguage, $toLanguage); + return new DataResponse([ - 'text' => $this->translationManager->translate($text, $fromLanguage, $toLanguage) + 'text' => $translation, + 'from' => $fromLanguage, + ]); } catch (PreConditionNotMetException) { return new DataResponse(['message' => $this->l->t('No translation provider available')], Http::STATUS_PRECONDITION_FAILED); } catch (InvalidArgumentException) { return new DataResponse(['message' => $this->l->t('Could not detect language')], Http::STATUS_BAD_REQUEST); - } catch (RuntimeException) { - return new DataResponse(['message' => $this->l->t('Unable to translate')], Http::STATUS_BAD_REQUEST); + } catch (CouldNotTranslateException $e) { + return new DataResponse(['message' => $this->l->t('Unable to translate'), 'from' => $e->getFrom()], Http::STATUS_BAD_REQUEST); } } } diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 83eef30eed1..316b21e8122 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -615,6 +615,7 @@ return array( 'OCP\\Talk\\IConversationOptions' => $baseDir . '/lib/public/Talk/IConversationOptions.php', 'OCP\\Talk\\ITalkBackend' => $baseDir . '/lib/public/Talk/ITalkBackend.php', 'OCP\\Template' => $baseDir . '/lib/public/Template.php', + 'OCP\\Translation\\CouldNotTranslateException' => $baseDir . '/lib/public/Translation/CouldNotTranslateException.php', 'OCP\\Translation\\IDetectLanguageProvider' => $baseDir . '/lib/public/Translation/IDetectLanguageProvider.php', 'OCP\\Translation\\ITranslationManager' => $baseDir . '/lib/public/Translation/ITranslationManager.php', 'OCP\\Translation\\ITranslationProvider' => $baseDir . '/lib/public/Translation/ITranslationProvider.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 1f97b5518f9..656f8196320 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -648,6 +648,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OCP\\Talk\\IConversationOptions' => __DIR__ . '/../../..' . '/lib/public/Talk/IConversationOptions.php', 'OCP\\Talk\\ITalkBackend' => __DIR__ . '/../../..' . '/lib/public/Talk/ITalkBackend.php', 'OCP\\Template' => __DIR__ . '/../../..' . '/lib/public/Template.php', + 'OCP\\Translation\\CouldNotTranslateException' => __DIR__ . '/../../..' . '/lib/public/Translation/CouldNotTranslateException.php', 'OCP\\Translation\\IDetectLanguageProvider' => __DIR__ . '/../../..' . '/lib/public/Translation/IDetectLanguageProvider.php', 'OCP\\Translation\\ITranslationManager' => __DIR__ . '/../../..' . '/lib/public/Translation/ITranslationManager.php', 'OCP\\Translation\\ITranslationProvider' => __DIR__ . '/../../..' . '/lib/public/Translation/ITranslationProvider.php', diff --git a/lib/private/Translation/TranslationManager.php b/lib/private/Translation/TranslationManager.php index ec829e83255..2a2b2cd0066 100644 --- a/lib/private/Translation/TranslationManager.php +++ b/lib/private/Translation/TranslationManager.php @@ -30,6 +30,7 @@ use InvalidArgumentException; use OC\AppFramework\Bootstrap\Coordinator; use OCP\IServerContainer; use OCP\PreConditionNotMetException; +use OCP\Translation\CouldNotTranslateException; use OCP\Translation\IDetectLanguageProvider; use OCP\Translation\ITranslationManager; use OCP\Translation\ITranslationProvider; @@ -58,20 +59,28 @@ class TranslationManager implements ITranslationManager { return $languages; } - public function translate(string $text, ?string $fromLanguage, string $toLanguage): string { + 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) { + foreach ($this->getProviders() as $provider) { + if ($provider instanceof IDetectLanguageProvider) { + $fromLanguage = $provider->detectLanguage($text); + } + + if ($fromLanguage !== null) { + break; + } } if ($fromLanguage === null) { throw new InvalidArgumentException('Could not detect language'); } + } + foreach ($this->getProviders() as $provider) { try { return $provider->translate($fromLanguage, $toLanguage, $text); } catch (RuntimeException $e) { @@ -79,7 +88,7 @@ class TranslationManager implements ITranslationManager { } } - throw new RuntimeException('Could not translate text'); + throw new CouldNotTranslateException($fromLanguage); } public function getProviders(): array { diff --git a/lib/public/Translation/CouldNotTranslateException.php b/lib/public/Translation/CouldNotTranslateException.php new file mode 100644 index 00000000000..bf7f5b4e8b3 --- /dev/null +++ b/lib/public/Translation/CouldNotTranslateException.php @@ -0,0 +1,47 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> + * + * @author Joas Schilling <coding@schilljs.com> + * + * @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 27.0.0 + */ +class CouldNotTranslateException extends \RuntimeException { + /** + * @since 27.0.0 + */ + public function __construct( + protected ?string $from, + ) { + parent::__construct(); + } + + /** + * @since 27.0.0 + */ + public function getFrom(): ?string { + return $this->from; + } +} diff --git a/lib/public/Translation/ITranslationManager.php b/lib/public/Translation/ITranslationManager.php index c6b67462152..4450f19c424 100644 --- a/lib/public/Translation/ITranslationManager.php +++ b/lib/public/Translation/ITranslationManager.php @@ -28,7 +28,6 @@ namespace OCP\Translation; use InvalidArgumentException; use OCP\PreConditionNotMetException; -use RuntimeException; /** * @since 26.0.0 @@ -54,7 +53,7 @@ interface ITranslationManager { * @since 26.0.0 * @throws PreConditionNotMetException If no provider was registered but this method was still called * @throws InvalidArgumentException If no matching provider was found that can detect a language - * @throws RuntimeException If the translation failed for other reasons + * @throws CouldNotTranslateException If the translation failed for other reasons */ - public function translate(string $text, ?string $fromLanguage, string $toLanguage): string; + public function translate(string $text, ?string &$fromLanguage, string $toLanguage): string; } |