choose configuration profile UI (WP-1022)

inc/Smartling/Base/SmartlingCoreExportApi.php

@@ -28,15 +28,16 @@ public function getFullyRelateAttachmentPathByBlogId($blogId, $foundRelativePath
         return trim(str_replace($this->getUploadPathForSite($blogId), '', $foundRelativePath), '/');
     }
 
-    public function sendAttachmentForTranslation(int $sourceBlogId, int $targetBlogId, int $sourceId, JobEntityWithBatchUid $jobInfo, bool $clone = false): SubmissionEntity
+    public function sendAttachmentForTranslation(int $sourceBlogId, int $targetBlogId, int $sourceId, JobEntityWithBatchUid $jobInfo, bool $clone = false, ?int $profileId = null): SubmissionEntity
     {
         return $this->getTranslationHelper()->tryPrepareRelatedContent(
             'attachment',
             $sourceBlogId,
             $sourceId,
             $targetBlogId,
             $jobInfo,
-            $clone
+            $clone,
+            $profileId,
         );
     }
 

inc/Smartling/Helpers/MetaFieldProcessor/ReferencedContentProcessor.php

@@ -96,6 +96,7 @@ public function processFieldPreTranslation(
                     $targetBlogId,
                     JobEntityWithBatchUid::fromJob($submission->getJobInfo(), ''),
                     $submission->isCloned(),
+                    $submission->getConfigurationProfileId(),
                 );
             }
 

inc/Smartling/Helpers/TranslationHelper.php

@@ -86,7 +86,7 @@ private function validateBlogs(int $sourceBlogId, int $targetBlogId): void
         }
     }
 
-    public function prepareSubmissionEntity(string $contentType, int $sourceBlog, int $sourceEntity, int $targetBlog, ?int $targetEntity = null): SubmissionEntity
+    public function prepareSubmissionEntity(string $contentType, int $sourceBlog, int $sourceEntity, int $targetBlog, ?int $targetEntity = null, ?int $profileId = null): SubmissionEntity
     {
         $this->validateBlogs($sourceBlog, $targetBlog);
 
@@ -96,7 +96,8 @@ public function prepareSubmissionEntity(string $contentType, int $sourceBlog, in
             $sourceEntity,
             $targetBlog,
             $this->multilangProxy,
-            $targetEntity
+            $targetEntity,
+            $profileId,
         );
     }
 
