Limiting Upload File Size - Revision history

Drn@ecs.soton.ac.uk: Fixed alert message for 4 again.

2023-01-23T10:18:35Z

Fixed alert message for 4 again.

Drn@ecs.soton.ac.uk: Updated JavaScript to print phrase

2023-01-23T09:46:13Z

Updated JavaScript to print phrase

Drn@ecs.soton.ac.uk: Updated instructions

2023-01-20T17:50:50Z

Updated instructions

Drn@ecs.soton.ac.uk: escapes HTML markup for phrase.

2023-01-20T16:38:10Z

escapes HTML markup for phrase.

Drn@ecs.soton.ac.uk: Added howto for limiting file upload

2023-01-20T09:32:13Z

Added howto for limiting file upload

New page

There are various things that may affect the maximum size of file you can upload to EPrints. One of the most common is Apache's [https://httpd.apache.org/docs/2.4/mod/core.html#limitrequestbody LimitRequestBody] which by default limits the maximum file upload to 1 GiB. However, when uploading a file larger than 1 GiB with EPrints file uploader (i.e. on the Upload stage of the eprint workflow) rather than telling you this is not possible, it just sits there any never uploads the file.

For both the reason above and that more generally you may want to stop users from uploading excessively large files, you may want to restrict the maximum file size that the EPrints file uploader will permit for upload and warn users if files are too large to upload rather than leaving them wondering what went wrong. This can be done by copy [[88_uploadmethod_file.js]] to you archive's ''cfg/static/javascript/auto/'' (creating such a directory if it does not already exist) and editing it as follows:

1. At the start of the file add the line, which sets ''max_size'' to 1 GiB (you can set this higher or lower if you want):
max_size = 1*1024*1024*1024; //max file size allowed in bytes.

2. Around the two occurences of <code>this.createFile (files[i]);</code> at an if statement to change it to the following:
if (this.checkFilesize(files[i]))
{
this.createFile (files[i]);
}

3. After the line <code></code> add the following if block:
if (json.size > max_size)
{
UploadMethod_cancel(uuid);
eprints.currentRepository().phrase( {'Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big':{} },function(phrase){ alert (phrase["Plugin/Screen/EPrint/UploadMethod/File
}

After these changes you will now need to add a phrase to warn the user when the file is to large. You can add this to either an existing or by creating you own new phrases file in your archive's ''cfg/lang/en/phrases/'' directory.
<epp:phrase id="Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big">The file size exceeds the limit allowed and cannot be uploaded.</epp:phrase>

[[Category:Howto]]

@@ Line 30: / Line 30: @@
+  {
       UploadMethod_cancel(uuid);
-      eprints.currentRepository().phrase( {'Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big':{} },function(phrase){ alert (file.name+": \n"+ phrase["Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big"]);  } ) ;
+     eprints.currentRepository().phrase( {'Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big':{} },function(phrase){ alert (phrase["Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big"]);  } ) ;
+  }

@@ Line 6: / Line 6: @@
   max_size = 1*1024*1024*1024; //max file size allowed in bytes.
-. Around the two occurences of <code>this.createFile (files[i]);</code> at an if statement to change it to the following:
+. Around the two occurrences of <code>this.createFile (files[i]);</code> at an if statement to change it to the following:
   if (this.checkFilesize(files[i]))
+  {
@@ Line 12: / Line 12: @@
+  }
-. After the line <code></code> add the following if block:
+. After the <code>handleFiles</code> function block, add another function called <code>checkFilesize</code> with the following code:
   if (json.size > max_size)
+  {

@@ Line 20: / Line 20: @@
 After these changes you will now need to add a phrase to warn the user when the file is to large.  You can add this to either an existing or by creating you own new phrases file in your archive's ''cfg/lang/en/phrases/'' directory.
-  <epp:phrase id="Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big">The file size exceeds the limit allowed and cannot be uploaded.</epp:phrase>
+  &lt;epp:phrase id="Plugin/Screen/EPrint/UploadMethod/File:filesize_too_big"&gt;The file size exceeds the limit allowed and cannot be uploaded.&lt;/epp:phrase&gt;
 [[Category:Howto]]