368 lines
13 KiB
TypeScript
368 lines
13 KiB
TypeScript
// (C) Copyright 2015 Moodle Pty Ltd.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import { Component, ElementRef, OnInit, ViewChild } from '@angular/core';
|
|
import { CoreQuestionQuestionParsed } from '@features/question/services/question';
|
|
import { CoreQuestionHelper } from '@features/question/services/question-helper';
|
|
import { IonContent, IonRefresher } from '@ionic/angular';
|
|
import { CoreNavigator } from '@services/navigator';
|
|
import { CoreDomUtils } from '@services/utils/dom';
|
|
import { CoreTextUtils } from '@services/utils/text';
|
|
import { CoreTimeUtils } from '@services/utils/time';
|
|
import { CoreUtils } from '@services/utils/utils';
|
|
import { ModalController, Translate } from '@singletons';
|
|
import {
|
|
AddonModQuizNavigationModalComponent,
|
|
AddonModQuizNavigationQuestion,
|
|
} from '../../components/navigation-modal/navigation-modal';
|
|
import {
|
|
AddonModQuiz,
|
|
AddonModQuizAttemptWSData,
|
|
AddonModQuizCombinedReviewOptions,
|
|
AddonModQuizGetAttemptReviewResponse,
|
|
AddonModQuizProvider,
|
|
AddonModQuizQuizWSData,
|
|
AddonModQuizWSAdditionalData,
|
|
} from '../../services/quiz';
|
|
import { AddonModQuizHelper } from '../../services/quiz-helper';
|
|
|
|
/**
|
|
* Page that allows reviewing a quiz attempt.
|
|
*/
|
|
@Component({
|
|
selector: 'page-addon-mod-quiz-review',
|
|
templateUrl: 'review.html',
|
|
styleUrls: ['review.scss'],
|
|
})
|
|
export class AddonModQuizReviewPage implements OnInit {
|
|
|
|
@ViewChild(IonContent) content?: IonContent;
|
|
|
|
attempt?: AddonModQuizAttemptWSData; // The attempt being reviewed.
|
|
component = AddonModQuizProvider.COMPONENT; // Component to link the files to.
|
|
showAll = false; // Whether to view all questions in the same page.
|
|
numPages?: number; // Number of pages.
|
|
showCompleted = false; // Whether to show completed time.
|
|
additionalData?: AddonModQuizWSAdditionalData[]; // Additional data to display for the attempt.
|
|
loaded = false; // Whether data has been loaded.
|
|
navigation: AddonModQuizNavigationQuestion[] = []; // List of questions to navigate them.
|
|
questions: QuizQuestion[] = []; // Questions of the current page.
|
|
nextPage = -2; // Next page.
|
|
previousPage = -2; // Previous page.
|
|
readableState?: string;
|
|
readableGrade?: string;
|
|
readableMark?: string;
|
|
timeTaken?: string;
|
|
overTime?: string;
|
|
quiz?: AddonModQuizQuizWSData; // The quiz the attempt belongs to.
|
|
courseId!: number; // The course ID the quiz belongs to.
|
|
cmId!: number; // Course module id the attempt belongs to.
|
|
|
|
protected attemptId!: number; // The attempt being reviewed.
|
|
protected currentPage!: number; // The current page being reviewed.
|
|
protected options?: AddonModQuizCombinedReviewOptions; // Review options.
|
|
|
|
constructor(
|
|
protected elementRef: ElementRef,
|
|
) {
|
|
}
|
|
|
|
/**
|
|
* Component being initialized.
|
|
*/
|
|
async ngOnInit(): Promise<void> {
|
|
this.cmId = CoreNavigator.instance.getRouteNumberParam('cmId')!;
|
|
this.courseId = CoreNavigator.instance.getRouteNumberParam('courseId')!;
|
|
this.attemptId = CoreNavigator.instance.getRouteNumberParam('attemptId')!;
|
|
this.currentPage = CoreNavigator.instance.getRouteNumberParam('page') || -1;
|
|
this.showAll = this.currentPage == -1;
|
|
|
|
try {
|
|
await this.fetchData();
|
|
|
|
CoreUtils.instance.ignoreErrors(
|
|
AddonModQuiz.instance.logViewAttemptReview(this.attemptId, this.quiz!.id, this.quiz!.name),
|
|
);
|
|
} finally {
|
|
this.loaded = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Change the current page. If slot is supplied, try to scroll to that question.
|
|
*
|
|
* @param page Page to load. -1 means all questions in same page.
|
|
* @param fromModal Whether the page was selected using the navigation modal.
|
|
* @param slot Slot of the question to scroll to.
|
|
*/
|
|
async changePage(page: number, fromModal?: boolean, slot?: number): Promise<void> {
|
|
if (typeof slot != 'undefined' && (this.attempt!.currentpage == -1 || page == this.currentPage)) {
|
|
// Scrol to a certain question in the current page.
|
|
this.scrollToQuestion(slot);
|
|
|
|
return;
|
|
} else if (page == this.currentPage) {
|
|
// If the user is navigating to the current page and no question specified, we do nothing.
|
|
return;
|
|
}
|
|
|
|
this.loaded = false;
|
|
this.content?.scrollToTop();
|
|
|
|
try {
|
|
await this.loadPage(page);
|
|
} catch (error) {
|
|
CoreDomUtils.instance.showErrorModalDefault(error, 'addon.mod_quiz.errorgetquestions', true);
|
|
} finally {
|
|
this.loaded = true;
|
|
|
|
if (typeof slot != 'undefined') {
|
|
// Scroll to the question. Give some time to the questions to render.
|
|
setTimeout(() => {
|
|
this.scrollToQuestion(slot);
|
|
}, 2000);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convenience function to get the quiz data.
|
|
*
|
|
* @return Promise resolved when done.
|
|
*/
|
|
protected async fetchData(): Promise<void> {
|
|
try {
|
|
this.quiz = await AddonModQuiz.instance.getQuiz(this.courseId, this.cmId);
|
|
|
|
this.options = await AddonModQuiz.instance.getCombinedReviewOptions(this.quiz.id, { cmId: this.cmId });
|
|
|
|
// Load the navigation data.
|
|
await this.loadNavigation();
|
|
|
|
// Load questions.
|
|
await this.loadPage(this.currentPage);
|
|
} catch (error) {
|
|
CoreDomUtils.instance.showErrorModalDefault(error, 'addon.mod_quiz.errorgetquiz', true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load a page questions.
|
|
*
|
|
* @param page The page to load.
|
|
* @return Promise resolved when done.
|
|
*/
|
|
protected async loadPage(page: number): Promise<void> {
|
|
const data = await AddonModQuiz.instance.getAttemptReview(this.attemptId, { page, cmId: this.quiz!.coursemodule });
|
|
|
|
this.attempt = data.attempt;
|
|
this.attempt.currentpage = page;
|
|
this.currentPage = page;
|
|
|
|
// Set the summary data.
|
|
this.setSummaryCalculatedData(data);
|
|
|
|
this.questions = data.questions;
|
|
this.nextPage = page == -1 ? -2 : page + 1;
|
|
this.previousPage = page - 1;
|
|
|
|
this.questions.forEach((question) => {
|
|
// Get the readable mark for each question.
|
|
question.readableMark = AddonModQuizHelper.instance.getQuestionMarkFromHtml(question.html);
|
|
|
|
// Extract the question info box.
|
|
CoreQuestionHelper.instance.extractQuestionInfoBox(question, '.info');
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Load data to navigate the questions using the navigation modal.
|
|
*
|
|
* @return Promise resolved when done.
|
|
*/
|
|
protected async loadNavigation(): Promise<void> {
|
|
// Get all questions in single page to retrieve all the questions.
|
|
const data = await AddonModQuiz.instance.getAttemptReview(this.attemptId, { page: -1, cmId: this.quiz!.coursemodule });
|
|
|
|
this.navigation = data.questions;
|
|
|
|
this.navigation.forEach((question) => {
|
|
question.stateClass = CoreQuestionHelper.instance.getQuestionStateClass(question.state || '');
|
|
});
|
|
|
|
const lastQuestion = data.questions[data.questions.length - 1];
|
|
this.numPages = lastQuestion ? lastQuestion.page + 1 : 0;
|
|
}
|
|
|
|
/**
|
|
* Refreshes data.
|
|
*
|
|
* @param refresher Refresher
|
|
*/
|
|
async refreshData(refresher: IonRefresher): Promise<void> {
|
|
const promises: Promise<void>[] = [];
|
|
|
|
promises.push(AddonModQuiz.instance.invalidateQuizData(this.courseId));
|
|
promises.push(AddonModQuiz.instance.invalidateAttemptReview(this.attemptId));
|
|
if (this.quiz) {
|
|
promises.push(AddonModQuiz.instance.invalidateCombinedReviewOptionsForUser(this.quiz.id));
|
|
}
|
|
|
|
await CoreUtils.instance.ignoreErrors(Promise.all(promises));
|
|
|
|
try {
|
|
await this.fetchData();
|
|
} finally {
|
|
refresher.complete();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Scroll to a certain question.
|
|
*
|
|
* @param slot Slot of the question to scroll to.
|
|
*/
|
|
protected scrollToQuestion(slot: number): void {
|
|
CoreDomUtils.instance.scrollToElementBySelector(
|
|
this.elementRef.nativeElement,
|
|
this.content,
|
|
`#addon-mod_quiz-question-${slot}`,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Calculate review summary data.
|
|
*
|
|
* @param data Result of getAttemptReview.
|
|
*/
|
|
protected setSummaryCalculatedData(data: AddonModQuizGetAttemptReviewResponse): void {
|
|
if (!this.attempt || !this.quiz) {
|
|
return;
|
|
}
|
|
|
|
this.readableState = AddonModQuiz.instance.getAttemptReadableStateName(this.attempt!.state || '');
|
|
|
|
if (this.attempt.state != AddonModQuizProvider.ATTEMPT_FINISHED) {
|
|
return;
|
|
}
|
|
|
|
this.showCompleted = true;
|
|
this.additionalData = data.additionaldata;
|
|
|
|
const timeTaken = (this.attempt.timefinish || 0) - (this.attempt.timestart || 0);
|
|
if (timeTaken > 0) {
|
|
// Format time taken.
|
|
this.timeTaken = CoreTimeUtils.instance.formatTime(timeTaken);
|
|
|
|
// Calculate overdue time.
|
|
if (this.quiz.timelimit && timeTaken > this.quiz.timelimit + 60) {
|
|
this.overTime = CoreTimeUtils.instance.formatTime(timeTaken - this.quiz.timelimit);
|
|
}
|
|
} else {
|
|
this.timeTaken = undefined;
|
|
}
|
|
|
|
// Treat grade.
|
|
if (this.options!.someoptions.marks >= AddonModQuizProvider.QUESTION_OPTIONS_MARK_AND_MAX &&
|
|
AddonModQuiz.instance.quizHasGrades(this.quiz)) {
|
|
|
|
if (data.grade === null || typeof data.grade == 'undefined') {
|
|
this.readableGrade = AddonModQuiz.instance.formatGrade(data.grade, this.quiz.decimalpoints);
|
|
} else {
|
|
// Show raw marks only if they are different from the grade (like on the entry page).
|
|
if (this.quiz.grade != this.quiz.sumgrades) {
|
|
this.readableMark = Translate.instance.instant('addon.mod_quiz.outofshort', { $a: {
|
|
grade: AddonModQuiz.instance.formatGrade(this.attempt.sumgrades, this.quiz.decimalpoints),
|
|
maxgrade: AddonModQuiz.instance.formatGrade(this.quiz.sumgrades, this.quiz.decimalpoints),
|
|
} });
|
|
}
|
|
|
|
// Now the scaled grade.
|
|
const gradeObject: Record<string, unknown> = {
|
|
grade: AddonModQuiz.instance.formatGrade(Number(data.grade), this.quiz.decimalpoints),
|
|
maxgrade: AddonModQuiz.instance.formatGrade(this.quiz.grade, this.quiz.decimalpoints),
|
|
};
|
|
|
|
if (this.quiz.grade != 100) {
|
|
gradeObject.percent = CoreTextUtils.instance.roundToDecimals(
|
|
this.attempt.sumgrades! * 100 / this.quiz.sumgrades!,
|
|
0,
|
|
);
|
|
this.readableGrade = Translate.instance.instant('addon.mod_quiz.outofpercent', { $a: gradeObject });
|
|
} else {
|
|
this.readableGrade = Translate.instance.instant('addon.mod_quiz.outof', { $a: gradeObject });
|
|
}
|
|
}
|
|
}
|
|
|
|
// Treat additional data.
|
|
this.additionalData.forEach((data) => {
|
|
// Remove help links from additional data.
|
|
data.content = CoreDomUtils.instance.removeElementFromHtml(data.content, '.helptooltip');
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Switch mode: all questions in same page OR one page at a time.
|
|
*/
|
|
switchMode(): void {
|
|
this.showAll = !this.showAll;
|
|
|
|
// Load all questions or first page, depending on the mode.
|
|
this.loadPage(this.showAll ? -1 : 0);
|
|
}
|
|
|
|
async openNavigation(): Promise<void> {
|
|
// Create the navigation modal.
|
|
const modal = await ModalController.instance.create({
|
|
component: AddonModQuizNavigationModalComponent,
|
|
componentProps: {
|
|
navigation: this.navigation,
|
|
summaryShown: false,
|
|
currentPage: this.attempt?.currentpage,
|
|
isReview: true,
|
|
numPages: this.numPages,
|
|
showAll: this.showAll,
|
|
},
|
|
cssClass: 'core-modal-lateral',
|
|
showBackdrop: true,
|
|
backdropDismiss: true,
|
|
// @todo enterAnimation: 'core-modal-lateral-transition',
|
|
// @todo leaveAnimation: 'core-modal-lateral-transition',
|
|
});
|
|
|
|
await modal.present();
|
|
|
|
const result = await modal.onWillDismiss();
|
|
|
|
if (!result.data) {
|
|
return;
|
|
}
|
|
|
|
if (result.data.action == AddonModQuizNavigationModalComponent.CHANGE_PAGE) {
|
|
this.changePage(result.data.page, true, result.data.slot);
|
|
} else if (result.data.action == AddonModQuizNavigationModalComponent.SWITCH_MODE) {
|
|
this.switchMode();
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Question with some calculated data for the view.
|
|
*/
|
|
type QuizQuestion = CoreQuestionQuestionParsed & {
|
|
readableMark?: string;
|
|
};
|