From cd16df271cd0275ffa9ec93e10d385442d3963f2 Mon Sep 17 00:00:00 2001
From: Stephen Kraffmiller <skraffmiller@hmdc.harvard.edu>
Date: Wed, 1 Nov 2017 10:15:49 -0400
Subject: [PATCH] #4139 Allow author to download files while in review and
 other minor changes

---
 src/main/java/Bundle.properties               |  2 ++
 .../edu/harvard/iq/dataverse/DatasetPage.java | 11 ++++++
 .../edu/harvard/iq/dataverse/FilePage.java    | 13 +++++++
 .../iq/dataverse/PermissionServiceBean.java   | 23 ++++++++++++
 .../file-download-button-fragment.xhtml       | 36 +++++++++++++------
 src/main/webapp/file.xhtml                    |  2 ++
 src/main/webapp/filesFragment.xhtml           | 11 +++---
 7 files changed, 82 insertions(+), 16 deletions(-)

diff --git a/src/main/java/Bundle.properties b/src/main/java/Bundle.properties
index 18c82c4f37a..a4e3fa63c58 100755
--- a/src/main/java/Bundle.properties
+++ b/src/main/java/Bundle.properties
@@ -1185,6 +1185,8 @@ dataset.message.uploadFiles=Upload Dataset Files - You can drag and drop files f
 dataset.message.editMetadata=Edit Dataset Metadata - Add more metadata about this dataset to help others easily find it.
 dataset.message.editTerms=Edit Dataset Terms - Update this dataset's terms of use.
 dataset.message.locked.editNotAllowedInReview=Dataset cannot be edited due to In Review dataset lock.
+dataset.message.locked.downloadNotAllowedInReview=Dataset file(s) may not be downloaded due to In Review dataset lock.
+dataset.message.locked.downloadNotAllowed=Dataset file(s) may not be downloaded due to dataset lock.
 dataset.message.locked.editNotAllowed=Dataset cannot be edited due to dataset lock.
 dataset.message.createSuccess=This dataset has been created.
 dataset.message.linkSuccess= {0} has been successfully linked to {1}.
diff --git a/src/main/java/edu/harvard/iq/dataverse/DatasetPage.java b/src/main/java/edu/harvard/iq/dataverse/DatasetPage.java
index dcc224bbf8c..17e9a5abb0c 100644
--- a/src/main/java/edu/harvard/iq/dataverse/DatasetPage.java
+++ b/src/main/java/edu/harvard/iq/dataverse/DatasetPage.java
@@ -2676,6 +2676,17 @@ public boolean isLockedFromEdits() {
         }
         return false;
     }
+    
+    public boolean isLockedFromDownload(){
+        
+        try {
+            permissionService.checkDownloadFileLock(dataset, dvRequestService.getDataverseRequest(), new CreateDatasetCommand(dataset, dvRequestService.getDataverseRequest()));
+        } catch (IllegalCommandException ex) {
+            return true;
+        }
+        return false;
+        
+    }
 
     public void setLocked(boolean locked) {
         // empty method, so that we can use DatasetPage.locked in a hidden 
diff --git a/src/main/java/edu/harvard/iq/dataverse/FilePage.java b/src/main/java/edu/harvard/iq/dataverse/FilePage.java
index fb1cb5207c8..1c902d33f92 100644
--- a/src/main/java/edu/harvard/iq/dataverse/FilePage.java
+++ b/src/main/java/edu/harvard/iq/dataverse/FilePage.java
@@ -15,6 +15,7 @@
 import edu.harvard.iq.dataverse.engine.command.Command;
 import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
 import edu.harvard.iq.dataverse.engine.command.exception.IllegalCommandException;
+import edu.harvard.iq.dataverse.engine.command.impl.CreateDatasetCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.RestrictFileCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.UpdateDatasetCommand;
 import edu.harvard.iq.dataverse.export.ExportException;
@@ -708,6 +709,18 @@ public boolean isLockedFromEdits() {
         }
         return false;
     }
+    
+    public boolean isLockedFromDownload(){
+        Dataset testDataset = fileMetadata.getDataFile().getOwner();
+        try {
+            permissionService.checkDownloadFileLock(testDataset, dvRequestService.getDataverseRequest(), new CreateDatasetCommand(testDataset, dvRequestService.getDataverseRequest()));
+        } catch (IllegalCommandException ex) {
+            return true;
+        }
+        System.out.print("returning false from is locked from Download....");
+        return false;
+        
+    }
 
     public String getPublicDownloadUrl() {
             try {
diff --git a/src/main/java/edu/harvard/iq/dataverse/PermissionServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/PermissionServiceBean.java
index 6431b16488a..3a00be24b78 100644
--- a/src/main/java/edu/harvard/iq/dataverse/PermissionServiceBean.java
+++ b/src/main/java/edu/harvard/iq/dataverse/PermissionServiceBean.java
@@ -27,6 +27,7 @@
 import static edu.harvard.iq.dataverse.engine.command.CommandHelper.CH;
 import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
 import edu.harvard.iq.dataverse.engine.command.exception.IllegalCommandException;
+import edu.harvard.iq.dataverse.engine.command.impl.CreateDatasetCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.PublishDatasetCommand;
 import edu.harvard.iq.dataverse.util.BundleUtil;
 import java.util.Arrays;
@@ -563,5 +564,27 @@ public void checkEditDatasetLock(Dataset dataset, DataverseRequest dataverseRequ
             }
         }
     }
+    
+    public void checkDownloadFileLock(Dataset dataset, DataverseRequest dataverseRequest, Command command) throws IllegalCommandException {
+        if (dataset.isLocked()) {
+            if (dataset.isLockedFor(DatasetLock.Reason.InReview)) {
+                // The "InReview" lock is not really a lock for curators or contributors. They can still download.
+                if (!isUserAllowedOn(dataverseRequest.getUser(), new CreateDatasetCommand(dataset, dataverseRequest, true), dataset)) {
+                    throw new IllegalCommandException(BundleUtil.getStringFromBundle("dataset.message.locked.downloadNotAllowedInReview"), command);
+                }
+            }
+            if (dataset.isLockedFor(DatasetLock.Reason.Ingest)) {
+                throw new IllegalCommandException(BundleUtil.getStringFromBundle("dataset.message.locked.downloadNotAllowed"), command);
+            }
+            // TODO: Do we need to check for "Workflow"? Should the message be more specific?
+            if (dataset.isLockedFor(DatasetLock.Reason.Workflow)) {
+                throw new IllegalCommandException(BundleUtil.getStringFromBundle("dataset.message.locked.downloadNotAllowed"), command);
+            }
+            // TODO: Do we need to check for "DcmUpload"? Should the message be more specific?
+            if (dataset.isLockedFor(DatasetLock.Reason.DcmUpload)) {
+                throw new IllegalCommandException(BundleUtil.getStringFromBundle("dataset.message.locked.downloadNotAllowed"), command);
+            }
+        }
+    }
 
 }
diff --git a/src/main/webapp/file-download-button-fragment.xhtml b/src/main/webapp/file-download-button-fragment.xhtml
index db760786aab..072cb82a603 100644
--- a/src/main/webapp/file-download-button-fragment.xhtml
+++ b/src/main/webapp/file-download-button-fragment.xhtml
@@ -56,12 +56,13 @@
             <li><!-- Two Ravens -->
                 <h:commandLink rendered="#{!downloadPopupRequired}"
                                styleClass="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
-                               disabled="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress or lockedFromDownload) ? 'disabled' : ''}"
                                action="#{fileDownloadService.startExploreDownloadLink(guestbookResponse, fileMetadata )}" target="_blank">
                     #{bundle['file.explore.twoRavens']} 
                 </h:commandLink>
                 <p:commandLink rendered="#{downloadPopupRequired}"                                            
                                action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'explore' )}"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress or lockedFromDownload) ? 'disabled' : ''}"
                                process="@this"
                                update="@widgetVar(downloadPopup)"
                                oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
@@ -70,14 +71,15 @@
             </li>
             <li><!-- WorldMap Explore -->
                 <h:commandLink rendered="#{!downloadPopupRequired}"
-                               styleClass="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
-                               disabled="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
+                               styleClass="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}"
+                               
                                action="#{fileDownloadService.startWorldMapDownloadLink(guestbookResponse, fileMetadata )}" target="_blank">
                     #{bundle['file.mapData.worldMap']}
                 </h:commandLink>
                 <p:commandLink rendered="#{downloadPopupRequired}"
-                               styleClass="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
-                               disabled="#{fileMetadata.dataFile.ingestInProgress}"
+                               styleClass="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}"
+                               disabled="#{fileMetadata.dataFile.ingestInProgress  or lockedFromDownload}"
                                process="@this"
                                action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'worldMap' )}"
                                update="@widgetVar(downloadPopup)"
@@ -93,7 +95,7 @@
         <h:commandLink rendered="#{!downloadPopupRequired}"
                        type="button" 
                        styleClass="btn btn-default #{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
-                       disabled="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}"
+                       disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}"
                        action="#{fileDownloadService.startExploreDownloadLink( guestbookResponse, fileMetadata )}" target="_blank">
             <span class="glyphicon glyphicon-equalizer"/> <span class="ladda-label">#{bundle.explore}</span>
         </h:commandLink>
@@ -102,7 +104,7 @@
                        process="@this"
                        action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'explore' )}"
                        update="@widgetVar(downloadPopup)"
-                       disabled="#{fileMetadata.dataFile.ingestInProgress}"
+                       disabled="#{fileMetadata.dataFile.ingestInProgress  or lockedFromDownload}"
                        oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
             <span class="glyphicon glyphicon-equalizer"/> #{bundle.explore}
         </p:commandLink>
@@ -113,7 +115,7 @@
         <h:commandLink pt:role="button" rendered="#{!downloadPopupRequired}"
                        type="button" 
                        styleClass="btn btn-default #{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}" 
-                       disabled="#{(fileMetadata.dataFile.ingestInProgress) ? 'disabled' : ''}" 
+                       disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                        title="Explore" action="#{fileDownloadService.startWorldMapDownloadLink(guestbookResponse, fileMetadata )}" target="_blank">
             <span class="glyphicon glyphicon-equalizer"/> #{bundle.explore}
         </h:commandLink>
@@ -122,7 +124,7 @@
                        process="@this"
                        action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'worldMap' )}"
                        update="@widgetVar(downloadPopup)"
-                       disabled="#{fileMetadata.dataFile.ingestInProgress}"
+                       disabled="#{fileMetadata.dataFile.ingestInProgress  or lockedFromDownload}"
                        oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
             <span class="glyphicon glyphicon-equalizer"/> #{bundle.explore}
         </p:commandLink>
@@ -140,6 +142,7 @@
     <p:commandLink rendered="#{ fileDownloadHelper.canDownloadFile(fileMetadata) and !(fileMetadata.dataFile.tabularData) and !(downloadPopupRequired) }"
                    type="button" styleClass="btn btn-default"
                    process="@this"
+                   disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                    actionListener="#{fileDownloadService.startFileDownload(guestbookResponse, fileMetadata, 'Download')}">
         <!-- non-tabular data file: -->
         <!-- no guest book/terms of use/etc. - straight to the download API url: -->
@@ -149,6 +152,7 @@
     <p:commandLink rendered="#{ fileDownloadHelper.canDownloadFile(fileMetadata) and !(fileMetadata.dataFile.tabularData) and downloadPopupRequired }"
                    type="button" styleClass="btn btn-default"
                    process="@this"
+                   disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                    action="#{guestbookResponseService.modifyDatafile(guestbookResponse, fileMetadata)}"
                    update="@widgetVar(downloadPopup)" oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
         <!-- guest book or terms of use, etc. enabled - open "download popup" first: -->
@@ -181,6 +185,7 @@
             <li>
                 <p:commandLink rendered="#{!downloadPopupRequired}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                actionListener="#{fileDownloadService.startFileDownload(guestbookResponse, fileMetadata, 'original')}">
                     <h:outputFormat value="#{bundle['file.downloadBtn.format.original']}">
                         <f:param value="#{fileMetadata.dataFile.originalFormatLabel}"/>
