ldc-groupe/public/app/plugins/wpml-string-translation/StringTranslation/Infrastructure/TranslateEverything/UntranslatedStrings.php

<?php

namespace WPML\StringTranslation\Infrastructure\TranslateEverything;

use WPML\API\PostTypes;
use WPML\Core\Component\Translation\Application\String\Repository\StringBatchRepositoryInterface;
use WPML\Element\API\Languages;
use WPML\FP\Cast;
use WPML\FP\Fns;
use WPML\FP\Lst;
use WPML\FP\Obj;
use WPML\Setup\Option;
use WPML\TM\API\ATE\CachedLanguageMappings;
use WPML\TM\API\ATE\LanguageMappings;
use WPML\TM\ATE\TranslateEverything\UntranslatedElementsInterface;
use WPML\TM\AutomaticTranslation\Actions\Actions;

/**
 * It handles sending strings to translation in Translate Everything process.
 *
 * !Important note: we include only English strings in the Translate Everything process.
 */
class UntranslatedStrings implements UntranslatedElementsInterface {

	const ENGLISH_SOURCE_LANGUAGE = 'en';

	/**
	 * @var \wpdb
	 */
	private $wpdb;

	/**
	 * @var StringBatchRepositoryInterface
	 */
	private $stringBatchRepository;

	public function __construct( StringBatchRepositoryInterface $stringBatchRepository, \wpdb $wpdb = null ) {
		$this->stringBatchRepository = $stringBatchRepository;

		if ( ! $wpdb ) {
			global $wpdb;
		}
		$this->wpdb = $wpdb;
	}

	/**
	 * @return {
	 *   0: string,
	 *   1: string[]
	 * } 0: type, 1: languageCodes
	 */
	public function getTypeWithLanguagesToProcess() {
		$completed             = $this->getCompleted();
		$notCompletedLanguages = array_diff( $this->getEligibleLanguageCodes(), $completed );

		return [ 'string', $notCompletedLanguages ];
	}

	/**
	 * @param string[] $languages Language codes
	 * @param string   $type
	 * @param int      $queueSize
	 *
	 * @return {
	 *   0: int
	 *   1: string
	 * }[] For example [ [element_id1, language_code1], [element_id1, language_code2], ... ]
	 */
	public function getElementsToProcess( $languages, $type, $queueSize ) {
		$languageSelect    = array_map(
			function ( $languageCode ) {
				return "SELECT '{$languageCode}' AS code";
			},
			$languages
		);
		$languageSelect    = implode( ' UNION ALL ', $languageSelect );
		$languageCrossJoin = "
			CROSS JOIN (
				$languageSelect	
			) as langs
		";

		$sql = "
			SELECT strings.id, langs.code AS language_code 
			FROM {$this->wpdb->prefix}icl_strings strings
			{$languageCrossJoin}
			LEFT JOIN {$this->wpdb->prefix}icl_string_translations translations
				ON strings.id = translations.string_id AND translations.language = langs.code
			WHERE strings.string_type = 1 
				AND ( translations.status IS NULL OR translations.status = 0 )
				AND EXISTS (
	        SELECT 1
	        FROM {$this->wpdb->prefix}icl_string_positions positions
	        WHERE positions.string_id = strings.id
	          AND positions.kind = %d
	    	) AND strings.language = %s
			ORDER BY langs.code, strings.id ASC 
			LIMIT %d
		";

		$sql = $this->wpdb->prepare( 
			$sql, 
			[ 
				ICL_STRING_TRANSLATION_STRING_TRACKING_TYPE_FRONTEND, 
				self::ENGLISH_SOURCE_LANGUAGE,
				$queueSize 
			] 
		);

		$rowset = $this->wpdb->get_results( $sql, ARRAY_N );

		return Fns::map(
			function ( $row ) {
				return [ (int) $row[0], $row[1] ];
			},
			$rowset
		);
	}

