ce0d3597a67811aebe83958f10b48a5938afd534
[moodle.git] / mod / quiz / module.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * JavaScript library for the quiz module.
18  *
19  * @package    mod
20  * @subpackage quiz
21  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 M.mod_quiz = M.mod_quiz || {};
27 M.mod_quiz.init_attempt_form = function(Y) {
28     M.core_question_engine.init_form(Y, '#responseform');
29     Y.on('submit', M.mod_quiz.timer.stop, '#responseform');
30     M.core_formchangechecker.init({formid: 'responseform'});
31 };
33 M.mod_quiz.init_review_form = function(Y) {
34     M.core_question_engine.init_form(Y, '.questionflagsaveform');
35     Y.on('submit', function(e) { e.halt(); }, '.questionflagsaveform');
36 };
38 M.mod_quiz.init_comment_popup = function(Y) {
39     // Add a close button to the window.
40     var closebutton = Y.Node.create('<input type="button" />');
41     closebutton.set('value', M.util.get_string('cancel', 'moodle'));
42     Y.one('#id_submitbutton').ancestor().append(closebutton);
43     Y.on('click', function() { window.close() }, closebutton);
44 }
46 // Code for updating the countdown timer that is used on timed quizzes.
47 M.mod_quiz.timer = {
48     // YUI object.
49     Y: null,
51     // Timestamp at which time runs out, according to the student's computer's clock.
52     endtime: 0,
54     // This records the id of the timeout that updates the clock periodically,
55     // so we can cancel.
56     timeoutid: null,
58     /**
59      * @param Y the YUI object
60      * @param timeleft, the time remaining, in seconds.
61      */
62     init: function(Y, timeleft) {
63         M.mod_quiz.timer.Y = Y;
64         M.mod_quiz.timer.endtime = new Date().getTime() + timeleft*1000;
65         M.mod_quiz.timer.update();
66         Y.one('#quiz-timer').setStyle('display', 'block');
67     },
69     /**
70      * Stop the timer, if it is running.
71      */
72     stop: function(e) {
73         if (M.mod_quiz.timer.timeoutid) {
74             clearTimeout(M.mod_quiz.timer.timeoutid);
75         }
76     },
78     /**
79      * Function to convert a number between 0 and 99 to a two-digit string.
80      */
81     two_digit: function(num) {
82         if (num < 10) {
83             return '0' + num;
84         } else {
85             return num;
86         }
87     },
89     // Function to update the clock with the current time left, and submit the quiz if necessary.
90     update: function() {
91         var Y = M.mod_quiz.timer.Y;
92         var secondsleft = Math.floor((M.mod_quiz.timer.endtime - new Date().getTime())/1000);
94         // If time has expired, Set the hidden form field that says time has expired.
95         if (secondsleft < 0) {
96             M.mod_quiz.timer.stop(null);
97             Y.one('#quiz-time-left').setContent(M.str.quiz.timesup);
98             var input = Y.one('input[name=timeup]');
99             input.set('value', 1);
100             var form = input.ancestor('form');
101             if (form.one('input[name=finishattempt]')) {
102                 form.one('input[name=finishattempt]').set('value', 0);
103             }
104             form.submit();
105             return;
106         }
108         // If time has nearly expired, change the colour.
109         if (secondsleft < 100) {
110             Y.one('#quiz-timer').removeClass('timeleft' + (secondsleft + 2))
111                     .removeClass('timeleft' + (secondsleft + 1))
112                     .addClass('timeleft' + secondsleft);
113         }
115         // Update the time display.
116         var hours = Math.floor(secondsleft/3600);
117         secondsleft -= hours*3600;
118         var minutes = Math.floor(secondsleft/60);
119         secondsleft -= minutes*60;
120         var seconds = secondsleft;
121         Y.one('#quiz-time-left').setContent(hours + ':' +
122                 M.mod_quiz.timer.two_digit(minutes) + ':' +
123                 M.mod_quiz.timer.two_digit(seconds));
125         // Arrange for this method to be called again soon.
126         M.mod_quiz.timer.timeoutid = setTimeout(M.mod_quiz.timer.update, 100);
127     }
128 };
130 M.mod_quiz.nav = M.mod_quiz.nav || {};
132 M.mod_quiz.nav.update_flag_state = function(attemptid, questionid, newstate) {
133     var Y = M.mod_quiz.nav.Y;
134     var navlink = Y.one('#quiznavbutton' + questionid);
135     navlink.removeClass('flagged');
136     if (newstate == 1) {
137         navlink.addClass('flagged');
138         navlink.one('.accesshide .flagstate').setContent(M.str.question.flagged);
139     } else {
140         navlink.one('.accesshide .flagstate').setContent('');
141     }
142 };
144 M.mod_quiz.nav.init = function(Y) {
145     M.mod_quiz.nav.Y = Y;
147     Y.all('#quiznojswarning').remove();
149     var form = Y.one('#responseform');
150     if (form) {
151         function find_enabled_submit() {
152             // This is rather inelegant, but the CSS3 selector
153             //     return form.one('input[type=submit]:enabled');
154             // does not work in IE7, 8 or 9 for me.
155             var enabledsubmit = null;
156             form.all('input[type=submit]').each(function(submit) {
157                 if (!enabledsubmit && !submit.get('disabled')) {
158                     enabledsubmit = submit;
159                 }
160             });
161             return enabledsubmit;
162         }
164         function nav_to_page(pageno) {
165             Y.one('#followingpage').set('value', pageno);
167             // Automatically submit the form. We do it this strange way because just
168             // calling form.submit() does not run the form's submit event handlers.
169             var submit = find_enabled_submit();
170             submit.set('name', '');
171             submit.getDOMNode().click();
172         };
174         Y.delegate('click', function(e) {
175             if (this.hasClass('thispage')) {
176                 return;
177             }
179             e.preventDefault();
181             var pageidmatch = this.get('href').match(/page=(\d+)/);
182             var pageno;
183             if (pageidmatch) {
184                 pageno = pageidmatch[1];
185             } else {
186                 pageno = 0;
187             }
189             var questionidmatch = this.get('href').match(/#q(\d+)/);
190             if (questionidmatch) {
191                 form.set('action', form.get('action') + '#q' + questionidmatch[1]);
192             }
194             nav_to_page(pageno);
195         }, document.body, '.qnbutton');
196     }
198     if (Y.one('a.endtestlink')) {
199         Y.on('click', function(e) {
200             e.preventDefault();
201             nav_to_page(-1);
202         }, 'a.endtestlink');
203     }
205     if (M.core_question_flags) {
206         M.core_question_flags.add_listener(M.mod_quiz.nav.update_flag_state);
207     }
208 };
210 M.mod_quiz.secure_window = {
211     init: function(Y) {
212         if (window.location.href.substring(0, 4) == 'file') {
213             window.location = 'about:blank';
214         }
215         Y.delegate('contextmenu', M.mod_quiz.secure_window.prevent, document, '*');
216         Y.delegate('mousedown',   M.mod_quiz.secure_window.prevent_mouse, document, '*');
217         Y.delegate('mouseup',     M.mod_quiz.secure_window.prevent_mouse, document, '*');
218         Y.delegate('dragstart',   M.mod_quiz.secure_window.prevent, document, '*');
219         Y.delegate('selectstart', M.mod_quiz.secure_window.prevent, document, '*');
220         Y.delegate('cut',         M.mod_quiz.secure_window.prevent, document, '*');
221         Y.delegate('copy',        M.mod_quiz.secure_window.prevent, document, '*');
222         Y.delegate('paste',       M.mod_quiz.secure_window.prevent, document, '*');
223         M.mod_quiz.secure_window.clear_status;
224         Y.on('beforeprint', function() {
225             Y.one(document.body).setStyle('display', 'none');
226         }, window);
227         Y.on('afterprint', function() {
228             Y.one(document.body).setStyle('display', 'block');
229         }, window);
230         Y.on('key', M.mod_quiz.secure_window.prevent, '*', 'press:67,86,88+ctrl');
231         Y.on('key', M.mod_quiz.secure_window.prevent, '*', 'up:67,86,88+ctrl');
232         Y.on('key', M.mod_quiz.secure_window.prevent, '*', 'down:67,86,88+ctrl');
233         Y.on('key', M.mod_quiz.secure_window.prevent, '*', 'press:67,86,88+meta');
234         Y.on('key', M.mod_quiz.secure_window.prevent, '*', 'up:67,86,88+meta');
235         Y.on('key', M.mod_quiz.secure_window.prevent, '*', 'down:67,86,88+meta');
236     },
238     clear_status: function() {
239         window.status = '';
240         setTimeout(M.mod_quiz.secure_window.clear_status, 10);
241     },
243     prevent: function(e) {
244         alert(M.str.quiz.functiondisabledbysecuremode);
245         e.halt();
246     },
248     prevent_mouse: function(e) {
249         if (e.button == 1 && /^(INPUT|TEXTAREA|BUTTON|SELECT|LABEL|A)$/i.test(e.target.get('tagName'))) {
250             // Left click on a button or similar. No worries.
251             return;
252         }
253         e.halt();
254     },
256     /**
257      * Event handler for the quiz start attempt button.
258      */
259     start_attempt_action: function(e, args) {
260         if (args.startattemptwarning == '') {
261             openpopup(e, args);
262         } else {
263             M.util.show_confirm_dialog(e, {
264                 message: args.startattemptwarning,
265                 callback: function() {
266                     openpopup(e, args);
267                 },
268                 continuelabel: M.util.get_string('startattempt', 'quiz')
269             });
270         }
271     },
273     init_close_button: function(Y, url) {
274         Y.on('click', function(e) {
275             M.mod_quiz.secure_window.close(url, 0)
276         }, '#secureclosebutton');
277     },
279     close: function(Y, url, delay) {
280         setTimeout(function() {
281             if (window.opener) {
282                 window.opener.document.location.reload();
283                 window.close();
284             } else {
285                 window.location.href = url;
286             }
287         }, delay*1000);
288     }
289 };