View source
<?php
namespace Drupal\tmgmt_smartling\Plugin\tmgmt\Translator;
use Drupal\Core\File\FileSystemInterface;
use Drupal;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountProxyInterface;
use Drupal\Core\Url;
use Drupal\file\FileUsage\DatabaseFileUsageBackend;
use Drupal\tmgmt\JobItemInterface;
use Drupal\tmgmt\Translator\TranslatableResult;
use Drupal\tmgmt\TranslatorPluginBase;
use Drupal\tmgmt\TranslatorInterface;
use Drupal\tmgmt\JobInterface;
use Drupal\tmgmt_extension_suit\ExtendedTranslatorPluginInterface;
use Drupal\tmgmt_file\Format\FormatManager;
use Drupal\tmgmt_smartling\Smartling\ConnectorInfo;
use Drupal\tmgmt_smartling\Smartling\SmartlingApiWrapper;
use Drupal\tmgmt_smartling\Smartling\Submission\TranslationRequestManager;
use Exception;
use GuzzleHttp\ClientInterface;
use Psr\Log\LoggerInterface;
use Smartling\AuditLog\Params\CreateRecordParameters;
use Smartling\BaseApiAbstract;
use Smartling\File\Params\UploadFileParameters;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\tmgmt\Translator\AvailableResult;
use Drupal\tmgmt\ContinuousTranslatorInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Drupal\tmgmt_smartling\Event\RequestTranslationEvent;
class SmartlingTranslator extends TranslatorPluginBase implements ExtendedTranslatorPluginInterface, ContainerFactoryPluginInterface, ContinuousTranslatorInterface {
protected $client;
protected $formatPluginsManager;
protected $fileUsage;
protected $eventDispatcher;
private $logger;
private $smartlingApiWrapper;
private $translationRequestManager;
protected $moduleHandler;
protected $currentUser;
public function __construct(ClientInterface $client, FormatManager $format_plugin_manager, DatabaseFileUsageBackend $file_usage, EventDispatcherInterface $event_dispatcher, array $configuration, $plugin_id, array $plugin_definition, LoggerInterface $logger, SmartlingApiWrapper $api_wrapper, TranslationRequestManager $translation_request_manager, ModuleHandlerInterface $module_handler, AccountProxyInterface $current_user) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->client = $client;
$this->formatPluginsManager = $format_plugin_manager;
$this->fileUsage = $file_usage;
$this->eventDispatcher = $event_dispatcher;
$this->logger = $logger;
$this->smartlingApiWrapper = $api_wrapper;
$this->translationRequestManager = $translation_request_manager;
$this->moduleHandler = $module_handler;
$this->currentUser = $current_user;
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($container
->get('http_client'), $container
->get('plugin.manager.tmgmt_file.format'), $container
->get('file.usage'), $container
->get('event_dispatcher'), $configuration, $plugin_id, $plugin_definition, $container
->get('logger.channel.smartling'), $container
->get('tmgmt_smartling.smartling_api_wrapper'), $container
->get('tmgmt_smartling.translation_request_manager'), $container
->get('module_handler'), $container
->get('current_user'));
}
public function checkAvailable(TranslatorInterface $translator) {
if ($translator
->getSetting('user_id') && $translator
->getSetting('token_secret') && $translator
->getSetting('project_id')) {
return AvailableResult::yes();
}
return AvailableResult::no(t('@translator is not available. Make sure it is properly <a href=:configured>configured</a>.', [
'@translator' => $translator
->label(),
':configured' => $translator
->toUrl(),
]));
}
public function checkTranslatable(TranslatorInterface $translator, JobInterface $job) {
return TranslatableResult::yes();
}
private function getCallbackUrl(JobInterface $job) {
$callback_url = Url::fromRoute('tmgmt_smartling.push_callback', [
'job' => $job
->id(),
])
->setOptions([
'absolute' => TRUE,
])
->toString();
$relative_callback_url = Url::fromRoute('tmgmt_smartling.push_callback', [
'job' => $job
->id(),
])
->toString();
$callback_url_host = rtrim($job
->getTranslator()
->getSetting('callback_url_host'), '/');
if (!empty($callback_url_host)) {
$callback_url = Url::fromUserInput($relative_callback_url, [
'base_url' => $callback_url_host,
])
->toString();
}
return $callback_url;
}
public function getApiWrapper(array $settings) {
ConnectorInfo::setUpCurrentClientInfo();
$this->smartlingApiWrapper
->setSettings($settings);
return $this->smartlingApiWrapper;
}
public function requestTranslation(JobInterface $job) {
$batch_uid = $job
->getSetting('batch_uid');
$api_wrapper = $this
->getApiWrapper($job
->getTranslator()
->getSettings());
$error_notification_message = t('File @name (job id = @job_id) wasn\'t uploaded. Please see logs for more info.', [
'@name' => $job
->getTranslatorPlugin()
->getFileName($job),
'@job_id' => $job
->id(),
])
->render();
$api_wrapper
->createAuditLogRecord($job, NULL, $this->currentUser, CreateRecordParameters::ACTION_TYPE_UPLOAD);
if (empty($batch_uid)) {
$this->logger
->error(t('File @name (job id = @job_id) wasn\'t uploaded due to previous error(s).', [
'@name' => $job
->getTranslatorPlugin()
->getFileName($job),
'@job_id' => $job
->id(),
])
->render());
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => $error_notification_message,
"type" => "error",
]);
return;
}
$translation_request = $this->translationRequestManager
->upsertTranslationRequest($job);
if (empty($translation_request)) {
$this->logger
->error('Can\'t upsert translation request for file @name (job id = @job_id).', [
'@name' => $job
->getTranslatorPlugin()
->getFileName($job),
'@job_id' => $job
->id(),
]);
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => 'Can\'t upsert translation request. ' . $error_notification_message,
"type" => "error",
]);
return;
}
$name = $this
->getFileName($job);
$export_format = pathinfo($name, PATHINFO_EXTENSION);
$export = $this->formatPluginsManager
->createInstance($export_format);
$path = $job
->getSetting('scheme') . '://tmgmt_sources/' . $name;
$dirname = dirname($path);
if (\Drupal::service('file_system')
->prepareDirectory($dirname, FileSystemInterface::CREATE_DIRECTORY)) {
$data = $export
->export($job);
$file = file_save_data($data, $path, FileSystemInterface::EXISTS_REPLACE);
$this->fileUsage
->add($file, 'tmgmt_smartling', 'tmgmt_job', $job
->id());
$job
->submitted('Exported file can be downloaded <a href="@link">here</a>.', array(
'@link' => file_create_url($path),
));
}
else {
$e = new \Exception('It is not possible to create a directory ' . $dirname);
watchdog_exception('tmgmt_smartling', $e);
$job
->rejected('Job has been rejected with following error: @error', [
'@error' => $e
->getMessage(),
], 'error');
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => $error_notification_message,
"type" => "error",
]);
$this->translationRequestManager
->commitError($job, $translation_request, $e);
return;
}
try {
$upload_params = new UploadFileParameters();
$upload_params
->setClientLibId(BaseApiAbstract::getCurrentClientId(), BaseApiAbstract::getCurrentClientVersion());
$upload_params
->setAuthorized(0);
if ($job
->getTranslator()
->getSetting('callback_url_use')) {
$upload_params
->set('callbackUrl', $this
->getCallbackUrl($job));
}
$file_type = $export_format === 'xlf' ? 'xliff' : $export_format;
$upload_params
->setLocalesToApprove($job
->getRemoteTargetLanguage());
$api_wrapper
->getApi('batch')
->uploadBatchFile($file
->getFileUri(), $file
->getFilename(), $file_type, $batch_uid, $this
->addSmartlingDirectives($upload_params, $job));
$message = t('File uploaded. Job id: @job_id, file name: @name.', [
'@name' => $job
->getTranslatorPlugin()
->getFileName($job),
'@job_id' => $job
->id(),
]);
$this->logger
->info($message);
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => $message
->render(),
"type" => "status",
]);
if ($job
->id() == $job
->getSetting('batch_execute_on_job')) {
$api_wrapper
->executeBatch($batch_uid);
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => t("Finished: content is in the job. You may need to wait a few seconds before content is authorized (if you checked 'authorize' checkbox).")
->render(),
"type" => "status",
]);
}
$this->eventDispatcher
->dispatch(RequestTranslationEvent::REQUEST_TRANSLATION_EVENT, new RequestTranslationEvent($job));
if (!$this->translationRequestManager
->commitSuccessfulUpload($job, $translation_request)) {
$warning_message = 'Can\'t update submitted date for translation request = @translation_request.';
$warning_message_context = [
'@translation_request' => json_encode($translation_request),
];
$this->logger
->warning($warning_message, $warning_message_context);
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => 'Can\'t update submitted date for translation request. See logs for more info.',
"type" => "warning",
]);
}
} catch (Exception $e) {
watchdog_exception('tmgmt_smartling', $e);
$job
->rejected('Job has been rejected with following error: @error uploading @file', [
'@error' => $e
->getMessage(),
'@file' => $file
->getFileUri(),
], 'error');
$api_wrapper
->createFirebaseRecord("tmgmt_smartling", "notifications", 10, [
"message" => t('Error while uploading @file. Please see logs for more info.', [
'@file' => $file
->getFileUri(),
])
->render(),
"type" => "error",
]);
$this->translationRequestManager
->commitError($job, $translation_request, $e);
}
}
protected function addSmartlingDirectives(UploadFileParameters $params, JobInterface $job) {
$directives = [
'smartling.translate_paths' => 'html/body/div/div, html/body/div/span',
'smartling.string_format_paths' => 'html : html/body/div/div, @default : html/body/div/span',
'smartling.variants_enabled' => 'true',
'smartling.source_key_paths' => 'html/body/div/{div.sl-variant}, html/body/div/{span.sl-variant}',
'smartling.character_limit_paths' => 'html/body/div/limit',
'smartling.placeholder_format_custom' => $job
->getSetting('custom_regexp_placeholder'),
'smartling.include_translatable_attributes' => $job
->getSetting('translatable_attributes'),
'smartling.exclude_translatable_attributes' => $job
->getSetting('exclude_translatable_attributes'),
'smartling.force_block_for_tags' => $job
->getSetting('force_block_for_tags'),
];
$this->moduleHandler
->alter('tmgmt_smartling_directives', $directives);
if (is_array($directives)) {
$directives = $this
->filterDirectives($directives);
foreach ($directives as $directive_name => $directive_value) {
$params
->set($directive_name, $directive_value);
}
}
return $params;
}
protected function filterDirectives(array $directives) {
$allowed_directives_for_xml_file = [
'smartling.entity_escaping',
'smartling.variants_enabled',
'smartling.translate_paths',
'smartling.string_format_paths',
'smartling.placeholder_format_custom',
'smartling.placeholder_format',
'smartling.sltrans',
'smartling.source_key_paths',
'smartling.pseudo_inflation',
'smartling.instruction_paths',
'smartling.character_limit_paths',
'smartling.force_inline_for_tags',
'smartling.include_translatable_attributes',
'smartling.exclude_translatable_attributes',
'smartling.force_block_for_tags',
];
$result = [];
foreach ($directives as $directive_name => $directive_value) {
if (in_array($directive_name, $allowed_directives_for_xml_file)) {
$result[$directive_name] = $directive_value;
}
}
return $result;
}
public function getSupportedRemoteLanguages(TranslatorInterface $translator) {
$languages = [];
if (!$translator
->getSetting('project_id')) {
return $languages;
}
try {
$smartling_project_details = $this
->getApiWrapper($translator
->getSettings())
->getApi('project')
->getProjectDetails();
foreach ($smartling_project_details['targetLocales'] as $language) {
$languages[$language['localeId']] = $language['localeId'];
}
} catch (\Exception $e) {
$this->logger
->error('Can not get languages from the translator: @message', [
'@message' => $e
->getMessage(),
]);
return $languages;
}
return $languages;
}
public function getDefaultRemoteLanguagesMappings() {
return array(
'zh-hans' => 'zh-CN',
'nl' => 'nl-NL',
'en' => 'en-EN',
);
}
public function getSupportedTargetLanguages(TranslatorInterface $translator, $source_language) {
$remote_languages = $this
->getSupportedRemoteLanguages($translator);
unset($remote_languages[$source_language]);
return $remote_languages;
}
public function hasCheckoutSettings(JobInterface $job) {
return TRUE;
}
public function getFileName(JobInterface $job) {
try {
$filename = $job
->get('job_file_name');
$filename = !empty($filename
->getValue()) ? $filename
->getValue()[0]['value'] : '';
} catch (\Exception $e) {
$filename = '';
}
if (empty($filename)) {
$extension = $job
->getSetting('export_format');
$name = "JobID" . $job
->id() . '_' . $job
->getSourceLangcode() . '_' . $job
->getTargetLangcode();
$cloned_job = clone $job;
\Drupal::moduleHandler()
->alter('tmgmt_smartling_filename', $name, $cloned_job);
$filename = $name . '.' . $extension;
}
return $filename;
}
private function cleanFileName($filename, $allow_dirs = FALSE) {
$trim_filename = trim($filename);
if (empty($trim_filename)) {
return '';
}
$pattern = '/[^a-zA-Z0-9_\\-\\:]/i';
$info = pathinfo(trim($filename));
$filename = preg_replace($pattern, '_', $info['filename']);
if (isset($info['extension']) && !empty($info['extension'])) {
$filename .= '.' . preg_replace($pattern, '_', $info['extension']);
}
if ($allow_dirs && isset($info['dirname']) && !empty($info['dirname'])) {
$filename = preg_replace('/[^a-zA-Z0-9_\\/\\-\\:]/i', '_', $info['dirname']) . '/' . $filename;
}
return (string) $filename;
}
public function defaultSettings() {
return array(
'export_format' => 'xml',
'allow_override' => TRUE,
'scheme' => 'public',
'retrieval_type' => 'published',
'callback_url_use' => FALSE,
'callback_url_host' => '',
'auto_authorize_locales' => TRUE,
'xliff_processing' => TRUE,
'context_silent_user_switching' => FALSE,
'custom_regexp_placeholder' => '(@|%|!)[\\w-]+',
'translatable_attributes' => 'title, alt',
'exclude_translatable_attributes' => '',
'force_block_for_tags' => '',
'context_skip_host_verifying' => FALSE,
'identical_file_name' => FALSE,
'enable_smartling_logging' => TRUE,
'enable_notifications' => TRUE,
'async_mode' => FALSE,
'enable_basic_auth' => FALSE,
'download_by_job_items' => FALSE,
'basic_auth' => [
'login' => '',
'password' => '',
],
);
}
public function requestJobItemsTranslation(array $job_items) {
$job = reset($job_items)
->getJob();
foreach ($job_items as $job_item) {
$this
->requestTranslation($job_item
->getJob());
if ($job
->isContinuous()) {
$job_item
->active();
}
}
}
public function isReadyForDownload(JobInterface $job) {
return $this->translationRequestManager
->isTranslationRequestReadyForDownload($job);
}
public function abortTranslation(JobInterface $job) {
$api_wrapper = $this
->getApiWrapper($job
->getTranslator()
->getSettings());
$api_wrapper
->createAuditLogRecord($job, NULL, $this->currentUser, CreateRecordParameters::ACTION_TYPE_CANCEL);
return parent::abortTranslation($job);
}
public function downloadTranslation(JobInterface $job, JobItemInterface $jobItem = NULL) {
return tmgmt_smartling_download_file($job, $jobItem);
}
public function cancelTranslation(JobInterface $job) {
}
public function requestTranslationExtended(JobInterface $job, array $data) {
$settings_map_item = $job->settings
->get(0);
if ($settings_map_item) {
$settings = $settings_map_item
->getValue();
if (isset($data['batch_uid'])) {
$settings['batch_uid'] = $data['batch_uid'];
}
if ($data['batch_execute_on_job']) {
$settings['batch_execute_on_job'] = $data['batch_execute_on_job'];
}
$job->settings
->set(0, $settings);
}
$this
->requestTranslation($job);
}
}
