feat(JobQueue) Implement import content job rest endpoint #30669

dotCMS/src/main/java/com/dotcms/rest/api/v1/JobQueueManagerHelper.java

@@ -0,0 +1,82 @@
+package com.dotcms.rest.api.v1;
+
+import com.dotcms.jobs.business.api.JobProcessorScanner;
+import com.dotcms.jobs.business.api.JobQueueManagerAPI;
+import com.dotcms.jobs.business.processor.JobProcessor;
+import com.dotcms.jobs.business.processor.Queue;
+import com.dotmarketing.util.Logger;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.inject.Inject;
+import java.lang.reflect.Constructor;
+import java.util.List;
+
+@ApplicationScoped
+public class JobQueueManagerHelper {
+
+    private JobProcessorScanner scanner;
+
+    @Inject
+    public JobQueueManagerHelper(JobProcessorScanner scanner) {
+        this.scanner = scanner;
+    }
+
+    public JobQueueManagerHelper() {
+    }
+
+    public void registerProcessors(JobQueueManagerAPI jobQueueManagerAPI) {
+        if (!jobQueueManagerAPI.isStarted()) {
+            jobQueueManagerAPI.start();
+            Logger.info(this.getClass(), "JobQueueManagerAPI started");
+        }
+
+        List<Class<? extends JobProcessor>> processors = scanner.discoverJobProcessors();
+        processors.forEach(processor -> {
+            try {
+                if (!testInstantiation(processor)) {
+                    return;
+                }
+                registerProcessor(jobQueueManagerAPI, processor);
+            } catch (Exception e) {
+                Logger.error(this.getClass(), "Unable to register JobProcessor ", e);
+            }
+        });
+    }
+
+    /**
+     * Test if a processor can be instantiated
+     * @param processor The processor to tested
+     * @return true if the processor can be instantiated, false otherwise
+     */
+    private boolean testInstantiation(Class<? extends JobProcessor> processor) {
+        try {
+            Constructor<? extends JobProcessor> declaredConstructor = processor.getDeclaredConstructor();
+            declaredConstructor.newInstance();
+            return true;
+        } catch (Exception e) {
+            Logger.error(this.getClass(), String.format(" JobProcessor [%s] cannot be instantiated and will be ignored.", processor.getName()), e);
+        }
+        return false;
+    }
+
+    private void registerProcessor(JobQueueManagerAPI jobQueueManagerAPI, Class<? extends JobProcessor> processor) {
+        if (processor.isAnnotationPresent(Queue.class)) {
+            Queue queue = processor.getAnnotation(Queue.class);
+            jobQueueManagerAPI.registerProcessor(queue.value(), processor);
+        } else {
+            jobQueueManagerAPI.registerProcessor(processor.getName(), processor);
+        }
+    }
+
+    public void shutdown(JobQueueManagerAPI jobQueueManagerAPI) {
+        if (jobQueueManagerAPI.isStarted()) {
+            try {
+                jobQueueManagerAPI.close();
+                Logger.info(this.getClass(), "JobQueueManagerAPI successfully closed");
+            } catch (Exception e) {
+                Logger.error(this.getClass(), e.getMessage(), e);
+            }
+        }
+    }
+}
+

dotCMS/src/main/java/com/dotcms/rest/api/v1/contentImport/ContentImportForm.java

@@ -0,0 +1,63 @@
+package com.dotcms.rest.api.v1.contentImport;
+
+import com.dotcms.repackage.javax.validation.constraints.NotNull;
+import com.dotcms.rest.api.Validated;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+
+/**
+ * Form object that represents the JSON parameters for content import operations.
+ */
+public class ContentImportForm extends Validated {
+
+    @NotNull(message = "Content Type is required")
+    private final String contentType;
+
+    private final String language;
+
+    @NotNull(message = "Workflow Action ID is required")
+    private final String workflowActionId;
+
+    private final List<String> fields;
+
+    @JsonCreator
+    public ContentImportForm(
+            @JsonProperty("contentType") final String contentType,
+            @JsonProperty("language") final String language,
+            @JsonProperty("workflowActionId") final String workflowActionId,
+            @JsonProperty("fields") final List<String> fields) {
+        super();
+        this.contentType = contentType;
+        this.language = language;
+        this.workflowActionId = workflowActionId;
+        this.fields = fields;
+    }
+
+    public String getContentType() {
+        return contentType;
+    }
+
+    public String getLanguage() {
+        return language;
+    }
+
+    public String getWorkflowActionId() {
+        return workflowActionId;
+    }
+
+    public List<String> getFields() {
+        return fields;
+    }
+
+    @Override
+    public String toString() {
+        return "ContentImportForm{" +
+                "contentType='" + contentType + '\'' +
+                ", language='" + language + '\'' +
+                ", workflowActionId='" + workflowActionId + '\'' +
+                ", fields=" + fields +
+                '}';
+    }
+}

