From aefdd3f86d5c1f97a02e53d287cd5c05569d1860 Mon Sep 17 00:00:00 2001
From: stuwilmur <stuwilmur@users.noreply.github.com>
Date: Thu, 2 Nov 2023 20:28:24 +0000
Subject: [PATCH] Handle/respect typeendtoleave navigation option Rename 'OK'
 button 'End exam' on confirm-end-exam-modal

---
 bin/exam.py                          |  4 +++-
 locales/en-GB.json                   |  1 +
 runtime/scripts/exam.js              | 29 +++++++++++++++++++---------
 schema/exam_schema.7.1.json          |  4 ++++
 tests/locales.js                     | 10 +++++++---
 tests/numbas-runtime.js              | 29 +++++++++++++++++++---------
 themes/default/templates/modals.html |  2 +-
 7 files changed, 56 insertions(+), 23 deletions(-)

diff --git a/bin/exam.py b/bin/exam.py
index 5e08baf81..546cde9f5 100644
--- a/bin/exam.py
+++ b/bin/exam.py
@@ -163,6 +163,7 @@ def __init__(self,name='Untitled Exam'):
                 'showresultspage': 'oncompletion',
                 'onleave': Event('onleave','none','You have not finished the current question'),
                 'preventleave': True,
+                'typeendtoleave': False,
                 'startpassword': '',
                 'allowAttemptDownload': False,
                 'downloadEncryptionKey': '',
@@ -192,7 +193,7 @@ def fromDATA(builder, data):
 
         if haskey(data,'navigation'):
             nav = data['navigation']
-            tryLoad(nav,['allowregen','navigatemode','reverse','browse','allowsteps','showfrontpage','showresultspage','preventleave','startpassword','allowAttemptDownload','downloadEncryptionKey'],exam.navigation)
+            tryLoad(nav,['allowregen','navigatemode','reverse','browse','allowsteps','showfrontpage','showresultspage','preventleave','typeendtoleave','startpassword','allowAttemptDownload','downloadEncryptionKey'],exam.navigation)
             if 'onleave' in nav:
                 tryLoad(nav['onleave'],['action','message'],exam.navigation['onleave'])
 
@@ -282,6 +283,7 @@ def toxml(self):
             'showfrontpage': strcons_fix(self.navigation['showfrontpage']),
             'showresultspage': strcons_fix(self.navigation['showresultspage']),
             'preventleave': strcons_fix(self.navigation['preventleave']),
+            'typeendtoleave': strcons_fix(self.navigation['typeendtoleave']),
             'startpassword': strcons(self.navigation['startpassword']),
             'allowAttemptDownload': strcons_fix(self.navigation['allowAttemptDownload']),
             'downloadEncryptionKey': strcons(self.navigation['downloadEncryptionKey'])
diff --git a/locales/en-GB.json b/locales/en-GB.json
index fc80b0587..26fff9c82 100644
--- a/locales/en-GB.json
+++ b/locales/en-GB.json
@@ -19,6 +19,7 @@
     "extension.not found": "Couldn't load the extension <code>{{name}}</code>.",
     "modal.confirm": "Confirm",
     "modal.confirm end exam": "Write <code>{{endConfirmation}}</code> in the box to confirm:",
+    "modal.end exam button": "End exam",
     "modal.alert": "Alert",
     "modal.ok": "OK",
     "modal.cancel": "Cancel",