@@ -188,6 +193,7 @@
                 </p:commandLink>
                 <p:commandLink rendered="#{downloadPopupRequired}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'original' )}"
                                update="@widgetVar(downloadPopup)"
                                oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
@@ -199,11 +205,13 @@
             <li>
                 <p:commandLink rendered="#{!downloadPopupRequired}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                actionListener="#{fileDownloadService.startFileDownload(guestbookResponse, fileMetadata, 'tab')}">
                     #{bundle['file.downloadBtn.format.tab']}
                 </p:commandLink>
                 <p:commandLink rendered="#{downloadPopupRequired}"
                                action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'tab' )}"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                update="@widgetVar(downloadPopup)"
                                oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
                     #{bundle['file.downloadBtn.format.tab']}
@@ -213,11 +221,13 @@
                 <li>
                     <p:commandLink rendered="#{!downloadPopupRequired}"
                                    process="@this"
+                                   disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                    actionListener="#{fileDownloadService.startFileDownload(guestbookResponse, fileMetadata, 'RData')}">
                         #{bundle['file.downloadBtn.format.rdata']}
                     </p:commandLink>
                     <p:commandLink rendered="#{downloadPopupRequired}"
                                    process="@this"
+                                   disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                    action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'RData' )}"
                                    update="@widgetVar(downloadPopup)"
                                    oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
@@ -228,11 +238,13 @@
             <li>
                 <p:commandLink rendered="#{!downloadPopupRequired}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                actionListener="#{fileDownloadService.startFileDownload(guestbookResponse, fileMetadata, 'var')}">
                     #{bundle['file.downloadBtn.format.var']}
                 </p:commandLink>
                 <p:commandLink rendered="#{downloadPopupRequired}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload) ? 'disabled' : ''}" 
                                action="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse, fileMetadata, 'var' )}"
                                update="@widgetVar(downloadPopup)"
                                oncomplete="PF('downloadPopup').show();handleResizeDialog('downloadPopup');">
@@ -242,18 +254,20 @@
             <li>
                 <p:commandLink id="fileDowloadDataSubsetButton" rendered="#{!(downloadPopupRequired)}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload or empty fileMetadata.dataFile.id) ? 'disabled' : ''}" 
                                actionListener="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse,fileMetadata, 'subset')}"
                                update="@widgetVar(downloadDataSubsetPopup)"
                                oncomplete="PF('downloadDataSubsetPopup').show()"
                                value="Data Subset"
-                               disabled="#{empty fileMetadata.dataFile.id}"/>
+                               />
                 <p:commandLink id="fileDowloadDataSubsetButtonPopupReq" rendered="#{downloadPopupRequired}"
                                process="@this"
+                               disabled="#{(fileMetadata.dataFile.ingestInProgress  or lockedFromDownload or empty fileMetadata.dataFile.id) ? 'disabled' : ''}" 
                                actionListener="#{guestbookResponseService.modifyDatafileAndFormat(guestbookResponse,fileMetadata, 'subset')}"
                                update="@widgetVar(downloadPopup)"
                                oncomplete="PF('downloadPopup').show()"
                                value="Data Subset"
-                               disabled="#{empty fileMetadata.dataFile.id}"/>
+                               />
             </li>
             <li class="dropdown-submenu pull-left">
                 <a tabindex="-1" href="javascript:void(0);">#{bundle['file.downloadBtn.format.citation']}</a>
diff --git a/src/main/webapp/file.xhtml b/src/main/webapp/file.xhtml
index d20f7c522b6..bc5897064e9 100644
--- a/src/main/webapp/file.xhtml
+++ b/src/main/webapp/file.xhtml
@@ -157,6 +157,7 @@
                                         <ui:param name="guestbookResponseService" value="#{FilePage.guestbookResponseService}"/>
                                         <ui:param name="fileDownloadService" value="#{FilePage.fileDownloadService}"/>
                                         <ui:param name="isFilePg" value="true"/>