dotCMS/src/main/java/com/dotcms/rest/api/v1/contentImport/ContentImportHelper.java

@@ -0,0 +1,157 @@
+package com.dotcms.rest.api.v1.contentImport;
+
+import com.dotcms.jobs.business.api.JobProcessorScanner;
+import com.dotcms.jobs.business.api.JobQueueManagerAPI;
+import com.dotcms.jobs.business.processor.JobProcessor;
+import com.dotcms.jobs.business.processor.Queue;
+import com.dotcms.rest.api.v1.JobQueueManagerHelper;
+import com.dotcms.rest.api.v1.temp.DotTempFile;
+import com.dotmarketing.business.APILocator;
+import com.dotmarketing.business.web.WebAPILocator;
+import com.dotmarketing.exception.DotDataException;
+import com.dotmarketing.exception.DotSecurityException;
+import com.dotmarketing.util.Logger;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.liferay.portal.model.User;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.enterprise.context.ApplicationScoped;
+import javax.inject.Inject;
+import javax.servlet.http.HttpServletRequest;
+import java.lang.reflect.Constructor;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+@ApplicationScoped
+public class ContentImportHelper {
+
+    private static final String CMD_PREVIEW = "preview";
+    private static final String CMD_PUBLISH = "publish";
+
+    private JobQueueManagerAPI jobQueueManagerAPI;
+    private JobQueueManagerHelper jobQueueManagerHelper;
+
+    @Inject
+    public ContentImportHelper(JobQueueManagerAPI jobQueueManagerAPI, JobQueueManagerHelper jobQueueManagerHelper) {
+        this.jobQueueManagerAPI = jobQueueManagerAPI;
+        this.jobQueueManagerHelper = jobQueueManagerHelper;
+    }
+
+    public ContentImportHelper() {
+    }
+
+    @PostConstruct
+    public void onInit() {
+        jobQueueManagerHelper.registerProcessors(jobQueueManagerAPI);
+    }
+
+    @PreDestroy
+    public void onDestroy() {
+        jobQueueManagerHelper.shutdown(jobQueueManagerAPI);
+    }
+
+    /**
+     * Creates a content import job with the provided parameters
+     *
+     * @param preview Whether this is a preview job
+     * @param queueName The name of the queue to submit the job to
+     * @param params The import parameters
+     * @param user The user initiating the import
+     * @param request The HTTP request
+     * @return The ID of the created job
+     */
+    public String createJob(
+            final boolean preview, 
+            final String queueName, 
+            final ContentImportParams params,
+            final User user,
+            final HttpServletRequest request) throws DotDataException, JsonProcessingException {
+
+        params.checkValid();
+        params.getForm().checkValid();
+
+        final Map<String, Object> jobParameters = createJobParameters(preview, params, user, request);
+        processFileUpload(params, jobParameters, request);
+
+        return jobQueueManagerAPI.createJob(queueName, jobParameters);
+    }
+
+    /**
+     * Creates the job parameters map from the provided inputs
+     */
+    private Map<String, Object> createJobParameters(
+            final boolean preview,
+            final com.dotcms.rest.api.v1.contentImport.ContentImportParams params,
+            final User user,
+            final HttpServletRequest request) throws JsonProcessingException, DotDataException {
+
+        final Map<String, Object> jobParameters = new HashMap<>();
+
+        // Add required parameters
+        jobParameters.put("cmd", preview ? CMD_PREVIEW : CMD_PUBLISH);
+        jobParameters.put("userId", user.getUserId());
+        jobParameters.put("contentType", params.getForm().getContentType());
+        jobParameters.put("workflowActionId", params.getForm().getWorkflowActionId());
+
+        // Add optional parameters
+        addOptionalParameters(params, jobParameters);
+
+        // Add site information
+        addSiteInformation(request, jobParameters);
+
+        return jobParameters;
+    }
+
+    /**
+     * Adds optional parameters to the job parameters map if they are present
+     */
+    private void addOptionalParameters(
+            final com.dotcms.rest.api.v1.contentImport.ContentImportParams params,
+            final Map<String, Object> jobParameters) throws JsonProcessingException {
+
+        final com.dotcms.rest.api.v1.contentImport.ContentImportForm form = params.getForm();
+
+        if (form.getLanguage() != null && !form.getLanguage().isEmpty()) {
+            jobParameters.put("language", form.getLanguage());
+        }
+        if (form.getFields() != null && !form.getFields().isEmpty()) {
+            jobParameters.put("fields", form.getFields());
+        }
+    }
+
+    /**
+     * Adds current site information to the job parameters
+     */
+    private void addSiteInformation(
+            final HttpServletRequest request, 
+            final Map<String, Object> jobParameters){
+
+        final var currentHost = WebAPILocator.getHostWebAPI().getCurrentHostNoThrow(request);
+        jobParameters.put("siteName", currentHost.getHostname());
+        jobParameters.put("siteIdentifier", currentHost.getIdentifier());
+    }
+
+    /**
+     * Processes the file upload and adds the necessary parameters to the job
+     */
+    private void processFileUpload(
+            final ContentImportParams params,
+            final Map<String, Object> jobParameters,
+            final HttpServletRequest request) throws DotDataException {
+
+        try {
+            final DotTempFile tempFile = APILocator.getTempFileAPI().createTempFile(
+                    params.getContentDisposition().getFileName(),
+                    request,
+                    params.getFileInputStream()
+            );
+            jobParameters.put("tempFileId", tempFile.id);
+            jobParameters.put("requestFingerPrint", APILocator.getTempFileAPI().getRequestFingerprint(request));
+        } catch (DotSecurityException e) {
+            Logger.error(this, "Error handling file upload", e);
+            throw new DotDataException("Error processing file upload: " + e.getMessage());
+        }
+    }
+}

