tmgmt_extension_suit.module in TMGMT Extension Suite 8

Same filename and directory in other branches
File

tmgmt_extension_suit.module
View source
<?php

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\Language;
use Drupal\Core\Url;
use Drupal\tmgmt\Entity\Job;
use Drupal\tmgmt\Form\SourceOverviewForm;
use Drupal\tmgmt\TMGMTException;
use Drupal\tmgmt_extension_suit\ExtendedTranslatorPluginInterface;
use Drupal\views\ViewExecutable;
use Drupal\tmgmt\JobInterface;
use Drupal\tmgmt\JobItemInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;

/**
 * Implements hook_views_pre_view().
 */
function tmgmt_extension_suit_views_pre_view(ViewExecutable $view, $display_id, array &$args) {
  if ($view
    ->id() != 'tmgmt_job_overview') {
    return;
  }
  $handlers = $view
    ->getHandlers('field');
  foreach ($handlers as $name => $value) {
    $view
      ->removeHandler($view->current_display, 'field', $name);
  }
  $view
    ->addHandler($view->current_display, 'field', 'tmgmt_job', 'tmgmt_job_bulk_form', [
    'id' => 'tmgmt_job_bulk_form',
    'table' => 'tmgmt_job',
    'field' => 'tmgmt_job_bulk_form',
    'group_type' => 'group',
    'label' => 'Bulk update',
    'hide_alter_empty' => 1,
    'action_title' => 'With selection',
    'include_exclude' => 'exclude',
    'selected_actions' => [],
    'entity_type' => 'tmgmt_job',
    'plugin_id' => 'bulk_form',
    'weight' => -10,
  ]);
  foreach ($handlers as $name => $value) {
    $view
      ->addHandler($view->current_display, 'field', 'tmgmt_job', $name, $value);
  }
}

/**
 * Add items to "check_status" queue.
 */
function tmgmt_extension_suit_add_to_check_status() {

  // Query returns ids of active/finished jobs with target language != 'und' and
  // which contains at least one job_item in state != 'review'. We need to take
  // into consideration finished jobs because there might be situations when
  // translator/editor has edited strings in a Smartling file and published
  // them again. In this case we should pull edits into Drupal.
  $query = Drupal::database()
    ->select('tmgmt_job', 'tj');
  $query
    ->join('tmgmt_job_item', 'tji', 'tji.tjid = tj.tjid');
  $query
    ->fields('tj', [
    'tjid',
  ])
    ->distinct()
    ->condition('tj.state', [
    JobInterface::STATE_ACTIVE,
    JobInterface::STATE_FINISHED,
  ], 'IN')
    ->condition('tj.target_language', 'und', '!=')
    ->condition('tji.state', JobItemInterface::STATE_REVIEW, '!=');
  $entities = $query
    ->execute()
    ->fetchCol();
  foreach ($entities as $eid) {
    Drupal::service('tmgmt_extension_suit.utils.queue_unique_item')
      ->addItem('tmgmt_extension_suit_check_status', [
      'id' => (int) $eid,
    ]);
  }
}

/**
 * Implements hook_cron().
 */
function tmgmt_extension_suit_cron() {
  tmgmt_extension_suit_add_to_check_status();
}

/**
 * Implements hook_entity_type_alter().
 *
 * @param array $entity_types
 */
function tmgmt_extension_suit_entity_type_alter(array &$entity_types) {
  $entity_types['tmgmt_job']
    ->setFormClass('edit', 'Drupal\\tmgmt_extension_suit\\Form\\JobExtendedForm');
}

/**
 * Calculates hash for a given job item depends on source data.
 *
 * @param \Drupal\tmgmt\JobItemInterface $job_item
 *
 * @return string
 */
