#30277 API/Factory methods to insert in the unique_fields table

dotCMS/src/main/java/com/dotcms/contenttype/business/UniqueFieldCriteria.java

@@ -0,0 +1,144 @@
+package com.dotcms.contenttype.business;
+
+import com.dotcms.content.elasticsearch.business.ESContentletAPIImpl;
+import com.dotcms.contenttype.model.field.Field;
+import com.dotcms.contenttype.model.type.ContentType;
+import com.dotmarketing.beans.Host;
+import com.dotmarketing.business.APILocator;
+import com.dotmarketing.exception.DotDataException;
+import com.dotmarketing.exception.DotRuntimeException;
+import com.dotmarketing.portlets.languagesmanager.model.Language;
+import com.dotmarketing.util.StringUtils;
+import com.liferay.util.StringPool;
+
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Represent the criteria used to determine if a value is unique or not
+ */
+public class UniqueFieldCriteria {
+    private final ContentType contentType;
+    private final Field field;
+    private final Object value;
+    private final Language language;
+    private final Host site;
+
+    public UniqueFieldCriteria(final Builder builder) {
+        this.contentType = builder.contentType;
+        this.field = builder.field;
+        this.value = builder.value;
+        this.language = builder.language;
+        this.site = builder.site;
+    }
+
+    /**
+     * Return a Map with the values in this Unique Field Criteria
+     * @return
+     */
+    public Map<String, Object> toMap(){
+        return Map.of(
+            "contentTypeID", Objects.requireNonNull(contentType.id()),
+            "fieldVariableName", Objects.requireNonNull(field.variable()),
+            "fieldValue", value.toString(),
+            "languageId", language.getId(),
+            "hostId", site.getIdentifier(),
+            "uniquePerSite", isUniqueForSite(contentType.id(), field.variable())
+        );
+    }
+
+    /**
+     * return true if the uniquePerSite Field Variable is set to true.
+     *
+     * @param contentTypeId
+     * @param fieldVariableName
+     * @return
+     */
+    private static boolean isUniqueForSite(String contentTypeId, String fieldVariableName)  {
+        try {
+            final Field uniqueField = APILocator.getContentTypeFieldAPI().byContentTypeIdAndVar(contentTypeId, fieldVariableName);
+
+            return uniqueField.fieldVariableValue(ESContentletAPIImpl.UNIQUE_PER_SITE_FIELD_VARIABLE_NAME)
+                    .map(Boolean::valueOf).orElse(false);
+        } catch (DotDataException e) {
+            throw  new DotRuntimeException(e);
+        }
+    }
+
+    /**
+     * Return a hash calculated as follow:
+     *
+     * - If the uniquePerSite Field Variable is set to true then concat the:
+     * Content Type' id + Field Variable Name + Language's Id + Field Value
+     *
+     * - If the uniquePerSite Field Variable is set to false then concat the:
+     * Content Type' id + Field Variable Name + Language's Id + Field Value + Site's id
+     *
+     * @return
+     */
+    public String hash(){
+        return StringUtils.hashText(contentType.id() + field.variable() + language.getId() + value +
+                ((isUniqueForSite(contentType.id(), field.variable())) ? site.getIdentifier() : StringPool.BLANK));
+    }
+
+    public Field field() {
+        return field;
+    }
+
+    public Object value() {
+        return value;
+    }
+
+    public ContentType contentType() {
+        return contentType;
+    }
+
+    public Language language() {
+        return language;
+    }
+
+
+    public static class Builder {
+        private ContentType contentType;
+        private Field field;
+        private Object value;
+        private Language language;
+        private Host site;
+
+
+        public Builder setContentType(final ContentType contentType) {
+            this.contentType = contentType;
+            return this;
+        }
+
+        public Builder setField(final Field field) {
+            this.field = field;
+            return this;
+        }
+
+        public Builder setValue(final Object value) {
+            this.value = value;
+            return this;
+        }
+
+        public Builder setLanguage(final Language language) {
+            this.language = language;
+            return this;
+        }
+
+        public Builder setSite(final Host site) {
+            this.site = site;
+            return this;
+        }
+
+        public UniqueFieldCriteria build(){
+            Objects.requireNonNull(contentType);
+            Objects.requireNonNull(field);
+            Objects.requireNonNull(value);
+            Objects.requireNonNull(language);
+            Objects.requireNonNull(site);
+
+            return new UniqueFieldCriteria(this);
+        }
+    }
+}

