MOBILE-1543 quiz: Ask preflight in prefetch

dpalou · dpalou · commit b0b4c2fbcef6 · 2016-05-18T16:57:33.000+02:00
diff --git a/www/addons/mod_quiz/accessrules/delaybetweenattempts/handlers.js b/www/addons/mod_quiz/accessrules/delaybetweenattempts/handlers.js
@@ -38,9 +38,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         return false;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/ipaddress/handlers.js b/www/addons/mod_quiz/accessrules/ipaddress/handlers.js
@@ -38,9 +38,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         return false;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/numattempts/handlers.js b/www/addons/mod_quiz/accessrules/numattempts/handlers.js
@@ -38,9 +38,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         return false;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/offlineattempts/handlers.js b/www/addons/mod_quiz/accessrules/offlineattempts/handlers.js
@@ -38,9 +38,14 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
+        if (prefetch) {
+            return false;
+        }
+
         if (!attempt) {
             return true;
         }
@@ -57,9 +62,10 @@ angular.module('mm.addons.mod_quiz')
      * @name $mmaModQuizAccessRulesDelegate#getFixedPreflightData
      * @param  {Object} attempt       Attempt.
      * @param  {Object} preflightData Object where to store the preflight data.
+     * @param  {Boolean} prefetch     True if prefetching, false if attempting the quiz.
      * @return {Void}
      */
-    self.getFixedPreflightData = function(attempt, preflightData) {
+    self.getFixedPreflightData = function(attempt, preflightData, prefetch) {
         preflightData.confirmdatasaved = 1;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/openclosedate/handlers.js b/www/addons/mod_quiz/accessrules/openclosedate/handlers.js
@@ -38,9 +38,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         return false;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/password/handlers.js b/www/addons/mod_quiz/accessrules/password/handlers.js
@@ -47,9 +47,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         // If the password rule is active in a quiz we always require to input the password.
         return true;
     };
diff --git a/www/addons/mod_quiz/accessrules/safebrowser/handlers.js b/www/addons/mod_quiz/accessrules/safebrowser/handlers.js
@@ -38,9 +38,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         return false;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/securewindow/handlers.js b/www/addons/mod_quiz/accessrules/securewindow/handlers.js
@@ -38,9 +38,10 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         return false;
     };
 
diff --git a/www/addons/mod_quiz/accessrules/timelimit/handlers.js b/www/addons/mod_quiz/accessrules/timelimit/handlers.js
@@ -38,10 +38,12 @@ angular.module('mm.addons.mod_quiz')
      * Check if a preflight check is required.
      *
      * @param  {Object} [attempt] Attempt to continue. Not defined if starting a new attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
      * @return {Boolean}          True if preflight check required.
      */