function _tmgmt_extension_suit_get_job_item_hash(JobItemInterface $job_item) {

  // Check if job exists at this moment. If we save job item into
  // cart it means that job doesn't exist for now and we can't get
  // source data for hash calculating.
  if ($job_item
    ->getJobId() == 0) {
    return '';
  }

  // Try to load the entity. If we deal with non-content types like strings,
  // we'll get an \Exception here and skip it for now.
  // @todo: Add support for strings
  try {
    $entity = Drupal::entityTypeManager()
      ->getStorage($job_item
      ->getItemType())
      ->load($job_item
      ->getItemId());
  } catch (\Exception $e) {
    return '';
  }
  if (!($entity instanceof ContentEntityInterface && $entity
    ->isTranslatable())) {
    return '';
  }
  $hash_data = Drupal::service('tmgmt.data')
    ->filterTranslatable($job_item
    ->getSourceData());
  return md5(json_encode($hash_data));
}

/**
 * Implements hook_entity_update().
 */
function tmgmt_extension_suit_entity_update(EntityInterface $entity) {
  if ($entity instanceof ContentEntityInterface && $entity
    ->isTranslatable() && Drupal::config('tmgmt_extension_suit.settings')
    ->get('do_track_changes')) {
    $entity = $entity
      ->getUntranslated();

    // Get job ids that contains current entity.
    $select = Drupal::database()
      ->select('tmgmt_job', 'tj');
    $select
      ->join('tmgmt_job_item', 'tji', 'tji.tjid = tj.tjid');
    $select
      ->addField('tj', 'tjid');
    $select
      ->condition('tj.state', [
      JobInterface::STATE_ACTIVE,
      JobInterface::STATE_REJECTED,
      JobInterface::STATE_FINISHED,
    ], 'IN');
    $select
      ->condition('tji.state', [
      JobItemInterface::STATE_ABORTED,
    ], 'NOT IN');
    $select
      ->condition('tji.item_type', $entity
      ->getEntityTypeId());
    $select
      ->condition('tji.item_id', $entity
      ->id());
    $job_ids = $select
      ->execute()
      ->fetchCol();

    // Set job state as active. Set all child job items state as active.
    // Reset all child data. Also we need to update job item hash because
    // source entity is updated.
    $upload_entities = [];
    foreach ($job_ids as $job_id) {
      if ($job = Job::load($job_id)) {
        $is_reopen_needed = FALSE;
        foreach ($job
          ->getItems() as $item) {
          $old_hash = $item
            ->get('tes_source_content_hash')
            ->getValue();
          $old_hash = isset($old_hash[0]['value']) ? $old_hash[0]['value'] : '';
          $hash = _tmgmt_extension_suit_get_job_item_hash($item);

          // Source entity is updated. Mark job item as active.
          if ($old_hash !== $hash) {

            // Reset an old data array with old entity field values.
            $item
              ->resetData();

            // Update current job item hash.
            $item
              ->set('tes_source_content_hash', $hash);

            // We don't use JobItem::setState() because it doesn't always call
            // JobItem::save(), and so the behaviour might be inconsistent.
            $item
              ->set('state', JobItemInterface::STATE_ACTIVE);
            $item
              ->save();
            $is_reopen_needed = TRUE;
          }
        }

        // Reopen parent job.
        if ($is_reopen_needed) {

          // Job::save() method invokes inside of Job::setState()
          // method. So there is no need to call save() directly.
          $job
            ->setState(JobInterface::STATE_ACTIVE);

          // Put job into upload queue.
          $upload_entities[] = $job
            ->id();
          Drupal::service('tmgmt_extension_suit.utils.queue_unique_item')
            ->addItem('tmgmt_extension_suit_upload', [
            'id' => (int) $job
              ->id(),
          ]);
          $translator_plugin = $job
            ->getTranslatorPlugin();
          if ($translator_plugin instanceof ExtendedTranslatorPluginInterface) {
            Drupal::getContainer()
              ->get('logger.channel.tmgmt_extension_suit')
              ->info(t('File upload queued (track entity changes). Job id: @job_id, file name: @name.', [
              '@name' => $translator_plugin
                ->getFileName($job),
              '@job_id' => $job
                ->id(),
            ]));
          }
        }
      }
    }
    if (!empty($upload_entities)) {
      \Drupal::moduleHandler()
        ->invokeAll('tmgmt_extension_suit_updated_entity_jobs', [
        $upload_entities,
      ]);
    }
  }
}

/**
 * Implements hook_entity_base_field_info().
 */
