[FIX] Memory Limit Issue with large files to upload (opencast-ilias#221)

* [FIX] Memory Limit Issue with large files to upload * [FIX] Show WaitOverlay on Form-Submit * Updated Changelog
srsolutionsag · Nov 21, 2023 · b67a7c6 · b67a7c6
1 parent 20b22ab
commit b67a7c6
Show file tree

Hide file tree

Showing 25 changed files with 231 additions and 220 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change Log
 
+## [5.3.2]
+- Fix #220: Upload of large files lead to a memory limit error.
+- Fixed the Overlay when creating a new Event.
+
+## [5.3.1]
+- Fix #11 and #113: Introducing new Paella 7 Player
+
 ## [5.3.0]
 - Implemented #193: The Chunk Size for Uploads is now configurable. The default value is 20MB, this can be changes in the plugin configuration.
 - Fix #176: Fixed a static timeout in fileuploads, this now uses max_execution_time of the server. 

diff --git a/classes/Conf/PermissionTemplates/class.xoctPermissionTemplateTableGUI.php b/classes/Conf/PermissionTemplates/class.xoctPermissionTemplateTableGUI.php
@@ -57,7 +57,8 @@ public function __construct(xoctPermissionTemplateGUI $a_parent_obj, $a_parent_c
         $b->setUrl($this->ctrl->getLinkTarget($a_parent_obj, xoctPermissionTemplateGUI::CMD_ADD));
         $this->addCommandButtonInstance($b);
 
-        xoctWaiterGUI::initJS();
+        new WaitOverlay($this->main_tpl); // TODO check if needed
+
         $this->main_tpl->addJavaScript($this->plugin->getDirectory() . '/templates/default/sortable.js');
         $base_link = $this->ctrl->getLinkTarget($this->parent_obj, 'reorder', '', true);
         $this->main_tpl->addOnLoadCode("xoctSortable.init('" . $base_link . "');");

diff --git a/classes/Event/class.xoctEventGUI.php b/classes/Event/class.xoctEventGUI.php
@@ -72,6 +72,10 @@ class xoctEventGUI extends xoctGUI
      * @var ilObjOpenCastGUI
      */
     private $parent_gui;
+    /**
+     * @var WaitOverlay
+     */
+    private $wait_overlay;
     /**
      * @var \ILIAS\UI\Implementation\DefaultRenderer
      */
@@ -192,6 +196,7 @@ public function __construct(
         $this->ui_renderer = new \ILIAS\UI\Implementation\DefaultRenderer(
             new Loader($DIC, ilOpenCastPlugin::getInstance())
         );
+        $this->wait_overlay  = new WaitOverlay($this->main_tpl);
     }
 
     /**
@@ -274,8 +279,7 @@ protected function performCommand($cmd)
      */
     protected function prepareContent()
     {
-        xoctWaiterGUI::initJS();
-        xoctWaiterGUI::addLinkOverlay('#rep_robj_xoct_event_clear_cache');
+        $this->wait_overlay->onLinkClick('#rep_robj_xoct_event_clear_cache');
         $this->main_tpl->addJavascript("./src/UI/templates/js/Modal/modal.js");
         $this->main_tpl->addOnLoadCode(
             'xoctEvent.init(\'' . json_encode([
@@ -504,11 +508,11 @@ protected function loadAjaxCodeForList()
 				    url: '{$ajax_link}',
 				    dataType: 'html',
 				    success: function(data){
-				        xoctWaiter.hide();
+				        il.Opencast.UI.waitOverlay.hide();
 				        $('div#xoct_table_placeholder').replaceWith($(data));
 				    }
 				});";
-        $this->main_tpl->addOnLoadCode('xoctWaiter.show();');
+        $this->main_tpl->addOnLoadCode('il.Opencast.UI.waitOverlay.show();');
         $this->main_tpl->addOnLoadCode($ajax);
     }
 
@@ -524,11 +528,11 @@ protected function loadAjaxCodeForTiles()
 				    url: '{$ajax_link}',
 				    dataType: 'html',
 				    success: function(data){
-				        xoctWaiter.hide();
+				        il.Opencast.UI.waitOverlay.hide();
 				        $('div#xoct_tiles_placeholder').replaceWith($(data));
 				    }
 				});";
-        $this->main_tpl->addOnLoadCode('xoctWaiter.show();');
+        $this->main_tpl->addOnLoadCode('il.Opencast.UI.waitOverlay.show();');
         $this->main_tpl->addOnLoadCode($ajax);
     }
 