dotCMS/src/main/java/com/dotcms/contenttype/business/UniqueFieldFactory.java

@@ -0,0 +1,20 @@
+package com.dotcms.contenttype.business;
+
+import com.dotmarketing.exception.DotDataException;
+
+import java.util.Map;
+
+/**
+ * This Factory allow you to interact with the unique_fields table
+ */
+public interface UniqueFieldFactory {
+
+    /**
+     * Insert a new register into the unique_fields table, if already exists another register with the same
+     * 'unique_key_val' then a {@link java.sql.SQLException} is thrown.
+     *
+     * @param key
+     * @param supportingValues
+     */
+    void insert(final String key, final Map<String, Object> supportingValues) throws DotDataException;
+}

dotCMS/src/main/java/com/dotcms/contenttype/business/UniqueFieldFactoryImpl.java

@@ -0,0 +1,24 @@
+package com.dotcms.contenttype.business;
+
+import com.dotmarketing.common.db.DotConnect;
+import com.dotmarketing.exception.DotDataException;
+
+import java.util.Map;
+
+/**
+ * Default implementation of {@link UniqueFieldFactory}
+ */
+public class UniqueFieldFactoryImpl implements UniqueFieldFactory {
+
+    private final static String INSERT_SQL = "INSERT INTO unique_fields (unique_key_val, supporting_values) VALUES (?, ?)";
+    /**
+     * Default implementation of {@link UniqueFieldFactory#insert(String, Map)}
+     *
+     * @param key
+     * @param supportingValues
+     */
+    @Override
+    public void insert(final String key, final Map<String, Object> supportingValues) throws DotDataException {
+        new DotConnect().setSQL(INSERT_SQL).addParam(key).addJSONParam(supportingValues).loadObjectResults();
+    }
+}

dotCMS/src/main/java/com/dotcms/contenttype/business/UniqueFieldUtil.java

