PrePublish disclaimer for submit for review

Author: stevenwinship

doc/release-notes/12325-submit-for-review-message.md

@@ -0,0 +1,3 @@
+## Feature
+
+Added Submit for Review dialog disclaimer messages (similar to Publish disclaimer messages). Can be set using setting :PrePublishDatasetDisclaimerText

src/main/java/edu/harvard/iq/dataverse/DatasetPage.java

@@ -6373,6 +6373,7 @@ public void setFileMetadataForAction(FileMetadata fileMetadataForAction) {
     private String termsOfAccess;
     private boolean fileAccessRequest;
     private boolean publishDisclaimerAcknowledged;
+    private boolean prePublishDisclaimerAcknowledged;
 
     public String getTermsOfAccess() {
         return termsOfAccess;
@@ -6398,6 +6399,14 @@ public void setPublishDisclaimerAcknowledged(boolean publishDisclaimerAcknowledg
         this.publishDisclaimerAcknowledged = publishDisclaimerAcknowledged;
     }
 
+    public boolean isPrePublishDisclaimerAcknowledged() {
+        return prePublishDisclaimerAcknowledged || !settingsWrapper.isHasPrePublishDatasetDisclaimerText();
+    }
+
+    public void setPrePublishDisclaimerAcknowledged(boolean prePublishDisclaimerAcknowledged) {
+        this.prePublishDisclaimerAcknowledged = prePublishDisclaimerAcknowledged;
+    }
+
     // wrapper method to see if the file has been deleted (or replaced) in the current version
     public boolean isFileDeleted (DataFile dataFile) {
         if (dataFile.getDeleted() == null) {
@@ -7005,4 +7014,4 @@ public void setRequestedCSL(String requestedCSL) {
     public void validateEmbargoReason(FacesContext context, UIComponent component, Object value) {
         FileUtil.validateEmbargoReason(context, component, value, removeEmbargo);
     }
-}
+}

src/main/java/edu/harvard/iq/dataverse/SettingsWrapper.java

@@ -127,7 +127,9 @@ public class SettingsWrapper implements java.io.Serializable {
     private String metricsUrl = null;
 
     private String publishDatasetDisclaimerText = null;
-    
+
+    private String prePublishDatasetDisclaimerText = null;
+
     private Boolean dataFilePIDSequentialDependent = null;
 
     private Boolean customLicenseAllowed = null;
@@ -885,4 +887,15 @@ public String getPublishDatasetDisclaimerText() {
     public Boolean isHasPublishDatasetDisclaimerText() {
         return !StringUtil.isEmpty(getPublishDatasetDisclaimerText());
     }
+
+    public String getPrePublishDatasetDisclaimerText() {
+        if (prePublishDatasetDisclaimerText == null) {
+            prePublishDatasetDisclaimerText = getValueForKey(Key.PrePublishDatasetDisclaimerText);
+        }
+        return prePublishDatasetDisclaimerText;
+    }
+
+    public Boolean isHasPrePublishDatasetDisclaimerText() {
+        return !StringUtil.isEmpty(getPrePublishDatasetDisclaimerText());
+    }
 }

src/main/java/edu/harvard/iq/dataverse/api/Info.java

@@ -52,6 +52,12 @@ public Response getPublishDatasetDisclaimerText() {
         return getSettingResponseByKey(SettingsServiceBean.Key.PublishDatasetDisclaimerText);
     }
 
+    @GET
+    @Path("settings/:PrePublishDatasetDisclaimerText")
+    public Response getPrePublishDatasetDisclaimerText() {
+        return getSettingResponseByKey(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText);
+    }
+
     @GET
     @Path("settings/:MaxEmbargoDurationInMonths")
     public Response getMaxEmbargoDurationInMonths() {

src/main/java/edu/harvard/iq/dataverse/settings/SettingsServiceBean.java

@@ -330,6 +330,10 @@ <p>Size limit (in bytes) for tabular file ingest. Accepts either a single numeri
          */
         PublishDatasetDisclaimerText,
         /*
+        Submit for review Disclaimer text. If this setting exists user must acknowledge before a Dataset can be submitted for review
+         */
+        PrePublishDatasetDisclaimerText,
+        /*
         Whether Harvesting (OAI) service is enabled
         */
         OAIServerEnabled,

src/main/webapp/dataset.xhtml

@@ -1950,8 +1950,19 @@
                         <c:if test="#{showSubmitForReviewLink}">
                             <ui:include src="datasetLicenseInfoFragment.xhtml"/>
                         </c:if>
+                        <ui:fragment rendered="#{valid and settingsWrapper.isHasPrePublishDatasetDisclaimerText()}">
+                            <div class="form-group">
+                                <p:selectBooleanCheckbox class="text-danger" id="submitForReviewDisclaimer"
+                                                         itemLabel="#{MarkupChecker:sanitizeAdvancedHTML(settingsWrapper.getPrePublishDatasetDisclaimerText())}"
+                                                         escape="false"
+                                                         value="#{DatasetPage.prePublishDisclaimerAcknowledged}">
+                                    <p:ajax event="change" update="submitReviewDatasetButton"/>
+                                </p:selectBooleanCheckbox>
+                            </div>
+                        </ui:fragment>
                         <div class="button-block">
-                            <p:commandButton rendered="#{DatasetPage.validOrCanReviewIncomplete}" styleClass="btn btn-default" value="#{bundle.submit}" 
+                            <p:commandButton id="submitReviewDatasetButton" rendered="#{DatasetPage.validOrCanReviewIncomplete}" styleClass="btn btn-default" value="#{bundle.submit}"
+                                             disabled="#{!DatasetPage.prePublishDisclaimerAcknowledged}"
                                              onclick="PF('inreview').hide();
                                                      PF('blockDatasetForm').hide();" action="#{DatasetPage.submitDataset}" immediate="true"/>
                             <button class="btn btn-link" onclick="PF('inreview').hide();PF('blockDatasetForm').hide();" type="button">

src/test/java/edu/harvard/iq/dataverse/api/InfoIT.java

@@ -26,22 +26,30 @@ public static void setUpClass() {
         UtilIT.deleteSetting(SettingsServiceBean.Key.ApplicationTermsOfUse);
         UtilIT.deleteSetting(SettingsServiceBean.Key.ApplicationTermsOfUse, "fr");
         UtilIT.deleteSetting(SettingsServiceBean.Key.PublishDatasetDisclaimerText);
+        UtilIT.deleteSetting(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText);
     }
 
     @AfterAll
     public static void afterClass() {
         UtilIT.deleteSetting(SettingsServiceBean.Key.MaxEmbargoDurationInMonths);
         UtilIT.deleteSetting(SettingsServiceBean.Key.DatasetPublishPopupCustomText);
         UtilIT.deleteSetting(SettingsServiceBean.Key.PublishDatasetDisclaimerText);
+        UtilIT.deleteSetting(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText);
     }
 
     @Test
     public void testGetDatasetPublishPopupCustomText() {
-        testSettingEndpoint(SettingsServiceBean.Key.DatasetPublishPopupCustomText, "Hello world!");
+        testSettingEndpoint(SettingsServiceBean.Key.DatasetPublishPopupCustomText, "Hello world! DatasetPublishPopupCustomText");
     }
+
     @Test
     public void testGetDatasetPublishDisclaimerText() {
-        testSettingEndpoint(SettingsServiceBean.Key.PublishDatasetDisclaimerText, "Hello world!");
+        testSettingEndpoint(SettingsServiceBean.Key.PublishDatasetDisclaimerText, "Hello world! PublishDatasetDisclaimerText");
+    }
+
+    @Test
+    public void testGetPrePublishDatasetDisclaimerText() {
+        testSettingEndpoint(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText, "Hello world! PrePublishDatasetDisclaimerText");
     }
 
     @Test