@@ -615,12 +619,8 @@ protected function add()
             $this->objectSettings->getObjId(),
             ilObjOpenCastAccess::hasPermission('edit_videos')
         );
-        xoctWaiterGUI::initJS();
-        $this->main_tpl->addOnLoadCode(
-            'window.onbeforeunload = function(){
-                        xoctWaiter.show();
-                    };'
-        );
+        $this->wait_overlay->onUnload();
+
         $this->main_tpl->setContent($this->ui_renderer->render($form));
     }
 
@@ -664,7 +664,7 @@ protected function create()
                     $this->ACLUtils->getBaseACLForUser(xoctUser::getInstance($this->user)),
                     new Processing(
                         PluginConfig::getConfig(PluginConfig::F_WORKFLOW),
-                        $this->getDefaultWorkflowParameters($data['workflow_configuration']['object'])
+                        $this->getDefaultWorkflowParameters($data['workflow_configuration']['object'] ?? null)
                     ),
                     xoctUploadFile::getInstanceFromFileArray($data['file']['file'])
                 )

diff --git a/classes/IVTGroup/class.xoctPermissionGroupGUI.php b/classes/IVTGroup/class.xoctPermissionGroupGUI.php
@@ -42,8 +42,9 @@ public function __construct(?ObjectSettings $objectSettings = null)
             $this->objectSettings = new ObjectSettings();
         }
         $tabs->setTabActive(ilObjOpenCastGUI::TAB_GROUPS);
-        //		xoctGroup::installDB();
-        xoctWaiterGUI::loadLib();
+
+        new WaitOverlay($this->main_tpl); // TODO check if needed
+
         $main_tpl->addCss($this->plugin->getStyleSheetLocation('default/groups.css'));
         $main_tpl->addJavaScript($this->plugin->getStyleSheetLocation('default/groups.js'));
     }

diff --git a/classes/IVTGroup/class.xoctPermissionGroupParticipantGUI.php b/classes/IVTGroup/class.xoctPermissionGroupParticipantGUI.php
@@ -35,7 +35,9 @@ public function __construct(?ObjectSettings $objectSettings = null)
             $this->objectSettings = new ObjectSettings();
         }
         $tabs->setTabActive(ilObjOpenCastGUI::TAB_GROUPS);
-        xoctWaiterGUI::loadLib();
+
+        new WaitOverlay($main_tpl); // TODO check if needed
+
         $main_tpl->addJavaScript(
             $this->plugin->getStyleSheetLocation('default/group_participants.js')
         );

