in progress #23903

CHANGELOG.md

@@ -4,6 +4,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v1.2.0-SNAPSHOT] - 2023-01-19
+
+#### Enhancements
+
+- [#23903] Catalogue Moderation: allow to send a message to the moderators on reject to pending operation
+
 ## [v1.1.1] - 2022-10-27
 
 #### Fixing

pom.xml

@@ -14,7 +14,7 @@
 	<groupId>org.gcube.portlets.widgets</groupId>
 	<artifactId>ckan-content-moderator-widget</artifactId>
 	<packaging>jar</packaging>
-	<version>1.1.1</version>
+	<version>1.2.0-SNAPSHOT</version>
 	<name>gCube Ckan Content Moderator Widget</name>
 
 	<description>

src/main/java/org/gcube/portlets/widgets/ckancontentmoderator/client/CkanContentModeratorCheckConfigs.java

@@ -106,7 +106,10 @@ public class CkanContentModeratorCheckConfigs {
 					attemptLC++;
 					GWT.log("checking configuration loaded, attempt " + attemptLC + " of "
 							+ MAX_RETRY_ON_LOADING_CONFIG);
-					boolean configsLoaded = getConfigurationLoaded() == CONFIGURATION_EXPECTED;
+					int confLoaded = getConfigurationLoaded();
+					GWT.log("configuration loaded " + confLoaded + " of "
+							+ CONFIGURATION_EXPECTED);
+					boolean configsLoaded = confLoaded == CONFIGURATION_EXPECTED;
 					GWT.log("configsLoaded: " + configsLoaded);
 					if (configsLoaded) {
 						GWT.log("ContentModeratorCheckConfig loaded correclty");

src/main/java/org/gcube/portlets/widgets/ckancontentmoderator/client/CkanContentModeratorService.java

@@ -21,17 +21,6 @@ import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
 @RemoteServiceRelativePath("ckanContentModeratorService")
 public interface CkanContentModeratorService extends RemoteService {
 
-	/**
-	 * Sets the status. Currently, this only used to change the status from Rejected
-	 * to Pending
-	 *
-	 * @param theStatus the the status
-	 * @param itemNames the item names
-	 * @return the operation report
-	 * @throws Exception the exception
-	 */
-	public OperationReport setStatus(ItemStatus theStatus, List<String> itemNames) throws Exception;
-
 	/**
 	 * Reject item.
 	 *
@@ -67,7 +56,7 @@ public interface CkanContentModeratorService extends RemoteService {
 	 * @return the list items for status
 	 * @throws Exception the exception
 	 */
-	List<CatalogueDataset> getListItemsForStatus(ItemStatus theStatus, int offset, int limit, boolean allFields,
+	public List<CatalogueDataset> getListItemsForStatus(ItemStatus theStatus, int offset, int limit, boolean allFields,
 			boolean restrictedToLoggedInUser, String sortForField) throws Exception;
 
 	/**
@@ -135,6 +124,16 @@ public interface CkanContentModeratorService extends RemoteService {
 	 * @return the item for name
 	 * @throws Exception the exception
 	 */
-	CatalogueDataset getItemForName(String itemName) throws Exception;
+	public CatalogueDataset getItemForName(String itemName) throws Exception;
+
+	/**
+	 * Sets the status.
+	 *
+	 * @param theStatus the the status
+	 * @param itemNames the item names
+	 * @return the operation report
+	 * @throws Exception the exception
+	 */
+	public OperationReport setStatus(ItemStatus theStatus, List<String> itemNames, String message) throws Exception;
 
 }

src/main/java/org/gcube/portlets/widgets/ckancontentmoderator/client/CkanContentModeratorServiceAsync.java

@@ -30,6 +30,18 @@ public interface CkanContentModeratorServiceAsync {
 	void rejectItem(List<String> itemNames, boolean permanentlyDelete, String reasonMsg,
 			AsyncCallback<OperationReport> callback);
 
+	/**
+	 * Gets the list items for status.
+	 *
+	 * @param theStatus                the the status
+	 * @param offset                   the offset
+	 * @param limit                    the limit
+	 * @param allFields                the all fields
+	 * @param restrictedToLoggedInUser the restricted to logged in user
+	 * @param sortForField             the sort for field
+	 * @param callback                 the callback
+	 * @return the list items for status
+	 */
 	void getListItemsForStatus(ItemStatus theStatus, int offset, int limit, boolean allFields,
 			boolean restrictedToLoggedInUser, String sortForField, AsyncCallback<List<CatalogueDataset>> callback);
 
@@ -70,9 +82,11 @@ public interface CkanContentModeratorServiceAsync {
 	 *
 	 * @param theStatus the the status
 	 * @param itemNames the item names
+	 * @param message   the message
 	 * @param callback  the callback
 	 */
-	void setStatus(ItemStatus theStatus, List<String> itemNames, AsyncCallback<OperationReport> callback);
+	void setStatus(ItemStatus theStatus, List<String> itemNames, String message,
+			AsyncCallback<OperationReport> callback);
 
 	/**
 	 * Gets the CMS roles for user in the context.

src/main/java/org/gcube/portlets/widgets/ckancontentmoderator/client/ui/DoActionCMSView.java

@@ -117,7 +117,8 @@ public class DoActionCMSView extends Composite {
 		switch (toStatus) {
 		case PENDING:
 			checkBoxPermDelete.setVisible(false);
-			txtMsgReason.setVisible(false);
+			txtMsgReason.setVisible(true);
+			txtMsgReason.setPlaceholder("(Optional) Type a message...");
 			break;
 		case APPROVED:
 			checkBoxPermDelete.setVisible(false);

src/main/java/org/gcube/portlets/widgets/ckancontentmoderator/client/ui/HomeView.java

@@ -106,7 +106,7 @@ public class HomeView extends Composite {
 	 * @param status                     the status
 	 * @param displayFields              the display fields
 	 * @param sortByField                the sort by field
-	 * @param readOnlyMode the read only mode
+	 * @param readOnlyMode               the read only mode
 	 * @param restrictDataToLoggedInUser the restrict data to logged in user
 	 */
 	public HomeView(HandlerManager eventBus, ItemStatus status, DISPLAY_FIELD[] displayFields,
@@ -423,7 +423,7 @@ public class HomeView extends Composite {
 	/**
 	 * Load form server the items with status.
 	 *
-	 * @param itemStatus the item status
+	 * @param itemStatus   the item status
 	 * @param sortForField
 	 */
 	public void loadItemsWithStatus(ItemStatus itemStatus, String sortForField) {
@@ -456,7 +456,7 @@ public class HomeView extends Composite {
 		case PENDING:
 
 			CkanContentModeratorWidgetController.contentModeratorService.setStatus(toStatus, listDatasetNames,
-					new AsyncCallback<OperationReport>() {
+					doActionCMSView.getTxtReasonMsg(), new AsyncCallback<OperationReport>() {
 
 						@Override
 						public void onSuccess(OperationReport result) {

src/main/java/org/gcube/portlets/widgets/ckancontentmoderator/server/CkanContentModeratorServiceImpl.java

@@ -54,6 +54,7 @@ public class CkanContentModeratorServiceImpl extends RemoteServiceServlet implem
 			DataCatalogueImpl catalogueImpl = CatalogueCMSFactory.getFactory().getCatalogueImplPerScope(scope);
 			CatalogueContentModeratorSystem cmsInstance = catalogueImpl.getCatalogueContentModerator();
 			isModerationEnabled = cmsInstance.isModerationEnabled(reloadConfig);
+			LOG.info("is ModerationEnabled? " + isModerationEnabled);
 		} catch (Exception e) {
 			LOG.error("Error occured on checking isContentModeratorEnabled, so returning false", e);
 			return false;
@@ -296,22 +297,29 @@ public class CkanContentModeratorServiceImpl extends RemoteServiceServlet implem
 	 *
 	 * @param theStatus the the status
 	 * @param itemNames the item names
+	 * @param message the message to send to Moderators. If null no messange is sent
 	 * @return the operation report
 	 * @throws Exception the exception
 	 */
 	@Override
-	public OperationReport setStatus(ItemStatus theStatus, List<String> itemNames) throws Exception {
+	public OperationReport setStatus(ItemStatus theStatus, List<String> itemNames, String message) throws Exception {
-		LOG.info("Called set status " + theStatus + " for Items with name: " + itemNames);
+		LOG.info("Called set status " + theStatus + " for items with name: " + itemNames + ". Is message null?: "+(message==null));
 
 		try {
 			String scope = setContexts();
 			DataCatalogueImpl catalogueImpl = CatalogueCMSFactory.getFactory().getCatalogueImplPerScope(scope);
+			CatalogueContentModeratorSystem cmsInstance = catalogueImpl.getCatalogueContentModerator();
 			Map<String, String> errorMapItems = new HashMap<String, String>();
 			List<String> changedStatusListItems = new ArrayList<String>();
 			for (String itemName : itemNames) {
 				try {
 					catalogueImpl.refreshDataset(itemName);
+					LOG.info("refresh dataset done");
 					changedStatusListItems.add(itemName);
+					if(message!=null && !message.isEmpty()) {
+						LOG.debug("Sending message: "+message);
+						cmsInstance.messageItem(itemName, message);
+					}
 				} catch (Exception e) {
 					LOG.warn("Error when setting status (updating) the itemName: " + itemName, e);
 					errorMapItems.put(itemName, e.getMessage());
@@ -500,5 +508,4 @@ public class CkanContentModeratorServiceImpl extends RemoteServiceServlet implem
 		LOG.debug("Returning: " + searchedData);
 		return searchedData;
 	}
-
 }