class SmartlingTranslator in TMGMT Translator Smartling 8.3

Same name and namespace in other branches

8.4 src/Plugin/tmgmt/Translator/SmartlingTranslator.php \Drupal\tmgmt_smartling\Plugin\tmgmt\Translator\SmartlingTranslator
8 src/Plugin/tmgmt/Translator/SmartlingTranslator.php \Drupal\tmgmt_smartling\Plugin\tmgmt\Translator\SmartlingTranslator
8.2 src/Plugin/tmgmt/Translator/SmartlingTranslator.php \Drupal\tmgmt_smartling\Plugin\tmgmt\Translator\SmartlingTranslator

Smartling translator plugin.

Plugin annotation


@TranslatorPlugin(
  id = "smartling",
  label = @Translation("Smartling translator"),
  description = @Translation("Smartling Translator service."),
  ui = "Drupal\tmgmt_smartling\SmartlingTranslatorUi"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\tmgmt\TranslatorPluginBase implements TranslatorPluginInterface
    class \Drupal\tmgmt_smartling\Plugin\tmgmt\Translator\SmartlingTranslator implements \Drupal\tmgmt_extension_suit\ExtendedTranslatorPluginInterface, ContainerFactoryPluginInterface, ContinuousTranslatorInterface

Expanded class hierarchy of SmartlingTranslator

6 files declare their use of SmartlingTranslator

RequestTranslationSubscriber.php in src/EventSubscriber/RequestTranslationSubscriber.php
SendContextActionApproveForm.php in src/Form/SendContextActionApproveForm.php
SmartlingTranslatorTest.php in tests/src/Kernel/SmartlingTranslatorTest.php
TmgmtSmartlingDashboardLink.php in src/Plugin/views/field/TmgmtSmartlingDashboardLink.php: Definition of Drupal\tmgmt_smartling\Plugin\views\field\TmgmtSmartlingDashboardLink
TranslationJobToUrl.php in src/Context/TranslationJobToUrl.php

... See full list

File

src/Plugin/tmgmt/Translator/SmartlingTranslator.php, line 48: Contains \Drupal\tmgmt_smartling\Plugin\tmgmt\Translator\SmartlingTranslator.

Namespace

Drupal\tmgmt_smartling\Plugin\tmgmt\Translator

View source

class SmartlingTranslator extends TranslatorPluginBase implements ExtendedTranslatorPluginInterface, ContainerFactoryPluginInterface, ContinuousTranslatorInterface {

  /**
   * Guzzle HTTP client.
   *
   * @var \Drupal\tmgmt_smartling\Smartling\SmartlingApi
   */
  protected $smartlingApi;

  /**
   * @var \GuzzleHttp\ClientInterface
   */
  protected $client;

  /**
   * @var \Drupal\tmgmt_file\Format\FormatManager
   */
  protected $formatPluginsManager;

  /**
   * @var \Drupal\file\FileUsage\DatabaseFileUsageBackend
   */
  protected $fileUsage;

  /**
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * @var LoggerInterface
   */
  private $logger;

  /**
   * @var SmartlingApiWrapper
   */
  private $smartlingApiWrapper;

  /**
   * @var TranslationProgressCalculator
   */
  private $translationProgressCalculator;

  /**
   * @var ModuleHandlerInterface
   */
  protected $moduleHandler;
  protected $currentUser;

  /**
   * Constructs a LocalActionBase object.
   *
   * @param \GuzzleHttp\ClientInterface $client
   *   The Guzzle HTTP client.
   * @param \Drupal\tmgmt_file\Format\FormatManager $format_plugin_manager
   * @param \Drupal\file\FileUsage\DatabaseFileUsageBackend $file_usage
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Psr\Log\LoggerInterface $logger
   * @param \Drupal\tmgmt_smartling\Smartling\SmartlingApiWrapper $api_wrapper
   * @param TranslationProgressCalculator $translation_progress_calculator
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   */
  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, TranslationProgressCalculator $translation_progress_calculator, 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->translationProgressCalculator = $translation_progress_calculator;
    $this->moduleHandler = $module_handler;
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  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_progress_calculator'), $container
      ->get('module_handler'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  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
        ->url(),
    ]));
  }

  /**
   * {@inheritdoc}
   */
  public function checkTranslatable(TranslatorInterface $translator, JobInterface $job) {

    // Anything can be exported.
    return TranslatableResult::yes();
  }

  /**
   * Returns callback url.
   *
   * Host value can be overridden by value defined in translator settings.
   *
   * @param JobInterface $job
   *
   * @return Drupal\Core\GeneratedUrl|string
   */
  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;
  }

  /**
   * @param array $settings
   * @return \Drupal\tmgmt_smartling\Smartling\SmartlingApiWrapper
   */
  public function getApiWrapper(array $settings) {
    ConnectorInfo::setUpCurrentClientInfo();
    $this->smartlingApiWrapper
      ->setSettings($settings);
    return $this->smartlingApiWrapper;
  }

  /**
   * {@inheritdoc}
   */
  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);

    // Skip processing if job/batch hasn't been created.
    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;
    }
    $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 (file_prepare_directory($dirname, FILE_CREATE_DIRECTORY)) {
      $data = $export
        ->export($job);
      $file = file_save_data($data, $path, FILE_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",
      ]);
    }
    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));
      }
      $real_path = \Drupal::service('file_system')
        ->realpath($file
        ->getFileUri());
      $file_type = $export_format === 'xlf' ? 'xliff' : $export_format;
      $upload_params
        ->setLocalesToApprove($job
        ->getRemoteTargetLanguage());
      $api_wrapper
        ->getApi('batch')
        ->uploadBatchFile($real_path, $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));
    } 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",
      ]);
    }

    // @todo disallow to submit translation to unsupported language.
  }

  /**
   * Adds smartling directives to upload parameters.
   *
   * Array of directives can be altered by `tmgmt_smartling_directives_alter`
   * hook.
   *
   * @param \Smartling\File\Params\UploadFileParameters $params
   * @param \Drupal\tmgmt\JobInterface $job
   *
   * @return \Smartling\File\Params\UploadFileParameters
   */
  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'),
    ];
    $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;
  }

  /**
   * @param array $directives
   * @return array
   */
  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',
    ];
    $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;
  }

  /**
   * {@inheritdoc}
   */
  public function getSupportedRemoteLanguages(TranslatorInterface $translator) {
    $languages = [];

    // Prevent access if the translator isn't configured yet.
    if (!$translator
      ->getSetting('project_id')) {

      // @todo should be implemented by an Exception.
      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;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultRemoteLanguagesMappings() {
    return array(
      'zh-hans' => 'zh-CH',
      'nl' => 'nl-NL',
      'en' => 'en-EN',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getSupportedTargetLanguages(TranslatorInterface $translator, $source_language) {
    $remote_languages = $this
      ->getSupportedRemoteLanguages($translator);
    unset($remote_languages[$source_language]);
    return $remote_languages;
  }

  /**
   * {@inheritdoc}
   */
  public function hasCheckoutSettings(JobInterface $job) {
    return TRUE;
  }

  /**
   * Returns file name.
   *
   * @param \Drupal\tmgmt\JobInterface $job
   * @return string
   */
  public function getFileName(JobInterface $job) {

    // TODO: identical filename task.
    // $extension = $job->getSetting('export_format');
    //
    // try {
    //   // Try to load existing file name from tmgmt_job table.
    //   $filename = $job->get('job_file_name');
    //
    //   if (!empty($filename->getValue())) {
    //     $filename = $filename->getValue()[0]['value'];
    //   }
    //   // Job item title should be included into a filename only if there is a
    //   // single JobItem in a Job. If there are 3 JobItems in a file - file name
    //   // should be "@entity_type_@entity_id>". And finally for every Job with
    //   // more than 3 JobItems - standard "JobId@id"
    //   elseif ($extension == 'xml') {
    //     $file_names = [];
    //     $job_items = $job->getItems();
    //     $job_items_count = count($job_items);
    //
    //     if ($job_items_count == 1) {
    //       $file_name_type = 'expanded';
    //     }
    //     else if ($job_items_count > 1 && $job_items_count <= 3) {
    //       $file_name_type = 'simplified';
    //     }
    //     else {
    //       $file_name_type = 'default';
    //     }
    //
    //     foreach ($job_items as $job_item) {
    //       $job_item_id = $job_item->getItemId();
    //       $job_item_type = $job_item->getItemType();
    //
    //       switch ($file_name_type) {
    //         case 'expanded':
    //           $temp_name = $job_item->getSourceLabel() . '_' . $job_item_type . '_' . $job_item_id;
    //
    //           break;
    //
    //         case 'simplified':
    //           $temp_name = $job_item_type . '_' . $job_item_id;
    //
    //           break;
    //
    //         default:
    //           $file_names[$job_item_id] = 'JobID' . $job->id() . '_' . $job->getSourceLangcode() . '_' . $job->getTargetLangcode();
    //
    //           break 2;
    //       }
    //
    //       $file_names[$job_item_id] = $temp_name;
    //     }
    //
    //     ksort($file_names);
    //     $filename = $this->cleanFileName(implode('_', $file_names) . '.' . $extension);
    //   }
    //   else {
    //     $filename = '';
    //   }
    // } catch (\Exception $e) {
    //   $filename = '';
    // }
    //
    // // Fallback to default file name.
    // if (empty($filename) || !$job->getSetting('identical_file_name')) {
    //   $filename = "JobID" . $job->id() . '_' . $job->getSourceLangcode() . '_' . $job->getTargetLangcode() . '.' . $extension;
    // }
    //
    // return $filename;
    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();

      // Alter name before saving it into database.
      $cloned_job = clone $job;
      \Drupal::moduleHandler()
        ->alter('tmgmt_smartling_filename', $name, $cloned_job);
      $filename = $name . '.' . $extension;
    }
    return $filename;
  }

  /**
   * Return clean filename, sanitized for path traversal vulnerability.
   *
   * Url (https://code.google.com/p/teenage-mutant-ninja-turtles
   * /wiki/AdvancedObfuscationPathtraversal).
   *
   * @param string $filename
   *   File name.
   * @param bool $allow_dirs
   *   TRUE if allow dirs. FALSE by default.
   *
   * @return string
   *   Return clean filename.
   */
  private function cleanFileName($filename, $allow_dirs = FALSE) {

    // Prior to PHP 5.5, empty() only supports variables.
    // (http://www.php.net/manual/en/function.empty.php).
    $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;
  }

  /**
   * {@inheritdoc}
   */
  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-]+',
      'context_skip_host_verifying' => FALSE,
      'identical_file_name' => FALSE,
      'enable_smartling_logging' => TRUE,
      'enable_notifications' => TRUE,
      'async_mode' => FALSE,
      'enable_basic_auth' => FALSE,
      'basic_auth' => [
        'login' => '',
        'password' => '',
      ],
    );
  }

  /**
   * {@inheritdoc}
   */
  public function requestJobItemsTranslation(array $job_items) {

    /** @var \Drupal\tmgmt\Entity\Job $job */
    $job = reset($job_items)
      ->getJob();
    foreach ($job_items as $job_item) {

      //tmgmt_smartling_download_file($job_item->getJob());
      $this
        ->requestTranslation($job_item
        ->getJob());
      if ($job
        ->isContinuous()) {
        $job_item
          ->active();
      }
    }
  }

  /**
   * Downloads translation file and applies it.
   *
   * @param \Drupal\tmgmt\JobInterface $job
   *
   * @return bool
   */
  public function downloadTranslation(JobInterface $job) {
    return tmgmt_smartling_download_file($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);
  }

  /**
   * Checks if file is ready for download.
   *
   * @param JobInterface $job
   *
   * @return bool
   */
  public function isReadyForDownload(JobInterface $job) {
    $result = FALSE;
    try {
      $settings = $job
        ->getTranslator()
        ->getSettings();
      $api_wrapper = $this
        ->getApiWrapper($settings);
      $filename = $this
        ->getFileName($job);
      $locale = $job
        ->getRemoteTargetLanguage();
      $request_result = $api_wrapper
        ->getApi('file')
        ->getStatus($filename, $locale);
      $progress = $this->translationProgressCalculator
        ->calculate($request_result, $settings["auto_authorize_locales"]);
      $file_last_modified = 0;
      $job_last_modified = intval($job
        ->getChangedTime());
      $last_modified = $api_wrapper
        ->getApi('file')
        ->lastModified($filename);
      foreach ($last_modified['items'] as $item) {
        if ($item['localeId'] == $locale) {
          $file_last_modified = $item['lastModified']
            ->getTimeStamp();
          break;
        }
      }

      // Chain of calls:
      // 1. Check status worker: SmartlingTranslator::isReadyForDownload().
      // 2. Download worker: SmartlingTranslator::isReadyForDownload() ->
      // SmartlingTranslator::downloadTranslation().
      //
      // In Drupal 7 connector we don't have second check "isReadyForDownload"
      // so there is a simpler condition - just if $file_last_modified GRATER
      // than $job_last_modified. In Drupal 8 connector we have a second call
      // of SmartlingTranslator::isReadyForDownload() so we need to take into
      // consideration this case.
      //
      // If $file_last_modified == $job_last_modified then it means that
      // this is second call of SmartlingTranslator::isReadyForDownload() for
      // this job (from JobDownload::processItem(), in other words it's happened
      // from download queue. In this case we should "lock" this check by
      // setting job's changed time as current time. Otherwise here will be
      // infinite loop of downloading process ($job_last_modified will always
      // be equal to $file_last_modified)).
      if ($file_last_modified >= $job_last_modified && $progress === 100) {

        // Case when $file_last_modified > $job_last_modified - the first check
        // "isReadyForDownload" from check status queue worker. Unlock the
        // condition for the second "isReadyForDownload" check from download
        // queue worker.
        if ($file_last_modified > $job_last_modified) {
          $job
            ->set('changed', $file_last_modified);
        }
        else {
          $job
            ->set('changed', time());
        }
        $job
          ->save();
        $result = TRUE;
      }
      else {
        $this->logger
          ->warning(t('File @file is not ready for download.', [
          '@file' => $this
            ->getFileName($job),
        ])
          ->render());
      }
      $this->logger
        ->info('Check status for file: @filename found @approved pending words and @completed completed ones', [
        '@filename' => $filename,
        '@approved' => $request_result['authorizedStringCount'],
        '@completed' => $request_result['completedStringCount'],
      ]);
    } catch (SmartlingApiException $e) {
      $this
        ->handleSmartlingApiException($e, $job);
    } catch (\Exception $e) {
      watchdog_exception('tmgmt_smartling', $e);
    }
    return $result;
  }
  protected function handleSmartlingApiException(SmartlingApiException $e, JobInterface $job) {
    if (!empty($e
      ->getErrorsByKey('file.not.found'))) {
      $filename = $this
        ->getFileName($job);
      $message = 'The file @filename could not be found in Smartling. The job @job_id is rejected. Please resubmit TMGMT Job in order to upload file in Smartling.';
      $substitutions = [
        '@filename' => $filename,
        '@job_id' => $job
          ->id(),
      ];
      $job
        ->rejected($message, $substitutions);
      $this->logger
        ->warning($message, $substitutions);
    }
    if (!empty($e
      ->getErrorsByKey('locale.not.found'))) {
      $locale = $job
        ->getRemoteTargetLanguage();
      $message = 'Specified locale \'@locale\' is not available for the project. The job @job_id is rejected.';
      $substitutions = [
        '@locale' => $locale,
        '@job_id' => $job
          ->id(),
      ];
      $job
        ->rejected($message, $substitutions);
      $this->logger
        ->warning($message, $substitutions);
    }
    if (!empty($e
      ->getErrorsByKey('locale.disabled'))) {
      $locale = $job
        ->getRemoteTargetLanguage();
      $message = 'Specified locale \'@locale\' is disabled. The job @job_id is rejected.';
      $substitutions = [
        '@locale' => $locale,
        '@job_id' => $job
          ->id(),
      ];
      $job
        ->rejected($message, $substitutions);
      $this->logger
        ->warning($message, $substitutions);
    }
    watchdog_exception('tmgmt_smartling', $e);
  }

  /**
   * {@inheritdoc}
   */
  public function cancelTranslation(JobInterface $job) {

    // TODO: Implement cancelTranslation() method.
  }

  /**
   * Requests translation.
   *
   * @param \Drupal\tmgmt\JobInterface $job
   * @param array $data
   *
   * @return mixed
   */
  public function requestTranslationExtended(JobInterface $job, array $data) {

    // Pass queue item data into job settings.
    $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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SmartlingTranslator::$client	protected	property
SmartlingTranslator::$currentUser	protected	property
SmartlingTranslator::$eventDispatcher	protected	property
SmartlingTranslator::$fileUsage	protected	property
SmartlingTranslator::$formatPluginsManager	protected	property
SmartlingTranslator::$logger	private	property
SmartlingTranslator::$moduleHandler	protected	property		1
SmartlingTranslator::$smartlingApi	protected	property	Guzzle HTTP client.
SmartlingTranslator::$smartlingApiWrapper	private	property
SmartlingTranslator::$translationProgressCalculator	private	property
SmartlingTranslator::abortTranslation	public	function	Aborts a translation job. Overrides TranslatorPluginBase::abortTranslation
SmartlingTranslator::addSmartlingDirectives	protected	function	Adds smartling directives to upload parameters.	1
SmartlingTranslator::cancelTranslation	public	function
SmartlingTranslator::checkAvailable	public	function	Checks whether a translator is available. Overrides TranslatorPluginBase::checkAvailable
SmartlingTranslator::checkTranslatable	public	function	Check whether this service can handle a particular translation job. Overrides TranslatorPluginBase::checkTranslatable
SmartlingTranslator::cleanFileName	private	function	Return clean filename, sanitized for path traversal vulnerability.
SmartlingTranslator::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SmartlingTranslator::defaultSettings	public	function	Defines default settings. Overrides TranslatorPluginBase::defaultSettings
SmartlingTranslator::downloadTranslation	public	function	Downloads translation file and applies it.
SmartlingTranslator::filterDirectives	protected	function		1
SmartlingTranslator::getApiWrapper	public	function
SmartlingTranslator::getCallbackUrl	private	function	Returns callback url.
SmartlingTranslator::getDefaultRemoteLanguagesMappings	public	function	Specifies default mappings for local to remote language codes. Overrides TranslatorPluginBase::getDefaultRemoteLanguagesMappings
SmartlingTranslator::getFileName	public	function	Returns file name.
SmartlingTranslator::getSupportedRemoteLanguages	public	function	Gets all supported languages of the translator. Overrides TranslatorPluginBase::getSupportedRemoteLanguages
SmartlingTranslator::getSupportedTargetLanguages	public	function	Returns all available target languages that are supported by this service when given a source language. Overrides TranslatorPluginBase::getSupportedTargetLanguages
SmartlingTranslator::handleSmartlingApiException	protected	function
SmartlingTranslator::hasCheckoutSettings	public	function	Returns if the translator has any settings for the passed job. Overrides TranslatorPluginBase::hasCheckoutSettings
SmartlingTranslator::isReadyForDownload	public	function	Checks if file is ready for download.
SmartlingTranslator::requestJobItemsTranslation	public	function	Requests the translation of a JobItem. Overrides ContinuousTranslatorInterface::requestJobItemsTranslation
SmartlingTranslator::requestTranslation	public	function	@abstract Overrides TranslatorPluginInterface::requestTranslation
SmartlingTranslator::requestTranslationExtended	public	function	Requests translation.
SmartlingTranslator::__construct	public	function	Constructs a LocalActionBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TranslatorPluginBase::$escapeEnd	protected	property	Characters that indicate the end of an escaped string.	1
TranslatorPluginBase::$escapeStart	protected	property	Characters that indicate the beginning of an escaped string.	1
TranslatorPluginBase::acceptedDataItem	public	function	Accept a single data item. Overrides TranslatorPluginInterface::acceptedDataItem
TranslatorPluginBase::escapeText	public	function	Returns the escaped #text of a data item. Overrides TranslatorPluginInterface::escapeText
TranslatorPluginBase::getEscapedString	protected	function	Returns the escaped string.
TranslatorPluginBase::getSupportedLanguagePairs	public	function	Default implementation that gets target languages for each remote language. This approach is ineffective and therefore it is advised that a plugin should provide own implementation. Overrides TranslatorPluginInterface::getSupportedLanguagePairs	1
TranslatorPluginBase::unescapeText	public	function	Removes escape patterns from an escaped text. Overrides TranslatorPluginInterface::unescapeText

You are here

class SmartlingTranslator in TMGMT Translator Smartling 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation