MDL-43247 SCORM: improve pop-up handling and redirect to homepage on …

…close.
DavidSichau · Jan 16, 2014 · 9d22765 · 9d22765
1 parent f05e25d
commit 9d22765
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 4 deletions.
diff --git a/mod/scorm/lang/en/scorm.php b/mod/scorm/lang/en/scorm.php
@@ -290,6 +290,7 @@
 $string['pluginadministration'] = 'SCORM package administration';
 $string['pluginname'] = 'SCORM package';
 $string['popup'] = 'New window';
+$string['popuplaunched'] = 'This SCORM package has been launched in a popup window, If you have finished viewing this resource, click here to return to the course page';
 $string['popupmenu'] = 'In a drop down menu';
 $string['popupopen'] = 'Open package in a new window';
 $string['popupsblocked'] = 'It appears that popup windows are blocked, stopping this SCORM package from playing. Please check your browser settings before trying again.';

diff --git a/mod/scorm/locallib.php b/mod/scorm/locallib.php
@@ -822,7 +822,7 @@ function scorm_view_display ($user, $scorm, $action, $cm) {
     $organization = optional_param('organization', '', PARAM_INT);
 
     if ($scorm->displaycoursestructure == 1) {
-        echo $OUTPUT->box_start('generalbox boxaligncenter toc');
+        echo $OUTPUT->box_start('generalbox boxaligncenter toc', 'toc');
         ?>
         <div class="structurehead"><?php print_string('contents', 'scorm') ?></div>
         <?php

diff --git a/mod/scorm/view.js b/mod/scorm/view.js
@@ -25,10 +25,53 @@ M.mod_scormform.init = function(Y) {
         poptions = poptions+',width='+cwidth+',height='+cheight;
     }
 
+    var scormredirect = function (winobj) {
+        winobj.onload = function () {
+
+            // Hide the form and toc if it exists - we don't want to allow multiple submissions when a window is open.
+            if (scormform) {
+                scormform.hide();
+            }
+
+            var scormtoc = Y.one('#toc');
+            if (scormtoc) {
+                scormtoc.hide();
+            }
+            // Hide the intro and display a message to the user if the window is closed but for some reason the events
+            // below aren't triggered.
+            var scormintro = Y.one('#intro');
+            scormintro.setHTML('<a href="'+ course_url + '">' + M.str.scorm.popuplaunched + '</a>');
+        }
+        // When pop-up is closed return to course homepage.
+        winobj.onunload = function () {
+            // Onunload is called multiple times in the SCORM window - we only want to handle when it is actually closed.
+            setTimeout(function() {
+                if (!winobj.opener) {
+                    // Redirect the parent window to the course homepage.
+                    parent.window.location = course_url;
+                }
+            }, 200)
+        }
+        // Check to make sure pop-up has been launched - if not display a warning,
+        // this shouldn't happen as the pop-up here is launched on user action but good to make sure.
+        setTimeout(function() {
+            if (!winobj) {
+                scormintro.setHTML(M.str.scorm.popupsblocked);
+            }}, 800);
+    }
+
     if (launch == true) {
         launch_url = launch_url+"&display=popup";
-        window.open(launch_url,'Popup', poptions);
-        parent.window.location = course_url;
+        var winobj = window.open(launch_url,'Popup', poptions);
+        this.target='Popup';
+        scormredirect(winobj);
+    }
+    // Listen for view form submit and generate popup on user interaction.
+    if (scormform) {
+        scormform.onsubmit = function() {
+            var winobj = window.open('', 'Popup', poptions);
+            this.target='Popup';
+            scormredirect(winobj);
+        }
     }
-    scormform.onsubmit = function() {window.open('', 'Popup', poptions); this.target='Popup'; parent.window.location = course_url;};
 }
diff --git a/mod/scorm/view.php b/mod/scorm/view.php
@@ -100,6 +100,8 @@
                                                            'cwidth' => $scorm->width,
                                                            'cheight' => $scorm->height,
                                                            'popupoptions' => $scorm->options), true);
+    $PAGE->requires->string_for_js('popupsblocked', 'scorm');
+    $PAGE->requires->string_for_js('popuplaunched', 'scorm');
     $PAGE->requires->js('/mod/scorm/view.js', true);
 }