Merge pull request #552 from Smartling/WP-920-add-profiles-filter-and-download-option

vsolovei-smartling · web-flow · commit 1985b6154bba · 2024-12-23T12:18:27.000+01:00
add manual download mode, add profile filter (WP-920)
diff --git a/inc/Smartling/Base/ExportedAPI.php b/inc/Smartling/Base/ExportedAPI.php
@@ -8,8 +8,8 @@
 use Smartling\Helpers\EventParameters\SmartlingFileUriFilterParamater;
 use Smartling\Helpers\EventParameters\TranslationStringFilterParameters;
 use Smartling\Models\NotificationParameters;
-use Smartling\Models\UploadQueueEntity;
 use Smartling\Models\UploadQueueItem;
+use Smartling\Settings\ConfigurationProfileEntity;
 use Smartling\Submissions\SubmissionEntity;
 use Smartling\Vendor\Symfony\Component\DependencyInjection\ContainerBuilder;
 
@@ -225,4 +225,9 @@ interface ExportedAPI
      * @param array items
      */
     public const FILTER_BULK_SUBMIT_PREPARE_ITEMS = 'smartling_filter_bulk_submit_prepare_items';
+
+    /**
+     * @param ConfigurationProfileEntity[]
+     */
+    public const FILTER_ACTIVE_PROFILES = 'smartling_filter_active_profiles';
 }
diff --git a/inc/Smartling/Jobs/LastModifiedCheckJob.php b/inc/Smartling/Jobs/LastModifiedCheckJob.php
@@ -115,10 +115,6 @@ protected function processFileUriSet(array $submissions, bool $failMissing): arr
         return $submissions;
     }
 