diff --git a/classes/Invitations/class.xoctGrantPermissionGUI.php b/classes/Invitations/class.xoctGrantPermissionGUI.php
@@ -51,7 +51,7 @@ public function __construct(ObjectSettings $objectSettings, EventRepository $eve
         $tabs->clearTargets();
 
         $tabs->setBackTarget($this->plugin->txt('tab_back'), $this->ctrl->getLinkTargetByClass(xoctEventGUI::class));
-        xoctWaiterGUI::loadLib();
+        new WaitOverlay($this->main_tpl); // TODO check if needed
         $main_tpl->addCss($this->plugin->getStyleSheetLocation('default/invitations.css'));
         $main_tpl->addJavaScript($this->plugin->getStyleSheetLocation('default/invitations.js'));
         $this->ctrl->saveParameter($this, xoctEventGUI::IDENTIFIER);

diff --git a/classes/Owner/class.xoctChangeOwnerGUI.php b/classes/Owner/class.xoctChangeOwnerGUI.php
@@ -60,7 +60,9 @@ public function __construct(ObjectSettings $objectSettings, EventRepository $eve
             $this->plugin->txt('tab_back'),
             $ctrl->getLinkTargetByClass(xoctEventGUI::class)
         );
-        xoctWaiterGUI::loadLib();
+
+        new WaitOverlay($this->main_tpl); // TODO check if needed
+
         $main_tpl->addCss($this->plugin->getStyleSheetLocation('default/change_owner.css'));
         $main_tpl->addJavaScript($this->plugin->getStyleSheetLocation('default/change_owner.js'));
         $ctrl->saveParameter($this, xoctEventGUI::IDENTIFIER);

diff --git a/classes/class.xoctWaiterGUI.php b/classes/class.xoctWaiterGUI.php
diff --git a/js/opencast/dist/index.js b/js/opencast/dist/index.js
diff --git a/js/opencast/src/UI/WaitOverlay.js b/js/opencast/src/UI/WaitOverlay.js
@@ -0,0 +1,81 @@
+/**
+ * PasswordToggle
+ *
+ * PasswordToggle class
+ *
+ * @author Fabian Schmid <fs@studer-raimann.ch>
+ * @author Farbod Zamani Boroujeni <zamani@elan-ev.de>
+ */
+export default class WaitOverlay {
+    count;
+    timer;
+
+
+    constructor() {
+        this.count = 0;
+        this.timer = null;
+    }
+
+    init(type) {
+        $('body').append('<div id="xoct_waiter" class="xoct_waiter"></div>')
+    }
+
+
+    show() {
+        if (this.count === 0) {
+            this.timer = setTimeout(function () {
+                $('#xoct_waiter').show();
+            }, 10);
+
+        }
+        this.count = this.count + 1;
+    }
+
+
+    hide() {
+        this.count = this.count - 1;
+        if (this.count === 0) {
+            window.clearTimeout(this.timer);
+            $('#xoct_waiter').fadeOut(200);
+        }
+    }
+
+    addListener(dom_selector_string) {
+        const self = this;
+        $(document).ready(function () {
+            $(dom_selector_string).on("click", function () {
+                self.show();
+            });
+        });
+    }
+
+
+    addLinkOverlay(dom_selector_string) {
+        const self = this;
+        $(document).ready(function () {
+            $(dom_selector_string).on("click", function (e) {
+                e.preventDefault();
+                self.show();
+                let href = $(this).attr('href');
+                setTimeout(function () {
+                    document.location.href = href;
+                }, 1000);
+            });
+        });
+    }
+
+    onFormSubmit(dom_selector_string) {
+        const self = this;
+        $(document).ready(function () {
+            // check if element is form, otherwise search for parent form
+            let form = $(dom_selector_string).is('form') ? $(dom_selector_string) : $(dom_selector_string).closest('form');
+            if (form.length === 0) {
+                console.warn('Unable to find form for selector: ' + dom_selector_string);
+                return;
+            }
+            form.on("submit", function () {
+                self.show();
+            });
+        });
+    }
+}
diff --git a/js/opencast/src/index.js b/js/opencast/src/index.js
@@ -1,11 +1,15 @@
 import il from 'ilias';
 import $ from 'jquery';
 import PasswordToggle from './Form/PasswordToggle';
+import WaitOverlay from './UI/WaitOverlay';
 import PaellaPlayer from './Paella/paella-player.min.js'
 
 il.Opencast = il.Opencast || {};
 il.Opencast.Form = il.Opencast.Form || {};
 il.Opencast.Form.passwordToggle = new PasswordToggle($);
 
+il.Opencast.UI = il.Opencast.UI || {};
+il.Opencast.UI.waitOverlay = new WaitOverlay($);
+
 il.Opencast.Paella = il.Opencast.Paella || {};
 il.Opencast.Paella.player = PaellaPlayer;
diff --git a/plugin.php b/plugin.php
@@ -1,7 +1,7 @@
 <?php
 
 $id = 'xoct';
-$version = '5.3.1';
+$version = '5.3.2';
 $version_check = '44ac530093a998b525b0a73ba536e64f03bbaff47446cf99e1a31d6a042a4549';
 $ilias_min_version = '6.0';
 $ilias_max_version = '7.999';

diff --git a/src/API/Handlers.php b/src/API/Handlers.php
@@ -44,10 +44,8 @@ private static function requestDebug()
         return function (callable $handler) {
             return function (RequestInterface $request, array $options) use ($handler) {
                 $path = $request->getUri()->getPath();
-                $host = $request->getUri()->getHost();
                 $query = $request->getUri()->getQuery();
                 $method = $request->getMethod();
-                $requestBody = $request->getBody()->getContents();
                 $completeUri = $request->getUri()->__toString();
 
                 // Exclude requests.

diff --git a/src/UI/EventFormBuilder.php b/src/UI/EventFormBuilder.php
@@ -185,6 +185,13 @@ function ($file) use ($upload_storage_service): array {
                                      )
                                  );
 
+        // We must bind the WaitOverlay to an Input since the Form itself is not JS-bindable
+        $file_input = $file_input->withAdditionalOnLoadCode(
+            function ($id) {
+                return 'il.Opencast.UI.waitOverlay.onFormSubmit("#' . $id . '")';
+            }
+        );
+
         $file_section_inputs = ['file' => $file_input];
         if ($obj_id == 0) {
             $file_section_inputs['isPartOf'] = $this->buildSeriesSelector();