Merge pull request #36584 from nextcloud/enh/translation-api
Julius Härtl
GitHub
commit
6cfd53a78e
@ -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]);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -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 to 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 $providerRegistration) {
|
||||
$class = $providerRegistration->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;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,39 @@
|
||||
<?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 OCP\Translation;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
interface IDetectLanguageProvider {
|
||||
/**
|
||||
* Try to detect the language of a given string
|
||||
*
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function detectLanguage(string $text): ?string;
|
||||
}
|
||||
@ -0,0 +1,60 @@
|
||||
<?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 OCP\Translation;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use OCP\PreConditionNotMetException;
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
interface ITranslationManager {
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function hasProviders(): bool;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function canDetectLanguage(): bool;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
* @return LanguageTuple[]
|
||||
*/
|
||||
public function getLanguages(): array;
|
||||
|
||||
/**
|
||||
* @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
|
||||
*/
|
||||
public function translate(string $text, ?string $fromLanguage, string $toLanguage): string;
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
<?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 OCP\Translation;
|
||||
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* @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
|
||||
* @throws RuntimeException If the text could not be translated
|
||||
*/
|
||||
public function translate(?string $fromLanguage, string $toLanguage, string $text): string;
|
||||
}
|
||||
@ -0,0 +1,69 @@
|
||||
<?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 OCP\Translation;
|
||||
|
||||
use JsonSerializable;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
class LanguageTuple implements JsonSerializable {
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function __construct(
|
||||
private string $from,
|
||||
private string $fromLabel,
|
||||
private string $to,
|
||||
private string $toLabel
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function jsonSerialize(): array {
|
||||
return [
|
||||
'from' => $this->from,
|
||||
'fromLabel' => $this->fromLabel,
|
||||
'to' => $this->to,
|
||||
'toLabel' => $this->toLabel,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public static function fromArray(array $data): LanguageTuple {
|
||||
return new self(
|
||||
$data['from'],
|
||||
$data['fromLabel'],
|
||||
$data['to'],
|
||||
$data['toLabel'],
|
||||
);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue