MOBILE-1577 quiz: Prevent submit quiz if essay has attachments

Author: dpalou

www/addons/mod_quiz/controllers/player.js

@@ -201,15 +201,14 @@ angular.module('mm.addons.mod_quiz')
     function loadSummary() {
         $scope.showSummary = true;
         $scope.summaryQuestions = [];
+
         return $mmaModQuiz.getAttemptSummary(attempt.id, $scope.preflightData, offline, true, true).then(function(questions) {
             $scope.summaryQuestions = questions;
             $scope.canReturn = attempt.state == $mmaModQuiz.ATTEMPT_IN_PROGRESS && !attempt.finishedOffline;
+            $scope.preventSubmitMessages = $mmaModQuiz.getPreventSubmitMessages(questions);
 
             attempt.dueDateWarning = $mmaModQuiz.getAttemptDueDateWarning(quiz, attempt);
 
-            // Remove all answers stored since the questions aren't rendered anymore.
-            $mmUtil.emptyObject($scope.answers);
-
             // Log summary as viewed.
             $mmaModQuiz.logViewAttemptSummary(attempt.id);
         }).catch(function(message) {

www/addons/mod_quiz/lang/en.json

@@ -4,6 +4,7 @@
 	"attemptnumber": "Attempt",
 	"attemptquiznow": "Attempt quiz now",
 	"attemptstate": "State",
+	"cannotsubmitquizdueto": "This quiz cannot be submitted due to the following reasons:",
 	"comment": "Comment",
 	"completedon": "Completed on",
 	"confirmclose": "Once you submit, you will no longer be able to change your answers for this attempt.",

www/addons/mod_quiz/services/quiz.js

@@ -749,6 +749,28 @@ angular.module('mm.addons.mod_quiz')
         }
     };
 
+    /**
+     * Given a list of questions, check if the quiz can be submitted.
+     * Will return an array with the messages to prevent the submit. Empty array if quiz can be submitted.
+     *
+     * @module mm.addons.mod_quiz
+     * @ngdoc method
+     * @name $mmaModQuiz#getPreventSubmitMessages
+     * @param  {Object[]} questions Questions.
+     * @return {String[]}           List of prevent submit messages. Empty array if quiz can be submitted.
+     */
+    self.getPreventSubmitMessages = function(questions) {
+        var messages = [];
+        angular.forEach(questions, function(question) {
+            var message = $mmQuestionDelegate.getPreventSubmitMessage(question);
+            if (message) {
+                message = $translate.instant(message);
+                messages.push($translate.instant('mm.question.questionmessage', {$a: question.slot, $b: message}));
+            }
+        });
+        return messages;
+    };
+
     /**
      * Get cache key for Quiz data WS calls.
      *

www/addons/mod_quiz/templates/player.html

@@ -64,7 +64,12 @@ <h2>{{ 'mma.mod_quiz.summaryofattempt' | translate }}</h2>
                     {{ attempt.dueDateWarning }}
                 </div>
                 <mm-timer ng-if="endTime" class="item item-text-wrap" end-time="endTime" finished="timeUp()" timer-text="{{ 'mma.mod_quiz.timeleft' | translate }}"></mm-timer>
-                <div class="item" ng-if="!attempt.finishedOffline">
+                <div class="item item-text-wrap" ng-if="preventSubmitMessages.length">
+                    <p class="item-heading">{{ 'mma.mod_quiz.cannotsubmitquizdueto' | translate }}</p>
+                    <p ng-repeat="message in preventSubmitMessages">{{message}}</p>
+                    <a class="button button-block" ng-href="{{moduleUrl}}" mm-browser>{{ 'mm.core.openinbrowser' | translate }}</a>
+                </div>
+                <div class="item" ng-if="!attempt.finishedOffline && !preventSubmitMessages.length">
                     <a class="button button-block" ng-click="finishAttempt()">{{ 'mma.mod_quiz.submitallandfinish' | translate }}</a>
                 </div>
             </div>

www/addons/qtype/essay/handlers.js

@@ -36,6 +36,25 @@ angular.module('mm.addons.qtype_essay')
         return 'manualgraded';
     };
 
+    /**
+     * Check if a question can be submitted.
+     * If a question cannot be submitted it should return a message explaining why (translated or not).
+     *
+     * @module mm.core.question
+     * @ngdoc method
+     * @name $mmQuestionDelegate#getPreventSubmitMessage
+     * @param  {Object} question Question.
+     * @return {String}          Prevent submit message. Undefined or empty if cannot be submitted.
+     */
+    self.getPreventSubmitMessage = function(question) {
+        var questionEl = angular.element(question.html)[0];
+
+        if (questionEl.querySelector('div[id*=filemanager]')) {
+            // The question allows attachments. Since the app cannot attach files yet we will prevent submitting the question.
+            return 'mm.question.errorattachmentsnotsupported';
+        }
+    };
+
     /**
      * Check if a response is complete.
      *

www/core/components/question/lang/en.json

@@ -13,6 +13,7 @@
 	"notanswered": "Not answered",
 	"notyetanswered": "Not yet answered",
 	"partiallycorrect": "Partially correct",
+	"questionmessage": "Question {{$a}}: {{$b}}",
 	"requiresgrading": "Requires grading",
 	"unknown": "Cannot determine status"
 }

www/core/components/question/services/delegate.js

@@ -130,6 +130,24 @@ angular.module('mm.core.question')
             }
         };
 
+        /**
+         * Check if a question can be submitted.
+         * If a question cannot be submitted it should return a message explaining why (translated or not).
+         *
+         * @module mm.core.question
+         * @ngdoc method
+         * @name $mmQuestionDelegate#getPreventSubmitMessage
+         * @param  {Object} question Question.
+         * @return {String}          Prevent submit message. Undefined or empty if cannot be submitted.
+         */
+        self.getPreventSubmitMessage = function(question) {
+            var type = 'qtype_' + question.type,
+                handler = enabledHandlers[type];
+            if (typeof handler != 'undefined' && handler.getPreventSubmitMessage) {
+                return handler.getPreventSubmitMessage(question);
+            }
+        };
+
         /**
          * Check if a response is complete.
          *

www/core/scss/styles.scss

@@ -74,6 +74,11 @@ em {
   @extend h2;
 }
 
+.item.item-text-wrap .item-heading {
+  overflow: visible;
+  white-space: normal;
+}
+
 // More options for grids.
 .col-65 {
   @include flex(0, 0, 65%);