This repository has been archived by the owner on May 11, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 863
/
interface.js
577 lines (469 loc) · 17.7 KB
/
interface.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
/**
* Interface glue to handle events from 'Exercises' and talk to 'Khan' or some
* Perseus object, whichever is appropriate for the current exercise.
*
* In general, khan-exercises and perseus will want to trigger events on
* Exercises but only listen to their own events.
*/
(function() {
// If any of these properties have already been defined, then leave them --
// this happens in local mode
_.defaults(Exercises, {
khanExercisesUrlBase: "/khan-exercises/",
getCurrentFramework: function(userExerciseOverride) {
return (userExerciseOverride || userExercise).exerciseModel.fileName
? "khan-exercises" : "perseus";
}
});
_.extend(Exercises, {
guessLog: undefined,
userActivityLog: undefined
});
var PerseusBridge = Exercises.PerseusBridge,
// Store localMode here so that it's hard to change after the fact via
// bookmarklet, etc.
localMode = Exercises.localMode,
originalCheckAnswerText,
userExercise,
problemNum,
answeredCorrectly,
hintsAreFree,
attempts,
numHints,
hintsUsed,
lastAttemptOrHint;
$(Exercises)
.bind("problemTemplateRendered", problemTemplateRendered)
.bind("newProblem", newProblem)
.bind("hintUsed", onHintUsed)
.bind("readyForNextProblem", readyForNextProblem)
.bind("warning", warning)
.bind("upcomingExercise", upcomingExercise)
.bind("gotoNextProblem", gotoNextProblem)
.bind("updateUserExercise", updateUserExercise)
.bind("clearExistingProblem", clearExistingProblem);
function problemTemplateRendered() {
// Setup appropriate img URLs
$("#issue-throbber").attr("src",
Exercises.khanExercisesUrlBase + "css/images/throbber.gif");
$("#positive-reinforcement").hide();
if (localMode) {
// The /khan-exercises/images/ folder isn't available in GAE prod so
// don't change the src there, even though it would kind of work.
$("#positive-reinforcement > img").attr("src",
Exercises.khanExercisesUrlBase + "images/face-smiley.png");
}
// 'Check Answer' or 'Submit Answer'
originalCheckAnswerText = $("#check-answer-button").val();
// Solution submission
$("#check-answer-button").click(handleCheckAnswer);
$("#answerform").submit(handleCheckAnswer);
$("#skip-question-button").click(handleSkippedQuestion);
// Hint button
$("#hint").click(onHintButtonClicked);
// Next question button
$("#next-question-button").click(function() {
$(Exercises).trigger("gotoNextProblem");
// Disable next question button until next time
// TODO(alpert): Why? Is blurring not enough?
$(this)
.attr("disabled", true)
.addClass("buttonDisabled");
});
// If happy face is clicked, pass click on through.
$("#positive-reinforcement").click(function() {
$("#next-question-button").click();
});
// Let users close the warning bar when appropriate
$("#warning-bar-close a").click(function(e) {
e.preventDefault();
$("#warning-bar").fadeOut("slow");
});
// Scratchpad toggle
$("#scratchpad-show").click(function(e) {
e.preventDefault();
Khan.scratchpad.toggle();
if (!localMode && userExercise.user) {
window.localStorage["scratchpad:" + userExercise.user] =
Khan.scratchpad.isVisible();
}
});
// These shouldn't interfere...
$(PerseusBridge).trigger("problemTemplateRendered");
$(Khan).trigger("problemTemplateRendered");
}
function newProblem(e, data) {
Exercises.guessLog = [];
Exercises.userActivityLog = [];
answeredCorrectly = false,
hintsAreFree = false,
attempts = 0;
numHints = data.numHints;
hintsUsed = 0;
lastAttemptOrHint = new Date().getTime();
var framework = Exercises.getCurrentFramework();
$("#problem-and-answer")
.removeClass("framework-khan-exercises")
.removeClass("framework-perseus")
.addClass("framework-" + framework);
// Enable/disable the get hint button
$("#hint").attr("disabled", numHints === 0);
}
function handleCheckAnswer() {
return handleAttempt({skipped: false});
}
function handleSkippedQuestion() {
return handleAttempt({skipped: true});
}
function handleAttempt(data) {
var framework = Exercises.getCurrentFramework();
var skipped = data.skipped;
var score;
if (framework === "perseus") {
score = PerseusBridge.scoreInput();
} else if (framework === "khan-exercises") {
score = Khan.scoreInput();
}
// Stop if the user didn't try to skip the question and also didn't yet
// enter a response
if (score.empty && !skipped) {
return false;
}
var curTime = new Date().getTime();
var timeTaken = Math.round((curTime - lastAttemptOrHint) / 1000);
var stringifiedGuess = JSON.stringify(score.guess);
var attemptData = null;
if (!localMode) {
attemptData = buildAttemptData(
score.correct, ++attempts, stringifiedGuess, timeTaken, skipped);
}
lastAttemptOrHint = curTime;
Exercises.guessLog.push(score.guess);
Exercises.userActivityLog.push([
score.correct ? "correct-activity" : "incorrect-activity",
stringifiedGuess, timeTaken]);
if (score.correct) {
answeredCorrectly = true;
$(Exercises).trigger("problemDone", {
card: Exercises.currentCard,
attempts: attempts
});
}
// Update interface corresponding to correctness
if (Exercises.assessmentMode) {
disableCheckAnswer();
} else if (score.correct) {
// Correct answer, so show the next question button.
$("#check-answer-button").hide();
$("#check-answer-results > p").hide();
$("#next-question-button")
.prop("disabled", false)
.removeClass("buttonDisabled")
.show()
.focus();
$("#positive-reinforcement").show();
} else {
// Wrong answer. Enable all the input elements
$("#check-answer-button")
.parent() // .check-answer-wrapper makes shake behave
.effect("shake", {times: 3, distance: 5}, 480)
.val("Try Again");
// Is this a message to be shown?
if (score.message != null) {
$("#check-answer-results > p").html(score.message).tmpl().show();
} else {
$("#check-answer-results > p").hide();
}
if (framework === "perseus") {
// TODO(alpert)?
} else if (framework === "khan-exercises") {
$(Khan).trigger("refocusSolutionInput");
}
}
if (!hintsAreFree) {
hintsAreFree = true;
$(".hint-box")
.css("position", "relative")
.animate({top: -10}, 250)
.find(".info-box-header")
.slideUp(250)
.end()
.find("#hint")
.removeClass("orange")
.addClass("green");
updateHintButtonText();
}
$(Exercises).trigger("checkAnswer", {
correct: score.correct,
card: Exercises.currentCard,
// Determine if this attempt qualifies as fast completion
fast: !localMode && userExercise.secondsPerFastProblem >= timeTaken
});
if (localMode) {
// Skip the server; just pretend we have success
return false;
}
// Save the problem results to the server
var requestUrl = "problems/" + problemNum + "/attempt";
request(requestUrl, attemptData).fail(function(xhr) {
// Alert any listeners of the error before reload
$(Exercises).trigger("attemptError");
if (xhr && xhr.readyState === 0) {
// This path gets called when there is a broken pipe during
// page unload- browser navigating away during ajax request
// See http://stackoverflow.com/a/1370383.
return;
}
// Error during submit. Disable the page and ask users to
// reload in an attempt to get updated data.
// Hide the page so users don't continue, then warn the user about the
// problem and encourage reloading the page
$("#problem-and-answer").css("visibility", "hidden");
$(Exercises).trigger("warning",
"This page is out of date. You need to <a href='" +
_.escape(window.location.href) + "'>refresh</a>, but " +
"don't worry, you haven't lost progress. If you think " +
"this is a mistake, <a href='http://www.khanacademy.org/" +
"reportissue?type=Defect&issue_labels='>tell us</a>.");
});
return false;
}
function onHintButtonClicked() {
var framework = Exercises.getCurrentFramework();
if (framework === "perseus") {
$(PerseusBridge).trigger("showHint");
} else if (framework === "khan-exercises") {
$(Khan).trigger("showHint");
}
}
function onHintUsed() {
// Grow the scratchpad to cover the new hint
Khan.scratchpad.resize();
hintsUsed++;
updateHintButtonText();
// If there aren't any more hints, disable the get hint button
if (hintsUsed === numHints) {
$("#hint").attr("disabled", true);
$(Exercises).trigger("allHintsUsed");
}
var curTime = new Date().getTime();
var timeTaken = Math.round((curTime - lastAttemptOrHint) / 1000);
lastAttemptOrHint = curTime;
Exercises.userActivityLog.push(["hint-activity", "0", timeTaken]);
if (!localMode && !userExercise.readOnly && !answeredCorrectly) {
// Don't do anything on success or failure; silently failing is ok here
request("problems/" + problemNum + "/hint",
buildAttemptData(false, attempts, "hint", timeTaken, false));
}
}
function updateHintButtonText() {
var $hintButton = $("#hint");
var hintsLeft = numHints - hintsUsed;
if (hintsAreFree) {
$hintButton.val(hintsUsed ?
"Show next step (" + hintsLeft + " left)" :
"Show solution");
} else {
$hintButton.val("I'd like another hint (" +
(hintsLeft === 1 ?
"1 hint left" :
hintsLeft + " hints left")
+ ")");
}
}
// Build the data to pass to the server
function buildAttemptData(correct, attemptNum, attemptContent, timeTaken,
skipped) {
var framework = Exercises.getCurrentFramework();
var data;
if (framework === "perseus") {
data = PerseusBridge.getSeedInfo();
} else if (framework === "khan-exercises") {
data = Khan.getSeedInfo();
}
_.extend(data, {
// Ask for camel casing in returned response
casing: "camel",
// Whether we're moving to the next problem (i.e., correctness)
complete: correct ? 1 : 0,
count_hints: hintsUsed,
time_taken: timeTaken,
// How many times the problem was attempted
attempt_number: attemptNum,
// The answer the user gave
attempt_content: attemptContent,
// Whether we're currently in review mode
review_mode: Exercises.reviewMode ? 1 : 0,
// Whether we are currently working on a topic, as opposed to an exercise
topic_mode: (!Exercises.reviewMode && !Exercises.practiceMode) ? 1 : 0,
// If working in the context of a LearningTask (on the new learning
// dashboard), supply the task ID.
task_id: Exercises.learningTask && Exercises.learningTask.get("id"),
// The current card data
card: JSON.stringify(Exercises.currentCard),
// Unique ID of the cached stack
stack_uid: Exercises.completeStack.getUid(),
// The current topic, if any
topic_slug: Exercises.topic && Exercises.topic.get("slug"),
// How many cards the user has already done
cards_done: Exercises.completeStack.length,
// How many cards the user has left to do
cards_left: Exercises.incompleteStack.length - 1,
// The user assessment key if in assessmentMode
user_assessment_key: Exercises.userAssessmentKey,
// Whether the user is skipping the question
skipped: skipped ? 1 : 0
});
return data;
}
var attemptHintQueue = jQuery({});
// If there are any requests left in the queue when the window unloads then we
// will have permanently lost their answers and will need to clear the session
// cache, to make sure we don't override what is passed down from the servers
$(window).unload(function() {
if (attemptHintQueue.queue().length) {
$(Exercises).trigger("attemptError");
}
});
function request(method, data) {
var apiBaseUrl = (Exercises.assessmentMode ?
"/api/v1/user/assessment/exercises" : "/api/v1/user/exercises");
var params = {
// Do a request to the server API
url: apiBaseUrl + "/" + userExercise.exerciseModel.name + "/" + method,
type: "POST",
data: data,
dataType: "json"
};
var deferred = $.Deferred();
attemptHintQueue.queue(function(next) {
$.ajax(params).then(function(data, textStatus, jqXHR) {
deferred.resolve(data, textStatus, jqXHR);
// Tell any listeners that we now have new userExercise data
$(Exercises).trigger("updateUserExercise", {
userExercise: data,
source: "serverResponse"
});
}, function(jqXHR, textStatus, errorThrown) {
// Execute passed error function first in case it wants different
// behavior depending upon the length of the request queue
// TODO(alpert): Huh? Don't think this matters.
deferred.reject(jqXHR, textStatus, errorThrown);
// Clear the queue so we don't spit out a bunch of queued up
// requests after the error
attemptHintQueue.clearQueue();
}).always(function() {
$(Exercises).trigger("apiRequestEnded");
next();
});
});
// Trigger an apiRequestStarted event here, and not in the queued function
// because listeners should know an API request is waiting as soon as it
// gets queued up.
$(Exercises).trigger("apiRequestStarted");
return deferred.promise();
}
function readyForNextProblem(e, data) {
userExercise = data.userExercise;
problemNum = userExercise.totalDone + 1;
$(Exercises).trigger("updateUserExercise", {userExercise: userExercise});
// (framework depends on userExercise set above)
var framework = Exercises.getCurrentFramework();
if (framework === "perseus") {
$(PerseusBridge).trigger("readyForNextProblem", data);
} else if (framework === "khan-exercises") {
$(Khan).trigger("readyForNextProblem", data);
}
}
function warning(e, message, showClose) {
$(function() {
var warningBar = $("#warning-bar");
$("#warning-bar-content").html(message);
if (showClose) {
warningBar.addClass("warning")
.children("#warning-bar-close").show();
} else {
warningBar.addClass("error")
.children("#warning-bar-close").hide();
}
warningBar.fadeIn("fast");
});
}
function upcomingExercise(e, data) {
var framework = Exercises.getCurrentFramework(data.userExercise);
if (framework === "perseus") {
$(PerseusBridge).trigger("upcomingExercise", data);
} else if (framework === "khan-exercises") {
$(Khan).trigger("upcomingExercise", data);
}
}
function gotoNextProblem() {
var framework = Exercises.getCurrentFramework();
if (framework === "perseus") {
// TODO(alpert)
} else if (framework === "khan-exercises") {
$(Khan).trigger("gotoNextProblem");
}
}
function updateUserExercise(e, data) {
var framework = Exercises.getCurrentFramework();
if (framework === "perseus") {
// TODO(alpert)
} else if (framework === "khan-exercises") {
$(Khan).trigger("updateUserExercise", data);
}
}
function enableCheckAnswer() {
$("#check-answer-button")
.prop("disabled", false)
.removeClass("buttonDisabled")
.val(originalCheckAnswerText);
$("#skip-question-button")
.prop("disabled", false)
.removeClass("buttonDisabled");
}
function disableCheckAnswer() {
$("#check-answer-button")
.prop("disabled", true)
.addClass("buttonDisabled")
.val("Please wait...");
$("#skip-question-button")
.prop("disabled", true)
.addClass("buttonDisabled");
}
function clearExistingProblem() {
var framework = Exercises.getCurrentFramework();
enableCheckAnswer();
$("#happy").hide();
if (!$("#examples-show").data("show")) {
// TODO(alpert): What does this do?
$("#examples-show").click();
}
// Toggle the navigation buttons
$("#check-answer-button").show();
$("#next-question-button").blur().hide();
$("#positive-reinforcement").hide();
// Wipe out any previous problem
if (framework === "perseus") {
// TODO(alpert): Do we have cleanup to do?
} else if (framework === "khan-exercises") {
$(Khan).trigger("cleanupProblem");
}
$("#workarea, #hintsarea, #solutionarea").empty();
// Take off the event handlers for disabling check answer; we'll rebind
// if we actually want them
$("#solutionarea").off(".emptyAnswer");
// Restore the hint button's original appearance
$("#hint")
.removeClass("green")
.addClass("orange")
.val("I'd like a hint")
.data("buttonText", false)
.appendTo("#get-hint-button-container");
$(".hint-box")
.css("top", 0)
.find(".info-box-header")
.show();
Khan.scratchpad.clear();
}
})();