diff --git a/runtime/scripts/exam.js b/runtime/scripts/exam.js
index 7d34c0192..e30f0c471 100644
--- a/runtime/scripts/exam.js
+++ b/runtime/scripts/exam.js
@@ -105,8 +105,8 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
         tryGetAttribute(settings,
             xml,
             'settings/navigation',
-            ['allowregen','navigatemode','reverse','browse','allowsteps','showfrontpage','showresultspage','preventleave','startpassword','allowAttemptDownload','downloadEncryptionKey'],
-            ['allowRegen','navigateMode','navigateReverse','navigateBrowse','allowSteps','showFrontPage','showResultsPage','preventLeave','startPassword','allowAttemptDownload','downloadEncryptionKey']);
+            ['allowregen','navigatemode','reverse','browse','allowsteps','showfrontpage','showresultspage','preventleave','typeendtoleave','startpassword','allowAttemptDownload','downloadEncryptionKey'],
+            ['allowRegen','navigateMode','navigateReverse','navigateBrowse','allowSteps','showFrontPage','showResultsPage','preventLeave','typeendtoleave','startPassword','allowAttemptDownload','downloadEncryptionKey']);
         //get navigation events and actions
         var navigationEventNodes = xml.selectNodes('settings/navigation/event');
         for( var i=0; i<navigationEventNodes.length; i++ ) {
@@ -228,7 +228,7 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
         }
         var navigation = tryGet(data,'navigation');
         if(navigation) {
-            tryLoad(navigation,['allowRegen','allowSteps','showFrontPage','showResultsPage','preventLeave','startPassword','allowAttemptDownload','downloadEncryptionKey','navigateMode'],settings);
+            tryLoad(navigation,['allowRegen','allowSteps','showFrontPage','showResultsPage','preventLeave','typeendtoleave','startPassword','allowAttemptDownload','downloadEncryptionKey','navigateMode'],settings);
             tryLoad(navigation,['reverse','browse'],settings,['navigateReverse','navigateBrowse']);
             var onleave = tryGet(navigation,'onleave');
             settings.navigationEvents.onleave = ExamEvent.createFromJSON('onleave',onleave);
@@ -355,6 +355,7 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
      * @property {boolean} shuffleQuestionGroups - randomize question group order?
      * @property {number} numQuestions - number of questions in this sitting
      * @property {boolean} preventLeave - prevent the browser from leaving the page while the exam is running?
+     * @property {boolean} typeendtoleave - require written confirmation before leaving the exam?
      * @property {string} startPassword - password the student must enter before beginning the exam
      * @property {boolean} allowRegen -can student re-randomise a question?
      * @property {boolean} allowAttemptDownload - Can the student download their results as a CSV?
@@ -1213,12 +1214,22 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
             message = R('control.not all questions submitted') + '<br/>' + message;
         }
         if(Numbas.display) {
-            Numbas.display.showConfirmEndExam(
-                message,
-                function() {
-                    exam.end(true);
-                }
-            );
+            if (exam.settings.typeendtoleave) {
+                Numbas.display.showConfirmEndExam(
+                    message,
+                    function() {
+                        exam.end(true);
+                    }
+                );
+            }
+            else {
+                Numbas.display.showConfirm(
+                    message,
+                    function() {
+                        exam.end(true);
+                    }
+                );
+            }
         } else {
             exam.end(true);
         }
diff --git a/schema/exam_schema.7.1.json b/schema/exam_schema.7.1.json
index d570a419d..8d3e6396f 100644
--- a/schema/exam_schema.7.1.json
+++ b/schema/exam_schema.7.1.json
@@ -303,6 +303,10 @@
                     "title": "Confirm before leaving the exam while it's running?",
                     "type": "boolean"
                 },
