first commit

wp-content/plugins/wpml-translation-management/classes/ATE/Sync/Arguments.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace WPML\TM\ATE\Sync;
+
+class Arguments {
+
+	/** @var string|null $lockKey */
+	public $lockKey;
+
+	/** @var string|null $ateToken */
+	public $ateToken;
+
+	/** @var int|null $page */
+	public $page;
+
+	/** @var int|null $numberOfPages */
+	public $numberOfPages;
+
+}

wp-content/plugins/wpml-translation-management/classes/ATE/Sync/Factory.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace WPML\TM\ATE\Sync;
+
+use function WPML\Container\make;
+use WPML\Utilities\KeyedLock;
+
+class Factory {
+
+	const LOCK_NAME = 'ate_sync';
+
+	/**
+	 * @return Process
+	 * @throws \Auryn\InjectionException
+	 */
+	public function create() {
+		$lock = make( KeyedLock::class, [ ':name' => self::LOCK_NAME ] );
+		return make( Process::class, [ ':lock' => $lock ] );
+	}
+}

wp-content/plugins/wpml-translation-management/classes/ATE/Sync/Process.php

@@ -0,0 +1,151 @@
+<?php
+
+namespace WPML\TM\ATE\Sync;
+
+use WPML\TM\ATE\Download\Job;
+use WPML\TM\ATE\Download\Queue;
+use WPML\Utilities\KeyedLock;
+use WPML_TM_ATE_API;
+use WPML_TM_ATE_Job_Repository;
+
+class Process {
+
+	const LOCK_RELEASE_TIMEOUT = 1 * MINUTE_IN_SECONDS;
+
+	/** @var WPML_TM_ATE_API $api */
+	private $api;
+
+	/** @var KeyedLock $lock */
+	private $lock;
+
+	/** @var WPML_TM_ATE_Job_Repository $ateRepository */
+	private $ateRepository;
+
+	/** @var Queue $downloadQueue */
+	private $downloadQueue;
+
+	/** @var Trigger $trigger */
+	private $trigger;
+
+	public function __construct(
+		WPML_TM_ATE_API $api,
+		KeyedLock $lock,
+		WPML_TM_ATE_Job_Repository $ateRepository,
+		Queue $downloadQueue,
+		Trigger $trigger
+	) {
+		$this->api           = $api;
+		$this->lock          = $lock;
+		$this->ateRepository = $ateRepository;
+		$this->downloadQueue = $downloadQueue;
+		$this->trigger       = $trigger;
+	}
+
+	/**
+	 * @param Arguments $args
+	 *
+	 * @return Result
+	 */
+	public function run( Arguments $args ) {
+		$result          = new Result();
+		$result->lockKey = $this->lock->create( $args->lockKey, self::LOCK_RELEASE_TIMEOUT );
+
+		if ( $result->lockKey ) {
+
+			if ( $args->page ) {
+				$result = $this->runSyncOnPages( $result, $args );
+			} else {
+				$result = $this->runSyncInit( $result );
+			}
+
+			if ( ! $result->nextPage ) {
+				$result->lockKey = false;
+				$this->lock->release();
+				$this->trigger->setLastSync();
+			}
+		}
+
+		$result->downloadQueueSize = $this->downloadQueue->count();
+
+		return $result;
+	}
+
+	/**
+	 * This will run the sync on extra pages.
+	 *
+	 * @param Result    $result
+	 * @param Arguments $args
+	 *
+	 * @return Result
+	 */
+	private function runSyncOnPages( Result $result, Arguments $args ) {
+		$apiPage = $args->page - 1; // ATE API pagination starts at 0.
+		$data    = $this->api->sync_page( $args->ateToken, $apiPage );
+
+		if ( isset( $data->items ) ) {
+			$this->pushToDownloadQueue( $data->items );
+		}
+
+		if ( $args->numberOfPages > $args->page ) {
+			$result->nextPage      = $args->page + 1;
+			$result->numberOfPages = $args->numberOfPages;
+			$result->ateToken      = $args->ateToken;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * This will run the first sync iteration.
+	 * We send all the job IDs we want to sync.
+	 *
+	 * @param Result $result
+	 *
+	 * @return Result
+	 */
+	private function runSyncInit( Result $result ) {
+		$ateJobIds = $this->getAteJobIdsToSync();
+
+		if ( $ateJobIds || $this->trigger->isSyncRequired() ) {
+			$data = $this->api->sync_all( $ateJobIds );
+
+			if ( isset( $data->items ) ) {
+				$this->pushToDownloadQueue( $data->items );
+			}
+
+			if ( isset( $data->edited ) ) {
+				$this->pushToDownloadQueue( $data->edited );
+			}
+
+			if ( isset( $data->next->pagination_token, $data->next->pages_number ) ) {
+				$result->ateToken      = $data->next->pagination_token;
+				$result->numberOfPages = $data->next->pages_number;
+				$result->nextPage      = 1; // We start pagination at 1 to avoid carrying a falsy value.
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @return array
+	 */
+	private function getAteJobIdsToSync() {
+		return wpml_collect( $this->ateRepository->get_jobs_to_sync()->map_to_property( 'editor_job_id' ) )
+			->diff( $this->downloadQueue->getEditorJobIds() )
+			->toArray();
+	}
+
+	/**
+	 * @param \stdClass[] $items
+	 */
+	private function pushToDownloadQueue( array $items ) {
+		$jobs = wpml_collect( $items )->map(
+			function( $item ) {
+				return Job::fromAteResponse( $item );
+			}
+		);
+
+		$this->downloadQueue->push( $jobs );
+	}
+}

wp-content/plugins/wpml-translation-management/classes/ATE/Sync/Result.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace WPML\TM\ATE\Sync;
+
+class Result {
+
+	/** @var string|false|null $lockKey */
+	public $lockKey;
+
+	/** @var string|null $ateToken */
+	public $ateToken;
+
+	/** @var int|null $nextPage */
+	public $nextPage;
+
+	/** @var int|null $numberOfPages */
+	public $numberOfPages;
+
+	/** @var int $downloadQueueSize */
+	public $downloadQueueSize = 0;
+
+}

wp-content/plugins/wpml-translation-management/classes/ATE/Sync/Trigger.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace WPML\TM\ATE\Sync;
+
+use function get_current_user_id;
+use WPML\Collect\Support\Collection;
+use WPML\WP\OptionManager;
+
+class Trigger {
+
+	const SYNC_TIMEOUT = 10 * MINUTE_IN_SECONDS;
+
+	const OPTION_GROUP            = 'WPML\TM\ATE\Sync';
+	const SYNC_LAST               = 'last';
+	const SYNC_REQUIRED_FOR_USERS = 'required_for_users';
+
+	/** @var OptionManager $optionManager */
+	private $optionManager;
+
+	public function __construct( OptionManager $optionManager ) {
+		$this->optionManager = $optionManager;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isSyncRequired() {
+		return $this->isUserSyncRequired() || $this->isPeriodicSyncRequired();
+	}
+
+	/**
+	 * @return bool
+	 */
+	private function isPeriodicSyncRequired() {
+		$lastSync = $this->optionManager->get( self::OPTION_GROUP, self::SYNC_LAST, 0 );
+		return ( time() - self::SYNC_TIMEOUT ) > $lastSync;
+	}
+
+	/**
+	 * @return bool
+	 */
+	private function isUserSyncRequired() {
+		return $this->getUsersNeedSync()->contains( get_current_user_id() );
+	}
+
+	public function setSyncRequiredForCurrentUser() {
+		$userId        = get_current_user_id();
+		$usersNeedSync = $this->getUsersNeedSync();
+
+		if ( ! $usersNeedSync->contains( $userId ) ) {
+			$usersNeedSync->push( $userId );
+			$this->setUsersNeedSync( $usersNeedSync );
+		}
+	}
+
+	public function setLastSync() {
+		$this->optionManager->set( self::OPTION_GROUP, self::SYNC_LAST, time(), false );
+
+		$currentUserId = get_current_user_id();
+		$usersNeedSync = $this->getUsersNeedSync();
+
+		if ( $usersNeedSync->contains( $currentUserId ) ) {
+			$isCurrentUser = function( $userId ) use ( $currentUserId ) {
+				return $userId === $currentUserId;
+			};
+			$this->setUsersNeedSync( $usersNeedSync->reject( $isCurrentUser ) );
+		}
+	}
+
+	/**
+	 * @return Collection
+	 */
+	private function getUsersNeedSync() {
+		return wpml_collect( $this->optionManager->get( self::OPTION_GROUP, self::SYNC_REQUIRED_FOR_USERS, [] ) );
+	}
+
+	private function setUsersNeedSync( Collection $usersNeedSync ) {
+		$this->optionManager->set( self::OPTION_GROUP, self::SYNC_REQUIRED_FOR_USERS, $usersNeedSync->toArray(), false );
+	}
+}