-    /**
-     * @param array $serializedPair
-     * @return bool
-     */
     private function validateSerializedPair(array $serializedPair): bool
     {
         $result = false;
@@ -198,7 +194,7 @@ protected function processDownloadOnChange(array $submissions): void
         foreach ($submissions as $submission) {
             $profile = $this->settingsManager->getSingleSettingsProfile($submission->getSourceBlogId());
 
-            if (($profile instanceof ConfigurationProfileEntity) && 1 === $profile->getDownloadOnChange()) {
+            if (ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_PROGRESS_CHANGES === $profile->getDownloadOnChange()) {
                 $this->getLogger()
                     ->debug(vsprintf('Adding submission %s to Download queue as it was changed.', [$submission->getId()]));
                 $this->queue->enqueue([$submission->getId()], QueueInterface::QUEUE_NAME_DOWNLOAD_QUEUE);
@@ -240,15 +236,15 @@ public function statusCheck(array $submissions): void
         $submissions = $this->submissionManager->storeSubmissions($statusCheckResult);
 
         foreach ($submissions as $submission) {
-            $this->checkEntityForDownload($submission);
+            $profile = $this->settingsManager->getSingleSettingsProfile($submission->getSourceBlogId());
+            if ($profile->getDownloadOnChange() !== ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_MANUAL) {
+                $this->checkEntityForDownload($submission);
+            }
         }
 
         $this->getLogger()->debug('Processing status check finished.');
     }
 
-    /**
-     * @param SubmissionEntity $entity
-     */
     public function checkEntityForDownload(SubmissionEntity $entity): void
     {
         if (100 === $entity->getCompletionPercentage() && 1 !== $entity->getIsCloned()) {
@@ -271,10 +267,6 @@ public function checkEntityForDownload(SubmissionEntity $entity): void
         }
     }
 
-    /**
-     * @param SubmissionEntity $submission
-     * @return string
-     */
     public function getSmartlingLocaleIdBySubmission(SubmissionEntity $submission): string
     {
         return $this->settingsManager
diff --git a/inc/Smartling/Settings/ConfigurationProfileEntity.php b/inc/Smartling/Settings/ConfigurationProfileEntity.php
@@ -20,6 +20,11 @@ class ConfigurationProfileEntity extends SmartlingEntityAbstract
 
     public const UPLOAD_ON_CHANGE_AUTO = 1;
 
+    public const TRANSLATION_DOWNLOAD_MODE_TRANSLATION_COMPLETED = 0;
+    public const TRANSLATION_DOWNLOAD_MODE_PROGRESS_CHANGES = 1;
+    public const TRANSLATION_DOWNLOAD_MODE_MANUAL = 2;
+
+
     public const TRANSLATION_PUBLISHING_MODE_NO_CHANGE = 0;
     public const TRANSLATION_PUBLISHING_MODE_PUBLISH = 1;
     public const TRANSLATION_PUBLISHING_MODE_DRAFT = 2;
@@ -353,7 +358,6 @@ public function setChangeAssetStatusOnCompletedTranslation(int $status): void
     /**
      * Alias for $this->setChangeAssetStatusOnCompletedTranslation, required for EntityAbstract::fromArray();
      * @noinspection PhpUnused
-     * @noinspection UnknownInspectionInspection
      */
     public function setPublishCompleted(int $publishCompleted): void
     {
diff --git a/inc/Smartling/Settings/SettingsManager.php b/inc/Smartling/Settings/SettingsManager.php
@@ -2,7 +2,10 @@
 
 namespace Smartling\Settings;
 
+use Smartling\Base\ExportedAPI;
 use Smartling\DbAl\EntityManagerAbstract;
+use Smartling\DbAl\LocalizationPluginProxyInterface;
+use Smartling\DbAl\SmartlingToCMSDatabaseAccessWrapperInterface;
 use Smartling\Exception\BlogNotFoundException;
 use Smartling\Exception\SmartlingConfigException;
 use Smartling\Exception\SmartlingDbException;
@@ -11,11 +14,23 @@
 use Smartling\Helpers\QueryBuilder\Condition\ConditionBlock;
 use Smartling\Helpers\QueryBuilder\Condition\ConditionBuilder;
 use Smartling\Helpers\QueryBuilder\QueryBuilder;
+use Smartling\Helpers\SiteHelper;
 use Smartling\Helpers\TestRunHelper;
+use Smartling\Helpers\WordpressFunctionProxyHelper;
 use Smartling\Submissions\SubmissionEntity;
 
 class SettingsManager extends EntityManagerAbstract
 {
+    public function __construct(
+        SmartlingToCMSDatabaseAccessWrapperInterface $dbal,
+        int $pageSize,
+        SiteHelper $siteHelper,
+        LocalizationPluginProxyInterface $localizationProxy,
+        private WordpressFunctionProxyHelper $wpProxy,
+    ) {
+        parent::__construct($dbal, $pageSize, $siteHelper, $localizationProxy);
+    }
+
     /**
      * @return ConfigurationProfileEntity[]
      */
@@ -44,7 +59,18 @@ public function getActiveProfiles(): array
     {
         $cnt = 0;
 
-        return $this->getEntities($cnt, true);
+        $profiles = $this->wpProxy->apply_filters(
+            ExportedAPI::FILTER_ACTIVE_PROFILES,
+            $this->getEntities($cnt, true),
+        );
+        foreach ($profiles as $profile) {
+            if (!$profile instanceof ConfigurationProfileEntity) {
+                throw new \RuntimeException('Expected instance of ' . ConfigurationProfileEntity::class . ', got ' .
+                    is_object($profile) ? get_class($profile) : gettype($profile));
+            }
+        }
+
+        return $profiles;
     }
 
     /**
diff --git a/inc/Smartling/WP/View/ConfigurationProfileForm.php b/inc/Smartling/WP/View/ConfigurationProfileForm.php
@@ -652,8 +652,9 @@ class="toggleExpert"><strong><?= __('Show Expert Settings', $domain) ?></strong>
                         HtmlTagGeneratorHelper::renderSelectOptions(
                             $profile->getDownloadOnChange(),
                             [
-                                0 => __('Translation Completed', $domain),
-                                1 => __('Progress Changes', $domain),
+                                ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_TRANSLATION_COMPLETED => __('Translation Completed', $domain),
+                                ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_PROGRESS_CHANGES => __('Progress Changes', $domain),
+                                ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_MANUAL => __('Manual', $domain),
                             ]
                         ),
                         ['name' => 'smartling_settings[download_on_change]'])
diff --git a/inc/config/services.yml b/inc/config/services.yml
@@ -288,6 +288,7 @@ services:
       - "%submission.pagesize%"
       - "@site.helper"
       - "@multilang.proxy"
+      - "@wp.proxy"
 
   plugin.info:
       class: Smartling\Helpers\PluginInfo
diff --git a/readme.txt b/readme.txt
@@ -62,14 +62,18 @@ Additional information on the Smartling Connector for WordPress can be found [he
 3. Track translation status within WordPress from the Submissions Board. View overall progress of submitted translation requests as well as resend updated content.
 
 == Changelog ==
+= 3.9.17 =
+* Added `smartling_filter_active_profiles` filter
+* Added `Manual` translation download mode
+
 = 3.9.16 =
-* Exclude WordPress built in style editor strings from translation
+* Excluded WordPress built in style editor strings from translation
 
 = 3.9.15 =
-* Add expert setting to skip ACF filter `acf_parse_save_blocks` removal. Defaults to on.
+* Added expert setting to skip ACF filter `acf_parse_save_blocks` removal. Defaults to on.
 
 = 3.9.14 =
-* Remove excessive logging
+* Removed excessive logging
 
 = 3.9.13 =
 * Improved handling of service strings inside nested ACF fields: they no longer should be sent for translation

Original file line number	Diff line number	Diff line change
`@@ -115,10 +115,6 @@ protected function processFileUriSet(array $submissions, bool $failMissing): arr`
`115`	`115`	`return $submissions;`
`116`	`116`	`}`
`117`	`117`
`118`		`- /**`
`119`		`- * @param array $serializedPair`
`120`		`- * @return bool`
`121`		`- */`
`122`	`118`	`private function validateSerializedPair(array $serializedPair): bool`
`123`	`119`	`{`
`124`	`120`	`$result = false;`
`@@ -198,7 +194,7 @@ protected function processDownloadOnChange(array $submissions): void`
`198`	`194`	`foreach ($submissions as $submission) {`
`199`	`195`	`$profile = $this->settingsManager->getSingleSettingsProfile($submission->getSourceBlogId());`
`200`	`196`
`201`		`- if (($profile instanceof ConfigurationProfileEntity) && 1 === $profile->getDownloadOnChange()) {`
	`197`	`+ if (ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_PROGRESS_CHANGES === $profile->getDownloadOnChange()) {`
`202`	`198`	`$this->getLogger()`
`203`	`199`	`->debug(vsprintf('Adding submission %s to Download queue as it was changed.', [$submission->getId()]));`
`204`	`200`	`$this->queue->enqueue([$submission->getId()], QueueInterface::QUEUE_NAME_DOWNLOAD_QUEUE);`
`@@ -240,15 +236,15 @@ public function statusCheck(array $submissions): void`
`240`	`236`	`$submissions = $this->submissionManager->storeSubmissions($statusCheckResult);`
`241`	`237`
`242`	`238`	`foreach ($submissions as $submission) {`
`243`		`- $this->checkEntityForDownload($submission);`
	`239`	`+ $profile = $this->settingsManager->getSingleSettingsProfile($submission->getSourceBlogId());`
	`240`	`+ if ($profile->getDownloadOnChange() !== ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_MANUAL) {`
	`241`	`+ $this->checkEntityForDownload($submission);`
	`242`	`+ }`
`244`	`243`	`}`
`245`	`244`
`246`	`245`	`$this->getLogger()->debug('Processing status check finished.');`
`247`	`246`	`}`
`248`	`247`
`249`		`- /**`
`250`		`- * @param SubmissionEntity $entity`
`251`		`- */`
`252`	`248`	`public function checkEntityForDownload(SubmissionEntity $entity): void`
`253`	`249`	`{`
`254`	`250`	`if (100 === $entity->getCompletionPercentage() && 1 !== $entity->getIsCloned()) {`
`@@ -271,10 +267,6 @@ public function checkEntityForDownload(SubmissionEntity $entity): void`
`271`	`267`	`}`
`272`	`268`	`}`
`273`	`269`
`274`		`- /**`
`275`		`- * @param SubmissionEntity $submission`
`276`		`- * @return string`
`277`		`- */`
`278`	`270`	`public function getSmartlingLocaleIdBySubmission(SubmissionEntity $submission): string`
`279`	`271`	`{`
`280`	`272`	`return $this->settingsManager`
Original file line number	Diff line number	Diff line change
`@@ -652,8 +652,9 @@ class="toggleExpert"><strong><?= __('Show Expert Settings', $domain) ?></strong>`
`652`	`652`	`HtmlTagGeneratorHelper::renderSelectOptions(`
`653`	`653`	`$profile->getDownloadOnChange(),`
`654`	`654`	`[`
`655`		`- 0 => __('Translation Completed', $domain),`
`656`		`- 1 => __('Progress Changes', $domain),`
	`655`	`+ ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_TRANSLATION_COMPLETED => __('Translation Completed', $domain),`
	`656`	`+ ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_PROGRESS_CHANGES => __('Progress Changes', $domain),`
	`657`	`+ ConfigurationProfileEntity::TRANSLATION_DOWNLOAD_MODE_MANUAL => __('Manual', $domain),`
`657`	`658`	`]`
`658`	`659`	`),`
`659`	`660`	`['name' => 'smartling_settings[download_on_change]'])`