	/**
	 * @param Actions $actions
	 * @param array   $elements [ [element_id1, language_code1], [element_id1, language_code2], ... ]
	 * @param string  $type (not used for strings)
	 *
	 * @return {
	 *  elementId: int,
	 *  lang: string,
	 *  elementType: string,
	 *  jobId: int,
	 * }[] For example [[elementId: 14, lang: fr, elementType: post, jobId: 123], ...]
	 */
	public function createTranslationJobs( Actions $actions, array $elements, $type ) {
		/** Like: {fr: [1,2,3], 'de': [5,6],...} */
		$stringsGroupedByLanguages = \wpml_collect( $elements )
			->groupBy( 1 )
			->map( Lst::pluck( 0 ) )
			->map( Fns::map( Cast::toInt() ) )
			->toArray();

		$batchElements = [];
		foreach ( $stringsGroupedByLanguages as $languageCode => $strings ) {
			$batchId = $this->stringBatchRepository->create(
				'translate everything|string|' . $languageCode,
				$strings,
				self::ENGLISH_SOURCE_LANGUAGE
			);

			$batchElements[] = [ $batchId, $languageCode ];
		}

		$jobs = $actions->createNewTranslationJobs( 'en', $batchElements, 'st-batch' );

		$jobsPerString = [];
		foreach ( $jobs as $job ) {
			$stringsInJobLanguages = $stringsGroupedByLanguages[ $job['lang'] ];

			foreach ( $stringsInJobLanguages as $string ) {
				$jobsPerString[] = [
					'elementId'   => $string,
					'lang'        => $job['lang'],
					'elementType' => 'string',
					'jobId'       => $job['jobId'],
				];
			}
		}

		return $jobsPerString;
	}

	public function isEverythingProcessed( $cached = false ) {
		$completed = $this->getCompleted();

		return count( array_diff( $this->getEligibleLanguageCodes( $cached ), $completed ) ) === 0;
	}

	public function getQueueSize(): int {
		return 150;
	}

	public function getEligibleLanguageCodes( bool $cached = false ): array {
		$languageMapper = $cached ? CachedLanguageMappings::class : LanguageMappings::class;

		$targetLanguages = $languageMapper::geCodesEligibleForAutomaticTranslations();

		$targetLanguages = $this->maybeAppendDefaultLanguage( $languageMapper, $targetLanguages );

		// filter out source language as it's the hardcoded source language
		$targetLanguages = $this->removeEnglishFromTargetLanguages( $targetLanguages );

		return $targetLanguages;
	}

	/**
	 * @return string[]
	 */
	private function getTargetLanguages(): array {
		$targetLanguages = Languages::getSecondaryCodes();

		if ( Languages::getDefaultCode() !== self::ENGLISH_SOURCE_LANGUAGE ) {
			$primary   = [ Languages::getDefaultCode() ];
			$targetLanguages = array_merge( $targetLanguages, $primary );
		}

		$targetLanguages = $this->removeEnglishFromTargetLanguages( $targetLanguages );

		return $targetLanguages;
	}

	/**
	 * @param string $type It's irrelevant for strings
	 * @param array  $languages
	 *
	 * @return void
	 */
	public function markTypeAsCompleted( string $type ) {
		$this->setCompleted( $this->getTargetLanguages() );
	}

	public function markEverythingAsCompleted() {
		$this->setCompleted( $this->getTargetLanguages() );
	}

	public function markEverythingAsUncompleted() {
		$this->setCompleted( [] );
	}

	public function markLanguagesAsCompleted( array $languages ) {
		$completed = $this->getCompleted();
		$completed = array_merge( $completed, $languages );
		$this->setCompleted( $completed );
	}

	public function markLanguagesAsUncompleted( array $languages ) {
		$completed = $this->getCompleted();
		$completed = array_diff( $completed, $languages );
		$this->setCompleted( $completed );
	}

	/**
	 * @return string[] For example ['fr', 'de']
	 */
	private function getCompleted() {
		return Option::getTranslateEverythingCompletedStrings();
	}

	/**
	 * @param string[] $completed For example ['fr', 'de']
	 *
	 * @return void
	 */
	private function setCompleted( array $completed ) {
		Option::setTranslateEverythingCompletedStrings( $completed );
	}

	/**
	 * @param array $targetLanguages
	 *
	 * @return array
	 */
	private function removeEnglishFromTargetLanguages( array $targetLanguages ): array {
		$targetLanguages = array_filter( $targetLanguages, function ( $languageCode ) {
			return $languageCode !== self::ENGLISH_SOURCE_LANGUAGE;
		} );

		return $targetLanguages;
	}

	/**
	 * @param string $languageMapper
	 * @param array $targetLanguages
	 *
	 * @return array
	 */
	private function maybeAppendDefaultLanguage( string $languageMapper, array $targetLanguages ): array {
		if ( Languages::getDefaultCode() !== self::ENGLISH_SOURCE_LANGUAGE && $languageMapper::doesDefaultLanguageSupportAutomaticTranslations() ) {
			$targetLanguages[] = Languages::getDefaultCode();
		}

		return $targetLanguages;
	}
}