-    self.isPreflightCheckRequired = function(attempt) {
+    self.isPreflightCheckRequired = function(attempt, prefetch) {
         // Warning only required if the attempt is not already started.
+        // prefetch should always be false since offline isn't compatible with timed quizzes.
         return !attempt;
     };
 
diff --git a/www/addons/mod_quiz/controllers/player.js b/www/addons/mod_quiz/controllers/player.js
@@ -132,7 +132,7 @@ angular.module('mm.addons.mod_quiz')
     function startOrContinueAttempt(fromModal) {
         // Check preflight data and start attempt if needed.
         var att = newAttempt ? undefined : attempt;
-        return $mmaModQuizHelper.checkPreflightData($scope, quiz, quizAccessInfo, att, offline, fromModal).then(function(att) {
+        return $mmaModQuiz.checkPreflightData($scope, quiz, quizAccessInfo, att, offline, fromModal).then(function(att) {
 
             // Re-fetch attempt access information with the right attempt (might have changed because a new attempt was created).
             return $mmaModQuiz.getAttemptAccessInformation(quiz.id, att.id, offline, true).then(function(info) {
@@ -156,6 +156,10 @@ angular.module('mm.addons.mod_quiz')
                     return loadSummary();
                 }
             });
+        }).catch(function(error) {
+            if (error) {
+                return $mmaModQuizHelper.showError(error, 'mm.core.error');
+            }
         });
     }
 
diff --git a/www/addons/mod_quiz/services/accessrulesdelegate.js b/www/addons/mod_quiz/services/accessrulesdelegate.js
@@ -77,13 +77,14 @@ angular.module('mm.addons.mod_quiz')
      * @param  {String[]} rules       Name of the rules.
      * @param  {Object} attempt       Attempt.
      * @param  {Object} preflightData Object where to store the preflight data.
+     * @param  {Boolean} prefetch     True if prefetching, false if attempting the quiz.
      * @return {Void}
      */
-    self.getFixedPreflightData = function(rules, attempt, preflightData) {
+    self.getFixedPreflightData = function(rules, attempt, preflightData, prefetch) {
         angular.forEach(rules, function(rule) {
             var handler = self.getAccessRuleHandler(rule);
             if (handler && handler.getFixedPreflightData) {
-                handler.getFixedPreflightData(attempt, preflightData);
+                handler.getFixedPreflightData(attempt, preflightData, prefetch);
             }
         });
     };
@@ -107,16 +108,17 @@ angular.module('mm.addons.mod_quiz')
      * @module mm.addons.mod_quiz
      * @ngdoc method
      * @name $mmaModQuizAccessRulesDelegate#isPreflightCheckRequired
-     * @param  {String[]} rules Name of the rules.
-     * @param  {Object} attempt Attempt.
-     * @return {Boolean}        True if required, false otherwise.
+     * @param  {String[]} rules   Name of the rules.
+     * @param  {Object} attempt   Attempt.
+     * @param  {Boolean} prefetch True if prefetching, false if attempting the quiz.
+     * @return {Boolean}          True if required, false otherwise.
      */
-    self.isPreflightCheckRequired = function(rules, attempt) {
+    self.isPreflightCheckRequired = function(rules, attempt, prefetch) {
         var isRequired = false;
         angular.forEach(rules, function(rule) {
             var handler = self.getAccessRuleHandler(rule);
             if (handler) {
-                if (handler.isPreflightCheckRequired(attempt)) {
+                if (handler.isPreflightCheckRequired(attempt, prefetch)) {
                     isRequired = true;
                 }
             }
@@ -136,10 +138,10 @@ angular.module('mm.addons.mod_quiz')
      *                           returning an object defining these properties. See {@link $mmUtil#resolveObject}.
      *                             - isEnabled (Boolean|Promise) Whether or not the handler is enabled on a site level.
      *                                                           When using a promise, it should return a boolean.
-     *                             - isPreflightCheckRequired(attempt) (Boolean|Promise) Whether or not the rule requires a
-     *                                                           preflight check when starting/continuing an attempt.
-     *                             - getFixedPreflightData(attempt, preflightData) Optional. Should add preflight data that doesn't
-     *                                                           require user interaction.
+     *                             - isPreflightCheckRequired(attempt, prefetch) (Boolean|Promise) Whether or not the rule requires
+     *                                                           a preflight check when prefetch or start/continue an attempt.
+     *                             - getFixedPreflightData(attempt, preflightData, prefetch) Optional. Should add preflight data
+     *                                                           that doesn't require user interaction.
      *                             - getPreflightDirectiveName() (String) Optional. Returns the name of the directive to render
      *                                                           the access rule preflight. Required if the handler needs a
      *                                                           preflight check in some cases.
diff --git a/www/addons/mod_quiz/services/handlers.js b/www/addons/mod_quiz/services/handlers.js
@@ -23,7 +23,7 @@ angular.module('mm.addons.mod_quiz')
  */
 .factory('$mmaModQuizHandlers', function($mmCourse, $mmaModQuiz, $state, $q, $mmContentLinksHelper, $mmUtil, $mmCourseHelper,
             $mmSite, $mmCoursePrefetchDelegate, $mmaModQuizPrefetchHandler, $mmEvents, mmCoreEventPackageStatusChanged,
-            mmaModQuizComponent, mmCoreDownloading, mmCoreNotDownloaded, mmCoreOutdated) {
+            mmaModQuizComponent, mmCoreDownloading, mmCoreNotDownloaded, mmCoreOutdated, $mmaModQuizHelper) {
 
     var self = {};
 
@@ -92,10 +92,10 @@ angular.module('mm.addons.mod_quiz')
                     }
 
                     $scope.spinner = true; // Show spinner since this operation might take a while.
-                    $mmaModQuizPrefetchHandler.prefetch(module, courseId).catch(function() {
+                    $mmaModQuizPrefetchHandler.prefetch(module, courseId, true).catch(function(error) {
                         $scope.spinner = false;
                         if (!$scope.$$destroyed) {
-                            $mmUtil.showErrorModal('mm.core.errordownloading', true);
+                            $mmaModQuizHelper.showError(error, 'mm.core.errordownloading');
                         }
                     });
                 }
diff --git a/www/addons/mod_quiz/services/helper.js b/www/addons/mod_quiz/services/helper.js
@@ -21,91 +21,10 @@ angular.module('mm.addons.mod_quiz')
  * @ngdoc service
  * @name $mmaModQuizHelper
  */
-.factory('$mmaModQuizHelper', function($mmaModQuiz, $mmUtil, $q, $ionicModal, $mmaModQuizAccessRulesDelegate, $translate,
-            $mmaModQuizOffline, $mmaModQuizSync, $timeout) {
+.factory('$mmaModQuizHelper', function($mmaModQuiz, $mmUtil, $q, $translate, $mmaModQuizSync) {
 
     var self = {};
 
-    /**
-     * Validate a preflight data or show a modal to input the preflight data if required.
-     * It calls $mmaModQuiz#startAttempt if a new attempt is needed.
-     *
-     * @module mm.addons.mod_quiz
-     * @ngdoc method
-     * @name $mmaModQuizHelper#checkPreflightData
-     * @param  {Object} scope             Scope.
-     * @param  {Object} quiz              Quiz.
-     * @param  {Object} quizAccessInfo    Quiz access info returned by $mmaModQuiz#getQuizAccessInformation.
-     * @param  {Object} [attempt]         Attempt to continue. Don't pass any value if the user needs to start a new attempt.
-     * @param  {Boolean} offline          True if attempt is offline.
-     * @param  {Boolean} fromModal        True if sending data using preflight modal, false otherwise.
-     * @return {Promise}                  Promise resolved when the preflight data is validated.
-     */
-    self.checkPreflightData = function(scope, quiz, quizAccessInfo, attempt, offline, fromModal) {
-        var promise,
-            preflightRequired = $mmaModQuizAccessRulesDelegate.isPreflightCheckRequired(quizAccessInfo.activerulenames, attempt);
-
-        if (preflightRequired && !fromModal) {
-            // Preflight check is required but no preflightData has been sent. Show a modal with the preflight form.
-            if (!scope.modal) {
-                // Modal hasn't been created yet. Create it and show it.
-                return self.initPreflightModal(scope, quizAccessInfo, attempt).catch(function(error) {
-                    return self.showError(error, 'Error initializing preflight modal.');
-                }).then(function() {
-                    scope.modal.show();
-                    return $q.reject();
-                });
-            } else if (!scope.modal.isShown()) {
-                // Modal is created but not shown. Show it.
-                scope.modal.show();
-            }
-            return $q.reject();
-        }
-
-        // Hide modal if needed.
-        scope.modal && scope.modal.hide();
-
-        // Get some fixed preflight data from access rules (data that doesn't require user interaction).
-        $mmaModQuizAccessRulesDelegate.getFixedPreflightData(quizAccessInfo.activerulenames, attempt, scope.preflightData);
-
-        if (attempt) {
-            if (attempt.state != $mmaModQuiz.ATTEMPT_OVERDUE && !attempt.finishedOffline) {
-                // We're continuing an attempt. Call getAttemptData to validate the preflight data.
-                var page = attempt.currentpage;
-                promise = $mmaModQuiz.getAttemptData(attempt.id, page, scope.preflightData, offline, true).then(function() {
-                    if (offline) {
-                        // Get current page stored in local.
-                        return $mmaModQuizOffline.getAttemptById(attempt.id).then(function(localAttempt) {
-                            attempt.currentpage = localAttempt.currentpage;
-                        }).catch(function() {
-                            // No local data.
-                        });
-                    }
-                });
-            } else {
-                // Attempt is overdue or finished in offline, we can only see the summary.
-                // Call getAttemptSummary to validate the preflight data.
-                promise = $mmaModQuiz.getAttemptSummary(attempt.id, scope.preflightData, offline, true);
-            }
-        } else {
-            // We're starting a new attempt, call startAttempt.
-            promise = $mmaModQuiz.startAttempt(quiz.id, scope.preflightData).then(function(att) {
-                attempt = att;
-            });
-        }
-
-        return promise.then(function() {
-            // Preflight data validated. Close modal if needed.
-            return attempt;
-        }).catch(function(error) {
-            // Show modal again. We need to wait a bit because if it's called too close to .hide then it won't be shown.
-            $timeout(function() {
-                scope.modal && scope.modal.show();
-            }, 500);
-            return self.showError(error, 'mm.core.error');
-        });
-    };
-
     /**
      * Gets the mark string from a question HTML.
      * Example result: "Marked out of 1.00".
@@ -153,62 +72,6 @@ angular.module('mm.addons.mod_quiz')
         }
     };
 
-    /**
-     * Init a preflight modal, adding it to the scope.
-     *
-     * @module mm.addons.mod_quiz
-     * @ngdoc method
-     * @name $mmaModQuizHelper#initPreflightModal
-     * @param  {Object} scope          Scope.
-     * @param  {Object} quizAccessInfo Quiz access info returned by $mmaModQuiz#getQuizAccessInformation.
-     * @param  {Object} [attempt]      Attempt to continue. Don't pass any value if the user needs to start a new attempt.
-     * @return {Promise}               Promise resolved when the modal is initialized.
-     */
-    self.initPreflightModal = function(scope, quizAccessInfo, attempt) {
-        var notSupported = [],
-            directives = [],
-            handlers = [];
-
-        angular.forEach(quizAccessInfo.activerulenames, function(rule) {
-            var handler = $mmaModQuizAccessRulesDelegate.getAccessRuleHandler(rule);
-            if (handler) {
-                if (handler.isPreflightCheckRequired(attempt)) {
-                    handlers.push(handler);
-                    directives.push(handler.getPreflightDirectiveName());
-                }
-            } else {
-                notSupported.push(rule);
-            }
-        });
-
-        if (notSupported.length) {
-            var error = $translate.instant('mma.mod_quiz.errorrulesnotsupported') + ' ' + JSON.stringify(notSupported);
-            return $q.reject(error);
-        }
-
-        scope.accessRulesDirectives = directives;
-
-        return $ionicModal.fromTemplateUrl('addons/mod_quiz/templates/preflight-modal.html', {
-            scope: scope,
-            animation: 'slide-in-up'
-        }).then(function(modal) {
-            scope.modal = modal;
-
-            scope.closeModal = function() {
-                modal.hide();
-                // Clean the preflight data.
-                handlers.forEach(function(handler) {
-                    if (typeof handler.cleanPreflight == 'function') {
-                        handler.cleanPreflight(scope.preflightData);
-                    }
-                });
-            };
-            scope.$on('$destroy', function() {
-                modal.remove();
-            });
-        });
-    };
-
     /**
      * Add some calculated data to the attempt.
      *
diff --git a/www/addons/mod_quiz/services/quiz.js b/www/addons/mod_quiz/services/quiz.js
diff --git a/www/addons/mod_quiz/templates/index.html b/www/addons/mod_quiz/templates/index.html
