Ugc Module initializer which initializes + * views registration in modules with {@link RegisteredViewModel} and {@link RegisteredViewModels}. + *
+ */ +@Slf4j +@Configuration +@ComponentScan("com.sdl.dxa.modules.ugc") +public class UgcInitializer { + + @Bean + public UgcCommentApi ugcCommentApi() { + return new DefaultUgcCommentApi(); + } + + //Todo: use UgcVoteCommentApi implementation when it becomes available + + @Component + @RegisteredViewModels({ + @RegisteredViewModel(viewName = "Comments", modelClass = UgcRegion.class), + @RegisteredViewModel(viewName = "UgcComments", modelClass = UgcComments.class), + @RegisteredViewModel(viewName = "UgcPostCommentForm", modelClass = UgcPostCommentForm.class, controllerName = "Ugc"), + @RegisteredViewModel(viewName = "GeneralPage", modelClass = DefaultPageModel.class) + }) + @ModuleInfo(name = "UGC module", areaName = "Ugc", description = "Support for UGC views") + public static class UgcViewModuleInitializer extends AbstractModuleInitializer { + @Override + protected String getAreaName() { + return "Ugc"; + } + } +} diff --git a/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/UgcService.java b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/UgcService.java new file mode 100644 index 000000000..efba18abb --- /dev/null +++ b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/UgcService.java @@ -0,0 +1,142 @@ +package com.sdl.dxa.modules.ugc; + +import com.sdl.delivery.ugc.client.comment.UgcCommentApi; +import com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter; +import com.sdl.dxa.modules.ugc.data.Comment; +import com.sdl.dxa.modules.ugc.data.User; +import com.sdl.web.ugc.Status; +import com.sdl.webapp.common.util.TcmUtils; +import com.tridion.ambientdata.AmbientDataContext; +import com.tridion.ambientdata.claimstore.ClaimStore; +import lombok.extern.slf4j.Slf4j; +import org.joda.time.DateTime; +import org.joda.time.DateTimeZone; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.net.URI; +import java.net.URISyntaxException; +import java.time.ZonedDateTime; +import java.util.*; + +/** + *Service providing methods to create and retrieve comments
+ */ +@Service +@Slf4j +public class UgcService { + + private static final int maximumThreadsDepth = -1; + + @Autowired + private UgcCommentApi ugcCommentApi; + + //Todo: use UgcVoteCommentApi implementation when it becomes available + + @Autowired + public UgcService() { + } + + /** + * retrieves a list of {@link Comment} items for a given page + * + * @param publicationId Publication Id + * @param pageId Page Id + * @param descending Order + * @param statuses Limit to specific statuses + * @param top maximum number of comments to show + * @param skip number of comments to skip + * @return List of {@link Comment} + */ + public ListUgc API controller that handles requests to /api/comments/.
handles get request
+ *listens to basepath/{publicationId}/{pageId}
handles post request
+ *listens to basepath/add
Ugc entity controller that handles include requests to /system/mvc/Framework/Ugc/{entityId}.
Ugc API controller that handles requests to /api/ugc/postcomment.
handles post comment request
+ *listens to /api/ugc/postcomment.
Ugc comment
+ */ + +@Data +public class Comment { + private long id; + + @JsonIgnore + private long parentId; + + private int itemPublicationId; + + private int itemId; + + private int itemType; + +// private CommentDate creationDate; + private DateTime creationDate; + +// private CommentDate lastModifiedDate; + private DateTime lastModifiedDate; + + private String content; + + private User user; + + private ListUgc posted comment
+ */ + +@Data +public class PostedComment { + private int publicationId; + + private int pageId; + + private String username; + + private String email; + + private String content; + + private int parentId = 0; + + private String publicationTitle; + + private String publicationUrl; + + private String pageTitle; + + private String pageUrl; + + private String language; +} diff --git a/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/data/PubIdTitleLang.java b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/data/PubIdTitleLang.java new file mode 100644 index 000000000..c8962cbf6 --- /dev/null +++ b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/data/PubIdTitleLang.java @@ -0,0 +1,17 @@ +package com.sdl.dxa.modules.ugc.data; + +import lombok.Data; + +/** + *Publication Title and Language
+ */ + +@Data +public class PubIdTitleLang { + + private int id; + + private String title; + + private String lang; +} diff --git a/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/data/User.java b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/data/User.java new file mode 100644 index 000000000..4782462d5 --- /dev/null +++ b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/data/User.java @@ -0,0 +1,17 @@ +package com.sdl.dxa.modules.ugc.data; + +import lombok.Data; + +/** + *Ugc User information
+ */ +@Data +public class User { + private String id; + + private String name; + + private String emailAddress; + + private String externalId; +} diff --git a/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/mapping/UgcModelBuilder.java b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/mapping/UgcModelBuilder.java new file mode 100644 index 000000000..9434f51ca --- /dev/null +++ b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/mapping/UgcModelBuilder.java @@ -0,0 +1,283 @@ +package com.sdl.dxa.modules.ugc.mapping; + +import com.sdl.dxa.api.datamodel.model.ContentModelData; +import com.sdl.dxa.api.datamodel.model.EntityModelData; +import com.sdl.dxa.api.datamodel.model.PageModelData; +import com.sdl.dxa.modules.ugc.model.entity.UgcComments; +import com.sdl.dxa.modules.ugc.model.entity.UgcPostCommentForm; +import com.sdl.dxa.modules.ugc.model.entity.UgcRegion; +import com.sdl.dxa.tridion.mapping.EntityModelBuilder; +import com.sdl.dxa.tridion.mapping.PageModelBuilder; +import com.sdl.webapp.common.api.WebRequestContext; +import com.sdl.webapp.common.api.localization.Localization; +import com.sdl.webapp.common.api.model.*; +import com.sdl.webapp.common.api.model.mvcdata.DefaultsMvcData; +import com.sdl.webapp.common.api.model.mvcdata.MvcDataCreator; +import com.sdl.webapp.common.exceptions.DxaException; +import com.sdl.webapp.common.util.TcmUtils; +import com.tridion.util.TCMURI; +import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.StringUtils; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +import java.text.ParseException; +import java.util.ArrayList; +import java.util.List; + +/** + *Builds {@linkplain PageModel Page Model} ando{@linkplain EntityModel Entity Model}.
+ */ +@Slf4j +@Component +public class UgcModelBuilder implements PageModelBuilder, EntityModelBuilder { + + private static final String COMMENTS_CONFIG = "ugcConfig"; + private static final String POST_FORM_CONFIG = "postFormConfig"; + + private static final String COMMENTS_REGION_KEY = "commentsRegion"; + private static final String SHOW_COMMENTS_KEY = "showComments"; + private static final String ALLOW_POST_KEY = "allowPost"; + + private static final String COMMENTS_REGION = "Comments"; + private static final String COMMENTS_AREA = "Ugc"; + + private static final String SHOW_COMMENTS_EXT_DATA = "UgcShowComments"; + private static final String POST_COMMENTS_EXT_DATA = "UgcPostComments"; + private static final String COMMENTS_ENTITY_REGION_EXT_DATA = "CommentsEntityRegion"; + + private static final String COMMENTS_QUALIFIED_NAME = "Ugc:Ugc:UgcComments"; + private static final String POST_FORM_QUALIFIED_NAME = "Ugc:Ugc:UgcPostCommentForm"; + + private final WebRequestContext webRequestContext; + + @Autowired + public UgcModelBuilder(WebRequestContext webRequestContext) { + this.webRequestContext = webRequestContext; + } + + private RegionModel findRegion(RegionModelSet regionModelSet, String regionName) { + for (RegionModel region : regionModelSet) { + if (region.getName().equals(regionName)) { + return region; + } + RegionModel childRegion = findRegion(region.getRegions(), regionName); + if (childRegion != null) { + return childRegion; + } + } + return null; + } + + private UgcRegion createRegion(PageModel pageModel, String areaName, String regionName) { + UgcRegion ugcRegion = null; + if (!pageModel.getRegions().containsClass(UgcRegion.class)) { + try { + ugcRegion = new UgcRegion(regionName); + MvcData mvcData = MvcDataCreator.creator() + .fromQualifiedName(String.format("%s:%s", areaName, regionName)) + .defaults(DefaultsMvcData.REGION) + .create(); + ugcRegion.setMvcData(mvcData); + pageModel.getRegions().add(ugcRegion); + } catch (DxaException e) { + log.error("Creation of RegionModel {} failed", regionName, e); + } + } else { + ugcRegion = pageModel.getRegions().stream() + .filter(regionModel -> regionModel instanceof UgcRegion) + .map(regionModel -> (UgcRegion) regionModel) + .findFirst().orElse(null); + } + return ugcRegion; + } + + private void addCommentsViews(PageModel pageModel, RegionModel region, Localization localization, RegionModel ugcRegion) { + final ListExtends the pagemodel with a UGC region and entities
+ * + * @param originalPageModel the strongly typed Page Model to build + * @param modelData the DXA R2 Data Model + */ + @Nullable + @Override + public PageModel buildPageModel(@Nullable PageModel originalPageModel, @NotNull PageModelData modelData) { + if (originalPageModel == null) { + log.error("Original page model is null"); + return null; + } + + final ContentModelData metadata = modelData.getPageTemplate() == null ? null : modelData.getPageTemplate().getMetadata(); + final ContentModelData ugcMetadata = ugcMetadata(metadata); + final Localization localization = webRequestContext.getLocalization(); + + String regionName = getValue(ugcMetadata, COMMENTS_REGION_KEY, String.class); + final RegionModel ugcRegion; + RegionModel ugcRegionModel; + if (StringUtils.isEmpty(regionName)) { + ugcRegionModel = findRegion(originalPageModel.getRegions(), COMMENTS_REGION); + if (ugcRegionModel == null) { + ugcRegionModel = createRegion(originalPageModel, COMMENTS_AREA, COMMENTS_REGION); + } + } else { + ugcRegionModel = findRegion(originalPageModel.getRegions(), regionName); + if (ugcRegionModel == null) { + log.error("Unable to locate region for comments '{}'.", regionName); + } + } + + ugcRegion = ugcRegionModel; + originalPageModel.getRegions().forEach(region -> addCommentsViews(originalPageModel, region, localization, ugcRegion)); + + if (ugcRegion != null) { + if (showComments(ugcMetadata)) { + ugcRegion.getEntities().add(createUgcCommentsEntity(localization, originalPageModel.getId(), TcmUtils.PAGE_ITEM_TYPE)); + } + if (postComments(ugcMetadata)) { + ugcRegion.getEntities().add(createUgcPostCommentEntity(localization, originalPageModel.getId(), TcmUtils.PAGE_ITEM_TYPE, + ugcPostFormMetadata(ugcMetadata))); + } + } + return originalPageModel; + } + + /** + *Extends the Entity Model with Ugc extension data. Never returns null.
+ * + * @param originalEntityModel the strongly typed Entity Model to build. Is null for the first Entity Model Builder in the ModelBuilderPipelineImpl + * @param modelData the DXA R2 Data Model + * @param expectedClass required class of entity model, gets the priority if modelData contains MVC data + * @return the strongly typed Entity Model + */ + @Override + publicEntityModel for a single Ugc comment
+ */ +@Data +@EqualsAndHashCode(callSuper = true) +public class UgcComment extends AbstractEntityModel { + + /** + * Comment Data + **/ + private Comment commentData; + + /** + * List of related comments + **/ + private ListEntityModel containing all comments related to a given page or component
+ */ +@Data +@EqualsAndHashCode(callSuper = true) +public class UgcComments extends AbstractEntityModel { + + /** + * Target CmUri for comments + **/ + @SemanticMappingIgnore + private CMURI target; + + /** + * List of comments + **/ + @SemanticMappingIgnore + private ListEntityModel for Posted Comment model
+ */ +@Data +@EqualsAndHashCode(callSuper = true) +@NeverCached(qualifier = "UgcPostCommentForm") +public class UgcPostCommentForm extends AbstractEntityModel { + + /** + * Holds the forms url, for redirecting purposes + */ + @SemanticMappingIgnore + @JsonIgnore + private String formUrl; + + /** + * Holds the form control value for username + */ + @SemanticMappingIgnore + private String userName; + + /** + * Holds the form control value for email address + **/ + @SemanticMappingIgnore + private String emailAddress; + + + + /** + * Holds the form control value for email address + **/ + @SemanticMappingIgnore + private String content; + + /** + * Metadata of comment to post + **/ + @SemanticMappingIgnore + private MapRegionModel for the Ugc Comment region
+ */ +@EqualsAndHashCode(callSuper = true) +@Data +public class UgcRegion extends RegionModelImpl { + /** + * @param other other Region + */ + public UgcRegion(RegionModel other) { + super(other); + } + + /** + * @param name Region name + * @throws DxaException if name is empty or null + */ + public UgcRegion(String name) throws DxaException { + super(name); + } + + /** + * @param name region name + * @param qualifiedViewName view name + * @throws DxaException if name is empty or null + */ + public UgcRegion(String name, String qualifiedViewName) throws DxaException { + super(name, qualifiedViewName); + } + + /** + * @param mvcData {@link MvcData} + * @throws DxaException if name is empty or null + */ + public UgcRegion(MvcData mvcData) throws DxaException { + super(mvcData); + } +} diff --git a/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/model/validator/UgcPostCommentFormValidator.java b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/model/validator/UgcPostCommentFormValidator.java new file mode 100644 index 000000000..bbd8a3f70 --- /dev/null +++ b/webapp-java/dxa-module-ugc/src/main/java/com/sdl/dxa/modules/ugc/model/validator/UgcPostCommentFormValidator.java @@ -0,0 +1,38 @@ +package com.sdl.dxa.modules.ugc.model.validator; + +import com.sdl.dxa.modules.ugc.model.entity.UgcPostCommentForm; +import org.springframework.stereotype.Component; +import org.springframework.validation.Errors; +import org.springframework.validation.ValidationUtils; +import org.springframework.validation.Validator; + +/** + *Validator, validating Ugc comment Posts
+ */ +@Component +public class UgcPostCommentFormValidator implements Validator { + + /** + * @param clazz supported form model class + * @return True/False + */ + @Override + public boolean supports(Class clazz) { + return UgcPostCommentForm.class.isAssignableFrom(clazz); + } + + /** + *Validates posted form
+ * + * @param target form to validate + * @param errors errors found during validation + */ + @Override + public void validate(Object target, Errors errors) { + final UgcPostCommentForm form = (UgcPostCommentForm) target; + + ValidationUtils.rejectIfEmptyOrWhitespace(errors, "userName", "userName.empty", form.getNoUserNameMessage()); + ValidationUtils.rejectIfEmptyOrWhitespace(errors, "emailAddress", "emailAddress.empty", form.getNoEmailAddressMessage()); + ValidationUtils.rejectIfEmptyOrWhitespace(errors, "content", "content.empty", form.getNoContentMessage()); + } +} diff --git a/webapp-java/dxa-module-ugc/src/main/resources/META-INF/resources/WEB-INF/Views/Ugc/Entity/UgcComments.jsp b/webapp-java/dxa-module-ugc/src/main/resources/META-INF/resources/WEB-INF/Views/Ugc/Entity/UgcComments.jsp new file mode 100644 index 000000000..aec04868b --- /dev/null +++ b/webapp-java/dxa-module-ugc/src/main/resources/META-INF/resources/WEB-INF/Views/Ugc/Entity/UgcComments.jsp @@ -0,0 +1,33 @@ +<%@ taglib prefix="dxa" uri="http://www.sdl.com/tridion-dxa" %> +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> +${comment.commentData.content}
+@Model.CommentData.Content
+