@@ -0,0 +1,77 @@
+package com.dotcms.contenttype.business;
+
+import com.dotcms.business.WrapInTransaction;
+import com.dotcms.content.elasticsearch.business.ESContentletAPIImpl;
+import com.dotcms.util.CollectionsUtils;
+import com.dotmarketing.business.FactoryLocator;
+import com.dotmarketing.exception.DotDataException;
+import com.dotmarketing.util.Logger;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * This Helper allow you to interact with the unique_fields table
+ */
+class UniqueFieldUtil {
+
+    private final UniqueFieldFactory uniqueFieldFactory;
+
+    public UniqueFieldUtil(){
+        this(FactoryLocator.getUniqueFieldFactory());
+    }
+
+    public UniqueFieldUtil(final UniqueFieldFactory uniqueFieldFactory) {
+        this.uniqueFieldFactory = uniqueFieldFactory;
+    }
+
+
+    /**
+     * Insert a new unique field value, if the value is duplicated then a {@link java.sql.SQLException} is thrown.
+     *
+     * @param uniqueFieldCriteria
+     * @param contentletId
+     *
+     * @throws UniqueFieldValueDupliacatedException when the Value is duplicated
+     * @throws DotDataException when a DotDataException is throws
+     */
+    @WrapInTransaction
+    public void insert(final UniqueFieldCriteria uniqueFieldCriteria, final String contentletId)
+            throws UniqueFieldValueDupliacatedException, DotDataException {
+
+        if (!uniqueFieldCriteria.field().unique()) {
+            final String message = String.format("The Field %s is not unique", uniqueFieldCriteria.field().variable());
+            Logger.debug(UniqueFieldUtil.class, message);
+            throw new IllegalArgumentException(message);
+        }
+
+        final boolean uniqueForSite = uniqueFieldCriteria.field().fieldVariableValue(ESContentletAPIImpl.UNIQUE_PER_SITE_FIELD_VARIABLE_NAME)
+                .map(Boolean::valueOf).orElse(false);
+
+        final Map<String, Object> supportingValues =  new HashMap<>(uniqueFieldCriteria.toMap());
+        supportingValues.put("contentletsId", CollectionsUtils.list(contentletId));
+        supportingValues.put("uniquePerSite", uniqueForSite);
+
+        try {
+            Logger.debug(UniqueFieldUtil.class, "Including value in the unique_fields table");
+            uniqueFieldFactory.insert(uniqueFieldCriteria.hash(), supportingValues);
+        } catch (DotDataException e) {
+
+            if (isDuplicatedKeyError(e)) {
+                final String duplicatedValueMessage = String.format("The value %s for the field %s in the Content type %s is duplicated",
+                        uniqueFieldCriteria.value(), uniqueFieldCriteria.field().variable(),
+                        uniqueFieldCriteria.contentType().variable());
+
+                Logger.error(UniqueFieldUtil.class, duplicatedValueMessage);
+                throw new UniqueFieldValueDupliacatedException(duplicatedValueMessage);
+            }
+        }
+    }
+
+    private static boolean isDuplicatedKeyError(final Exception exeption) {
+        final String originalMessage = exeption.getMessage();
+
+        return originalMessage != null && originalMessage.startsWith(
+                "ERROR: duplicate key value violates unique constraint \"unique_fields_pkey\"");
+    }
+}

dotCMS/src/main/java/com/dotcms/contenttype/business/UniqueFieldValueDupliacatedException.java

@@ -0,0 +1,11 @@
+package com.dotcms.contenttype.business;
+
+/**
+ * Throw if try to insert a duplicated register in unique_fiedls table
+ */
+public class UniqueFieldValueDupliacatedException extends Exception{
+
+    public UniqueFieldValueDupliacatedException(String message) {
+        super(message);
+    }
+}

dotCMS/src/main/java/com/dotmarketing/business/APILocator.java

@@ -30,18 +30,7 @@
 import com.dotcms.content.elasticsearch.business.ESIndexAPI;
 import com.dotcms.content.elasticsearch.business.IndiciesAPI;
 import com.dotcms.content.elasticsearch.business.IndiciesAPIImpl;
-import com.dotcms.contenttype.business.ContentTypeAPI;
-import com.dotcms.contenttype.business.ContentTypeAPIImpl;
-import com.dotcms.contenttype.business.ContentTypeDestroyAPI;
-import com.dotcms.contenttype.business.ContentTypeDestroyAPIImpl;
-import com.dotcms.contenttype.business.ContentTypeFieldLayoutAPI;
-import com.dotcms.contenttype.business.ContentTypeFieldLayoutAPIImpl;
-import com.dotcms.contenttype.business.DotAssetAPI;
-import com.dotcms.contenttype.business.DotAssetAPIImpl;
-import com.dotcms.contenttype.business.FieldAPI;
-import com.dotcms.contenttype.business.FieldAPIImpl;
-import com.dotcms.contenttype.business.StoryBlockAPI;
-import com.dotcms.contenttype.business.StoryBlockAPIImpl;
+import com.dotcms.contenttype.business.*;
 import com.dotcms.device.DeviceAPI;
 import com.dotcms.device.DeviceAPIImpl;
 import com.dotcms.dotpubsub.DotPubSubProvider;

dotCMS/src/main/java/com/dotmarketing/business/FactoryLocator.java