+                                        <ui:param name="lockedFromDownload" value="#{FilePage.lockedFromDownload}"/>
                                     </ui:include>
                                 </div>
                                 <!-- END: Explore/Download/Request Button Block -->
@@ -444,6 +445,7 @@
                             <ui:param name="guestbookResponseService" value="#{FilePage.guestbookResponseService}"/>
                             <ui:param name="fileDownloadService" value="#{FilePage.fileDownloadService}"/>
                             <ui:param name="twoRavensHelper" value="#{FilePage.twoRavensHelper}"/>
+                            <ui:param name="lockedFromDownload" value="#{FilePage.lockedFromDownload}"/>
                         </ui:include>
                     </p:dialog>
                     <p:dialog id="downloadDataSubsetPopup" styleClass="smallPopUp" header="#{bundle['file.download.subset.header']}" widgetVar="downloadDataSubsetPopup"
diff --git a/src/main/webapp/filesFragment.xhtml b/src/main/webapp/filesFragment.xhtml
index fa41ad5653a..f4c733859e2 100644
--- a/src/main/webapp/filesFragment.xhtml
+++ b/src/main/webapp/filesFragment.xhtml
@@ -282,31 +282,31 @@
                         <span class="glyphicon glyphicon-pencil"/> #{bundle['file.editFiles']} <span class="caret"></span>
                     </button>
                     <ul class="dropdown-menu multi-level pull-right text-left" role="menu">
-                        <li class="#{DatasetPage.locked ? 'disabled' : ''}">
+                        <li class="#{DatasetPage.lockedFromEdits ? 'disabled' : ''}">
                             <p:commandLink onclick="testFilesSelectedForDelete();" id="deleteSelectedFile"> 
                                 <h:outputText value="#{bundle['file.delete']}"/> 
                             </p:commandLink>
                         </li>
-                        <li class="#{DatasetPage.locked ? 'disabled' : ''}">
+                        <li class="#{DatasetPage.lockedFromEdits ? 'disabled' : ''}">
                             <p:commandLink onclick="testFilesSelectedForEditMetadata();" id="editMetadataSelectedFile" action="#{DatasetPage.editFileMetadata()}">                                         
                                 <h:outputText value="#{bundle['file.metadata']}"/>
                             </p:commandLink>
                         </li>
                         <ui:fragment rendered="#{!settingsWrapper.publicInstall}">
-                            <li class="#{DatasetPage.locked  ? 'disabled' : ''}">
+                            <li class="#{DatasetPage.lockedFromEdits  ? 'disabled' : ''}">
                                 <p:commandLink oncomplete="toggle_dropdown();" 
                                                onclick="testFilesSelectedForRestriction()">
                                     <h:outputText value="#{bundle['file.restrict']}"/>
                                 </p:commandLink>
                             </li>
-                            <li class="#{DatasetPage.locked  ? 'disabled' : ''}">
+                            <li class="#{DatasetPage.lockedFromEdits  ? 'disabled' : ''}">
                                 <p:commandLink update=":datasetForm,,:messagePanel" oncomplete="toggle_dropdown();" 
                                                action="#{DatasetPage.restrictSelectedFiles(false)}">
                                     <h:outputText value="#{bundle['file.unrestrict']}"/>
                                 </p:commandLink>
                             </li>
                         </ui:fragment>
-                        <li class="#{DatasetPage.locked  ? 'disabled' : ''}">
+                        <li class="#{DatasetPage.lockedFromEdits  ? 'disabled' : ''}">
                             <p:commandLink id="fileCategoriesLinkTwo"    
                                            onclick="testFilesSelectedForTags()">
                                         #{bundle['file.tags']} 
@@ -371,6 +371,7 @@
                     <ui:param name="guestbookResponse" value="#{DatasetPage.guestbookResponse}"/>
                     <ui:param name="guestbookResponseService" value="#{DatasetPage.guestbookResponseService}"/>
                     <ui:param name="fileDownloadService" value="#{DatasetPage.fileDownloadService}"/>
+                    <ui:param name="lockedFromDownload" value="#{DatasetPage.lockedFromDownload}"/>
                 </ui:include>
             </div>