Merge pull request #12028 from IQSS/11528-display-collection-size-on-add-files-page

Display current collection size on Add Files page

Author: scolapasta

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

@@ -1490,11 +1490,15 @@ public UploadSessionQuotaLimit getUploadSessionQuotaLimit(DvObjectContainer pare
         // Note that we are checking the recorded storage use not on the 
         // immediate parent necessarily, but on the specific ancestor 
         // DvObjectContainer on which the storage quota is defined:
-        Long currentSize = storageUseService.findStorageSizeByDvContainerId(testDvContainer.getId()); 
+        Long currentSize = currentStorageSizeInBytes(testDvContainer);
 
         return new UploadSessionQuotaLimit(quota.getAllocation(), currentSize);
     }
 
+    public Long currentStorageSizeInBytes(DvObjectContainer dvObjectContainer) {
+        return storageUseService.findStorageSizeByDvContainerId(dvObjectContainer.getId());
+    }
+
     public boolean isInReleasedVersion(Long id) {
         Query query = em.createNativeQuery("SELECT fm.id FROM filemetadata fm WHERE fm.datasetversion_id=(SELECT dv.id FROM datasetversion dv, dvobject dvo WHERE dv.dataset_id=dvo.owner_id AND dv.versionState='RELEASED' and dvo.id=" + id + " ORDER BY dv.versionNumber DESC, dv.minorVersionNumber DESC LIMIT 1) AND fm.datafile_id=" + id);
 

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

@@ -35,16 +35,9 @@
 import edu.harvard.iq.dataverse.license.LicenseServiceBean;
 import edu.harvard.iq.dataverse.search.IndexServiceBean;
 import edu.harvard.iq.dataverse.settings.JvmSettings;
-import edu.harvard.iq.dataverse.settings.Setting;
 import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
 import edu.harvard.iq.dataverse.storageuse.UploadSessionQuotaLimit;
-import edu.harvard.iq.dataverse.util.FileUtil;
-import edu.harvard.iq.dataverse.util.JsfHelper;
-import edu.harvard.iq.dataverse.util.SystemConfig;
-import edu.harvard.iq.dataverse.util.WebloaderUtil;
-import edu.harvard.iq.dataverse.util.BundleUtil;
-import edu.harvard.iq.dataverse.util.EjbUtil;
-import edu.harvard.iq.dataverse.util.FileMetadataUtil;
+import edu.harvard.iq.dataverse.util.*;
 
 import static edu.harvard.iq.dataverse.util.JsfHelper.JH;
 import java.io.File;
@@ -188,6 +181,8 @@ public enum Referrer {
 
     private String versionString = "";
 
+    private String storageSizeStr;
+
     private boolean saveEnabled = false;
 
     // Used to store results of permissions checks
@@ -567,6 +562,17 @@ public boolean isFileUploadCountExceeded() {
         return !ignoreLimit && !isFileReplaceOperation() && fileUploadsAvailable != null && fileUploadsAvailable == 0;
     }
 
+    /**
+     *
+     * @return cached formatted storage size. '1,234 bytes'; '1.23 GB'; '1.00 TB'
+     */
+    public String getCurrentContainerStorageUse() {
+        if (storageSizeStr == null) {
+            storageSizeStr = FileSizeChecker.bytesToHumanReadable(datafileService.currentStorageSizeInBytes(dataset.getOwner()));
+        }
+        return storageSizeStr;
+    }
+
     public String init() {
         // default mode should be EDIT
         if (mode == null) {
@@ -1059,6 +1065,7 @@ public String saveReplacementFile() throws FileReplaceException {
 
     public String save() {
 
+        storageSizeStr = null; // Let this re-calculate after the calling save()
         Collection<String> duplicates = IngestUtil.findDuplicateFilenames(workingVersion, newFiles);
         if (!duplicates.isEmpty()) {
             JH.addMessage(FacesMessage.SEVERITY_ERROR, BundleUtil.getStringFromBundle("dataset.message.filesFailure"), BundleUtil.getStringFromBundle("dataset.message.editMetadata.duplicateFilenames", new ArrayList<>(duplicates)));

src/main/java/propertyFiles/Bundle.properties

@@ -1876,6 +1876,7 @@ file.selectToAdd.tipMaxNumFilesUploadsAvailable=Maximum of {0} {0, choice, 0#fil
 file.selectToAdd.tipTabularLimit=<a href="{0}/{1}/user/dataset-management.html#tabular-data-files" title="Tabular Data Files - Dataverse User Guide" target="_blank" rel="noopener">Tabular file ingest</a> is limited to {2}.
 file.selectToAdd.tipPerFileTabularLimit=Ingest is limited to the following file sizes based on their format: {0}.
 file.selectToAdd.tipMoreInformation=Select files or drag and drop into the upload widget.
+file.selectToAdd.tipTotalSizeUsed=Total size of Collection: {0}.
 file.selectToAdd.dragdropMsg=Drag and drop files here.
 file.createUploadDisabled=Upload files using rsync via SSH. This method is recommended for large file transfers. The upload script will be available on the Upload Files page once you save this dataset.
 file.fromHTTP=Upload with HTTP via your browser

src/main/webapp/editFilesFragment.xhtml

@@ -98,6 +98,9 @@
                                         <f:param value="#{systemConfig.guidesBaseUrl}"/>
                                         <f:param value="#{systemConfig.guidesVersion}"/>
                                     </h:outputFormat>
+                                    <h:outputFormat value=" #{bundle['file.selectToAdd.tipTotalSizeUsed']}" escape="false">
+                                        <f:param value="#{EditDatafilesPage.currentContainerStorageUse}"/>
+                                    </h:outputFormat>
                                     <h:outputFormat value=" #{bundle['file.selectToAdd.tipMaxNumFiles']}" escape="false"
                                                     rendered="#{EditDatafilesPage.maxNumberOfFiles > 0}">
                                         <f:param value="#{EditDatafilesPage.maxNumberOfFiles}"/>

src/test/java/edu/harvard/iq/dataverse/util/StringUtilTest.java

@@ -10,6 +10,7 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 
+import edu.harvard.iq.dataverse.datasetutility.FileSizeChecker;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;