+                "typeendtoleave": {
+                    "title": "Require written confirmation before leaving the exam",
+                    "type": "boolean"
+                },
                 "reverse": {
                     "title": "Allow move to previous question?",
                     "type": "boolean"
diff --git a/tests/locales.js b/tests/locales.js
index 0ec4062cf..e1b1401c7 100644
--- a/tests/locales.js
+++ b/tests/locales.js
@@ -1475,7 +1475,8 @@ Numbas.locale = {
     "die.error": "Error",
     "extension.not found": "Couldn't load the extension <code>{{name}}</code>.",
     "modal.confirm": "Confirm",
-    "modal.confirm end exam": "Write '{{endConfirmation}}' in the box below to confirm.",
+    "modal.confirm end exam": "Write <code>{{endConfirmation}}</code> in the box to confirm:",
+    "modal.end exam button": "End exam",
     "modal.alert": "Alert",
     "modal.ok": "OK",
     "modal.cancel": "Cancel",
@@ -1559,7 +1560,9 @@ Numbas.locale = {
     "control.style options": "Display options",
     "control.move to next question": "Move to the next question",
     "control.show introduction": "Introduction",
-    "control.end confirmation": "end",
+    "control.confirm end.correct": "You may now end the exam.",
+    "control.confirm end.incorrect": "This is not the expected text.",
+    "control.confirm end.password": "end",
     "display.answer widget.unknown widget type": "The answer widget type <code>{{name}}</code> is not recognised.",
     "display.part.jme.error making maths": "Error making maths display",
     "display.error making html": "Error making HTML in {{contextDescription}}: {{-message}}",
@@ -1934,7 +1937,8 @@ Numbas.locale = {
     "worksheet.reconfigure": "Generate different sheets",
     "worksheet.show sheet": "Preview the sheet with ID:",
     "worksheet.answersheet show question content": "Show question content in answer sheets?"
-}}
+}
+}
 ,
         "en-school": {translation: 
 {
diff --git a/tests/numbas-runtime.js b/tests/numbas-runtime.js
index dd4242cbe..13d315bfc 100644
--- a/tests/numbas-runtime.js
+++ b/tests/numbas-runtime.js
@@ -23269,8 +23269,8 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
         tryGetAttribute(settings,
             xml,
             'settings/navigation',
-            ['allowregen','navigatemode','reverse','browse','allowsteps','showfrontpage','showresultspage','preventleave','startpassword','allowAttemptDownload','downloadEncryptionKey'],
-            ['allowRegen','navigateMode','navigateReverse','navigateBrowse','allowSteps','showFrontPage','showResultsPage','preventLeave','startPassword','allowAttemptDownload','downloadEncryptionKey']);
+            ['allowregen','navigatemode','reverse','browse','allowsteps','showfrontpage','showresultspage','preventleave','typeendtoleave','startpassword','allowAttemptDownload','downloadEncryptionKey'],
+            ['allowRegen','navigateMode','navigateReverse','navigateBrowse','allowSteps','showFrontPage','showResultsPage','preventLeave','typeendtoleave','startPassword','allowAttemptDownload','downloadEncryptionKey']);
         //get navigation events and actions
         var navigationEventNodes = xml.selectNodes('settings/navigation/event');
         for( var i=0; i<navigationEventNodes.length; i++ ) {
@@ -23392,7 +23392,7 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
         }
         var navigation = tryGet(data,'navigation');
         if(navigation) {
-            tryLoad(navigation,['allowRegen','allowSteps','showFrontPage','showResultsPage','preventLeave','startPassword','allowAttemptDownload','downloadEncryptionKey','navigateMode'],settings);
+            tryLoad(navigation,['allowRegen','allowSteps','showFrontPage','showResultsPage','preventLeave','typeendtoleave','startPassword','allowAttemptDownload','downloadEncryptionKey','navigateMode'],settings);
             tryLoad(navigation,['reverse','browse'],settings,['navigateReverse','navigateBrowse']);
             var onleave = tryGet(navigation,'onleave');
             settings.navigationEvents.onleave = ExamEvent.createFromJSON('onleave',onleave);
@@ -23519,6 +23519,7 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
      * @property {boolean} shuffleQuestionGroups - randomize question group order?
      * @property {number} numQuestions - number of questions in this sitting
      * @property {boolean} preventLeave - prevent the browser from leaving the page while the exam is running?
+     * @property {boolean} typeendtoleave - require written confirmation before leaving the exam?
      * @property {string} startPassword - password the student must enter before beginning the exam
      * @property {boolean} allowRegen -can student re-randomise a question?
      * @property {boolean} allowAttemptDownload - Can the student download their results as a CSV?
@@ -24377,12 +24378,22 @@ Exam.prototype = /** @lends Numbas.Exam.prototype */ {
             message = R('control.not all questions submitted') + '<br/>' + message;
         }
         if(Numbas.display) {
-            Numbas.display.showConfirmEndExam(
-                message,
-                function() {
-                    exam.end(true);
-                }
-            );
+            if (exam.settings.typeendtoleave) {
+                Numbas.display.showConfirmEndExam(
+                    message,
+                    function() {
+                        exam.end(true);
+                    }
+                );
+            }
+            else {
+                Numbas.display.showConfirm(
+                    message,
+                    function() {
+                        exam.end(true);
+                    }
+                );
+            }
         } else {
             exam.end(true);
         }
diff --git a/themes/default/templates/modals.html b/themes/default/templates/modals.html
index 415dc8389..30b167e04 100644
--- a/themes/default/templates/modals.html
+++ b/themes/default/templates/modals.html
@@ -47,7 +47,7 @@ <h4 id="confirm-end-exam-modal-title" data-localise="modal.confirm"></h4>
             </div>
             <div class="modal-footer">
                 <button type="button" class="cancel btn btn-default" data-dismiss="modal" data-localise="modal.cancel"></button>
-                <button type="button" class="ok btn btn-primary" data-dismiss="modal" data-bind="disable: !confirmEndHandler.valid(), css: confirmEndHandler.feedback().buttonClass" data-localise="modal.ok"></button>
+                <button type="button" class="ok btn btn-primary" data-dismiss="modal" data-bind="disable: !confirmEndHandler.valid(), css: confirmEndHandler.feedback().buttonClass" data-localise="modal.end exam button"></button>
             </div>
         </div>
     </div>