@@ -7,12 +7,7 @@
 import com.dotcms.cluster.business.ServerFactory;
 import com.dotcms.content.elasticsearch.business.ESContentFactoryImpl;
 import com.dotcms.content.elasticsearch.business.IndiciesFactory;
-import com.dotcms.contenttype.business.ContentTypeFactory;
-import com.dotcms.contenttype.business.ContentTypeFactoryImpl;
-import com.dotcms.contenttype.business.FieldFactory;
-import com.dotcms.contenttype.business.FieldFactoryImpl;
-import com.dotcms.contenttype.business.RelationshipFactory;
-import com.dotcms.contenttype.business.RelationshipFactoryImpl;
+import com.dotcms.contenttype.business.*;
 import com.dotcms.cube.CubeJSClientFactory;
 import com.dotcms.cube.CubeJSClientFactoryImpl;
 import com.dotcms.enterprise.DashboardProxy;
@@ -290,6 +285,15 @@ public static ContentAnalyticsFactory getContentAnalyticsFactory() {
         return (ContentAnalyticsFactory) getInstance(FactoryIndex.CONTENT_ANALYTICS_FACTORY);
     }
 
+    /**
+     * Returns the Factory object that handles operations related to unique_fields Validation
+     *
+     * @return An instance of the {@link HostFactory} object.
+     */
+    public static UniqueFieldFactory getUniqueFieldFactory() {
+        return (UniqueFieldFactory) getInstance(FactoryIndex.UNIQUE_FIELD_FACTORY);
+    }
+
     private static Object getInstance(FactoryIndex index) {
 
 		if(instance == null){
@@ -369,7 +373,8 @@ enum FactoryIndex
     SYSTEM_TABLE_FACTORY,
     CUBEJS_CLIENT_FACTORY,
     LANGUAGE_VARIABLE_FACTORY,
-    CONTENT_ANALYTICS_FACTORY;
+    CONTENT_ANALYTICS_FACTORY,
+    UNIQUE_FIELD_FACTORY;
 
 	Object create() {
 		switch(this) {
@@ -414,6 +419,7 @@ Object create() {
             case CUBEJS_CLIENT_FACTORY: return new CubeJSClientFactoryImpl();
             case LANGUAGE_VARIABLE_FACTORY: return new LanguageVariableFactoryImpl();
             case CONTENT_ANALYTICS_FACTORY: CDIUtils.getBean(ContentAnalyticsFactory.class).orElseThrow(() -> new DotRuntimeException("ContentAnalyticsFactory not found"));
+            case UNIQUE_FIELD_FACTORY: return new UniqueFieldFactoryImpl();
 		}
 		throw new AssertionError("Unknown Factory Index: " + this);
 	}

dotcms-integration/src/test/java/com/dotcms/MainSuite2b.java

@@ -24,9 +24,7 @@
 import com.dotcms.content.business.json.LegacyJSONObjectRenderTest;
 import com.dotcms.content.elasticsearch.business.ESIndexAPITest;
 import com.dotcms.content.model.hydration.MetadataDelegateTest;
-import com.dotcms.contenttype.business.ContentTypeDestroyAPIImplTest;
-import com.dotcms.contenttype.business.ContentTypeInitializerTest;
-import com.dotcms.contenttype.business.StoryBlockAPITest;
+import com.dotcms.contenttype.business.*;
 import com.dotcms.csspreproc.CSSCacheTest;
 import com.dotcms.csspreproc.CSSPreProcessServletTest;
 import com.dotcms.dotpubsub.RedisPubSubImplTest;
@@ -385,7 +383,9 @@
         SimpleInjectionIT.class,
         LegacyJSONObjectRenderTest.class,
         Task241013RemoveFullPathLcColumnFromIdentifierTest.class,
-        Task241009CreatePostgresJobQueueTablesTest.class
+        Task241009CreatePostgresJobQueueTablesTest.class,
+        UniqueFieldFactoryImplTest.class,
+        UniqueFieldUtilTest.class
 })
 
 public class MainSuite2b {