function tmgmt_extension_suit_entity_base_field_info(EntityTypeInterface $entity_type) {
  if ($entity_type
    ->id() === 'tmgmt_job_item') {
    $fields['tes_source_content_hash'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Source content hash (md5)'))
      ->setSetting('max_length', 32)
      ->setTranslatable(FALSE);
    return $fields;
  }
}

/**
 * Implements hook_ENTITY_TYPE_presave().
 */
function tmgmt_extension_suit_tmgmt_job_item_presave(Drupal\Core\Entity\EntityInterface $job_item) {

  // Create hash for job item while creation process. We only need to update
  // job item hash in case source entity was updated in Drupal.
  // @see tmgmt_extension_suit_entity_update().
  $old_hash = $job_item
    ->get('tes_source_content_hash')
    ->getValue();
  $old_hash = isset($old_hash[0]['value']) ? $old_hash[0]['value'] : '';
  if ('' != $old_hash) {
    return;
  }
  $hash = _tmgmt_extension_suit_get_job_item_hash($job_item);
  if ($hash !== '') {
    $job_item
      ->set('tes_source_content_hash', $hash);
  }
}

/**
 * Implements hook_translatable_fields_alter.
 */
function tmgmt_extension_suit_tmgmt_translatable_fields_alter(\Drupal\Core\Entity\ContentEntityInterface $entity, array &$translatable_fields) {
  unset($translatable_fields['moderation_state']);
}

/**
 * Implements hook_entity_base_field_info_alter().
 */
function tmgmt_extension_suit_entity_base_field_info_alter(array &$fields, EntityTypeInterface $entity_type) {
  if ($entity_type
    ->id() === 'tmgmt_job' && empty($fields['job_file_name'])) {
    $fields['job_file_name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Generated file name'))
      ->setSetting('max_length', 1024)
      ->setTranslatable(FALSE)
      ->setProvider('tmgmt_extension_suit')
      ->setName('job_file_name')
      ->setTargetEntityTypeId($entity_type
      ->id())
      ->setTargetBundle(NULL);
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function tmgmt_extension_suit_form_tmgmt_overview_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  if (!empty($form['operations']['checkout'])) {
    $form['operations']['checkout']['smartling_submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#weight' => 4,
      '#value' => t('Request translation in a batch'),
      '#submit' => [
        'tmgmt_extension_suit_form_tmgmt_overview_form_submit',
      ],
      '#validate' => [
        'tmgmt_extension_suit_form_tmgmt_overview_form_validate',
      ],
    ];
    if (!empty($form['operations']['checkout']['source_language'])) {
      $form['operations']['checkout']['source_language']['#weight'] = 1;
    }
    if (!empty($form['operations']['checkout']['target_language'])) {
      $form['operations']['checkout']['target_language']['#weight'] = 2;
    }
    if (!empty($form['operations']['checkout']['submit'])) {
      $form['operations']['checkout']['submit']['#weight'] = 3;
    }
    if (!empty($form['operations']['checkout']['target_languages'])) {
      $form['operations']['checkout']['target_languages']['#weight'] = 5;
    }
  }
}

/**
 * Overview form validate.
 *
 * @param array $form
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 */
function tmgmt_extension_suit_form_tmgmt_overview_form_validate(array $form, FormStateInterface $form_state) {
  $plugin = $form_state
    ->get('plugin');
  $item_type = $form_state
    ->get('item_type');
  $entity_languages = [];
  $items = array_filter($form_state
    ->getValue('items'));
  $excluded_items = [];
  $source_language = $form_state
    ->getValue('source_language');
  $target_language = $form_state
    ->getValue('target_language');
  $target_languages = $form_state
    ->getValue('target_languages');
  if ($target_language == SourceOverviewForm::ALL) {
    $target_languages = array_combine(array_keys($target_languages), array_keys($target_languages));
  }
  elseif (!in_array($target_language, [
    Language::LANGCODE_NOT_SPECIFIED,
    SourceOverviewForm::MULTIPLE,
    SourceOverviewForm::ALL,
  ])) {
    $target_languages = [
      $target_language,
    ];
  }
  if (empty($items)) {
    $form_state
      ->setError($form, t("You didn't select any source items."));
    return;
  }
  foreach ($items as $item) {
    switch ($plugin) {
      case 'content':
        $entity_manager = \Drupal::entityTypeManager();
        $entity = $entity_manager
          ->getStorage($item_type)
          ->load($item);
        $entity_source_language = $entity
          ->language()
          ->getId();
        break;
      case 'config':
        $config_factory = Drupal::configFactory()
          ->get($item);
        $entity_source_language = $config_factory
          ->get('langcode');
        break;
      default:
        $entity_source_language = 'en';
    }
    if ($source_language != SourceOverviewForm::SOURCE && $source_language != $entity_source_language) {
      $excluded_items[$item] = $item;
    }
    $entity_languages[$entity_source_language] = TRUE;
  }
  if (count($entity_languages) > 1) {
    $form_state
      ->setError($form, t("You can't request translation in a batch for items in different source languages."));
    return;
  }
  if (empty(array_diff($items, $excluded_items))) {
    $form_state
      ->setError($form, t('From the selection you made it was not possible to create any translation job.'));
    return;
  }
  $form_state
    ->setValue('source_language', key($entity_languages));
  $form_state
    ->setValue('default_target_languages', $target_languages);
}

/**
 * Overview form submit.
 *
 * @param array $form
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 */
function tmgmt_extension_suit_form_tmgmt_overview_form_submit(array $form, FormStateInterface $form_state) {
  $tempStore = Drupal::service('user.private_tempstore')
    ->get('tmgmt_extension_suit');
  $tempStore
    ->set('request_translation_batch', [
    'items' => array_filter($form_state
      ->getValue('items')),
    'plugin' => $form_state
      ->get('plugin'),
    'item_type' => $form_state
      ->get('item_type'),
    'source_language' => $form_state
      ->getValue('source_language'),
    'default_target_languages' => $form_state
      ->getValue('default_target_languages'),
  ]);
  $url = new Url('tmgmt_extension_suit.request_translation_approve_form');
  $form_state
    ->setRedirectUrl($url);
}

/**
 * Implements hook_ENTITY_TYPE_update().
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 */
function tmgmt_extension_suit_tmgmt_job_presave(Drupal\Core\Entity\EntityInterface $entity) {
  try {
    if ($entity
      ->hasTranslator()) {
      $plugin = $entity
        ->getTranslatorPlugin();
      if ($plugin instanceof ExtendedTranslatorPluginInterface) {
        $entity
          ->set('job_file_name', $plugin
          ->getFileName($entity));
      }
    }
  } catch (TMGMTException $e) {
    watchdog_exception('tmgmt_smartling', $e);
  }
}
Functions

Name	Description
tmgmt_extension_suit_add_to_check_status	Add items to "check_status" queue.
tmgmt_extension_suit_cron	Implements hook_cron().
tmgmt_extension_suit_entity_base_field_info	Implements hook_entity_base_field_info().
tmgmt_extension_suit_entity_base_field_info_alter	Implements hook_entity_base_field_info_alter().
tmgmt_extension_suit_entity_type_alter	Implements hook_entity_type_alter().
tmgmt_extension_suit_entity_update	Implements hook_entity_update().
tmgmt_extension_suit_form_tmgmt_overview_form_alter	Implements hook_form_FORM_ID_alter().
tmgmt_extension_suit_form_tmgmt_overview_form_submit	Overview form submit.
tmgmt_extension_suit_form_tmgmt_overview_form_validate	Overview form validate.
tmgmt_extension_suit_tmgmt_job_item_presave	Implements hook_ENTITY_TYPE_presave().
tmgmt_extension_suit_tmgmt_job_presave	Implements hook_ENTITY_TYPE_update().
tmgmt_extension_suit_tmgmt_translatable_fields_alter	Implements hook_translatable_fields_alter.
tmgmt_extension_suit_views_pre_view	Implements hook_views_pre_view().
_tmgmt_extension_suit_get_job_item_hash	Calculates hash for a given job item depends on source data.
You are here

tmgmt_extension_suit.module in TMGMT Extension Suite 8

File

Functions

API Navigation
