ENH: refs #446. Client side validation for upload quota on revision upload

Author: zachmullen

core/controllers/UploadController.php

@@ -167,6 +167,8 @@ public function revisionAction()
     $this->view->item = $item;
     $itemRevision = $this->Item->getLastRevision($item);
     $this->view->lastrevision = $itemRevision;
+    $this->view->extraHtml = Zend_Registry::get('notifier')->callback(
+      'CALLBACK_CORE_GET_REVISIONUPLOAD_EXTRA_HTML', array('item' => $item));
     }//end revisionAction
 
 

core/public/css/upload/upload.revision.css

@@ -15,6 +15,24 @@ width:94%!important;
 
 }
 
+div.uploadValidationError{
+  display:none;
+}
+
+div.uploadValidationError img{
+  position: relative;
+  top: 3px;
+}
+
+div.tooBigUpload{
+  display:none;
+}
+
+div.tooBigUpload img{
+  position: relative;
+  top: 3px;
+}
+
 /* -- Form Styles ------------------------------- */
 #swfuploadContent form {
 	margin: 0;

core/public/js/upload/upload.revision.js

@@ -25,6 +25,18 @@ midas.upload.revision.initJqueryFileupload = function()
   //see http://aquantum-demo.appspot.com/file-upload
   $('.file_upload:visible').fileUploadUIX({
     beforeSend: function (event, files, index, xhr, handler, callBack) {
+      if(index == 0) //only do this once since we have all the files every time
+        {
+        var retVal = midas.doCallback('CALLBACK_CORE_VALIDATE_UPLOAD', {files: files, revision: true});
+        $.each(retVal, function(module, resp) {
+          if(resp.status === false)
+            {
+            $('div.uploadValidationError b').html(resp.message);
+            $('div.uploadValidationError').show();
+            }
+          });
+        }
+
       handler.uploadRow.find('.file_upload_start').click(function () {
         handler.formData = {
           parent: $('#destinationId').val(),
@@ -162,3 +174,6 @@ $('#browseMIDASLink').click(function() {
   loadDialog("select", "/browse/movecopy/?selectElement=true");
   showDialog('Browse');
   });
+
+midas.doCallback('CALLBACK_CORE_REVISIONUPLOAD_LOADED');
+

core/views/upload/revision.phtml

@@ -78,6 +78,15 @@ PURPOSE.  See the above copyright notices for more information.
         <div class="file_upload_overall_progress" style='display:none;'><div style="display:none;"></div></div>
       </div>
     </div>
+    <div class="belowDestinationUpload"></div>
+    <div class="uploadValidationError"><img src="<?php echo $this->coreWebroot ?>/public/images/icons/close.png" alt=""/><b></b><hr></div>
+    <div class="tooBigUpload">
+      <img src="<?php echo $this->coreWebroot ?>/public/images/icons/close.png" alt=""/> <b><?php echo $this->t('Please use the large file tool, the following files are too big:')?></b>
+      <ul>
+
+      </ul>
+    </div>
+    <br />
     <b><?php echo $this->t('Step 2: Select a license')?></b>
     <div>
       <?php
@@ -112,6 +121,9 @@ PURPOSE.  See the above copyright notices for more information.
 <input type="hidden" class="uploadedSimple" value="0"/>
 <input type="hidden" class="uploadedJava" value="0"/>
 <input type="hidden" class="uploadedLinks" value="0"/>
-
-
-
+<?php
+foreach($this->extraHtml as $module => $extra)
+  {
+  echo $extra."\n";
+  }
+?>

modules/sizequota/Notification.php

@@ -32,8 +32,9 @@ public function init()
     $this->addCallBack('CALLBACK_CORE_GET_COMMUNITY_MANAGE_TABS', 'getCommunityTab');
     $this->addCallBack('CALLBACK_CORE_GET_USER_TABS', 'getUserTab');
     $this->addCallBack('CALLBACK_CORE_GET_FOOTER_LAYOUT', 'getScript');
-    $this->addCallBack('CALLBACK_CORE_GET_SIMPLEUPLOAD_EXTRA_HTML', 'getExtraHtml');
-    $this->addCallBack('CALLBACK_CORE_GET_JAVAUPLOAD_EXTRA_HTML', 'getExtraHtml');
+    $this->addCallBack('CALLBACK_CORE_GET_SIMPLEUPLOAD_EXTRA_HTML', 'getExtraHtmlSimple');
+    $this->addCallBack('CALLBACK_CORE_GET_JAVAUPLOAD_EXTRA_HTML', 'getExtraHtmlSimple');
+    $this->addCallBack('CALLBACK_CORE_GET_REVISIONUPLOAD_EXTRA_HTML', 'getExtraHtmlRevision');
     $this->addCallBack('CALLBACK_CORE_VALIDATE_UPLOAD', 'validateUpload');
 
     $this->enableWebAPI($this->moduleName);
@@ -72,8 +73,11 @@ public function getScript()
     return '<script type="text/javascript" src="'.$modulePublicWebroot.'/public/js/common/common.notify.js"></script>';
     }
 
-  /** Add free space information to the dom on the simple upload page */
-  public function getExtraHtml($args)
+  /**
+   * Add free space information to the dom on the simple upload & java upload pages
+   * @param folder The folder dao that you are uploading into
+   */
+  public function getExtraHtmlSimple($args)
     {
     $modelLoader = new MIDAS_ModelLoader();
     $folderModel = $modelLoader->loadModel('Folder');
@@ -97,6 +101,44 @@ public function getExtraHtml($args)
       }
     }
 
+  /**
+   * Add free space information to the dom on the revision uploader page
+   * @param item The item dao that you are uploading a new revision into
+   */
+  public function getExtraHtmlRevision($args)
+    {
+    $modelLoader = new MIDAS_ModelLoader();
+    $folderModel = $modelLoader->loadModel('Folder');
+    $folderQuotaModel = $modelLoader->loadModel('FolderQuota', $this->moduleName);
+
+    $item = $args['item'];
+    $folders = $item->getFolders();
+    if(count($folders) == 0)
+      {
+      //don't allow any more uploading into an orphaned item
+      return '<div id="sizequotaFreeSpace" style="display:none;">0</div>'.
+             '<div id="sizequotaHFreeSpace" style="display:none;">'.$this->t('None').'</div>';
+      }
+    else
+      {
+      $rootFolder = $folderModel->getRoot($folders[0]);
+      $quota = $folderQuotaModel->getFolderQuota($rootFolder);
+      if($quota == '')
+        {
+        return '<div id="sizequotaFreeSpace" style="display:none;"></div>'.
+               '<div id="sizequotaHFreeSpace" style="display:none;">'.$this->t('Unlimited').'</div>';
+        }
+      else
+        {
+        $used = $folderModel->getSize($rootFolder);
+        $freeSpace = number_format($quota - $used, 0, '.', '');
+        $hFreeSpace = UtilityComponent::formatSize($quota - $used);
+        return '<div id="sizequotaFreeSpace" style="display:none;">'.$freeSpace.'</div>'.
+               '<div id="sizequotaHFreeSpace" style="display:none;">'.$hFreeSpace.'</div>';
+        }
+      }
+    }
+
   /**
    * Return whether or not the upload is allowed.  If uploading the file
    * will cause the size to surpass the quota, it will be rejected.

modules/sizequota/public/js/common/common.notify.js

@@ -15,10 +15,22 @@ midas.sizequota.validateUpload = function(args)
 
   if(freeSpace != '' && midas.sizequota.totalSize > parseInt(freeSpace))
     {
-    return {
-      status: false,
-      message: 'Uploading these files would exceed the maximum quota for the selected folder.  Please choose a different folder or remove some of the files.'
-      };
+    if(args.revision)
+      {
+      return {
+        status: false,
+        message: 'Uploading these files would exceed the maximum quota for the parent folder. '
+                + 'Please remove some of the files.'
+        };
+      }
+    else
+      {
+      return {
+        status: false,
+        message: 'Uploading these files would exceed the maximum quota for the selected folder. '
+                + 'Please choose a different folder or remove some of the files.'
+        };
+      }
     }
   else
     {
@@ -98,4 +110,5 @@ midas.registerCallback('CALLBACK_CORE_RESET_UPLOAD_TOTAL', 'sizequota', midas.si
 midas.registerCallback('CALLBACK_CORE_UPLOAD_FOLDER_CHANGED', 'sizequota', midas.sizequota.folderChanged);
 midas.registerCallback('CALLBACK_CORE_SIMPLEUPLOAD_LOADED', 'sizequota', midas.sizequota.onPageLoad);
 midas.registerCallback('CALLBACK_CORE_JAVAUPLOAD_LOADED', 'sizequota', midas.sizequota.onPageLoad);
+midas.registerCallback('CALLBACK_CORE_REVISIONUPLOAD_LOADED', 'sizequota', midas.sizequota.updateFreeSpaceMessage);