MOBILE-1576 quiz: Show automatic sync warnings when viewing quiz

Author: dpalou

www/addons/mod_quiz/controllers/index.js

@@ -55,6 +55,15 @@ angular.module('mm.addons.mod_quiz')
             $scope.title = quiz.name || $scope.title;
             $scope.description = quiz.intro || $scope.description;
 
+            // Try to get warnings from automatic sync.
+            return $mmaModQuizSync.getQuizSyncWarnings(quiz.id).then(function(warnings) {
+                if (warnings && warnings.length) {
+                    // Show warnings and delete them so they aren't shown again.
+                    $mmUtil.showErrorModal($mmText.buildMessage(warnings));
+                    return $mmaModQuizSync.setQuizSyncWarnings(quiz.id, []);
+                }
+            });
+        }).then(function() {
             // Try to sync the quiz.
             return syncQuiz(!refresh, false).catch(function() {
                 // Ignore errors, keep getting data even if sync fails.

www/addons/mod_quiz/services/quiz_sync.js

@@ -15,13 +15,19 @@
 angular.module('mm.addons.mod_quiz')
 
 .constant('mmaModQuizSynchronizationStore', 'mod_quiz_sync')
+.constant('mmaModQuizSynchronizationWarningsStore', 'mod_quiz_sync_warnings')
 
-.config(function($mmSitesFactoryProvider, mmaModQuizSynchronizationStore) {
+.config(function($mmSitesFactoryProvider, mmaModQuizSynchronizationStore, mmaModQuizSynchronizationWarningsStore) {
     var stores = [
         {
             name: mmaModQuizSynchronizationStore,
             keyPath: 'quizid',
             indexes: []
+        },
+        {
+            name: mmaModQuizSynchronizationWarningsStore,
+            keyPath: 'quizid',
+            indexes: []
         }
     ];
     $mmSitesFactoryProvider.registerStores(stores);
@@ -36,7 +42,7 @@ angular.module('mm.addons.mod_quiz')
  */
 .factory('$mmaModQuizSync', function($log, $mmaModQuiz, $mmSite, $mmSitesManager, $q, $mmaModQuizOffline, $mmQuestion,
             $mmQuestionDelegate, $mmApp, $mmConfig, $mmEvents, $translate, mmaModQuizSynchronizationStore, mmaModQuizSyncTime,
-            mmaModQuizEventAutomSynced, mmCoreSettingsSyncOnlyOnWifi) {
+            mmaModQuizEventAutomSynced, mmCoreSettingsSyncOnlyOnWifi, mmaModQuizSynchronizationWarningsStore) {
 
     $log = $log.getInstance('$mmaModQuizSync');
 
@@ -64,6 +70,27 @@ angular.module('mm.addons.mod_quiz')
         });
     };
 
+    /**
+     * Get the synchronization warnings of a quiz.
+     *
+     * @module mm.addons.mod_quiz
+     * @ngdoc method
+     * @name $mmaModQuizSync#getQuizSyncTime
+     * @param  {Number} quizId   Quiz ID.
+     * @param  {String} [siteId] Site ID. If not defined, current site.
+     * @return {Promise}         Promise resolved with the time.
+     */
+    self.getQuizSyncWarnings = function(quizId, siteId) {
+        siteId = siteId || $mmSite.getId();
+        return $mmSitesManager.getSiteDb(siteId).then(function(db) {
+            return db.get(mmaModQuizSynchronizationWarningsStore, quizId).then(function(entry) {
+                return entry.warnings;
+            }).catch(function() {
+                return [];
+            });
+        });
+    };
+
     /**
      * Check if a quiz has data to synchronize.
      *
@@ -83,15 +110,15 @@ angular.module('mm.addons.mod_quiz')
     };
 
     /**
-     * Get the synchronization time of a quiz. Returns 0 if no time stored.
+     * Set the synchronization time for a quiz.
      *
      * @module mm.addons.mod_quiz
      * @ngdoc method
      * @name $mmaModQuizSync#setQuizSyncTime
      * @param  {Number} quizId   Quiz ID.
      * @param  {String} [siteId] Site ID. If not defined, current site.
      * @param  {Number} [time]   Time to set. If not defined, current time.
-     * @return {Promise}        Promise resolved with the time.
+     * @return {Promise}         Promise resolved when done.
      */
     self.setQuizSyncTime = function(quizId, siteId, time) {
         siteId = siteId || $mmSite.getId();
@@ -103,6 +130,27 @@ angular.module('mm.addons.mod_quiz')
         });
     };
 
+    /**
+     * Set the synchronization warnings for a quiz.
+     *
+     * @module mm.addons.mod_quiz
+     * @ngdoc method
+     * @name $mmaModQuizSync#setQuizSyncWarnings
+     * @param  {Number} quizId     Quiz ID.
+     * @param  {String[]} warnings Warnings to set.
+     * @param  {String} [siteId]   Site ID. If not defined, current site.
+     * @return {Promise}           Promise resolved when done.
+     */
+    self.setQuizSyncWarnings = function(quizId, warnings, siteId) {
+        siteId = siteId || $mmSite.getId();
+        return $mmSitesManager.getSiteDb(siteId).then(function(db) {
+            if (typeof warnings == 'undefined') {
+                warnings = [];
+            }
+            return db.insert(mmaModQuizSynchronizationWarningsStore, {quizid: quizId, warnings: warnings});
+        });
+    };
+
     /**
      * Try to synchronize all quizzes from current site that need it and haven't been synchronized in a while.
      *
@@ -161,6 +209,13 @@ angular.module('mm.addons.mod_quiz')
                             if (!$mmaModQuiz.isQuizBeingPlayed(quiz.id, siteId)) {
                                 promises.push($mmaModQuiz.getQuizById(quiz.courseid, quiz.id, siteId).then(function(quiz) {
                                     return self.syncQuizIfNeeded(quiz, siteId).then(function(warnings) {
+                                        if (warnings && warnings.length) {
+                                            // Store the warnings to show them when the user opens the quiz.
+                                            return self.setQuizSyncWarnings(quiz.id, warnings, siteId).then(function() {
+                                                return warnings;
+                                            });
+                                        }
+                                    }).then(function(warnings) {
                                         if (typeof warnings != 'undefined') {
                                             // We tried to sync. Send event.
                                             $mmEvents.trigger(mmaModQuizEventAutomSynced, {