Add DatasetPrePublishPopupCustomText

Author: stevenwinship

doc/sphinx-guides/source/api/native-api.rst

@@ -6605,6 +6605,28 @@ The fully expanded example above (without environment variables) looks like this
 
   curl "https://demo.dataverse.org/api/info/settings/:DatasetPublishPopupCustomText"
 
+.. _show-custom-popup-for-pre-publishing-datasets:
+
+Show Custom Popup Text for Pre-Publishing Datasets (Submit for Review)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For now, only the value for the :ref:`:DatasetPrePublishPopupCustomText` setting from the Configuration section of the Installation Guide is exposed:
+
+.. note:: See :ref:`show-disclaimer-for-prepublishing-datasets` if you want the user to acknowledge before submitting for review.
+.. note:: See :ref:`curl-examples-and-environment-variables` if you are unfamiliar with the use of export below.
+
+.. code-block:: bash
+
+  export SERVER_URL=https://demo.dataverse.org
+
+  curl "$SERVER_URL/api/info/settings/:DatasetPrePublishPopupCustomText"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl "https://demo.dataverse.org/api/info/settings/:DatasetPrePublishPopupCustomText"
+
 .. _show-disclaimer-for-publishing-datasets:
 
 Show Disclaimer for Publishing Datasets

doc/sphinx-guides/source/installation/config.rst

@@ -4842,6 +4842,23 @@ Set whether a user will see the custom text when publishing all versions of a da
 
 ``curl -X PUT -d true http://localhost:8080/api/admin/settings/:DatasetPublishPopupCustomTextOnAllVersions``
 
+.. _:DatasetPrePublishPopupCustomText:
+
+:DatasetPrePublishPopupCustomText
++++++++++++++++++++++++++++++++++
+
+Set custom text a user will view when submitting a dataset for review. Note that this text is exposed via the "Info" endpoint of the :doc:`/api/native-api`.
+
+``curl -X PUT -d "Deposit License Requirements" http://localhost:8080/api/admin/settings/:DatasetPrePublishPopupCustomText``
+
+If you have a long text string, you can upload it as a file as in the example below.
+
+``curl -X PUT --upload-file /tmp/long.txt http://localhost:8080/api/admin/settings/:DatasetPrePublishPopupCustomText``
+
+There is a related setting called :ref:`:PrePublishDatasetDisclaimerText` that also makes text appear on the popup when submitting for review, but it requires a checkbox to be clicked.
+
+See also :ref:`show-custom-popup-for-pre-publishing-datasets` in the API Guide.
+
 :SearchHighlightFragmentSize
 ++++++++++++++++++++++++++++
 

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

@@ -4870,6 +4870,18 @@ public Boolean isDatasetPublishPopupCustomTextOnAllVersions(){
         return  settingsWrapper.isTrueForKey(SettingsServiceBean.Key.DatasetPublishPopupCustomTextOnAllVersions, false);
     }
 
+    public boolean isDisplayPrePublishPopupCustomText() {
+        return !getDatasetPrePublishCustomText().isEmpty();
+    }
+
+    public String getDatasetPrePublishCustomText(){
+        String datasetPrePublishCustomText = settingsWrapper.getValueForKey(SettingsServiceBean.Key.DatasetPrePublishPopupCustomText);
+        if (datasetPrePublishCustomText != null && !datasetPrePublishCustomText.isEmpty()) {
+            return datasetPrePublishCustomText;
+        }
+        return "";
+    }
+
     public String getVariableMetadataURL(Long fileid) {
         String myHostURL = getDataverseSiteUrl();
         String metaURL = myHostURL + "/api/meta/datafile/" + fileid;

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

@@ -46,6 +46,12 @@ public Response getDatasetPublishPopupCustomText() {
         return getSettingResponseByKey(SettingsServiceBean.Key.DatasetPublishPopupCustomText);
     }
 
+    @GET
+    @Path("settings/:DatasetPrePublishPopupCustomText")
+    public Response DatasetPrePublishPopupCustomText() {
+        return getSettingResponseByKey(SettingsServiceBean.Key.DatasetPrePublishPopupCustomText);
+    }
+
     @GET
     @Path("settings/:PublishDatasetDisclaimerText")
     public Response getPublishDatasetDisclaimerText() {

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

@@ -325,6 +325,10 @@ <p>Size limit (in bytes) for tabular file ingest. Accepts either a single numeri
         Whether to display the publish text for every published version
         */
         DatasetPublishPopupCustomTextOnAllVersions,
+        /**
+         The message added to a popup upon dataset submit for review
+         */
+        DatasetPrePublishPopupCustomText,
         /*
         Publish Disclaimer text. If this setting exists user must acknowledge before a Dataset can be published
          */

src/main/webapp/dataset.xhtml

@@ -1947,6 +1947,9 @@
                         <p jsf:rendered="#{!valid}" class="text-warning">
                             <span class="glyphicon glyphicon-warning-sign"/><b style="color:red;"> #{bundle['dataset.message.incomplete.warning']}</b>
                         </p>
+                        <div class="well terms-agreement-block" jsf:rendered="#{DatasetPage.displayPrePublishPopupCustomText}">
+                            <h:outputText value="#{DatasetPage.datasetPrePublishCustomText}" escape="false"/>
+                        </div>
                         <c:if test="#{showSubmitForReviewLink}">
                             <ui:include src="datasetLicenseInfoFragment.xhtml"/>
                         </c:if>

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

@@ -26,6 +26,7 @@ public static void setUpClass() {
         UtilIT.deleteSetting(SettingsServiceBean.Key.ApplicationTermsOfUse);
         UtilIT.deleteSetting(SettingsServiceBean.Key.ApplicationTermsOfUse, "fr");
         UtilIT.deleteSetting(SettingsServiceBean.Key.PublishDatasetDisclaimerText);
+        UtilIT.deleteSetting(SettingsServiceBean.Key.DatasetPrePublishPopupCustomText);
         UtilIT.deleteSetting(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText);
     }
 
@@ -34,6 +35,7 @@ public static void afterClass() {
         UtilIT.deleteSetting(SettingsServiceBean.Key.MaxEmbargoDurationInMonths);
         UtilIT.deleteSetting(SettingsServiceBean.Key.DatasetPublishPopupCustomText);
         UtilIT.deleteSetting(SettingsServiceBean.Key.PublishDatasetDisclaimerText);
+        UtilIT.deleteSetting(SettingsServiceBean.Key.DatasetPrePublishPopupCustomText);
         UtilIT.deleteSetting(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText);
     }
 
@@ -52,6 +54,11 @@ public void testGetPrePublishDatasetDisclaimerText() {
         testSettingEndpoint(SettingsServiceBean.Key.PrePublishDatasetDisclaimerText, "Hello world! PrePublishDatasetDisclaimerText");
     }
 
+    @Test
+    public void testGetDatasetPrePublishPopupCustomText() {
+        testSettingEndpoint(SettingsServiceBean.Key.DatasetPrePublishPopupCustomText, "Hello world! DatasetPrePublishPopupCustomText");
+    }
+
     @Test
     public void testGetMaxEmbargoDurationInMonths() {
         testSettingEndpoint(SettingsServiceBean.Key.MaxEmbargoDurationInMonths, "12");