dotCMS/src/main/java/com/dotcms/rest/api/v1/contentImport/ContentImportParams.java

@@ -0,0 +1,85 @@
+package com.dotcms.rest.api.v1.contentImport;
+
+import com.dotcms.repackage.javax.validation.ValidationException;
+import com.dotcms.repackage.javax.validation.constraints.NotNull;
+import com.dotcms.rest.api.Validated;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import net.minidev.json.annotate.JsonIgnore;
+import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
+import org.glassfish.jersey.media.multipart.FormDataParam;
+
+import java.io.InputStream;
+
+/**
+ * Bean class that encapsulates the multipart form parameters for content import operations.
+ */
+public class ContentImportParams extends Validated {
+
+    @NotNull(message = "The file is required.")
+    @FormDataParam("file")
+    private InputStream fileInputStream;
+
+    @JsonIgnore
+    @FormDataParam("file")
+    private FormDataContentDisposition contentDisposition;
+
+    @FormDataParam("form")
+    private ContentImportForm form;
+
+    @NotNull(message = "The form data is required.")
+    @FormDataParam("form")
+    private String jsonForm;
+
+    public InputStream getFileInputStream() {
+        return fileInputStream;
+    }
+
+    public void setFileInputStream(InputStream fileInputStream) {
+        this.fileInputStream = fileInputStream;
+    }
+
+    public FormDataContentDisposition getContentDisposition() {
+        return contentDisposition;
+    }
+
+    public void setContentDisposition(FormDataContentDisposition contentDisposition) {
+        this.contentDisposition = contentDisposition;
+    }
+
+    public String getJsonForm() {
+        return jsonForm;
+    }
+
+    public void setForm(ContentImportForm form) {
+        this.form = form;
+    }
+
+    /**
+     * Gets the parsed form object, lazily parsing the JSON if needed
+     * @return The ContentImportForm object
+     */
+    public ContentImportForm getForm() throws JsonProcessingException {
+        if (null == form && (null != jsonForm && !jsonForm.isEmpty())) {
+            form = new ObjectMapper().readValue(jsonForm, com.dotcms.rest.api.v1.contentImport.ContentImportForm.class);
+        }
+        return form;
+    }
+
+    @Override
+    public String toString() {
+        return "ContentImportParams{" +
+                "form=" + form +
+                ", hasFile=" + (fileInputStream != null) +
+                ", fileName=" + (contentDisposition != null ? contentDisposition.getFileName() : "null") +
+                '}';
+    }
+
+    @Override
+    public void checkValid() {
+        super.checkValid();
+        if (contentDisposition == null || contentDisposition.getFileName() == null) {
+            throw new ValidationException("The file must have a valid file name.");
+        }
+    }
+}