class SmartlingTranslatorUi in TMGMT Translator Smartling 8.2
Same name and namespace in other branches
- 8.4 src/SmartlingTranslatorUi.php \Drupal\tmgmt_smartling\SmartlingTranslatorUi
- 8 src/SmartlingTranslatorUi.php \Drupal\tmgmt_smartling\SmartlingTranslatorUi
- 8.3 src/SmartlingTranslatorUi.php \Drupal\tmgmt_smartling\SmartlingTranslatorUi
Smartling translator UI.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\tmgmt\TranslatorPluginUiBase implements TranslatorPluginUiInterface
- class \Drupal\tmgmt_smartling\SmartlingTranslatorUi
- class \Drupal\tmgmt\TranslatorPluginUiBase implements TranslatorPluginUiInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SmartlingTranslatorUi
1 file declares its use of SmartlingTranslatorUi
- RequestSubscriber.php in src/
EventSubscriber/ RequestSubscriber.php
File
- src/
SmartlingTranslatorUi.php, line 21 - Contains \Drupal\tmgmt_smartling\SmartlingTranslatorUi.
Namespace
Drupal\tmgmt_smartlingView source
class SmartlingTranslatorUi extends TranslatorPluginUiBase {
const TEMP_STORAGE_NAME = 'tmgmt_smartling_send_context';
const USER_NAME_BEFORE_SWITCHING = 'user_name_before_switching';
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
/** @var \Drupal\tmgmt\TranslatorInterface $translator */
$translator = $form_state
->getFormObject()
->getEntity();
$form['project_id'] = [
'#type' => 'textfield',
'#title' => t('Project Id'),
'#default_value' => $translator
->getSetting('project_id'),
'#size' => 63,
'#maxlength' => 25,
'#required' => TRUE,
];
$form['user_id'] = [
'#type' => 'textfield',
'#title' => t('User Id'),
'#default_value' => $translator
->getSetting('user_id'),
'#size' => 63,
'#maxlength' => 40,
'#required' => TRUE,
];
$form['token_secret'] = [
'#type' => 'textfield',
'#title' => t('Token Secret'),
'#default_value' => $translator
->getSetting('token_secret'),
'#size' => 63,
'#maxlength' => 65,
'#required' => TRUE,
];
$form['contextUsername'] = [
'#type' => 'textfield',
'#title' => t('Username for context retrieval'),
'#size' => 63,
'#maxlength' => 40,
'#default_value' => $translator
->getSetting('contextUsername'),
'#required' => FALSE,
];
$form['context_silent_user_switching'] = [
'#type' => 'checkbox',
'#title' => t('Context silent user authentication'),
'#description' => t('If checked, Smartling won\'t trigger hook_login and hook_logout during user authentication for retrieving context.'),
'#default_value' => $translator
->getSetting('context_silent_user_switching'),
'#required' => FALSE,
];
$form['context_skip_host_verifying'] = [
'#type' => 'checkbox',
'#title' => t('Skip host verification'),
'#description' => t('If checked, curl won\'t verify host during retrieving context (CURLOPT_SSL_VERIFYHOST = 0). Use only for developing and testing purposes on NON PRODUCTION environments.'),
'#default_value' => $translator
->getSetting('context_skip_host_verifying'),
'#required' => FALSE,
];
$form['retrieval_type'] = [
'#type' => 'select',
'#title' => t('The desired format for download'),
'#default_value' => $translator
->getSetting('retrieval_type'),
'#options' => [
'pending' => t('Smartling returns any translations (including non-published translations)'),
'published' => t('Smartling returns only published/pre-published translations'),
'pseudo' => t('Smartling returns a modified version of the original text'),
],
'#required' => FALSE,
];
$form['auto_authorize_locales'] = [
'#type' => 'checkbox',
'#title' => t('Automatically authorize content for translation in Smartling'),
// @todo Add description to display full URL.
'#default_value' => $translator
->getSetting('auto_authorize_locales'),
'#required' => FALSE,
];
$form['callback_url_use'] = [
'#type' => 'checkbox',
'#title' => t('Use Smartling callback: [host]/tmgmt-smartling-callback/[job_id]'),
// @todo Add description to display full URL.
'#default_value' => $translator
->getSetting('callback_url_use'),
'#required' => FALSE,
];
$form['callback_url_host'] = [
'#type' => 'textfield',
'#title' => t('Override host value'),
'#description' => t('Leave blank for default value.'),
'#default_value' => $translator
->getSetting('callback_url_host'),
'#size' => 63,
'#states' => [
'visible' => [
'input[name="settings[callback_url_use]"]' => [
'checked' => TRUE,
],
],
],
];
// Any visible, writable wrapper can potentially be used for the files
// directory, including a remote file system that integrates with a CDN.
foreach (\Drupal::service('stream_wrapper_manager')
->getDescriptions(StreamWrapperInterface::WRITE_VISIBLE) as $scheme => $description) {
$options[$scheme] = $description;
}
if (!empty($options)) {
$form['scheme'] = [
'#type' => 'radios',
'#title' => t('Download method'),
'#default_value' => $translator
->getSetting('scheme'),
'#options' => $options,
'#description' => t('Choose the location where exported files should be stored. The usage of a protected location (e.g. private://) is recommended to prevent unauthorized access.'),
];
}
$form['custom_regexp_placeholder'] = [
'#type' => 'textfield',
'#title' => t('Custom placeholder (regular expression)'),
'#description' => t('The content matching this regular expression will not be editable by translators in Smartling.'),
'#size' => 63,
'#maxlength' => 80,
'#default_value' => $translator
->getSetting('custom_regexp_placeholder'),
'#required' => FALSE,
];
$form['export_format'] = [
'#type' => 'select',
'#title' => t('File type'),
'#description' => t('The file type format that is used to upload/download from Smartling'),
'#default_value' => $translator
->getSetting('export_format'),
'#options' => [
'html' => t('HTML'),
'xlf' => t('XLIFF'),
'xml' => t('XML'),
],
'#required' => FALSE,
];
// TODO: identical filename task.
// $form['identical_file_name'] = [
// '#type' => 'checkbox',
// '#title' => t('Use identical file names for jobs that contain identical content'),
// '#description' => t('Generated file will have identical name for jobs that have identical content.'),
// '#default_value' => $translator->getSetting('identical_file_name'),
// '#required' => FALSE,
// ];
$form['enable_smartling_logging'] = [
'#type' => 'checkbox',
'#title' => t('Enable Smartling remote logging'),
'#description' => t('If enabled, <b>only connector related logs</b> will be sent to Smartling - the same information stored in the database.'),
'#default_value' => $translator
->getSetting('enable_smartling_logging'),
];
$basic_auth_defaults = $translator
->getSetting('basic_auth');
$form['enable_basic_auth'] = [
'#type' => 'checkbox',
'#title' => t('Enable basic auth for context'),
'#default_value' => $translator
->getSetting('enable_basic_auth'),
];
$form['basic_auth'] = [
'#type' => 'details',
'#title' => t('Basic auth'),
'#open' => TRUE,
'#states' => [
'visible' => [
'input[name="settings[enable_basic_auth]"]' => [
'checked' => TRUE,
],
],
],
];
$form['basic_auth']['login'] = [
'#type' => 'textfield',
'#title' => t('Login'),
'#default_value' => $basic_auth_defaults['login'],
'#states' => [
'required' => [
'input[name="settings[enable_basic_auth]"]' => [
'checked' => TRUE,
],
],
],
];
$form['basic_auth']['password'] = [
'#type' => 'password',
'#title' => t('Password'),
'#attributes' => [
'value' => $basic_auth_defaults['password'],
],
'#states' => [
'required' => [
'input[name="settings[enable_basic_auth]"]' => [
'checked' => TRUE,
],
],
],
];
// Cron & queues table.
$form['cron_and_queues'] = [
'#type' => 'details',
'#title' => t('Cron & queues'),
'#open' => TRUE,
'#tree' => FALSE,
];
$header = [
'title' => t('Queue'),
'items' => t('Number of items'),
];
$options = [];
foreach (SmartlingTranslatorUi::getSmartlingQueuesDefinitions() as $name => $queue_definition) {
$queue = \Drupal::service('queue')
->get($name);
$title = (string) $queue_definition['title'];
$options[$name] = [
'title' => $title,
'items' => $queue
->numberOfItems(),
];
}
$form['cron_and_queues']['top'] = [
'#type' => 'container',
'last_run' => [
'#markup' => t('Last cron run: %time ago.', [
'%time' => \Drupal::service('date.formatter')
->formatTimeDiffSince(\Drupal::state()
->get('system.cron_last')),
]),
],
'actions' => [
'#type' => 'container',
'#attributes' => [
'class' => [
'form-actions',
],
],
'run_cron' => [
'#type' => 'submit',
'#submit' => [
[
$this,
'runCron',
],
],
'#value' => t('Run cron'),
],
],
];
$form['cron_and_queues']['queues'] = [
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#empty' => t('No queues defined'),
];
$form['cron_and_queues']['bottom'] = [
'actions' => [
'#type' => 'container',
'#attributes' => [
'class' => [
'form-actions',
],
],
'process_selected_queues' => [
'#type' => 'submit',
'#submit' => [
[
$this,
'processSelectedQueues',
],
],
'#value' => t('Process selected queues'),
],
],
];
return $form;
}
/**
* @param array $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*/
public function processSelectedQueues(array &$form, FormStateInterface $form_state) {
$selected_queues = array_filter($form_state
->getValue('queues'));
if (!empty($selected_queues)) {
$batch = [
'operations' => [],
];
// We can't switch user in a middle of the batch process so unset
// context queue from processing array if there are some additional
// queues selected.
if (count($selected_queues) > 1 && in_array('smartling_context_upload', $selected_queues)) {
unset($selected_queues['smartling_context_upload']);
drupal_set_message(t('Please, process "Upload context" queue separately.'), 'warning');
}
foreach ($selected_queues as $queue_name) {
$queue = \Drupal::service('queue')
->get($queue_name);
if ($queue
->numberOfItems()) {
// Special case for context uploading queue: we have to switch user
// before doing this in a batch and switch user back when we finish.
if ($queue_name == 'smartling_context_upload') {
$batch['finished'] = [
get_class($this),
'finishBatch',
];
$translator_settings = $form_state
->getValue('settings');
\Drupal::getContainer()
->get('user.shared_tempstore')
->get(self::TEMP_STORAGE_NAME)
->set(self::USER_NAME_BEFORE_SWITCHING, \Drupal::currentUser()
->getAccountName());
try {
\Drupal::getContainer()
->get('tmgmt_smartling.utils.context.user_auth')
->switchUser($translator_settings['contextUsername'], $translator_settings['context_silent_user_switching']);
} catch (Exception $e) {
watchdog_exception('tmgmt_smartling', $e);
}
}
foreach (range(1, $queue
->numberOfItems()) as $index) {
$batch['operations'][] = [
'\\Drupal\\tmgmt_smartling\\SmartlingTranslatorUi::step',
[
$queue_name,
],
];
}
}
}
batch_set($batch);
}
}
/**
* @param array $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*/
public function runCron(array &$form, FormStateInterface $form_state) {
if (\Drupal::service('cron')
->run()) {
drupal_set_message(t('Cron ran successfully.'));
}
else {
drupal_set_message(t('Cron run failed.'), 'error');
}
}
/**
* Batch step definition to process one queue item.
*
* Based on \Drupal\Core\Cron::processQueues().
*/
public static function step($queue_name, $context) {
if (isset($context['interrupted']) && $context['interrupted']) {
return;
}
$queueManager = \Drupal::service('plugin.manager.queue_worker');
$queueFactory = \Drupal::service('queue');
$info = $queueManager
->getDefinition($queue_name);
$title = $info['title'];
// Make sure every queue exists. There is no harm in trying to recreate
// an existing queue.
$queueFactory
->get($queue_name)
->createQueue();
$queue_worker = $queueManager
->createInstance($queue_name);
$queue = $queueFactory
->get($queue_name);
if ($item = $queue
->claimItem()) {
try {
$queue_worker
->processItem($item->data);
$context['message'] = $title;
$queue
->deleteItem($item);
} catch (SuspendQueueException $e) {
// If the worker indicates there is a problem with the whole queue,
// release the item and skip to the next queue.
$queue
->releaseItem($item);
watchdog_exception('cron', $e);
// Skip to the next queue.
$context['interrupted'] = TRUE;
} catch (Exception $e) {
// In case of any other kind of exception, log it and leave the item
// in the queue to be processed again later.
watchdog_exception('cron', $e);
}
}
}
/**
* Finish batch callback.
*
* Switch user back after "Upload context" queue batch processing.
*/
public static function finishBatch() {
$user_name_before_switching = \Drupal::getContainer()
->get('user.shared_tempstore')
->get(self::TEMP_STORAGE_NAME)
->get(self::USER_NAME_BEFORE_SWITCHING);
\Drupal::getContainer()
->get('tmgmt_smartling.utils.context.user_auth')
->switchUser($user_name_before_switching);
}
/**
* Returns Smartling queues definitions.
*
* @return array
*/
public static function getSmartlingQueuesDefinitions() {
return array_filter(\Drupal::service('plugin.manager.queue_worker')
->getDefinitions(), function ($worker) {
return in_array($worker['id'], [
'tmgmt_extension_suit_download',
'tmgmt_extension_suit_check_status',
'tmgmt_extension_suit_upload',
'smartling_context_upload',
]);
});
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::validateConfigurationForm($form, $form_state);
/** @var \Drupal\tmgmt\TranslatorInterface $translator */
$translator = $form_state
->getFormObject()
->getEntity();
$supported_remote_languages = $translator
->getPlugin()
->getSupportedRemoteLanguages($translator);
if (empty($supported_remote_languages)) {
$form_state
->setErrorByName('settings][project_id', t('The "User Id", "Token Secret", or "Project Id" are not correct.'));
$form_state
->setErrorByName('settings][user_id', t('The "User Id", "Token Secret", or "Project Id" are not correct.'));
$form_state
->setErrorByName('settings][token_secret', t('The "User Id", "Token Secret", or "Project Id" are not correct.'));
}
if ($translator
->getSetting('enable_basic_auth')) {
$auth_settings = $translator
->getSetting('basic_auth');
if (empty($auth_settings['login']) || empty($auth_settings['password'])) {
$form_state
->setErrorByName('settings][basic_auth', t('Please fill in both login and password (HTTP basic authentication credentials).'));
}
}
}
/**
* {@inheritdoc}
*/
public function checkoutInfo(JobInterface $job) {
// If the job is finished, it's not possible to import translations anymore.
if ($job
->isFinished()) {
return parent::checkoutInfo($job);
}
$output = [];
try {
$output = array(
'#type' => 'fieldset',
'#title' => t('Import translated file'),
);
$output['submit'] = array(
'#type' => 'submit',
'#value' => t('Download'),
'#submit' => [
'tmgmt_smartling_download_file_submit',
],
);
$output = $this
->checkoutInfoWrapper($job, $output);
} catch (Exception $e) {
}
return $output;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
SmartlingTranslatorUi:: |
public | function |
Form constructor. Overrides TranslatorPluginUiBase:: |
|
SmartlingTranslatorUi:: |
public | function |
Retrieves information about a translation job. Overrides TranslatorPluginUiBase:: |
|
SmartlingTranslatorUi:: |
public static | function | Finish batch callback. | |
SmartlingTranslatorUi:: |
public static | function | Returns Smartling queues definitions. | |
SmartlingTranslatorUi:: |
public | function | ||
SmartlingTranslatorUi:: |
public | function | ||
SmartlingTranslatorUi:: |
public static | function | Batch step definition to process one queue item. | |
SmartlingTranslatorUi:: |
constant | |||
SmartlingTranslatorUi:: |
constant | |||
SmartlingTranslatorUi:: |
public | function |
Form validation handler. Overrides TranslatorPluginUiBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TranslatorPluginUiBase:: |
public | function | Adds a "Connect" button to a form. | |
TranslatorPluginUiBase:: |
public | function | Provides a simple wrapper for the checkout info fieldset. | |
TranslatorPluginUiBase:: |
public | function |
Form callback for the checkout settings form. Overrides TranslatorPluginUiInterface:: |
3 |
TranslatorPluginUiBase:: |
public | function |
Form callback for the data item element form. Overrides TranslatorPluginUiInterface:: |
1 |
TranslatorPluginUiBase:: |
public | function |
Form callback for the job item review form. Overrides TranslatorPluginUiInterface:: |
|
TranslatorPluginUiBase:: |
public | function |
Submit callback for the job item review form. Overrides TranslatorPluginUiInterface:: |
|
TranslatorPluginUiBase:: |
public | function |
Validation callback for the job item review form. Overrides TranslatorPluginUiInterface:: |
|
TranslatorPluginUiBase:: |
public | function |
Form submission handler. Overrides TranslatorPluginUiInterface:: |
|
TranslatorPluginUiBase:: |
public | function | Handles submit call of "Connect" button. |