@@ -107,7 +108,7 @@ public function prepareSubmissionEntity(string $contentType, int $sourceBlog, in
      * @throws SmartlingDataReadException
      * @throws SmartlingInvalidFactoryArgumentException
      */
-    public function prepareSubmission(string $contentType, int $sourceBlog, int $sourceId, int $targetBlog, bool $clone = false): SubmissionEntity
+    public function prepareSubmission(string $contentType, int $sourceBlog, int $sourceId, int $targetBlog, bool $clone = false, ?int $profileId = null): SubmissionEntity
     {
         if (0 === $sourceId) {
             throw new \InvalidArgumentException('Source id cannot be 0.');
@@ -116,7 +117,9 @@ public function prepareSubmission(string $contentType, int $sourceBlog, int $sou
             $contentType,
             $sourceBlog,
             $sourceId,
-            $targetBlog
+            $targetBlog,
+            null,
+            $profileId,
         );
         if ($submission->getFileUri() === '') {
             $submission->setFileUri($this->fileUriHelper->generateFileUri($submission));
@@ -158,11 +161,11 @@ public function isRelatedSubmissionCreationNeeded(string $contentType, int $sour
     /**
      * @throws SmartlingDataReadException
      */
-    public function getExistingSubmissionOrCreateNew(string $contentType, int $sourceBlogId, int $contentId, int $targetBlogId, JobEntityWithBatchUid $jobInfo): SubmissionEntity {
-        $submission = $this->submissionManager->getSubmissionEntity($contentType, $sourceBlogId, $contentId, $targetBlogId, $this->multilangProxy);
+    public function getExistingSubmissionOrCreateNew(string $contentType, int $sourceBlogId, int $contentId, int $targetBlogId, JobEntityWithBatchUid $jobInfo, ?int $profileId = null): SubmissionEntity {
+        $submission = $this->submissionManager->getSubmissionEntity($contentType, $sourceBlogId, $contentId, $targetBlogId, $this->multilangProxy, null, $profileId);
         if ($submission->getTargetId() === 0) {
             $this->getLogger()->debug("Got submission with 0 target id");
-            $submission = $this->tryPrepareRelatedContent($contentType, $sourceBlogId, $contentId, $targetBlogId, $jobInfo);
+            $submission = $this->tryPrepareRelatedContent($contentType, $sourceBlogId, $contentId, $targetBlogId, $jobInfo, false, $profileId);
         }
         return $submission;
     }
@@ -174,9 +177,9 @@ public function getExistingSubmissionOrCreateNew(string $contentType, int $sourc
      * @throws SmartlingDataReadException
      * @throws SmartlingInvalidFactoryArgumentException
      */
-    public function tryPrepareRelatedContent(string $contentType, int $sourceBlog, int $sourceId, int $targetBlog, JobEntityWithBatchUid $jobInfo, bool $clone = false): SubmissionEntity
+    public function tryPrepareRelatedContent(string $contentType, int $sourceBlog, int $sourceId, int $targetBlog, JobEntityWithBatchUid $jobInfo, bool $clone = false, ?int $profileId = null): SubmissionEntity
     {
-        $relatedSubmission = $this->prepareSubmission($contentType, $sourceBlog, $sourceId, $targetBlog, $clone);
+        $relatedSubmission = $this->prepareSubmission($contentType, $sourceBlog, $sourceId, $targetBlog, $clone, $profileId);
 
         if (0 !== $sourceId && 0 === $relatedSubmission->getTargetId() &&
             SubmissionEntity::SUBMISSION_STATUS_FAILED !== $relatedSubmission->getStatus()

inc/Smartling/Models/UserTranslationRequest.php

@@ -7,23 +7,24 @@
 
 class UserTranslationRequest
 {
-    private int $contentId;
-    private string $contentType;
-    private string $description;
     private array $relations;
     private array $targetBlogIds;
-    private JobInformation $jobInformation;
     private array $ids;
 
-    public function __construct(int $contentId, string $contentType, array $relations, array $targetBlogIds, JobInformation $jobInformation, array $ids = [], string $description = '')
+    public function __construct(
+        private int $contentId,
+        private string $contentType,
+        array $relations,
+        array $targetBlogIds,
+        private JobInformation $jobInformation,
+        array $ids = [],
+        private string $description = '',
+        private ?int $profileId = null,
+    )
     {
-        $this->contentId = $contentId;
-        $this->contentType = $contentType;
-        $this->description = $description;
         krsort($relations);
         $this->relations = $relations;
         $this->targetBlogIds = ArrayHelper::toArrayOfIntegers($targetBlogIds, 'Target blog id expected to be numeric');
-        $this->jobInformation = $jobInformation;
         $this->ids = self::toIntegerArray($ids);
     }
 
@@ -60,6 +61,11 @@ public function getJobInformation(): JobInformation
         return $this->jobInformation;
     }
 
+    public function getProfileId(): ?int
+    {
+        return $this->profileId;
+    }
+
     public function getIds(): array
     {
         return $this->ids;
@@ -79,6 +85,7 @@ public static function fromArray(array $array): self
             new JobInformation($array['job']['id'], $array['job']['authorize'] === 'true', $array['job']['name'], $array['job']['description'], $array['job']['dueDate'], $array['job']['timeZone']),
             $ids,
             $array['description'] ?? (count($ids) > 0 ? 'From Bulk Submit' : 'From Widget'),
+            self::parseProfileId($array['profileId'] ?? null),
         );
     }
 
@@ -124,6 +131,22 @@ private static function validate(array $array): void
         }
     }
 
+    public static function parseProfileId(mixed $value): ?int
+    {
+        if ($value === null || $value === '') {
+            return null;
+        }
+        if (!is_int($value) && !(is_string($value) && ctype_digit($value))) {
+            throw new \InvalidArgumentException('Profile id must be a positive integer');
+        }
+        $profileId = (int)$value;
+        if ($profileId < 1) {
+            throw new \InvalidArgumentException('Profile id must be a positive integer');
+        }
+
+        return $profileId;
+    }
+
     private static function toIntegerArray(array $ids): array
     {
         return ArrayHelper::toArrayOfIntegers($ids, 'Content id expected to be numeric');

inc/Smartling/Services/ContentRelationsDiscoveryService.php

@@ -103,13 +103,11 @@ public function bulkUpload(
                     }
                     $submission->setFileUri($this->fileUriHelper->generateFileUri($submission));
                 }
+                $this->warnIfReprofilingInProgress($submission, $profile->getId());
                 $submission->setJobInfo($jobInfo);
                 $submission->setStatus(SubmissionEntity::SUBMISSION_STATUS_NEW);
                 $submission->setIsCloned(0);
-                // Bulk-submitting is an explicit new translation request: (re)stamp with the
-                // profile this request's batch is being created under, for both a found
-                // existing submission (which bypasses getSubmissionEntity() above) and a new
-                // one (where this just confirms what getSubmissionEntity() already stamped).
+                // Bulk-submitting is an explicit new translation request: (re)stamp with the profile it was requested with.
                 $submission->setConfigurationProfileId($profile->getId());
                 $submission = $this->submissionManager->storeEntity($submission);
                 $queueIds[] = $submission->getId();
@@ -153,7 +151,8 @@ public function bulkUpload(
     public function createSubmissions(UserTranslationRequest $request): void
     {
         $curBlogId = $this->wordpressProxy->get_current_blog_id();
-        $profile = $this->settingsManager->getSingleSettingsProfile($curBlogId);
+        $profile = $this->settingsManager->resolveRequestedProfile($request->getProfileId(), $curBlogId);
+        $this->settingsManager->assertTargetBlogIdsBelongToProfile($profile, $request->getTargetBlogIds());
         $job = $request->getJobInformation();
         $jobInfo = new JobEntity($job->getName(), $job->getId(), $profile->getProjectId());
 
@@ -228,12 +227,11 @@ public function createSubmissions(UserTranslationRequest $request): void
                     'type' => $request->getContentType(),
                 ];
             } else {
+                $this->warnIfReprofilingInProgress($submission, $profile->getId());
                 $submission->setStatus(SubmissionEntity::SUBMISSION_STATUS_NEW);
                 $submission->setIsCloned(0);
-                // Resubmitting an existing submission is an explicit new translation request,
-                // so (re)stamp it with the profile active right now, same as
-                // SubmissionManager::getSubmissionEntity() does - this path never goes through
-                // that method, so it would otherwise keep whatever profile (or none) it had.
+                // Resubmitting an existing submission is an explicit new translation request, so restamp it with the
+                // profile it was requested with.
                 $submission->setConfigurationProfileId($profile->getId());
                 $submission = $this->storeWithJobInfo($submission, $jobInfo, $request->getDescription());
                 $fileUris[] = $submission->getFileUri();
@@ -242,9 +240,7 @@ public function createSubmissions(UserTranslationRequest $request): void
 
             $submissionTemplateArray[SubmissionEntity::FIELD_STATUS] = SubmissionEntity::SUBMISSION_STATUS_NEW;
             $submissionTemplateArray[SubmissionEntity::FIELD_SUBMISSION_DATE] = DateTimeHelper::nowAsString();
-            // New submissions built from this template bypass getSubmissionEntity() too; stamp
-            // them with the profile this request's batch is being created under (below), so
-            // UploadJob never has to guess at a profile for them later.
+            // New submissions built from this template bypass getSubmissionEntity(), stamp them with the requested profile.
             $submissionTemplateArray[SubmissionEntity::FIELD_CONFIGURATION_PROFILE_ID] = $profile->getId();
 
             foreach ($sources as $source) {
@@ -594,6 +590,27 @@ public function normalizeReferences(array $references): array
         return $result;
     }
 
+    /**
+     * Re-stamping an existing submission to a different profile is an explicit, supported part of resubmitting
+     * under a user-chosen profile - but if it's still IN_PROGRESS under the old one, it loses its link to that
+     * project's file/job, and status checks/downloads will look at the new project instead. Warn so this is at
+     * least visible, without blocking the resubmission.
+     */
+    private function warnIfReprofilingInProgress(SubmissionEntity $submission, int $newProfileId): void
+    {
+        $oldProfileId = $submission->getConfigurationProfileId();
+        if ($oldProfileId !== null && $oldProfileId !== $newProfileId
+            && $submission->getStatus() === SubmissionEntity::SUBMISSION_STATUS_IN_PROGRESS
+        ) {
+            $this->getLogger()->warning(sprintf(
+                'Resubmitting submissionId=%d from profileId=%d to profileId=%d while still in progress; it will lose its link to the previous profile\'s file/job.',
+                $submission->getId(),
+                $oldProfileId,
+                $newProfileId,
+            ));
+        }
+    }
+
     private function storeWithJobInfo(SubmissionEntity $submission, JobEntity $jobInfo, string $description): SubmissionEntity
     {
         $submission->setJobInfo($jobInfo);

inc/Smartling/Services/ContentRelationsHandler.php

@@ -101,6 +101,8 @@ public function createSubmissionsHandler(array $data = null): void
         try {
             $this->service->createSubmissions(UserTranslationRequest::fromArray($data));
             $this->returnResponse(['status' => BaseAjaxServiceAbstract::RESPONSE_SUCCESS]);
+        } catch (SmartlingHumanReadableException $e) {
+            $this->returnError($e->getKey(), $e->getMessage(), $e->getResponseCode());
         } catch (Exception $e) {
             $this->returnError('content.submission.failed', $e->getMessage());
         }

inc/Smartling/Settings/ConfigurationProfileEntity.php

@@ -3,6 +3,7 @@
 namespace Smartling\Settings;
 
 use Smartling\Base\SmartlingEntityAbstract;
+use Smartling\Helpers\ArrayHelper;
 use Smartling\Vendor\Psr\Log\LoggerInterface;
 use Smartling\WP\Controller\ConfigurationProfileFormController as Form;
 
@@ -443,4 +444,24 @@ public function toArraySafe(): array
         unset($struct['secret_key']);
         return $struct;
     }
+
+    /**
+     * Data for the job wizard profile select and its target locale list.
+     */
+    public function toWizardArray(): array
+    {
+        $locales = $this->getTargetLocales();
+        ArrayHelper::sortLocales($locales);
+
+        return [
+            'id' => $this->getId(),
+            'name' => $this->getProfileName(),
+            'locales' => array_values(array_map(static fn(TargetLocale $l) => [
+                'blogId' => $l->getBlogId(),
+                'label' => $l->getLabel(),
+                'smartlingLocale' => $l->getSmartlingLocale(),
+                'enabled' => $l->isEnabled(),
+            ], array_filter($locales, static fn(TargetLocale $l) => $l->isEnabled()))),
+        ];
+    }
 }

inc/Smartling/Settings/SettingsManager.php

@@ -10,6 +10,7 @@
 use Smartling\Exception\EntityNotFoundException;
 use Smartling\Exception\SmartlingConfigException;
 use Smartling\Exception\SmartlingDbException;
+use Smartling\Exception\SmartlingHumanReadableException;
 use Smartling\Helpers\ArrayHelper;
 use Smartling\Helpers\QueryBuilder\Condition\Condition;
 use Smartling\Helpers\QueryBuilder\Condition\ConditionBlock;
@@ -119,6 +120,68 @@ public function getSingleSettingsProfile(int $mainBlogId): ConfigurationProfileE
         throw new SmartlingDbException($message);
     }
 
+    /**
+     * Resolves the profile for a translation request.
+     * An explicitly requested profile must exist, belong to the blog and be active, otherwise the request is rejected.
+     * Without an explicit profile, the blog's active profile is used.
+     *
+     * Failures are reported as SmartlingHumanReadableException (rather than the broader SmartlingDbException thrown
+     * by unrelated DB/content errors elsewhere in the request) so callers can map profile-resolution failures to a
+     * clean 400 without mislabeling other failures as invalid profile errors.
+     *
+     * @throws SmartlingHumanReadableException
+     */
+    public function resolveRequestedProfile(?int $requestedProfileId, int $blogId): ConfigurationProfileEntity
+    {
+        if ($requestedProfileId === null) {
+            try {
+                return $this->getSingleSettingsProfile($blogId);
+            } catch (SmartlingDbException $e) {
+                throw new SmartlingHumanReadableException($e->getMessage(), 'profile.not.found', 400);
+            }
+        }
+
+        $profile = ArrayHelper::first($this->getEntityById($requestedProfileId));
+        if (!$profile instanceof ConfigurationProfileEntity) {
+            $message = "Requested profileId=$requestedProfileId not found";
+            $this->getLogger()->warning($message);
+            throw new SmartlingHumanReadableException($message, 'profile.invalid', 400);
+        }
+        if ($profile->getSourceLocale()->getBlogId() !== $blogId || 1 !== $profile->getIsActive()) {
+            $message = "Requested profileId=$requestedProfileId is not an active profile for blogId=$blogId";
+            $this->getLogger()->warning($message);
+            throw new SmartlingHumanReadableException($message, 'profile.invalid', 400);
+        }
+        $this->getLogger()->debug("Using requested profileId=$requestedProfileId for blogId=$blogId");
+
+        return $profile;
+    }
+
+    /**
+     * @param int[] $targetBlogIds
+     * @throws SmartlingHumanReadableException
+     */
+    public function assertTargetBlogIdsBelongToProfile(ConfigurationProfileEntity $profile, array $targetBlogIds): void
+    {
+        $allowedBlogIds = [];
+        foreach ($profile->getTargetLocales() as $locale) {
+            if ($locale->isEnabled()) {
+                $allowedBlogIds[] = $locale->getBlogId();
+            }
+        }
+
+        $invalidBlogIds = array_diff($targetBlogIds, $allowedBlogIds);
+        if (0 < count($invalidBlogIds)) {
+            $message = sprintf(
+                'Target blogId(s) %s are not enabled target locales for profileId=%d',
+                implode(',', $invalidBlogIds),
+                $profile->getId(),
+            );
+            $this->getLogger()->warning($message);
+            throw new SmartlingHumanReadableException($message, 'target.blog.invalid', 400);
+        }
+    }
+
     /**
      * Returns the profile the submission was requested with, so delivery doesn't depend on which profile is active now.
      * Falls back to the active profile of the source blog for submissions without a stored (or an existing) profile.