b0b564f625e8233d11037a03f4790a28ed8013ed
[moodle.git] / mod / lesson / locallib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Local library file for Lesson.  These are non-standard functions that are used
20  * only by Lesson.
21  *
22  * @package mod_lesson
23  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
25  **/
27 /** Make sure this isn't being directly accessed */
28 defined('MOODLE_INTERNAL') || die();
30 /** Include the files that are required by this module */
31 require_once($CFG->dirroot.'/course/moodleform_mod.php');
32 require_once($CFG->dirroot . '/mod/lesson/lib.php');
33 require_once($CFG->libdir . '/filelib.php');
35 /** This page */
36 define('LESSON_THISPAGE', 0);
37 /** Next page -> any page not seen before */
38 define("LESSON_UNSEENPAGE", 1);
39 /** Next page -> any page not answered correctly */
40 define("LESSON_UNANSWEREDPAGE", 2);
41 /** Jump to Next Page */
42 define("LESSON_NEXTPAGE", -1);
43 /** End of Lesson */
44 define("LESSON_EOL", -9);
45 /** Jump to an unseen page within a branch and end of branch or end of lesson */
46 define("LESSON_UNSEENBRANCHPAGE", -50);
47 /** Jump to Previous Page */
48 define("LESSON_PREVIOUSPAGE", -40);
49 /** Jump to a random page within a branch and end of branch or end of lesson */
50 define("LESSON_RANDOMPAGE", -60);
51 /** Jump to a random Branch */
52 define("LESSON_RANDOMBRANCH", -70);
53 /** Cluster Jump */
54 define("LESSON_CLUSTERJUMP", -80);
55 /** Undefined */
56 define("LESSON_UNDEFINED", -99);
58 /** LESSON_MAX_EVENT_LENGTH = 432000 ; 5 days maximum */
59 define("LESSON_MAX_EVENT_LENGTH", "432000");
61 /** Answer format is HTML */
62 define("LESSON_ANSWER_HTML", "HTML");
64 /** Placeholder answer for all other answers. */
65 define("LESSON_OTHER_ANSWERS", "@#wronganswer#@");
67 //////////////////////////////////////////////////////////////////////////////////////
68 /// Any other lesson functions go here.  Each of them must have a name that
69 /// starts with lesson_
71 /**
72  * Checks to see if a LESSON_CLUSTERJUMP or
73  * a LESSON_UNSEENBRANCHPAGE is used in a lesson.
74  *
75  * This function is only executed when a teacher is
76  * checking the navigation for a lesson.
77  *
78  * @param stdClass $lesson Id of the lesson that is to be checked.
79  * @return boolean True or false.
80  **/
81 function lesson_display_teacher_warning($lesson) {
82     global $DB;
84     // get all of the lesson answers
85     $params = array ("lessonid" => $lesson->id);
86     if (!$lessonanswers = $DB->get_records_select("lesson_answers", "lessonid = :lessonid", $params)) {
87         // no answers, then not using cluster or unseen
88         return false;
89     }
90     // just check for the first one that fulfills the requirements
91     foreach ($lessonanswers as $lessonanswer) {
92         if ($lessonanswer->jumpto == LESSON_CLUSTERJUMP || $lessonanswer->jumpto == LESSON_UNSEENBRANCHPAGE) {
93             return true;
94         }
95     }
97     // if no answers use either of the two jumps
98     return false;
99 }
101 /**
102  * Interprets the LESSON_UNSEENBRANCHPAGE jump.
103  *
104  * will return the pageid of a random unseen page that is within a branch
105  *
106  * @param lesson $lesson
107  * @param int $userid Id of the user.
108  * @param int $pageid Id of the page from which we are jumping.
109  * @return int Id of the next page.
110  **/
111 function lesson_unseen_question_jump($lesson, $user, $pageid) {
112     global $DB;
114     // get the number of retakes
115     if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$lesson->id, "userid"=>$user))) {
116         $retakes = 0;
117     }
119     // get all the lesson_attempts aka what the user has seen
120     if ($viewedpages = $DB->get_records("lesson_attempts", array("lessonid"=>$lesson->id, "userid"=>$user, "retry"=>$retakes), "timeseen DESC")) {
121         foreach($viewedpages as $viewed) {
122             $seenpages[] = $viewed->pageid;
123         }
124     } else {
125         $seenpages = array();
126     }
128     // get the lesson pages
129     $lessonpages = $lesson->load_all_pages();
131     if ($pageid == LESSON_UNSEENBRANCHPAGE) {  // this only happens when a student leaves in the middle of an unseen question within a branch series
132         $pageid = $seenpages[0];  // just change the pageid to the last page viewed inside the branch table
133     }
135     // go up the pages till branch table
136     while ($pageid != 0) { // this condition should never be satisfied... only happens if there are no branch tables above this page
137         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
138             break;
139         }
140         $pageid = $lessonpages[$pageid]->prevpageid;
141     }
143     $pagesinbranch = $lesson->get_sub_pages_of($pageid, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
145     // this foreach loop stores all the pages that are within the branch table but are not in the $seenpages array
146     $unseen = array();
147     foreach($pagesinbranch as $page) {
148         if (!in_array($page->id, $seenpages)) {
149             $unseen[] = $page->id;
150         }
151     }
153     if(count($unseen) == 0) {
154         if(isset($pagesinbranch)) {
155             $temp = end($pagesinbranch);
156             $nextpage = $temp->nextpageid; // they have seen all the pages in the branch, so go to EOB/next branch table/EOL
157         } else {
158             // there are no pages inside the branch, so return the next page
159             $nextpage = $lessonpages[$pageid]->nextpageid;
160         }
161         if ($nextpage == 0) {
162             return LESSON_EOL;
163         } else {
164             return $nextpage;
165         }
166     } else {
167         return $unseen[rand(0, count($unseen)-1)];  // returns a random page id for the next page
168     }
171 /**
172  * Handles the unseen branch table jump.
173  *
174  * @param lesson $lesson
175  * @param int $userid User id.
176  * @return int Will return the page id of a branch table or end of lesson
177  **/
178 function lesson_unseen_branch_jump($lesson, $userid) {
179     global $DB;
181     if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$lesson->id, "userid"=>$userid))) {
182         $retakes = 0;
183     }
185     if (!$seenbranches = $lesson->get_content_pages_viewed($retakes, $userid, 'timeseen DESC')) {
186         print_error('cannotfindrecords', 'lesson');
187     }
189     // get the lesson pages
190     $lessonpages = $lesson->load_all_pages();
192     // this loads all the viewed branch tables into $seen until it finds the branch table with the flag
193     // which is the branch table that starts the unseenbranch function
194     $seen = array();
195     foreach ($seenbranches as $seenbranch) {
196         if (!$seenbranch->flag) {
197             $seen[$seenbranch->pageid] = $seenbranch->pageid;
198         } else {
199             $start = $seenbranch->pageid;
200             break;
201         }
202     }
203     // this function searches through the lesson pages to find all the branch tables
204     // that follow the flagged branch table
205     $pageid = $lessonpages[$start]->nextpageid; // move down from the flagged branch table
206     $branchtables = array();
207     while ($pageid != 0) {  // grab all of the branch table till eol
208         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
209             $branchtables[] = $lessonpages[$pageid]->id;
210         }
211         $pageid = $lessonpages[$pageid]->nextpageid;
212     }
213     $unseen = array();
214     foreach ($branchtables as $branchtable) {
215         // load all of the unseen branch tables into unseen
216         if (!array_key_exists($branchtable, $seen)) {
217             $unseen[] = $branchtable;
218         }
219     }
220     if (count($unseen) > 0) {
221         return $unseen[rand(0, count($unseen)-1)];  // returns a random page id for the next page
222     } else {
223         return LESSON_EOL;  // has viewed all of the branch tables
224     }
227 /**
228  * Handles the random jump between a branch table and end of branch or end of lesson (LESSON_RANDOMPAGE).
229  *
230  * @param lesson $lesson
231  * @param int $pageid The id of the page that we are jumping from (?)
232  * @return int The pageid of a random page that is within a branch table
233  **/
234 function lesson_random_question_jump($lesson, $pageid) {
235     global $DB;
237     // get the lesson pages
238     $params = array ("lessonid" => $lesson->id);
239     if (!$lessonpages = $DB->get_records_select("lesson_pages", "lessonid = :lessonid", $params)) {
240         print_error('cannotfindpages', 'lesson');
241     }
243     // go up the pages till branch table
244     while ($pageid != 0) { // this condition should never be satisfied... only happens if there are no branch tables above this page
246         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
247             break;
248         }
249         $pageid = $lessonpages[$pageid]->prevpageid;
250     }
252     // get the pages within the branch
253     $pagesinbranch = $lesson->get_sub_pages_of($pageid, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
255     if(count($pagesinbranch) == 0) {
256         // there are no pages inside the branch, so return the next page
257         return $lessonpages[$pageid]->nextpageid;
258     } else {
259         return $pagesinbranch[rand(0, count($pagesinbranch)-1)]->id;  // returns a random page id for the next page
260     }
263 /**
264  * Calculates a user's grade for a lesson.
265  *
266  * @param object $lesson The lesson that the user is taking.
267  * @param int $retries The attempt number.
268  * @param int $userid Id of the user (optional, default current user).
269  * @return object { nquestions => number of questions answered
270                     attempts => number of question attempts
271                     total => max points possible
272                     earned => points earned by student
273                     grade => calculated percentage grade
274                     nmanual => number of manually graded questions
275                     manualpoints => point value for manually graded questions }
276  */
277 function lesson_grade($lesson, $ntries, $userid = 0) {
278     global $USER, $DB;
280     if (empty($userid)) {
281         $userid = $USER->id;
282     }
284     // Zero out everything
285     $ncorrect     = 0;
286     $nviewed      = 0;
287     $score        = 0;
288     $nmanual      = 0;
289     $manualpoints = 0;
290     $thegrade     = 0;
291     $nquestions   = 0;
292     $total        = 0;
293     $earned       = 0;
295     $params = array ("lessonid" => $lesson->id, "userid" => $userid, "retry" => $ntries);
296     if ($useranswers = $DB->get_records_select("lesson_attempts",  "lessonid = :lessonid AND
297             userid = :userid AND retry = :retry", $params, "timeseen")) {
298         // group each try with its page
299         $attemptset = array();
300         foreach ($useranswers as $useranswer) {
301             $attemptset[$useranswer->pageid][] = $useranswer;
302         }
304         // Drop all attempts that go beyond max attempts for the lesson
305         foreach ($attemptset as $key => $set) {
306             $attemptset[$key] = array_slice($set, 0, $lesson->maxattempts);
307         }
309         // get only the pages and their answers that the user answered
310         list($usql, $parameters) = $DB->get_in_or_equal(array_keys($attemptset));
311         array_unshift($parameters, $lesson->id);
312         $pages = $DB->get_records_select("lesson_pages", "lessonid = ? AND id $usql", $parameters);
313         $answers = $DB->get_records_select("lesson_answers", "lessonid = ? AND pageid $usql", $parameters);
315         // Number of pages answered
316         $nquestions = count($pages);
318         foreach ($attemptset as $attempts) {
319             $page = lesson_page::load($pages[end($attempts)->pageid], $lesson);
320             if ($lesson->custom) {
321                 $attempt = end($attempts);
322                 // If essay question, handle it, otherwise add to score
323                 if ($page->requires_manual_grading()) {
324                     $useranswerobj = unserialize($attempt->useranswer);
325                     if (isset($useranswerobj->score)) {
326                         $earned += $useranswerobj->score;
327                     }
328                     $nmanual++;
329                     $manualpoints += $answers[$attempt->answerid]->score;
330                 } else if (!empty($attempt->answerid)) {
331                     $earned += $page->earned_score($answers, $attempt);
332                 }
333             } else {
334                 foreach ($attempts as $attempt) {
335                     $earned += $attempt->correct;
336                 }
337                 $attempt = end($attempts); // doesn't matter which one
338                 // If essay question, increase numbers
339                 if ($page->requires_manual_grading()) {
340                     $nmanual++;
341                     $manualpoints++;
342                 }
343             }
344             // Number of times answered
345             $nviewed += count($attempts);
346         }
348         if ($lesson->custom) {
349             $bestscores = array();
350             // Find the highest possible score per page to get our total
351             foreach ($answers as $answer) {
352                 if(!isset($bestscores[$answer->pageid])) {
353                     $bestscores[$answer->pageid] = $answer->score;
354                 } else if ($bestscores[$answer->pageid] < $answer->score) {
355                     $bestscores[$answer->pageid] = $answer->score;
356                 }
357             }
358             $total = array_sum($bestscores);
359         } else {
360             // Check to make sure the student has answered the minimum questions
361             if ($lesson->minquestions and $nquestions < $lesson->minquestions) {
362                 // Nope, increase number viewed by the amount of unanswered questions
363                 $total =  $nviewed + ($lesson->minquestions - $nquestions);
364             } else {
365                 $total = $nviewed;
366             }
367         }
368     }
370     if ($total) { // not zero
371         $thegrade = round(100 * $earned / $total, 5);
372     }
374     // Build the grade information object
375     $gradeinfo               = new stdClass;
376     $gradeinfo->nquestions   = $nquestions;
377     $gradeinfo->attempts     = $nviewed;
378     $gradeinfo->total        = $total;
379     $gradeinfo->earned       = $earned;
380     $gradeinfo->grade        = $thegrade;
381     $gradeinfo->nmanual      = $nmanual;
382     $gradeinfo->manualpoints = $manualpoints;
384     return $gradeinfo;
387 /**
388  * Determines if a user can view the left menu.  The determining factor
389  * is whether a user has a grade greater than or equal to the lesson setting
390  * of displayleftif
391  *
392  * @param object $lesson Lesson object of the current lesson
393  * @return boolean 0 if the user cannot see, or $lesson->displayleft to keep displayleft unchanged
394  **/
395 function lesson_displayleftif($lesson) {
396     global $CFG, $USER, $DB;
398     if (!empty($lesson->displayleftif)) {
399         // get the current user's max grade for this lesson
400         $params = array ("userid" => $USER->id, "lessonid" => $lesson->id);
401         if ($maxgrade = $DB->get_record_sql('SELECT userid, MAX(grade) AS maxgrade FROM {lesson_grades} WHERE userid = :userid AND lessonid = :lessonid GROUP BY userid', $params)) {
402             if ($maxgrade->maxgrade < $lesson->displayleftif) {
403                 return 0;  // turn off the displayleft
404             }
405         } else {
406             return 0; // no grades
407         }
408     }
410     // if we get to here, keep the original state of displayleft lesson setting
411     return $lesson->displayleft;
414 /**
415  *
416  * @param $cm
417  * @param $lesson
418  * @param $page
419  * @return unknown_type
420  */
421 function lesson_add_fake_blocks($page, $cm, $lesson, $timer = null) {
422     $bc = lesson_menu_block_contents($cm->id, $lesson);
423     if (!empty($bc)) {
424         $regions = $page->blocks->get_regions();
425         $firstregion = reset($regions);
426         $page->blocks->add_fake_block($bc, $firstregion);
427     }
429     $bc = lesson_mediafile_block_contents($cm->id, $lesson);
430     if (!empty($bc)) {
431         $page->blocks->add_fake_block($bc, $page->blocks->get_default_region());
432     }
434     if (!empty($timer)) {
435         $bc = lesson_clock_block_contents($cm->id, $lesson, $timer, $page);
436         if (!empty($bc)) {
437             $page->blocks->add_fake_block($bc, $page->blocks->get_default_region());
438         }
439     }
442 /**
443  * If there is a media file associated with this
444  * lesson, return a block_contents that displays it.
445  *
446  * @param int $cmid Course Module ID for this lesson
447  * @param object $lesson Full lesson record object
448  * @return block_contents
449  **/
450 function lesson_mediafile_block_contents($cmid, $lesson) {
451     global $OUTPUT;
452     if (empty($lesson->mediafile)) {
453         return null;
454     }
456     $options = array();
457     $options['menubar'] = 0;
458     $options['location'] = 0;
459     $options['left'] = 5;
460     $options['top'] = 5;
461     $options['scrollbars'] = 1;
462     $options['resizable'] = 1;
463     $options['width'] = $lesson->mediawidth;
464     $options['height'] = $lesson->mediaheight;
466     $link = new moodle_url('/mod/lesson/mediafile.php?id='.$cmid);
467     $action = new popup_action('click', $link, 'lessonmediafile', $options);
468     $content = $OUTPUT->action_link($link, get_string('mediafilepopup', 'lesson'), $action, array('title'=>get_string('mediafilepopup', 'lesson')));
470     $bc = new block_contents();
471     $bc->title = get_string('linkedmedia', 'lesson');
472     $bc->attributes['class'] = 'mediafile block';
473     $bc->content = $content;
475     return $bc;
478 /**
479  * If a timed lesson and not a teacher, then
480  * return a block_contents containing the clock.
481  *
482  * @param int $cmid Course Module ID for this lesson
483  * @param object $lesson Full lesson record object
484  * @param object $timer Full timer record object
485  * @return block_contents
486  **/
487 function lesson_clock_block_contents($cmid, $lesson, $timer, $page) {
488     // Display for timed lessons and for students only
489     $context = context_module::instance($cmid);
490     if ($lesson->timelimit == 0 || has_capability('mod/lesson:manage', $context)) {
491         return null;
492     }
494     $content = '<div id="lesson-timer">';
495     $content .=  $lesson->time_remaining($timer->starttime);
496     $content .= '</div>';
498     $clocksettings = array('starttime' => $timer->starttime, 'servertime' => time(), 'testlength' => $lesson->timelimit);
499     $page->requires->data_for_js('clocksettings', $clocksettings, true);
500     $page->requires->strings_for_js(array('timeisup'), 'lesson');
501     $page->requires->js('/mod/lesson/timer.js');
502     $page->requires->js_init_call('show_clock');
504     $bc = new block_contents();
505     $bc->title = get_string('timeremaining', 'lesson');
506     $bc->attributes['class'] = 'clock block';
507     $bc->content = $content;
509     return $bc;
512 /**
513  * If left menu is turned on, then this will
514  * print the menu in a block
515  *
516  * @param int $cmid Course Module ID for this lesson
517  * @param lesson $lesson Full lesson record object
518  * @return void
519  **/
520 function lesson_menu_block_contents($cmid, $lesson) {
521     global $CFG, $DB;
523     if (!$lesson->displayleft) {
524         return null;
525     }
527     $pages = $lesson->load_all_pages();
528     foreach ($pages as $page) {
529         if ((int)$page->prevpageid === 0) {
530             $pageid = $page->id;
531             break;
532         }
533     }
534     $currentpageid = optional_param('pageid', $pageid, PARAM_INT);
536     if (!$pageid || !$pages) {
537         return null;
538     }
540     $content = '<a href="#maincontent" class="accesshide">' .
541         get_string('skip', 'lesson') .
542         "</a>\n<div class=\"menuwrapper\">\n<ul>\n";
544     while ($pageid != 0) {
545         $page = $pages[$pageid];
547         // Only process branch tables with display turned on
548         if ($page->displayinmenublock && $page->display) {
549             if ($page->id == $currentpageid) {
550                 $content .= '<li class="selected">'.format_string($page->title,true)."</li>\n";
551             } else {
552                 $content .= "<li class=\"notselected\"><a href=\"$CFG->wwwroot/mod/lesson/view.php?id=$cmid&amp;pageid=$page->id\">".format_string($page->title,true)."</a></li>\n";
553             }
555         }
556         $pageid = $page->nextpageid;
557     }
558     $content .= "</ul>\n</div>\n";
560     $bc = new block_contents();
561     $bc->title = get_string('lessonmenu', 'lesson');
562     $bc->attributes['class'] = 'menu block';
563     $bc->content = $content;
565     return $bc;
568 /**
569  * Adds header buttons to the page for the lesson
570  *
571  * @param object $cm
572  * @param object $context
573  * @param bool $extraeditbuttons
574  * @param int $lessonpageid
575  */
576 function lesson_add_header_buttons($cm, $context, $extraeditbuttons=false, $lessonpageid=null) {
577     global $CFG, $PAGE, $OUTPUT;
578     if (has_capability('mod/lesson:edit', $context) && $extraeditbuttons) {
579         if ($lessonpageid === null) {
580             print_error('invalidpageid', 'lesson');
581         }
582         if (!empty($lessonpageid) && $lessonpageid != LESSON_EOL) {
583             $url = new moodle_url('/mod/lesson/editpage.php', array(
584                 'id'       => $cm->id,
585                 'pageid'   => $lessonpageid,
586                 'edit'     => 1,
587                 'returnto' => $PAGE->url->out(false)
588             ));
589             $PAGE->set_button($OUTPUT->single_button($url, get_string('editpagecontent', 'lesson')));
590         }
591     }
594 /**
595  * This is a function used to detect media types and generate html code.
596  *
597  * @global object $CFG
598  * @global object $PAGE
599  * @param object $lesson
600  * @param object $context
601  * @return string $code the html code of media
602  */
603 function lesson_get_media_html($lesson, $context) {
604     global $CFG, $PAGE, $OUTPUT;
605     require_once("$CFG->libdir/resourcelib.php");
607     // get the media file link
608     if (strpos($lesson->mediafile, '://') !== false) {
609         $url = new moodle_url($lesson->mediafile);
610     } else {
611         // the timemodified is used to prevent caching problems, instead of '/' we should better read from files table and use sortorder
612         $url = moodle_url::make_pluginfile_url($context->id, 'mod_lesson', 'mediafile', $lesson->timemodified, '/', ltrim($lesson->mediafile, '/'));
613     }
614     $title = $lesson->mediafile;
616     $clicktoopen = html_writer::link($url, get_string('download'));
618     $mimetype = resourcelib_guess_url_mimetype($url);
620     $extension = resourcelib_get_extension($url->out(false));
622     $mediamanager = core_media_manager::instance($PAGE);
623     $embedoptions = array(
624         core_media_manager::OPTION_TRUSTED => true,
625         core_media_manager::OPTION_BLOCK => true
626     );
628     // find the correct type and print it out
629     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
630         $code = resourcelib_embed_image($url, $title);
632     } else if ($mediamanager->can_embed_url($url, $embedoptions)) {
633         // Media (audio/video) file.
634         $code = $mediamanager->embed_url($url, $title, 0, 0, $embedoptions);
636     } else {
637         // anything else - just try object tag enlarged as much as possible
638         $code = resourcelib_embed_general($url, $title, $clicktoopen, $mimetype);
639     }
641     return $code;
644 /**
645  * Logic to happen when a/some group(s) has/have been deleted in a course.
646  *
647  * @param int $courseid The course ID.
648  * @param int $groupid The group id if it is known
649  * @return void
650  */
651 function lesson_process_group_deleted_in_course($courseid, $groupid = null) {
652     global $DB;
654     $params = array('courseid' => $courseid);
655     if ($groupid) {
656         $params['groupid'] = $groupid;
657         // We just update the group that was deleted.
658         $sql = "SELECT o.id, o.lessonid
659                   FROM {lesson_overrides} o
660                   JOIN {lesson} lesson ON lesson.id = o.lessonid
661                  WHERE lesson.course = :courseid
662                    AND o.groupid = :groupid";
663     } else {
664         // No groupid, we update all orphaned group overrides for all lessons in course.
665         $sql = "SELECT o.id, o.lessonid
666                   FROM {lesson_overrides} o
667                   JOIN {lesson} lesson ON lesson.id = o.lessonid
668              LEFT JOIN {groups} grp ON grp.id = o.groupid
669                  WHERE lesson.course = :courseid
670                    AND o.groupid IS NOT NULL
671                    AND grp.id IS NULL";
672     }
673     $records = $DB->get_records_sql_menu($sql, $params);
674     if (!$records) {
675         return; // Nothing to do.
676     }
677     $DB->delete_records_list('lesson_overrides', 'id', array_keys($records));
680 /**
681  * Return the overview report table and data.
682  *
683  * @param  lesson $lesson       lesson instance
684  * @param  mixed $currentgroup  false if not group used, 0 for all groups, group id (int) to filter by that groups
685  * @return mixed false if there is no information otherwise html_table and stdClass with the table and data
686  * @since  Moodle 3.3
687  */
688 function lesson_get_overview_report_table_and_data(lesson $lesson, $currentgroup) {
689     global $DB, $CFG;
690     require_once($CFG->dirroot . '/mod/lesson/pagetypes/branchtable.php');
692     $context = $lesson->context;
693     $cm = $lesson->cm;
694     // Count the number of branch and question pages in this lesson.
695     $branchcount = $DB->count_records('lesson_pages', array('lessonid' => $lesson->id, 'qtype' => LESSON_PAGE_BRANCHTABLE));
696     $questioncount = ($DB->count_records('lesson_pages', array('lessonid' => $lesson->id)) - $branchcount);
698     // Only load students if there attempts for this lesson.
699     $attempts = $DB->record_exists('lesson_attempts', array('lessonid' => $lesson->id));
700     $branches = $DB->record_exists('lesson_branch', array('lessonid' => $lesson->id));
701     $timer = $DB->record_exists('lesson_timer', array('lessonid' => $lesson->id));
702     if ($attempts or $branches or $timer) {
703         list($esql, $params) = get_enrolled_sql($context, '', $currentgroup, true);
704         list($sort, $sortparams) = users_order_by_sql('u');
706         $extrafields = get_extra_user_fields($context);
708         $params['a1lessonid'] = $lesson->id;
709         $params['b1lessonid'] = $lesson->id;
710         $params['c1lessonid'] = $lesson->id;
711         $ufields = user_picture::fields('u', $extrafields);
712         $sql = "SELECT DISTINCT $ufields
713                 FROM {user} u
714                 JOIN (
715                     SELECT userid, lessonid FROM {lesson_attempts} a1
716                     WHERE a1.lessonid = :a1lessonid
717                         UNION
718                     SELECT userid, lessonid FROM {lesson_branch} b1
719                     WHERE b1.lessonid = :b1lessonid
720                         UNION
721                     SELECT userid, lessonid FROM {lesson_timer} c1
722                     WHERE c1.lessonid = :c1lessonid
723                     ) a ON u.id = a.userid
724                 JOIN ($esql) ue ON ue.id = a.userid
725                 ORDER BY $sort";
727         $students = $DB->get_recordset_sql($sql, $params);
728         if (!$students->valid()) {
729             $students->close();
730             return array(false, false);
731         }
732     } else {
733         return array(false, false);
734     }
736     if (! $grades = $DB->get_records('lesson_grades', array('lessonid' => $lesson->id), 'completed')) {
737         $grades = array();
738     }
740     if (! $times = $DB->get_records('lesson_timer', array('lessonid' => $lesson->id), 'starttime')) {
741         $times = array();
742     }
744     // Build an array for output.
745     $studentdata = array();
747     $attempts = $DB->get_recordset('lesson_attempts', array('lessonid' => $lesson->id), 'timeseen');
748     foreach ($attempts as $attempt) {
749         // if the user is not in the array or if the retry number is not in the sub array, add the data for that try.
750         if (empty($studentdata[$attempt->userid]) || empty($studentdata[$attempt->userid][$attempt->retry])) {
751             // restore/setup defaults
752             $n = 0;
753             $timestart = 0;
754             $timeend = 0;
755             $usergrade = null;
756             $eol = 0;
758             // search for the grade record for this try. if not there, the nulls defined above will be used.
759             foreach($grades as $grade) {
760                 // check to see if the grade matches the correct user
761                 if ($grade->userid == $attempt->userid) {
762                     // see if n is = to the retry
763                     if ($n == $attempt->retry) {
764                         // get grade info
765                         $usergrade = round($grade->grade, 2); // round it here so we only have to do it once
766                         break;
767                     }
768                     $n++; // if not equal, then increment n
769                 }
770             }
771             $n = 0;
772             // search for the time record for this try. if not there, the nulls defined above will be used.
773             foreach($times as $time) {
774                 // check to see if the grade matches the correct user
775                 if ($time->userid == $attempt->userid) {
776                     // see if n is = to the retry
777                     if ($n == $attempt->retry) {
778                         // get grade info
779                         $timeend = $time->lessontime;
780                         $timestart = $time->starttime;
781                         $eol = $time->completed;
782                         break;
783                     }
784                     $n++; // if not equal, then increment n
785                 }
786             }
788             // build up the array.
789             // this array represents each student and all of their tries at the lesson
790             $studentdata[$attempt->userid][$attempt->retry] = array( "timestart" => $timestart,
791                                                                     "timeend" => $timeend,
792                                                                     "grade" => $usergrade,
793                                                                     "end" => $eol,
794                                                                     "try" => $attempt->retry,
795                                                                     "userid" => $attempt->userid);
796         }
797     }
798     $attempts->close();
800     $branches = $DB->get_recordset('lesson_branch', array('lessonid' => $lesson->id), 'timeseen');
801     foreach ($branches as $branch) {
802         // If the user is not in the array or if the retry number is not in the sub array, add the data for that try.
803         if (empty($studentdata[$branch->userid]) || empty($studentdata[$branch->userid][$branch->retry])) {
804             // Restore/setup defaults.
805             $n = 0;
806             $timestart = 0;
807             $timeend = 0;
808             $usergrade = null;
809             $eol = 0;
810             // Search for the time record for this try. if not there, the nulls defined above will be used.
811             foreach ($times as $time) {
812                 // Check to see if the grade matches the correct user.
813                 if ($time->userid == $branch->userid) {
814                     // See if n is = to the retry.
815                     if ($n == $branch->retry) {
816                         // Get grade info.
817                         $timeend = $time->lessontime;
818                         $timestart = $time->starttime;
819                         $eol = $time->completed;
820                         break;
821                     }
822                     $n++; // If not equal, then increment n.
823                 }
824             }
826             // Build up the array.
827             // This array represents each student and all of their tries at the lesson.
828             $studentdata[$branch->userid][$branch->retry] = array( "timestart" => $timestart,
829                                                                     "timeend" => $timeend,
830                                                                     "grade" => $usergrade,
831                                                                     "end" => $eol,
832                                                                     "try" => $branch->retry,
833                                                                     "userid" => $branch->userid);
834         }
835     }
836     $branches->close();
838     // Need the same thing for timed entries that were not completed.
839     foreach ($times as $time) {
840         $endoflesson = $time->completed;
841         // If the time start is the same with another record then we shouldn't be adding another item to this array.
842         if (isset($studentdata[$time->userid])) {
843             $foundmatch = false;
844             $n = 0;
845             foreach ($studentdata[$time->userid] as $key => $value) {
846                 if ($value['timestart'] == $time->starttime) {
847                     // Don't add this to the array.
848                     $foundmatch = true;
849                     break;
850                 }
851             }
852             $n = count($studentdata[$time->userid]) + 1;
853             if (!$foundmatch) {
854                 // Add a record.
855                 $studentdata[$time->userid][] = array(
856                                 "timestart" => $time->starttime,
857                                 "timeend" => $time->lessontime,
858                                 "grade" => null,
859                                 "end" => $endoflesson,
860                                 "try" => $n,
861                                 "userid" => $time->userid
862                             );
863             }
864         } else {
865             $studentdata[$time->userid][] = array(
866                                 "timestart" => $time->starttime,
867                                 "timeend" => $time->lessontime,
868                                 "grade" => null,
869                                 "end" => $endoflesson,
870                                 "try" => 0,
871                                 "userid" => $time->userid
872                             );
873         }
874     }
876     // To store all the data to be returned by the function.
877     $data = new stdClass();
879     // Determine if lesson should have a score.
880     if ($branchcount > 0 AND $questioncount == 0) {
881         // This lesson only contains content pages and is not graded.
882         $data->lessonscored = false;
883     } else {
884         // This lesson is graded.
885         $data->lessonscored = true;
886     }
887     // set all the stats variables
888     $data->numofattempts = 0;
889     $data->avescore      = 0;
890     $data->avetime       = 0;
891     $data->highscore     = null;
892     $data->lowscore      = null;
893     $data->hightime      = null;
894     $data->lowtime       = null;
895     $data->students      = array();
897     $table = new html_table();
899     $headers = [get_string('name')];
901     foreach ($extrafields as $field) {
902         $headers[] = get_user_field_name($field);
903     }
905     $headers [] = get_string('attempts', 'lesson');
907     // Set up the table object.
908     if ($data->lessonscored) {
909         $headers [] = get_string('highscore', 'lesson');
910     }
912     $colcount = count($headers);
914     $table->head = $headers;
916     $table->align = [];
917     $table->align = array_pad($table->align, $colcount, 'center');
918     $table->align[$colcount - 1] = 'left';
920     if ($data->lessonscored) {
921         $table->align[$colcount - 2] = 'left';
922     }
924     $table->wrap = [];
925     $table->wrap = array_pad($table->wrap, $colcount, 'nowrap');
927     $table->attributes['class'] = 'standardtable generaltable';
929     // print out the $studentdata array
930     // going through each student that has attempted the lesson, so, each student should have something to be displayed
931     foreach ($students as $student) {
932         // check to see if the student has attempts to print out
933         if (array_key_exists($student->id, $studentdata)) {
934             // set/reset some variables
935             $attempts = array();
936             $dataforstudent = new stdClass;
937             $dataforstudent->attempts = array();
938             // gather the data for each user attempt
939             $bestgrade = 0;
940             $bestgradefound = false;
941             // $tries holds all the tries/retries a student has done
942             $tries = $studentdata[$student->id];
943             $studentname = fullname($student, true);
945             foreach ($tries as $try) {
946                 $dataforstudent->attempts[] = $try;
948                 // Start to build up the checkbox and link.
949                 if (has_capability('mod/lesson:edit', $context)) {
950                     $temp = '<input type="checkbox" id="attempts" name="attempts['.$try['userid'].']['.$try['try'].']" /> ';
951                 } else {
952                     $temp = '';
953                 }
955                 $temp .= "<a href=\"report.php?id=$cm->id&amp;action=reportdetail&amp;userid=".$try['userid']
956                         .'&amp;try='.$try['try'].'" class="lesson-attempt-link">';
957                 if ($try["grade"] !== null) { // if null then not done yet
958                     // this is what the link does when the user has completed the try
959                     $timetotake = $try["timeend"] - $try["timestart"];
961                     $temp .= $try["grade"]."%";
962                     $bestgradefound = true;
963                     if ($try["grade"] > $bestgrade) {
964                         $bestgrade = $try["grade"];
965                     }
966                     $temp .= "&nbsp;".userdate($try["timestart"]);
967                     $temp .= ",&nbsp;(".format_time($timetotake).")</a>";
968                 } else {
969                     if ($try["end"]) {
970                         // User finished the lesson but has no grade. (Happens when there are only content pages).
971                         $temp .= "&nbsp;".userdate($try["timestart"]);
972                         $timetotake = $try["timeend"] - $try["timestart"];
973                         $temp .= ",&nbsp;(".format_time($timetotake).")</a>";
974                     } else {
975                         // This is what the link does/looks like when the user has not completed the attempt.
976                         $temp .= get_string("notcompleted", "lesson");
977                         if ($try['timestart'] !== 0) {
978                             // Teacher previews do not track time spent.
979                             $temp .= "&nbsp;".userdate($try["timestart"]);
980                         }
981                         $temp .= "</a>";
982                         $timetotake = null;
983                     }
984                 }
985                 // build up the attempts array
986                 $attempts[] = $temp;
988                 // Run these lines for the stats only if the user finnished the lesson.
989                 if ($try["end"]) {
990                     // User has completed the lesson.
991                     $data->numofattempts++;
992                     $data->avetime += $timetotake;
993                     if ($timetotake > $data->hightime || $data->hightime == null) {
994                         $data->hightime = $timetotake;
995                     }
996                     if ($timetotake < $data->lowtime || $data->lowtime == null) {
997                         $data->lowtime = $timetotake;
998                     }
999                     if ($try["grade"] !== null) {
1000                         // The lesson was scored.
1001                         $data->avescore += $try["grade"];
1002                         if ($try["grade"] > $data->highscore || $data->highscore === null) {
1003                             $data->highscore = $try["grade"];
1004                         }
1005                         if ($try["grade"] < $data->lowscore || $data->lowscore === null) {
1006                             $data->lowscore = $try["grade"];
1007                         }
1009                     }
1010                 }
1011             }
1012             // get line breaks in after each attempt
1013             $attempts = implode("<br />\n", $attempts);
1014             $row = [$studentname];
1016             foreach ($extrafields as $field) {
1017                 $row[] = $student->$field;
1018             }
1020             $row[] = $attempts;
1022             if ($data->lessonscored) {
1023                 // Add the grade if the lesson is graded.
1024                 $row[] = $bestgrade."%";
1025             }
1027             $table->data[] = $row;
1029             // Add the student data.
1030             $dataforstudent->id = $student->id;
1031             $dataforstudent->fullname = $studentname;
1032             $dataforstudent->bestgrade = $bestgrade;
1033             $data->students[] = $dataforstudent;
1034         }
1035     }
1036     $students->close();
1037     if ($data->numofattempts > 0) {
1038         $data->avescore = $data->avescore / $data->numofattempts;
1039     }
1041     return array($table, $data);
1044 /**
1045  * Return information about one user attempt (including answers)
1046  * @param  lesson $lesson  lesson instance
1047  * @param  int $userid     the user id
1048  * @param  int $attempt    the attempt number
1049  * @return array the user answers (array) and user data stats (object)
1050  * @since  Moodle 3.3
1051  */
1052 function lesson_get_user_detailed_report_data(lesson $lesson, $userid, $attempt) {
1053     global $DB;
1055     $context = $lesson->context;
1056     if (!empty($userid)) {
1057         // Apply overrides.
1058         $lesson->update_effective_access($userid);
1059     }
1061     $pageid = 0;
1062     $lessonpages = $lesson->load_all_pages();
1063     foreach ($lessonpages as $lessonpage) {
1064         if ($lessonpage->prevpageid == 0) {
1065             $pageid = $lessonpage->id;
1066         }
1067     }
1069     // now gather the stats into an object
1070     $firstpageid = $pageid;
1071     $pagestats = array();
1072     while ($pageid != 0) { // EOL
1073         $page = $lessonpages[$pageid];
1074         $params = array ("lessonid" => $lesson->id, "pageid" => $page->id);
1075         if ($allanswers = $DB->get_records_select("lesson_attempts", "lessonid = :lessonid AND pageid = :pageid", $params, "timeseen")) {
1076             // get them ready for processing
1077             $orderedanswers = array();
1078             foreach ($allanswers as $singleanswer) {
1079                 // ordering them like this, will help to find the single attempt record that we want to keep.
1080                 $orderedanswers[$singleanswer->userid][$singleanswer->retry][] = $singleanswer;
1081             }
1082             // this is foreach user and for each try for that user, keep one attempt record
1083             foreach ($orderedanswers as $orderedanswer) {
1084                 foreach($orderedanswer as $tries) {
1085                     $page->stats($pagestats, $tries);
1086                 }
1087             }
1088         } else {
1089             // no one answered yet...
1090         }
1091         //unset($orderedanswers);  initialized above now
1092         $pageid = $page->nextpageid;
1093     }
1095     $manager = lesson_page_type_manager::get($lesson);
1096     $qtypes = $manager->get_page_type_strings();
1098     $answerpages = array();
1099     $answerpage = "";
1100     $pageid = $firstpageid;
1101     // cycle through all the pages
1102     //  foreach page, add to the $answerpages[] array all the data that is needed
1103     //  from the question, the users attempt, and the statistics
1104     // grayout pages that the user did not answer and Branch, end of branch, cluster
1105     // and end of cluster pages
1106     while ($pageid != 0) { // EOL
1107         $page = $lessonpages[$pageid];
1108         $answerpage = new stdClass;
1109         // Keep the original page object.
1110         $answerpage->page = $page;
1111         $data ='';
1113         $answerdata = new stdClass;
1114         // Set some defaults for the answer data.
1115         $answerdata->score = null;
1116         $answerdata->response = null;
1117         $answerdata->responseformat = FORMAT_PLAIN;
1119         $answerpage->title = format_string($page->title);
1121         $options = new stdClass;
1122         $options->noclean = true;
1123         $options->overflowdiv = true;
1124         $options->context = $context;
1125         $answerpage->contents = format_text($page->contents, $page->contentsformat, $options);
1127         $answerpage->qtype = $qtypes[$page->qtype].$page->option_description_string();
1128         $answerpage->grayout = $page->grayout;
1129         $answerpage->context = $context;
1131         if (empty($userid)) {
1132             // there is no userid, so set these vars and display stats.
1133             $answerpage->grayout = 0;
1134             $useranswer = null;
1135         } elseif ($useranswers = $DB->get_records("lesson_attempts",array("lessonid"=>$lesson->id, "userid"=>$userid, "retry"=>$attempt,"pageid"=>$page->id), "timeseen")) {
1136             // get the user's answer for this page
1137             // need to find the right one
1138             $i = 0;
1139             foreach ($useranswers as $userattempt) {
1140                 $useranswer = $userattempt;
1141                 $i++;
1142                 if ($lesson->maxattempts == $i) {
1143                     break; // reached maxattempts, break out
1144                 }
1145             }
1146         } else {
1147             // user did not answer this page, gray it out and set some nulls
1148             $answerpage->grayout = 1;
1149             $useranswer = null;
1150         }
1151         $i = 0;
1152         $n = 0;
1153         $answerpages[] = $page->report_answers(clone($answerpage), clone($answerdata), $useranswer, $pagestats, $i, $n);
1154         $pageid = $page->nextpageid;
1155     }
1157     $userstats = new stdClass;
1158     if (!empty($userid)) {
1159         $params = array("lessonid"=>$lesson->id, "userid"=>$userid);
1161         $alreadycompleted = true;
1163         if (!$grades = $DB->get_records_select("lesson_grades", "lessonid = :lessonid and userid = :userid", $params, "completed", "*", $attempt, 1)) {
1164             $userstats->grade = -1;
1165             $userstats->completed = -1;
1166             $alreadycompleted = false;
1167         } else {
1168             $userstats->grade = current($grades);
1169             $userstats->completed = $userstats->grade->completed;
1170             $userstats->grade = round($userstats->grade->grade, 2);
1171         }
1173         if (!$times = $lesson->get_user_timers($userid, 'starttime', '*', $attempt, 1)) {
1174             $userstats->timetotake = -1;
1175             $alreadycompleted = false;
1176         } else {
1177             $userstats->timetotake = current($times);
1178             $userstats->timetotake = $userstats->timetotake->lessontime - $userstats->timetotake->starttime;
1179         }
1181         if ($alreadycompleted) {
1182             $userstats->gradeinfo = lesson_grade($lesson, $attempt, $userid);
1183         }
1184     }
1186     return array($answerpages, $userstats);
1189 /**
1190  * Return user's deadline for all lessons in a course, hereby taking into account group and user overrides.
1191  *
1192  * @param int $courseid the course id.
1193  * @return object An object with of all lessonsids and close unixdates in this course,
1194  * taking into account the most lenient overrides, if existing and 0 if no close date is set.
1195  */
1196 function lesson_get_user_deadline($courseid) {
1197     global $DB, $USER;
1199     // For teacher and manager/admins return lesson's deadline.
1200     if (has_capability('moodle/course:update', context_course::instance($courseid))) {
1201         $sql = "SELECT lesson.id, lesson.deadline AS userdeadline
1202                   FROM {lesson} lesson
1203                  WHERE lesson.course = :courseid";
1205         $results = $DB->get_records_sql($sql, array('courseid' => $courseid));
1206         return $results;
1207     }
1209     $sql = "SELECT a.id,
1210                    COALESCE(v.userclose, v.groupclose, a.deadline, 0) AS userdeadline
1211               FROM (
1212                       SELECT lesson.id as lessonid,
1213                              MAX(leo.deadline) AS userclose, MAX(qgo.deadline) AS groupclose
1214                         FROM {lesson} lesson
1215                    LEFT JOIN {lesson_overrides} leo on lesson.id = leo.lessonid AND leo.userid = :userid
1216                    LEFT JOIN {groups_members} gm ON gm.userid = :useringroupid
1217                    LEFT JOIN {lesson_overrides} qgo on lesson.id = qgo.lessonid AND qgo.groupid = gm.groupid
1218                        WHERE lesson.course = :courseid
1219                     GROUP BY lesson.id
1220                    ) v
1221               JOIN {lesson} a ON a.id = v.lessonid";
1223     $results = $DB->get_records_sql($sql, array('userid' => $USER->id, 'useringroupid' => $USER->id, 'courseid' => $courseid));
1224     return $results;
1228 /**
1229  * Abstract class that page type's MUST inherit from.
1230  *
1231  * This is the abstract class that ALL add page type forms must extend.
1232  * You will notice that all but two of the methods this class contains are final.
1233  * Essentially the only thing that extending classes can do is extend custom_definition.
1234  * OR if it has a special requirement on creation it can extend construction_override
1235  *
1236  * @abstract
1237  * @copyright  2009 Sam Hemelryk
1238  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1239  */
1240 abstract class lesson_add_page_form_base extends moodleform {
1242     /**
1243      * This is the classic define that is used to identify this pagetype.
1244      * Will be one of LESSON_*
1245      * @var int
1246      */
1247     public $qtype;
1249     /**
1250      * The simple string that describes the page type e.g. truefalse, multichoice
1251      * @var string
1252      */
1253     public $qtypestring;
1255     /**
1256      * An array of options used in the htmleditor
1257      * @var array
1258      */
1259     protected $editoroptions = array();
1261     /**
1262      * True if this is a standard page of false if it does something special.
1263      * Questions are standard pages, branch tables are not
1264      * @var bool
1265      */
1266     protected $standard = true;
1268     /**
1269      * Answer format supported by question type.
1270      */
1271     protected $answerformat = '';
1273     /**
1274      * Response format supported by question type.
1275      */
1276     protected $responseformat = '';
1278     /**
1279      * Each page type can and should override this to add any custom elements to
1280      * the basic form that they want
1281      */
1282     public function custom_definition() {}
1284     /**
1285      * Returns answer format used by question type.
1286      */
1287     public function get_answer_format() {
1288         return $this->answerformat;
1289     }
1291     /**
1292      * Returns response format used by question type.
1293      */
1294     public function get_response_format() {
1295         return $this->responseformat;
1296     }
1298     /**
1299      * Used to determine if this is a standard page or a special page
1300      * @return bool
1301      */
1302     public final function is_standard() {
1303         return (bool)$this->standard;
1304     }
1306     /**
1307      * Add the required basic elements to the form.
1308      *
1309      * This method adds the basic elements to the form including title and contents
1310      * and then calls custom_definition();
1311      */
1312     public final function definition() {
1313         global $CFG;
1314         $mform = $this->_form;
1315         $editoroptions = $this->_customdata['editoroptions'];
1317         if ($this->qtypestring != 'selectaqtype') {
1318             if ($this->_customdata['edit']) {
1319                 $mform->addElement('header', 'qtypeheading', get_string('edit'. $this->qtypestring, 'lesson'));
1320             } else {
1321                 $mform->addElement('header', 'qtypeheading', get_string('add'. $this->qtypestring, 'lesson'));
1322             }
1323         }
1325         if (!empty($this->_customdata['returnto'])) {
1326             $mform->addElement('hidden', 'returnto', $this->_customdata['returnto']);
1327             $mform->setType('returnto', PARAM_URL);
1328         }
1330         $mform->addElement('hidden', 'id');
1331         $mform->setType('id', PARAM_INT);
1333         $mform->addElement('hidden', 'pageid');
1334         $mform->setType('pageid', PARAM_INT);
1336         if ($this->standard === true) {
1337             $mform->addElement('hidden', 'qtype');
1338             $mform->setType('qtype', PARAM_INT);
1340             $mform->addElement('text', 'title', get_string('pagetitle', 'lesson'), array('size'=>70));
1341             $mform->addRule('title', get_string('required'), 'required', null, 'client');
1342             if (!empty($CFG->formatstringstriptags)) {
1343                 $mform->setType('title', PARAM_TEXT);
1344             } else {
1345                 $mform->setType('title', PARAM_CLEANHTML);
1346             }
1348             $this->editoroptions = array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$this->_customdata['maxbytes']);
1349             $mform->addElement('editor', 'contents_editor', get_string('pagecontents', 'lesson'), null, $this->editoroptions);
1350             $mform->setType('contents_editor', PARAM_RAW);
1351             $mform->addRule('contents_editor', get_string('required'), 'required', null, 'client');
1352         }
1354         $this->custom_definition();
1356         if ($this->_customdata['edit'] === true) {
1357             $mform->addElement('hidden', 'edit', 1);
1358             $mform->setType('edit', PARAM_BOOL);
1359             $this->add_action_buttons(get_string('cancel'), get_string('savepage', 'lesson'));
1360         } else if ($this->qtype === 'questiontype') {
1361             $this->add_action_buttons(get_string('cancel'), get_string('addaquestionpage', 'lesson'));
1362         } else {
1363             $this->add_action_buttons(get_string('cancel'), get_string('savepage', 'lesson'));
1364         }
1365     }
1367     /**
1368      * Convenience function: Adds a jumpto select element
1369      *
1370      * @param string $name
1371      * @param string|null $label
1372      * @param int $selected The page to select by default
1373      */
1374     protected final function add_jumpto($name, $label=null, $selected=LESSON_NEXTPAGE) {
1375         $title = get_string("jump", "lesson");
1376         if ($label === null) {
1377             $label = $title;
1378         }
1379         if (is_int($name)) {
1380             $name = "jumpto[$name]";
1381         }
1382         $this->_form->addElement('select', $name, $label, $this->_customdata['jumpto']);
1383         $this->_form->setDefault($name, $selected);
1384         $this->_form->addHelpButton($name, 'jumps', 'lesson');
1385     }
1387     /**
1388      * Convenience function: Adds a score input element
1389      *
1390      * @param string $name
1391      * @param string|null $label
1392      * @param mixed $value The default value
1393      */
1394     protected final function add_score($name, $label=null, $value=null) {
1395         if ($label === null) {
1396             $label = get_string("score", "lesson");
1397         }
1399         if (is_int($name)) {
1400             $name = "score[$name]";
1401         }
1402         $this->_form->addElement('text', $name, $label, array('size'=>5));
1403         $this->_form->setType($name, PARAM_INT);
1404         if ($value !== null) {
1405             $this->_form->setDefault($name, $value);
1406         }
1407         $this->_form->addHelpButton($name, 'score', 'lesson');
1409         // Score is only used for custom scoring. Disable the element when not in use to stop some confusion.
1410         if (!$this->_customdata['lesson']->custom) {
1411             $this->_form->freeze($name);
1412         }
1413     }
1415     /**
1416      * Convenience function: Adds an answer editor
1417      *
1418      * @param int $count The count of the element to add
1419      * @param string $label, null means default
1420      * @param bool $required
1421      * @param string $format
1422      * @return void
1423      */
1424     protected final function add_answer($count, $label = null, $required = false, $format= '') {
1425         if ($label === null) {
1426             $label = get_string('answer', 'lesson');
1427         }
1429         if ($format == LESSON_ANSWER_HTML) {
1430             $this->_form->addElement('editor', 'answer_editor['.$count.']', $label,
1431                     array('rows' => '4', 'columns' => '80'),
1432                     array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $this->_customdata['maxbytes']));
1433             $this->_form->setType('answer_editor['.$count.']', PARAM_RAW);
1434             $this->_form->setDefault('answer_editor['.$count.']', array('text' => '', 'format' => FORMAT_HTML));
1435         } else {
1436             $this->_form->addElement('text', 'answer_editor['.$count.']', $label,
1437                     array('size' => '50', 'maxlength' => '200'));
1438             $this->_form->setType('answer_editor['.$count.']', PARAM_TEXT);
1439         }
1441         if ($required) {
1442             $this->_form->addRule('answer_editor['.$count.']', get_string('required'), 'required', null, 'client');
1443         }
1444     }
1445     /**
1446      * Convenience function: Adds an response editor
1447      *
1448      * @param int $count The count of the element to add
1449      * @param string $label, null means default
1450      * @param bool $required
1451      * @return void
1452      */
1453     protected final function add_response($count, $label = null, $required = false) {
1454         if ($label === null) {
1455             $label = get_string('response', 'lesson');
1456         }
1457         $this->_form->addElement('editor', 'response_editor['.$count.']', $label,
1458                  array('rows' => '4', 'columns' => '80'),
1459                  array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $this->_customdata['maxbytes']));
1460         $this->_form->setType('response_editor['.$count.']', PARAM_RAW);
1461         $this->_form->setDefault('response_editor['.$count.']', array('text' => '', 'format' => FORMAT_HTML));
1463         if ($required) {
1464             $this->_form->addRule('response_editor['.$count.']', get_string('required'), 'required', null, 'client');
1465         }
1466     }
1468     /**
1469      * A function that gets called upon init of this object by the calling script.
1470      *
1471      * This can be used to process an immediate action if required. Currently it
1472      * is only used in special cases by non-standard page types.
1473      *
1474      * @return bool
1475      */
1476     public function construction_override($pageid, lesson $lesson) {
1477         return true;
1478     }
1483 /**
1484  * Class representation of a lesson
1485  *
1486  * This class is used the interact with, and manage a lesson once instantiated.
1487  * If you need to fetch a lesson object you can do so by calling
1488  *
1489  * <code>
1490  * lesson::load($lessonid);
1491  * // or
1492  * $lessonrecord = $DB->get_record('lesson', $lessonid);
1493  * $lesson = new lesson($lessonrecord);
1494  * </code>
1495  *
1496  * The class itself extends lesson_base as all classes within the lesson module should
1497  *
1498  * These properties are from the database
1499  * @property int $id The id of this lesson
1500  * @property int $course The ID of the course this lesson belongs to
1501  * @property string $name The name of this lesson
1502  * @property int $practice Flag to toggle this as a practice lesson
1503  * @property int $modattempts Toggle to allow the user to go back and review answers
1504  * @property int $usepassword Toggle the use of a password for entry
1505  * @property string $password The password to require users to enter
1506  * @property int $dependency ID of another lesson this lesson is dependent on
1507  * @property string $conditions Conditions of the lesson dependency
1508  * @property int $grade The maximum grade a user can achieve (%)
1509  * @property int $custom Toggle custom scoring on or off
1510  * @property int $ongoing Toggle display of an ongoing score
1511  * @property int $usemaxgrade How retakes are handled (max=1, mean=0)
1512  * @property int $maxanswers The max number of answers or branches
1513  * @property int $maxattempts The maximum number of attempts a user can record
1514  * @property int $review Toggle use or wrong answer review button
1515  * @property int $nextpagedefault Override the default next page
1516  * @property int $feedback Toggles display of default feedback
1517  * @property int $minquestions Sets a minimum value of pages seen when calculating grades
1518  * @property int $maxpages Maximum number of pages this lesson can contain
1519  * @property int $retake Flag to allow users to retake a lesson
1520  * @property int $activitylink Relate this lesson to another lesson
1521  * @property string $mediafile File to pop up to or webpage to display
1522  * @property int $mediaheight Sets the height of the media file popup
1523  * @property int $mediawidth Sets the width of the media file popup
1524  * @property int $mediaclose Toggle display of a media close button
1525  * @property int $slideshow Flag for whether branch pages should be shown as slideshows
1526  * @property int $width Width of slideshow
1527  * @property int $height Height of slideshow
1528  * @property string $bgcolor Background colour of slideshow
1529  * @property int $displayleft Display a left menu
1530  * @property int $displayleftif Sets the condition on which the left menu is displayed
1531  * @property int $progressbar Flag to toggle display of a lesson progress bar
1532  * @property int $available Timestamp of when this lesson becomes available
1533  * @property int $deadline Timestamp of when this lesson is no longer available
1534  * @property int $timemodified Timestamp when lesson was last modified
1535  * @property int $allowofflineattempts Whether to allow the lesson to be attempted offline in the mobile app
1536  *
1537  * These properties are calculated
1538  * @property int $firstpageid Id of the first page of this lesson (prevpageid=0)
1539  * @property int $lastpageid Id of the last page of this lesson (nextpageid=0)
1540  *
1541  * @copyright  2009 Sam Hemelryk
1542  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1543  */
1544 class lesson extends lesson_base {
1546     /**
1547      * The id of the first page (where prevpageid = 0) gets set and retrieved by
1548      * {@see get_firstpageid()} by directly calling <code>$lesson->firstpageid;</code>
1549      * @var int
1550      */
1551     protected $firstpageid = null;
1552     /**
1553      * The id of the last page (where nextpageid = 0) gets set and retrieved by
1554      * {@see get_lastpageid()} by directly calling <code>$lesson->lastpageid;</code>
1555      * @var int
1556      */
1557     protected $lastpageid = null;
1558     /**
1559      * An array used to cache the pages associated with this lesson after the first
1560      * time they have been loaded.
1561      * A note to developers: If you are going to be working with MORE than one or
1562      * two pages from a lesson you should probably call {@see $lesson->load_all_pages()}
1563      * in order to save excess database queries.
1564      * @var array An array of lesson_page objects
1565      */
1566     protected $pages = array();
1567     /**
1568      * Flag that gets set to true once all of the pages associated with the lesson
1569      * have been loaded.
1570      * @var bool
1571      */
1572     protected $loadedallpages = false;
1574     /**
1575      * Course module object gets set and retrieved by directly calling <code>$lesson->cm;</code>
1576      * @see get_cm()
1577      * @var stdClass
1578      */
1579     protected $cm = null;
1581     /**
1582      * Course object gets set and retrieved by directly calling <code>$lesson->courserecord;</code>
1583      * @see get_courserecord()
1584      * @var stdClass
1585      */
1586     protected $courserecord = null;
1588     /**
1589      * Context object gets set and retrieved by directly calling <code>$lesson->context;</code>
1590      * @see get_context()
1591      * @var stdClass
1592      */
1593     protected $context = null;
1595     /**
1596      * Constructor method
1597      *
1598      * @param object $properties
1599      * @param stdClass $cm course module object
1600      * @param stdClass $course course object
1601      * @since Moodle 3.3
1602      */
1603     public function __construct($properties, $cm = null, $course = null) {
1604         parent::__construct($properties);
1605         $this->cm = $cm;
1606         $this->courserecord = $course;
1607     }
1609     /**
1610      * Simply generates a lesson object given an array/object of properties
1611      * Overrides {@see lesson_base->create()}
1612      * @static
1613      * @param object|array $properties
1614      * @return lesson
1615      */
1616     public static function create($properties) {
1617         return new lesson($properties);
1618     }
1620     /**
1621      * Generates a lesson object from the database given its id
1622      * @static
1623      * @param int $lessonid
1624      * @return lesson
1625      */
1626     public static function load($lessonid) {
1627         global $DB;
1629         if (!$lesson = $DB->get_record('lesson', array('id' => $lessonid))) {
1630             print_error('invalidcoursemodule');
1631         }
1632         return new lesson($lesson);
1633     }
1635     /**
1636      * Deletes this lesson from the database
1637      */
1638     public function delete() {
1639         global $CFG, $DB;
1640         require_once($CFG->libdir.'/gradelib.php');
1641         require_once($CFG->dirroot.'/calendar/lib.php');
1643         $cm = get_coursemodule_from_instance('lesson', $this->properties->id, $this->properties->course);
1644         $context = context_module::instance($cm->id);
1646         $this->delete_all_overrides();
1648         grade_update('mod/lesson', $this->properties->course, 'mod', 'lesson', $this->properties->id, 0, null, array('deleted'=>1));
1650         // We must delete the module record after we delete the grade item.
1651         $DB->delete_records("lesson", array("id"=>$this->properties->id));
1652         $DB->delete_records("lesson_pages", array("lessonid"=>$this->properties->id));
1653         $DB->delete_records("lesson_answers", array("lessonid"=>$this->properties->id));
1654         $DB->delete_records("lesson_attempts", array("lessonid"=>$this->properties->id));
1655         $DB->delete_records("lesson_grades", array("lessonid"=>$this->properties->id));
1656         $DB->delete_records("lesson_timer", array("lessonid"=>$this->properties->id));
1657         $DB->delete_records("lesson_branch", array("lessonid"=>$this->properties->id));
1658         if ($events = $DB->get_records('event', array("modulename"=>'lesson', "instance"=>$this->properties->id))) {
1659             $coursecontext = context_course::instance($cm->course);
1660             foreach($events as $event) {
1661                 $event->context = $coursecontext;
1662                 $event = calendar_event::load($event);
1663                 $event->delete();
1664             }
1665         }
1667         // Delete files associated with this module.
1668         $fs = get_file_storage();
1669         $fs->delete_area_files($context->id);
1671         return true;
1672     }
1674     /**
1675      * Deletes a lesson override from the database and clears any corresponding calendar events
1676      *
1677      * @param int $overrideid The id of the override being deleted
1678      * @return bool true on success
1679      */
1680     public function delete_override($overrideid) {
1681         global $CFG, $DB;
1683         require_once($CFG->dirroot . '/calendar/lib.php');
1685         $cm = get_coursemodule_from_instance('lesson', $this->properties->id, $this->properties->course);
1687         $override = $DB->get_record('lesson_overrides', array('id' => $overrideid), '*', MUST_EXIST);
1689         // Delete the events.
1690         $conds = array('modulename' => 'lesson',
1691                 'instance' => $this->properties->id);
1692         if (isset($override->userid)) {
1693             $conds['userid'] = $override->userid;
1694         } else {
1695             $conds['groupid'] = $override->groupid;
1696         }
1697         $events = $DB->get_records('event', $conds);
1698         foreach ($events as $event) {
1699             $eventold = calendar_event::load($event);
1700             $eventold->delete();
1701         }
1703         $DB->delete_records('lesson_overrides', array('id' => $overrideid));
1705         // Set the common parameters for one of the events we will be triggering.
1706         $params = array(
1707             'objectid' => $override->id,
1708             'context' => context_module::instance($cm->id),
1709             'other' => array(
1710                 'lessonid' => $override->lessonid
1711             )
1712         );
1713         // Determine which override deleted event to fire.
1714         if (!empty($override->userid)) {
1715             $params['relateduserid'] = $override->userid;
1716             $event = \mod_lesson\event\user_override_deleted::create($params);
1717         } else {
1718             $params['other']['groupid'] = $override->groupid;
1719             $event = \mod_lesson\event\group_override_deleted::create($params);
1720         }
1722         // Trigger the override deleted event.
1723         $event->add_record_snapshot('lesson_overrides', $override);
1724         $event->trigger();
1726         return true;
1727     }
1729     /**
1730      * Deletes all lesson overrides from the database and clears any corresponding calendar events
1731      */
1732     public function delete_all_overrides() {
1733         global $DB;
1735         $overrides = $DB->get_records('lesson_overrides', array('lessonid' => $this->properties->id), 'id');
1736         foreach ($overrides as $override) {
1737             $this->delete_override($override->id);
1738         }
1739     }
1741     /**
1742      * Checks user enrollment in the current course.
1743      *
1744      * @param int $userid
1745      * @return null|stdClass user record
1746      */
1747     public function is_participant($userid) {
1748         return is_enrolled($this->get_context(), $userid, 'mod/lesson:view', $this->show_only_active_users());
1749     }
1751     /**
1752      * Check is only active users in course should be shown.
1753      *
1754      * @return bool true if only active users should be shown.
1755      */
1756     public function show_only_active_users() {
1757         return !has_capability('moodle/course:viewsuspendedusers', $this->get_context());
1758     }
1760     /**
1761      * Updates the lesson properties with override information for a user.
1762      *
1763      * Algorithm:  For each lesson setting, if there is a matching user-specific override,
1764      *   then use that otherwise, if there are group-specific overrides, return the most
1765      *   lenient combination of them.  If neither applies, leave the quiz setting unchanged.
1766      *
1767      *   Special case: if there is more than one password that applies to the user, then
1768      *   lesson->extrapasswords will contain an array of strings giving the remaining
1769      *   passwords.
1770      *
1771      * @param int $userid The userid.
1772      */
1773     public function update_effective_access($userid) {
1774         global $DB;
1776         // Check for user override.
1777         $override = $DB->get_record('lesson_overrides', array('lessonid' => $this->properties->id, 'userid' => $userid));
1779         if (!$override) {
1780             $override = new stdClass();
1781             $override->available = null;
1782             $override->deadline = null;
1783             $override->timelimit = null;
1784             $override->review = null;
1785             $override->maxattempts = null;
1786             $override->retake = null;
1787             $override->password = null;
1788         }
1790         // Check for group overrides.
1791         $groupings = groups_get_user_groups($this->properties->course, $userid);
1793         if (!empty($groupings[0])) {
1794             // Select all overrides that apply to the User's groups.
1795             list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
1796             $sql = "SELECT * FROM {lesson_overrides}
1797                     WHERE groupid $extra AND lessonid = ?";
1798             $params[] = $this->properties->id;
1799             $records = $DB->get_records_sql($sql, $params);
1801             // Combine the overrides.
1802             $availables = array();
1803             $deadlines = array();
1804             $timelimits = array();
1805             $reviews = array();
1806             $attempts = array();
1807             $retakes = array();
1808             $passwords = array();
1810             foreach ($records as $gpoverride) {
1811                 if (isset($gpoverride->available)) {
1812                     $availables[] = $gpoverride->available;
1813                 }
1814                 if (isset($gpoverride->deadline)) {
1815                     $deadlines[] = $gpoverride->deadline;
1816                 }
1817                 if (isset($gpoverride->timelimit)) {
1818                     $timelimits[] = $gpoverride->timelimit;
1819                 }
1820                 if (isset($gpoverride->review)) {
1821                     $reviews[] = $gpoverride->review;
1822                 }
1823                 if (isset($gpoverride->maxattempts)) {
1824                     $attempts[] = $gpoverride->maxattempts;
1825                 }
1826                 if (isset($gpoverride->retake)) {
1827                     $retakes[] = $gpoverride->retake;
1828                 }
1829                 if (isset($gpoverride->password)) {
1830                     $passwords[] = $gpoverride->password;
1831                 }
1832             }
1833             // If there is a user override for a setting, ignore the group override.
1834             if (is_null($override->available) && count($availables)) {
1835                 $override->available = min($availables);
1836             }
1837             if (is_null($override->deadline) && count($deadlines)) {
1838                 if (in_array(0, $deadlines)) {
1839                     $override->deadline = 0;
1840                 } else {
1841                     $override->deadline = max($deadlines);
1842                 }
1843             }
1844             if (is_null($override->timelimit) && count($timelimits)) {
1845                 if (in_array(0, $timelimits)) {
1846                     $override->timelimit = 0;
1847                 } else {
1848                     $override->timelimit = max($timelimits);
1849                 }
1850             }
1851             if (is_null($override->review) && count($reviews)) {
1852                 $override->review = max($reviews);
1853             }
1854             if (is_null($override->maxattempts) && count($attempts)) {
1855                 $override->maxattempts = max($attempts);
1856             }
1857             if (is_null($override->retake) && count($retakes)) {
1858                 $override->retake = max($retakes);
1859             }
1860             if (is_null($override->password) && count($passwords)) {
1861                 $override->password = array_shift($passwords);
1862                 if (count($passwords)) {
1863                     $override->extrapasswords = $passwords;
1864                 }
1865             }
1867         }
1869         // Merge with lesson defaults.
1870         $keys = array('available', 'deadline', 'timelimit', 'maxattempts', 'review', 'retake');
1871         foreach ($keys as $key) {
1872             if (isset($override->{$key})) {
1873                 $this->properties->{$key} = $override->{$key};
1874             }
1875         }
1877         // Special handling of lesson usepassword and password.
1878         if (isset($override->password)) {
1879             if ($override->password == '') {
1880                 $this->properties->usepassword = 0;
1881             } else {
1882                 $this->properties->usepassword = 1;
1883                 $this->properties->password = $override->password;
1884                 if (isset($override->extrapasswords)) {
1885                     $this->properties->extrapasswords = $override->extrapasswords;
1886                 }
1887             }
1888         }
1889     }
1891     /**
1892      * Fetches messages from the session that may have been set in previous page
1893      * actions.
1894      *
1895      * <code>
1896      * // Do not call this method directly instead use
1897      * $lesson->messages;
1898      * </code>
1899      *
1900      * @return array
1901      */
1902     protected function get_messages() {
1903         global $SESSION;
1905         $messages = array();
1906         if (!empty($SESSION->lesson_messages) && is_array($SESSION->lesson_messages) && array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
1907             $messages = $SESSION->lesson_messages[$this->properties->id];
1908             unset($SESSION->lesson_messages[$this->properties->id]);
1909         }
1911         return $messages;
1912     }
1914     /**
1915      * Get all of the attempts for the current user.
1916      *
1917      * @param int $retries
1918      * @param bool $correct Optional: only fetch correct attempts
1919      * @param int $pageid Optional: only fetch attempts at the given page
1920      * @param int $userid Optional: defaults to the current user if not set
1921      * @return array|false
1922      */
1923     public function get_attempts($retries, $correct=false, $pageid=null, $userid=null) {
1924         global $USER, $DB;
1925         $params = array("lessonid"=>$this->properties->id, "userid"=>$userid, "retry"=>$retries);
1926         if ($correct) {
1927             $params['correct'] = 1;
1928         }
1929         if ($pageid !== null) {
1930             $params['pageid'] = $pageid;
1931         }
1932         if ($userid === null) {
1933             $params['userid'] = $USER->id;
1934         }
1935         return $DB->get_records('lesson_attempts', $params, 'timeseen ASC');
1936     }
1939     /**
1940      * Get a list of content pages (formerly known as branch tables) viewed in the lesson for the given user during an attempt.
1941      *
1942      * @param  int $lessonattempt the lesson attempt number (also known as retries)
1943      * @param  int $userid        the user id to retrieve the data from
1944      * @param  string $sort          an order to sort the results in (a valid SQL ORDER BY parameter)
1945      * @param  string $fields        a comma separated list of fields to return
1946      * @return array of pages
1947      * @since  Moodle 3.3
1948      */
1949     public function get_content_pages_viewed($lessonattempt, $userid = null, $sort = '', $fields = '*') {
1950         global $USER, $DB;
1952         if ($userid === null) {
1953             $userid = $USER->id;
1954         }
1955         $conditions = array("lessonid" => $this->properties->id, "userid" => $userid, "retry" => $lessonattempt);
1956         return $DB->get_records('lesson_branch', $conditions, $sort, $fields);
1957     }
1959     /**
1960      * Returns the first page for the lesson or false if there isn't one.
1961      *
1962      * This method should be called via the magic method __get();
1963      * <code>
1964      * $firstpage = $lesson->firstpage;
1965      * </code>
1966      *
1967      * @return lesson_page|bool Returns the lesson_page specialised object or false
1968      */
1969     protected function get_firstpage() {
1970         $pages = $this->load_all_pages();
1971         if (count($pages) > 0) {
1972             foreach ($pages as $page) {
1973                 if ((int)$page->prevpageid === 0) {
1974                     return $page;
1975                 }
1976             }
1977         }
1978         return false;
1979     }
1981     /**
1982      * Returns the last page for the lesson or false if there isn't one.
1983      *
1984      * This method should be called via the magic method __get();
1985      * <code>
1986      * $lastpage = $lesson->lastpage;
1987      * </code>
1988      *
1989      * @return lesson_page|bool Returns the lesson_page specialised object or false
1990      */
1991     protected function get_lastpage() {
1992         $pages = $this->load_all_pages();
1993         if (count($pages) > 0) {
1994             foreach ($pages as $page) {
1995                 if ((int)$page->nextpageid === 0) {
1996                     return $page;
1997                 }
1998             }
1999         }
2000         return false;
2001     }
2003     /**
2004      * Returns the id of the first page of this lesson. (prevpageid = 0)
2005      * @return int
2006      */
2007     protected function get_firstpageid() {
2008         global $DB;
2009         if ($this->firstpageid == null) {
2010             if (!$this->loadedallpages) {
2011                 $firstpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'prevpageid'=>0));
2012                 if (!$firstpageid) {
2013                     print_error('cannotfindfirstpage', 'lesson');
2014                 }
2015                 $this->firstpageid = $firstpageid;
2016             } else {
2017                 $firstpage = $this->get_firstpage();
2018                 $this->firstpageid = $firstpage->id;
2019             }
2020         }
2021         return $this->firstpageid;
2022     }
2024     /**
2025      * Returns the id of the last page of this lesson. (nextpageid = 0)
2026      * @return int
2027      */
2028     public function get_lastpageid() {
2029         global $DB;
2030         if ($this->lastpageid == null) {
2031             if (!$this->loadedallpages) {
2032                 $lastpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'nextpageid'=>0));
2033                 if (!$lastpageid) {
2034                     print_error('cannotfindlastpage', 'lesson');
2035                 }
2036                 $this->lastpageid = $lastpageid;
2037             } else {
2038                 $lastpageid = $this->get_lastpage();
2039                 $this->lastpageid = $lastpageid->id;
2040             }
2041         }
2043         return $this->lastpageid;
2044     }
2046      /**
2047      * Gets the next page id to display after the one that is provided.
2048      * @param int $nextpageid
2049      * @return bool
2050      */
2051     public function get_next_page($nextpageid) {
2052         global $USER, $DB;
2053         $allpages = $this->load_all_pages();
2054         if ($this->properties->nextpagedefault) {
2055             // in Flash Card mode...first get number of retakes
2056             $nretakes = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
2057             shuffle($allpages);
2058             $found = false;
2059             if ($this->properties->nextpagedefault == LESSON_UNSEENPAGE) {
2060                 foreach ($allpages as $nextpage) {
2061                     if (!$DB->count_records("lesson_attempts", array("pageid" => $nextpage->id, "userid" => $USER->id, "retry" => $nretakes))) {
2062                         $found = true;
2063                         break;
2064                     }
2065                 }
2066             } elseif ($this->properties->nextpagedefault == LESSON_UNANSWEREDPAGE) {
2067                 foreach ($allpages as $nextpage) {
2068                     if (!$DB->count_records("lesson_attempts", array('pageid' => $nextpage->id, 'userid' => $USER->id, 'correct' => 1, 'retry' => $nretakes))) {
2069                         $found = true;
2070                         break;
2071                     }
2072                 }
2073             }
2074             if ($found) {
2075                 if ($this->properties->maxpages) {
2076                     // check number of pages viewed (in the lesson)
2077                     if ($DB->count_records("lesson_attempts", array("lessonid" => $this->properties->id, "userid" => $USER->id, "retry" => $nretakes)) >= $this->properties->maxpages) {
2078                         return LESSON_EOL;
2079                     }
2080                 }
2081                 return $nextpage->id;
2082             }
2083         }
2084         // In a normal lesson mode
2085         foreach ($allpages as $nextpage) {
2086             if ((int)$nextpage->id === (int)$nextpageid) {
2087                 return $nextpage->id;
2088             }
2089         }
2090         return LESSON_EOL;
2091     }
2093     /**
2094      * Sets a message against the session for this lesson that will displayed next
2095      * time the lesson processes messages
2096      *
2097      * @param string $message
2098      * @param string $class
2099      * @param string $align
2100      * @return bool
2101      */
2102     public function add_message($message, $class="notifyproblem", $align='center') {
2103         global $SESSION;
2105         if (empty($SESSION->lesson_messages) || !is_array($SESSION->lesson_messages)) {
2106             $SESSION->lesson_messages = array();
2107             $SESSION->lesson_messages[$this->properties->id] = array();
2108         } else if (!array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
2109             $SESSION->lesson_messages[$this->properties->id] = array();
2110         }
2112         $SESSION->lesson_messages[$this->properties->id][] = array($message, $class, $align);
2114         return true;
2115     }
2117     /**
2118      * Check if the lesson is accessible at the present time
2119      * @return bool True if the lesson is accessible, false otherwise
2120      */
2121     public function is_accessible() {
2122         $available = $this->properties->available;
2123         $deadline = $this->properties->deadline;
2124         return (($available == 0 || time() >= $available) && ($deadline == 0 || time() < $deadline));
2125     }
2127     /**
2128      * Starts the lesson time for the current user
2129      * @return bool Returns true
2130      */
2131     public function start_timer() {
2132         global $USER, $DB;
2134         $cm = get_coursemodule_from_instance('lesson', $this->properties()->id, $this->properties()->course,
2135             false, MUST_EXIST);
2137         // Trigger lesson started event.
2138         $event = \mod_lesson\event\lesson_started::create(array(
2139             'objectid' => $this->properties()->id,
2140             'context' => context_module::instance($cm->id),
2141             'courseid' => $this->properties()->course
2142         ));
2143         $event->trigger();
2145         $USER->startlesson[$this->properties->id] = true;
2147         $timenow = time();
2148         $startlesson = new stdClass;
2149         $startlesson->lessonid = $this->properties->id;
2150         $startlesson->userid = $USER->id;
2151         $startlesson->starttime = $timenow;
2152         $startlesson->lessontime = $timenow;
2153         if (WS_SERVER) {
2154             $startlesson->timemodifiedoffline = $timenow;
2155         }
2156         $DB->insert_record('lesson_timer', $startlesson);
2157         if ($this->properties->timelimit) {
2158             $this->add_message(get_string('timelimitwarning', 'lesson', format_time($this->properties->timelimit)), 'center');
2159         }
2160         return true;
2161     }
2163     /**
2164      * Updates the timer to the current time and returns the new timer object
2165      * @param bool $restart If set to true the timer is restarted
2166      * @param bool $continue If set to true AND $restart=true then the timer
2167      *                        will continue from a previous attempt
2168      * @return stdClass The new timer
2169      */
2170     public function update_timer($restart=false, $continue=false, $endreached =false) {
2171         global $USER, $DB;
2173         $cm = get_coursemodule_from_instance('lesson', $this->properties->id, $this->properties->course);
2175         // clock code
2176         // get time information for this user
2177         if (!$timer = $this->get_user_timers($USER->id, 'starttime DESC', '*', 0, 1)) {
2178             $this->start_timer();
2179             $timer = $this->get_user_timers($USER->id, 'starttime DESC', '*', 0, 1);
2180         }
2181         $timer = current($timer); // This will get the latest start time record.
2183         if ($restart) {
2184             if ($continue) {
2185                 // continue a previous test, need to update the clock  (think this option is disabled atm)
2186                 $timer->starttime = time() - ($timer->lessontime - $timer->starttime);
2188                 // Trigger lesson resumed event.
2189                 $event = \mod_lesson\event\lesson_resumed::create(array(
2190                     'objectid' => $this->properties->id,
2191                     'context' => context_module::instance($cm->id),
2192                     'courseid' => $this->properties->course
2193                 ));
2194                 $event->trigger();
2196             } else {
2197                 // starting over, so reset the clock
2198                 $timer->starttime = time();
2200                 // Trigger lesson restarted event.
2201                 $event = \mod_lesson\event\lesson_restarted::create(array(
2202                     'objectid' => $this->properties->id,
2203                     'context' => context_module::instance($cm->id),
2204                     'courseid' => $this->properties->course
2205                 ));
2206                 $event->trigger();
2208             }
2209         }
2211         $timenow = time();
2212         $timer->lessontime = $timenow;
2213         if (WS_SERVER) {
2214             $timer->timemodifiedoffline = $timenow;
2215         }
2216         $timer->completed = $endreached;
2217         $DB->update_record('lesson_timer', $timer);
2219         // Update completion state.
2220         $cm = get_coursemodule_from_instance('lesson', $this->properties()->id, $this->properties()->course,
2221             false, MUST_EXIST);
2222         $course = get_course($cm->course);
2223         $completion = new completion_info($course);
2224         if ($completion->is_enabled($cm) && $this->properties()->completiontimespent > 0) {
2225             $completion->update_state($cm, COMPLETION_COMPLETE);
2226         }
2227         return $timer;
2228     }
2230     /**
2231      * Updates the timer to the current time then stops it by unsetting the user var
2232      * @return bool Returns true
2233      */
2234     public function stop_timer() {
2235         global $USER, $DB;
2236         unset($USER->startlesson[$this->properties->id]);
2238         $cm = get_coursemodule_from_instance('lesson', $this->properties()->id, $this->properties()->course,
2239             false, MUST_EXIST);
2241         // Trigger lesson ended event.
2242         $event = \mod_lesson\event\lesson_ended::create(array(
2243             'objectid' => $this->properties()->id,
2244             'context' => context_module::instance($cm->id),
2245             'courseid' => $this->properties()->course
2246         ));
2247         $event->trigger();
2249         return $this->update_timer(false, false, true);
2250     }
2252     /**
2253      * Checks to see if the lesson has pages
2254      */
2255     public function has_pages() {
2256         global $DB;
2257         $pagecount = $DB->count_records('lesson_pages', array('lessonid'=>$this->properties->id));
2258         return ($pagecount>0);
2259     }
2261     /**
2262      * Returns the link for the related activity
2263      * @return string
2264      */
2265     public function link_for_activitylink() {
2266         global $DB;
2267         $module = $DB->get_record('course_modules', array('id' => $this->properties->activitylink));
2268         if ($module) {
2269             $modname = $DB->get_field('modules', 'name', array('id' => $module->module));
2270             if ($modname) {
2271                 $instancename = $DB->get_field($modname, 'name', array('id' => $module->instance));
2272                 if ($instancename) {
2273                     return html_writer::link(new moodle_url('/mod/'.$modname.'/view.php',
2274                         array('id' => $this->properties->activitylink)), get_string('activitylinkname',
2275                         'lesson', $instancename), array('class' => 'centerpadded lessonbutton standardbutton p-r-1'));
2276                 }
2277             }
2278         }
2279         return '';
2280     }
2282     /**
2283      * Loads the requested page.
2284      *
2285      * This function will return the requested page id as either a specialised
2286      * lesson_page object OR as a generic lesson_page.
2287      * If the page has been loaded previously it will be returned from the pages
2288      * array, otherwise it will be loaded from the database first
2289      *
2290      * @param int $pageid
2291      * @return lesson_page A lesson_page object or an object that extends it
2292      */
2293     public function load_page($pageid) {
2294         if (!array_key_exists($pageid, $this->pages)) {
2295             $manager = lesson_page_type_manager::get($this);
2296             $this->pages[$pageid] = $manager->load_page($pageid, $this);
2297         }
2298         return $this->pages[$pageid];
2299     }
2301     /**
2302      * Loads ALL of the pages for this lesson
2303      *
2304      * @return array An array containing all pages from this lesson
2305      */
2306     public function load_all_pages() {
2307         if (!$this->loadedallpages) {
2308             $manager = lesson_page_type_manager::get($this);
2309             $this->pages = $manager->load_all_pages($this);
2310             $this->loadedallpages = true;
2311         }
2312         return $this->pages;
2313     }
2315     /**
2316      * Duplicate the lesson page.
2317      *
2318      * @param  int $pageid Page ID of the page to duplicate.
2319      * @return void.
2320      */
2321     public function duplicate_page($pageid) {
2322         global $PAGE;
2323         $cm = get_coursemodule_from_instance('lesson', $this->properties->id, $this->properties->course);
2324         $context = context_module::instance($cm->id);
2325         // Load the page.
2326         $page = $this->load_page($pageid);
2327         $properties = $page->properties();
2328         // The create method checks to see if these properties are set and if not sets them to zero, hence the unsetting here.
2329         if (!$properties->qoption) {
2330             unset($properties->qoption);
2331         }
2332         if (!$properties->layout) {
2333             unset($properties->layout);
2334         }
2335         if (!$properties->display) {
2336             unset($properties->display);
2337         }
2339         $properties->pageid = $pageid;
2340         // Add text and format into the format required to create a new page.
2341         $properties->contents_editor = array(
2342             'text' => $properties->contents,
2343             'format' => $properties->contentsformat
2344         );
2345         $answers = $page->get_answers();
2346         // Answers need to be added to $properties.
2347         $i = 0;
2348         $answerids = array();
2349         foreach ($answers as $answer) {
2350             // Needs to be rearranged to work with the create function.
2351             $properties->answer_editor[$i] = array(
2352                 'text' => $answer->answer,
2353                 'format' => $answer->answerformat
2354             );
2356             $properties->response_editor[$i] = array(
2357               'text' => $answer->response,
2358               'format' => $answer->responseformat
2359             );
2360             $answerids[] = $answer->id;
2362             $properties->jumpto[$i] = $answer->jumpto;
2363             $properties->score[$i] = $answer->score;
2365             $i++;
2366         }
2367         // Create the duplicate page.
2368         $newlessonpage = lesson_page::create($properties, $this, $context, $PAGE->course->maxbytes);
2369         $newanswers = $newlessonpage->get_answers();
2370         // Copy over the file areas as well.
2371         $this->copy_page_files('page_contents', $pageid, $newlessonpage->id, $context->id);
2372         $j = 0;
2373         foreach ($newanswers as $answer) {
2374             if (isset($answer->answer) && strpos($answer->answer, '@@PLUGINFILE@@') !== false) {
2375                 $this->copy_page_files('page_answers', $answerids[$j], $answer->id, $context->id);
2376             }
2377             if (isset($answer->response) && !is_array($answer->response) && strpos($answer->response, '@@PLUGINFILE@@') !== false) {
2378                 $this->copy_page_files('page_responses', $answerids[$j], $answer->id, $context->id);
2379             }
2380             $j++;
2381         }
2382     }
2384     /**
2385      * Copy the files from one page to another.
2386      *
2387      * @param  string $filearea Area that the files are stored.
2388      * @param  int $itemid Item ID.
2389      * @param  int $newitemid The item ID for the new page.
2390      * @param  int $contextid Context ID for this page.
2391      * @return void.
2392      */
2393     protected function copy_page_files($filearea, $itemid, $newitemid, $contextid) {
2394         $fs = get_file_storage();
2395         $files = $fs->get_area_files($contextid, 'mod_lesson', $filearea, $itemid);
2396         foreach ($files as $file) {
2397             $fieldupdates = array('itemid' => $newitemid);
2398             $fs->create_file_from_storedfile($fieldupdates, $file);
2399         }
2400     }
2402     /**
2403      * Determines if a jumpto value is correct or not.
2404      *
2405      * returns true if jumpto page is (logically) after the pageid page or
2406      * if the jumpto value is a special value.  Returns false in all other cases.
2407      *
2408      * @param int $pageid Id of the page from which you are jumping from.
2409      * @param int $jumpto The jumpto number.
2410      * @return boolean True or false after a series of tests.
2411      **/
2412     public function jumpto_is_correct($pageid, $jumpto) {
2413         global $DB;
2415         // first test the special values
2416         if (!$jumpto) {
2417             // same page
2418             return false;
2419         } elseif ($jumpto == LESSON_NEXTPAGE) {
2420             return true;
2421         } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
2422             return true;
2423         } elseif ($jumpto == LESSON_RANDOMPAGE) {
2424             return true;
2425         } elseif ($jumpto == LESSON_CLUSTERJUMP) {
2426             return true;
2427         } elseif ($jumpto == LESSON_EOL) {
2428             return true;
2429         }
2431         $pages = $this->load_all_pages();
2432         $apageid = $pages[$pageid]->nextpageid;
2433         while ($apageid != 0) {
2434             if ($jumpto == $apageid) {
2435                 return true;
2436             }
2437             $apageid = $pages[$apageid]->nextpageid;
2438         }
2439         return false;
2440     }
2442     /**
2443      * Returns the time a user has remaining on this lesson
2444      * @param int $starttime Starttime timestamp
2445      * @return string
2446      */
2447     public function time_remaining($starttime) {
2448         $timeleft = $starttime + $this->properties->timelimit - time();
2449         $hours = floor($timeleft/3600);
2450         $timeleft = $timeleft - ($hours * 3600);
2451         $minutes = floor($timeleft/60);
2452         $secs = $timeleft - ($minutes * 60);
2454         if ($minutes < 10) {
2455             $minutes = "0$minutes";
2456         }
2457         if ($secs < 10) {
2458             $secs = "0$secs";
2459         }
2460         $output   = array();
2461         $output[] = $hours;
2462         $output[] = $minutes;
2463         $output[] = $secs;
2464         $output = implode(':', $output);
2465         return $output;
2466     }
2468     /**
2469      * Interprets LESSON_CLUSTERJUMP jumpto value.
2470      *
2471      * This will select a page randomly
2472      * and the page selected will be inbetween a cluster page and end of clutter or end of lesson
2473      * and the page selected will be a page that has not been viewed already
2474      * and if any pages are within a branch table or end of branch then only 1 page within
2475      * the branch table or end of branch will be randomly selected (sub clustering).
2476      *
2477      * @param int $pageid Id of the current page from which we are jumping from.
2478      * @param int $userid Id of the user.
2479      * @return int The id of the next page.
2480      **/
2481     public function cluster_jump($pageid, $userid=null) {
2482         global $DB, $USER;
2484         if ($userid===null) {
2485             $userid = $USER->id;
2486         }
2487         // get the number of retakes
2488         if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->properties->id, "userid"=>$userid))) {
2489             $retakes = 0;
2490         }
2491         // get all the lesson_attempts aka what the user has seen
2492         $seenpages = array();
2493         if ($attempts = $this->get_attempts($retakes)) {
2494             foreach ($attempts as $attempt) {
2495                 $seenpages[$attempt->pageid] = $attempt->pageid;
2496             }
2498         }
2500         // get the lesson pages
2501         $lessonpages = $this->load_all_pages();
2502         // find the start of the cluster
2503         while ($pageid != 0) { // this condition should not be satisfied... should be a cluster page
2504             if ($lessonpages[$pageid]->qtype == LESSON_PAGE_CLUSTER) {
2505                 break;
2506             }
2507             $pageid = $lessonpages[$pageid]->prevpageid;
2508         }
2510         $clusterpages = array();
2511         $clusterpages = $this->get_sub_pages_of($pageid, array(LESSON_PAGE_ENDOFCLUSTER));
2512         $unseen = array();
2513         foreach ($clusterpages as $key=>$cluster) {
2514             // Remove the page if  it is in a branch table or is an endofbranch.
2515             if ($this->is_sub_page_of_type($cluster->id,
2516                     array(LESSON_PAGE_BRANCHTABLE), array(LESSON_PAGE_ENDOFBRANCH, LESSON_PAGE_CLUSTER))
2517                     || $cluster->qtype == LESSON_PAGE_ENDOFBRANCH) {
2518                 unset($clusterpages[$key]);
2519             } else if ($cluster->qtype == LESSON_PAGE_BRANCHTABLE) {
2520                 // If branchtable, check to see if any pages inside have been viewed.
2521                 $branchpages = $this->get_sub_pages_of($cluster->id, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
2522                 $flag = true;
2523                 foreach ($branchpages as $branchpage) {
2524                     if (array_key_exists($branchpage->id, $seenpages)) {  // Check if any of the pages have been viewed.
2525                         $flag = false;
2526                     }
2527                 }
2528                 if ($flag && count($branchpages) > 0) {
2529                     // Add branch table.
2530                     $unseen[] = $cluster;
2531                 }
2532             } elseif ($cluster->is_unseen($seenpages)) {
2533                 $unseen[] = $cluster;
2534             }
2535         }
2537         if (count($unseen) > 0) {
2538             // it does not contain elements, then use exitjump, otherwise find out next page/branch
2539             $nextpage = $unseen[rand(0, count($unseen)-1)];
2540             if ($nextpage->qtype == LESSON_PAGE_BRANCHTABLE) {
2541                 // if branch table, then pick a random page inside of it
2542                 $branchpages = $this->get_sub_pages_of($nextpage->id, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
2543                 return $branchpages[rand(0, count($branchpages)-1)]->id;
2544             } else { // otherwise, return the page's id
2545                 return $nextpage->id;
2546             }
2547         } else {
2548             // seen all there is to see, leave the cluster
2549             if (end($clusterpages)->nextpageid == 0) {
2550                 return LESSON_EOL;
2551             } else {
2552                 $clusterendid = $pageid;
2553                 while ($clusterendid != 0) { // This condition should not be satisfied... should be an end of cluster page.
2554                     if ($lessonpages[$clusterendid]->qtype == LESSON_PAGE_ENDOFCLUSTER) {
2555                         break;
2556                     }
2557                     $clusterendid = $lessonpages[$clusterendid]->nextpageid;
2558                 }
2559                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $clusterendid, "lessonid" => $this->properties->id));
2560                 if ($exitjump == LESSON_NEXTPAGE) {
2561                     $exitjump = $lessonpages[$clusterendid]->nextpageid;
2562                 }
2563                 if ($exitjump == 0) {
2564                     return LESSON_EOL;
2565                 } else if (in_array($exitjump, array(LESSON_EOL, LESSON_PREVIOUSPAGE))) {
2566                     return $exitjump;
2567                 } else {
2568                     if (!array_key_exists($exitjump, $lessonpages)) {
2569                         $found = false;
2570                         foreach ($lessonpages as $page) {
2571                             if ($page->id === $clusterendid) {
2572                                 $found = true;
2573                             } else if ($page->qtype == LESSON_PAGE_ENDOFCLUSTER) {
2574                                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $page->id, "lessonid" => $this->properties->id));
2575                                 if ($exitjump == LESSON_NEXTPAGE) {
2576                                     $exitjump = $lessonpages[$page->id]->nextpageid;
2577                                 }
2578                                 break;
2579                             }
2580                         }
2581                     }
2582                     if (!array_key_exists($exitjump, $lessonpages)) {
2583                         return LESSON_EOL;
2584                     }
2585                     // Check to see that the return type is not a cluster.
2586                     if ($lessonpages[$exitjump]->qtype == LESSON_PAGE_CLUSTER) {
2587                         // If the exitjump is a cluster then go through this function again and try to find an unseen question.
2588                         $exitjump = $this->cluster_jump($exitjump, $userid);
2589                     }
2590                     return $exitjump;
2591                 }
2592             }
2593         }
2594     }
2596     /**
2597      * Finds all pages that appear to be a subtype of the provided pageid until
2598      * an end point specified within $ends is encountered or no more pages exist
2599      *
2600      * @param int $pageid
2601      * @param array $ends An array of LESSON_PAGE_* types that signify an end of
2602      *               the subtype
2603      * @return array An array of specialised lesson_page objects
2604      */
2605     public function get_sub_pages_of($pageid, array $ends) {
2606         $lessonpages = $this->load_all_pages();
2607         $pageid = $lessonpages[$pageid]->nextpageid;  // move to the first page after the branch table
2608         $pages = array();
2610         while (true) {
2611             if ($pageid == 0 || in_array($lessonpages[$pageid]->qtype, $ends)) {
2612                 break;
2613             }
2614             $pages[] = $lessonpages[$pageid];
2615             $pageid = $lessonpages[$pageid]->nextpageid;
2616         }
2618         return $pages;
2619     }
2621     /**
2622      * Checks to see if the specified page[id] is a subpage of a type specified in
2623      * the $types array, until either there are no more pages of we find a type
2624      * corresponding to that of a type specified in $ends
2625      *
2626      * @param int $pageid The id of the page to check
2627      * @param array $types An array of types that would signify this page was a subpage
2628      * @param array $ends An array of types that mean this is not a subpage
2629      * @return bool
2630      */
2631     public function is_sub_page_of_type($pageid, array $types, array $ends) {
2632         $pages = $this->load_all_pages();
2633         $pageid = $pages[$pageid]->prevpageid; // move up one
2635         array_unshift($ends, 0);
2636         // go up the pages till branch table
2637         while (true) {
2638             if ($pageid==0 || in_array($pages[$pageid]->qtype, $ends)) {
2639                 return false;
2640             } else if (in_array($pages[$pageid]->qtype, $types)) {
2641                 return true;
2642             }
2643             $pageid = $pages[$pageid]->prevpageid;
2644         }
2645     }
2647     /**
2648      * Move a page resorting all other pages.
2649      *
2650      * @param int $pageid
2651      * @param int $after
2652      * @return void
2653      */
2654     public function resort_pages($pageid, $after) {
2655         global $CFG;
2657         $cm = get_coursemodule_from_instance('lesson', $this->properties->id, $this->properties->course);
2658         $context = context_module::instance($cm->id);
2660         $pages = $this->load_all_pages();
2662         if (!array_key_exists($pageid, $pages) || ($after!=0 && !array_key_exists($after, $pages))) {
2663             print_error('cannotfindpages', 'lesson', "$CFG->wwwroot/mod/lesson/edit.php?id=$cm->id");
2664         }
2666         $pagetomove = clone($pages[$pageid]);
2667         unset($pages[$pageid]);
2669         $pageids = array();
2670         if ($after === 0) {
2671             $pageids['p0'] = $pageid;
2672         }
2673         foreach ($pages as $page) {
2674             $pageids[] = $page->id;
2675             if ($page->id == $after) {
2676                 $pageids[] = $pageid;
2677             }
2678         }
2680         $pageidsref = $pageids;
2681         reset($pageidsref);
2682         $prev = 0;
2683         $next = next($pageidsref);
2684         foreach ($pageids as $pid) {
2685             if ($pid === $pageid) {
2686                 $page = $pagetomove;
2687             } else {
2688                 $page = $pages[$pid];
2689             }
2690             if ($page->prevpageid != $prev || $page->nextpageid != $next) {
2691                 $page->move($next, $prev);
2693                 if ($pid === $pageid) {
2694                     // We will trigger an event.
2695                     $pageupdated = array('next' => $next, 'prev' => $prev);
2696                 }
2697             }
2699             $prev = $page->id;
2700             $next = next($pageidsref);
2701             if (!$next) {
2702                 $next = 0;
2703             }
2704         }
2706         // Trigger an event: page moved.
2707         if (!empty($pageupdated)) {
2708             $eventparams = array(
2709                 'context' => $context,
2710                 'objectid' => $pageid,
2711                 'other' => array(
2712                     'pagetype' => $page->get_typestring(),
2713                     'prevpageid' => $pageupdated['prev'],
2714                     'nextpageid' => $pageupdated['next']
2715                 )
2716             );
2717             $event = \mod_lesson\event\page_moved::create($eventparams);
2718             $event->trigger();
2719         }
2721     }
2723     /**
2724      * Return the lesson context object.
2725      *
2726      * @return stdClass context
2727      * @since  Moodle 3.3
2728      */
2729     public function get_context() {
2730         if ($this->context == null) {
2731             $this->context = context_module::instance($this->get_cm()->id);
2732         }
2733         return $this->context;
2734     }
2736     /**
2737      * Set the lesson course module object.
2738      *
2739      * @param stdClass $cm course module objct
2740      * @since  Moodle 3.3
2741      */
2742     private function set_cm($cm) {
2743         $this->cm = $cm;
2744     }
2746     /**
2747      * Return the lesson course module object.
2748      *
2749      * @return stdClass course module
2750      * @since  Moodle 3.3
2751      */
2752     public function get_cm() {
2753         if ($this->cm == null) {
2754             $this->cm = get_coursemodule_from_instance('lesson', $this->properties->id);
2755         }
2756         return $this->cm;
2757     }
2759     /**
2760      * Set the lesson course object.
2761      *
2762      * @param stdClass $course course objct
2763      * @since  Moodle 3.3
2764      */
2765     private function set_courserecord($course) {
2766         $this->courserecord = $course;
2767     }
2769     /**
2770      * Return the lesson course object.
2771      *
2772      * @return stdClass course
2773      * @since  Moodle 3.3
2774      */
2775     public function get_courserecord() {
2776         global $DB;
2778         if ($this->courserecord == null) {
2779             $this->courserecord = $DB->get_record('course', array('id' => $this->properties->course));
2780         }
2781         return $this->courserecord;
2782     }
2784     /**
2785      * Check if the user can manage the lesson activity.
2786      *
2787      * @return bool true if the user can manage the lesson
2788      * @since  Moodle 3.3
2789      */
2790     public function can_manage() {
2791         return has_capability('mod/lesson:manage', $this->get_context());
2792     }
2794     /**
2795      * Check if time restriction is applied.
2796      *
2797      * @return mixed false if  there aren't restrictions or an object with the restriction information
2798      * @since  Moodle 3.3
2799      */
2800     public function get_time_restriction_status() {
2801         if ($this->can_manage()) {
2802             return false;
2803         }
2805         if (!$this->is_accessible()) {
2806             if ($this->properties->deadline != 0 && time() > $this->properties->deadline) {
2807                 $status = ['reason' => 'lessonclosed', 'time' => $this->properties->deadline];
2808             } else {
2809                 $status = ['reason' => 'lessonopen', 'time' => $this->properties->available];
2810             }
2811             return (object) $status;
2812         }
2813         return false;
2814     }
2816     /**
2817      * Check if password restriction is applied.
2818      *
2819      * @param string $userpassword the user password to check (if the restriction is set)
2820      * @return mixed false if there aren't restrictions or an object with the restriction information
2821      * @since  Moodle 3.3
2822      */
2823     public function get_password_restriction_status($userpassword) {
2824         global $USER;
2825         if ($this->can_manage()) {
2826             return false;
2827         }
2829         if ($this->properties->usepassword && empty($USER->lessonloggedin[$this->id])) {
2830             $correctpass = false;
2831             if (!empty($userpassword) &&
2832                     (($this->properties->password == md5(trim($userpassword))) || ($this->properties->password == trim($userpassword)))) {
2833                 // With or without md5 for backward compatibility (MDL-11090).
2834                 $correctpass = true;
2835                 $USER->lessonloggedin[$this->id] = true;
2836             } else if (isset($this->properties->extrapasswords)) {
2837                 // Group overrides may have additional passwords.
2838                 foreach ($this->properties->extrapasswords as $password) {
2839                     if (strcmp($password, md5(trim($userpassword))) === 0 || strcmp($password, trim($userpassword)) === 0) {
2840                         $correctpass = true;
2841                         $USER->lessonloggedin[$this->id] = true;
2842                     }
2843                 }
2844             }
2845             return !$correctpass;
2846         }
2847         return false;
2848     }
2850     /**
2851      * Check if dependencies restrictions are applied.
2852      *
2853      * @return mixed false if there aren't restrictions or an object with the restriction information
2854      * @since  Moodle 3.3
2855      */
2856     public function get_dependencies_restriction_status() {
2857         global $DB, $USER;
2858         if ($this->can_manage()) {
2859             return false;
2860         }
2862         if ($dependentlesson = $DB->get_record('lesson', array('id' => $this->properties->dependency))) {
2863             // Lesson exists, so we can proceed.
2864             $conditions = unserialize($this->properties->conditions);
2865             // Assume false for all.
2866             $errors = array();
2867             // Check for the timespent condition.
2868             if ($conditions->timespent) {
2869                 $timespent = false;
2870                 if ($attempttimes = $DB->get_records('lesson_timer', array("userid" => $USER->id, "lessonid" => $dependentlesson->id))) {
2871                     // Go through all the times and test to see if any of them satisfy the condition.
2872                     foreach ($attempttimes as $attempttime) {
2873                         $duration = $attempttime->lessontime - $attempttime->starttime;
2874                         if ($conditions->timespent < $duration / 60) {
2875                             $timespent = true;
2876                         }
2877                     }
2878                 }
2879                 if (!$timespent) {
2880                     $errors[] = get_string('timespenterror', 'lesson', $conditions->timespent);
2881                 }
2882             }
2883             // Check for the gradebetterthan condition.
2884             if ($conditions->gradebetterthan) {
2885                 $gradebetterthan = false;
2886                 if ($studentgrades = $DB->get_records('lesson_grades', array("userid" => $USER->id, "lessonid" => $dependentlesson->id))) {
2887                     // Go through all the grades and test to see if any of them satisfy the condition.
2888                     foreach ($studentgrades as $studentgrade) {
2889                         if ($studentgrade->grade >= $conditions->gradebetterthan) {
2890                             $gradebetterthan = true;
2891                         }
2892                     }
2893                 }
2894                 if (!$gradebetterthan) {
2895                     $errors[] = get_string('gradebetterthanerror', 'lesson', $conditions->gradebetterthan);
2896                 }
2897             }
2898             // Check for the completed condition.
2899             if ($conditions->completed) {
2900                 if (!$DB->count_records('lesson_grades', array('userid' => $USER->id, 'lessonid' => $dependentlesson->id))) {
2901                     $errors[] = get_string('completederror', 'lesson');
2902                 }
2903             }
2904             if (!empty($errors)) {
2905                 return (object) ['errors' => $errors, 'dependentlesson' => $dependentlesson];
2906             }
2907         }
2908         return false;
2909     }
2911     /**
2912      * Check if the lesson is in review mode. (The user already finished it and retakes are not allowed).
2913      *
2914      * @return bool true if is in review mode
2915      * @since  Moodle 3.3
2916      */
2917     public function is_in_review_mode() {
2918         global $DB, $USER;
2920         $userhasgrade = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
2921         if ($userhasgrade && !$this->properties->retake) {
2922             return true;
2923         }
2924         return false;
2925     }
2927     /**
2928      * Return the last page the current user saw.
2929      *
2930      * @param int $retriescount the number of retries for the lesson (the last retry number).
2931      * @return mixed false if the user didn't see the lesson or the last page id
2932      */
2933     public function get_last_page_seen($retriescount) {
2934         global $DB, $USER;
2936         $lastpageseen = false;
2937         $allattempts = $this->get_attempts($retriescount);
2938         if (!empty($allattempts)) {
2939             $attempt = end($allattempts);
2940             $attemptpage = $this->load_page($attempt->pageid);
2941             $jumpto = $DB->get_field('lesson_answers', 'jumpto', array('id' => $attempt->answerid));
2942             // Convert the jumpto to a proper page id.
2943             if ($jumpto == 0) {
2944                 // Check if a question has been incorrectly answered AND no more attempts at it are left.
2945                 $nattempts = $this->get_attempts($attempt->retry, false, $attempt->pageid, $USER->id);
2946                 if (count($nattempts) >= $this->properties->maxattempts) {
2947                     $lastpageseen = $this->get_next_page($attemptpage->nextpageid);
2948                 } else {
2949                     $lastpageseen = $attempt->pageid;
2950                 }
2951             } else if ($jumpto == LESSON_NEXTPAGE) {
2952                 $lastpageseen = $this->get_next_page($attemptpage->nextpageid);
2953             } else if ($jumpto == LESSON_CLUSTERJUMP) {
2954                 $lastpageseen = $this->cluster_jump($attempt->pageid);
2955             } else {
2956                 $lastpageseen = $jumpto;
2957             }
2958         }
2960         if ($branchtables = $this->get_content_pages_viewed($retriescount, $USER->id, 'timeseen DESC')) {
2961             // In here, user has viewed a branch table.
2962             $lastbranchtable = current($branchtables);
2963             if (count($allattempts) > 0) {
2964                 if ($lastbranchtable->timeseen > $attempt->timeseen) {
2965                     // This branch table was viewed more recently than the question page.
2966                     if (!empty($lastbranchtable->nextpageid)) {
2967                         $lastpageseen = $lastbranchtable->nextpageid;
2968                     } else {
2969                         // Next page ID did not exist prior to MDL-34006.
2970                         $lastpageseen = $lastbranchtable->pageid;
2971                     }
2972                 }
2973             } else {
2974                 // Has not answered any questions but has viewed a branch table.
2975                 if (!empty($lastbranchtable->nextpageid)) {
2976                     $lastpageseen = $lastbranchtable->nextpageid;
2977                 } else {
2978                     // Next page ID did not exist prior to MDL-34006.
2979                     $lastpageseen = $lastbranchtable->pageid;
2980                 }
2981             }
2982         }
2983         return $lastpageseen;
2984     }
2986     /**
2987      * Return the number of retries in a lesson for a given user.
2988      *
2989      * @param  int $userid the user id
2990      * @return int the retries count
2991      * @since  Moodle 3.3
2992      */
2993     public function count_user_retries($userid) {
2994         global $DB;
2996         return $DB->count_records('lesson_grades', array("lessonid" => $this->properties->id, "userid" => $userid));
2997     }
2999     /**
3000      * Check if a user left a timed session.
3001      *
3002      * @param int $retriescount the number of retries for the lesson (the last retry number).
3003      * @return true if the user left the timed session
3004      * @since  Moodle 3.3
3005      */
3006     public function left_during_timed_session($retriescount) {
3007         global $DB, $USER;
3009         $conditions = array('lessonid' => $this->properties->id, 'userid' => $USER->id, 'retry' => $retriescount);
3010         return $DB->count_records('lesson_attempts', $conditions) > 0 || $DB->count_records('lesson_branch', $conditions) > 0;
3011     }
3013     /**
3014      * Trigger module viewed event and set the module viewed for completion.
3015      *
3016      * @since  Moodle 3.3
3017      */
3018     public function set_module_viewed() {
3019         global $CFG;
3020         require_once($CFG->libdir . '/completionlib.php');
3022         // Trigger module viewed event.
3023         $event = \mod_lesson\event\course_module_viewed::create(array(
3024             'objectid' => $this->properties->id,
3025             'context' => $this->get_context()
3026         ));
3027         $event->add_record_snapshot('course_modules', $this->get_cm());
3028         $event->add_record_snapshot('course', $this->get_courserecord());
3029         $event->trigger();
3031         // Mark as viewed.
3032         $completion = new completion_info($this->get_courserecord());
3033         $completion->set_module_viewed($this->get_cm());
3034     }
3036     /**
3037      * Return the timers in the current lesson for the given user.
3038      *
3039      * @param  int      $userid    the user id
3040      * @param  string   $sort      an order to sort the results in (optional, a valid SQL ORDER BY parameter).
3041      * @param  string   $fields    a comma separated list of fields to return
3042      * @param  int      $limitfrom return a subset of records, starting at this point (optional).
3043      * @param  int      $limitnum  return a subset comprising this many records in total (optional, required if $limitfrom is set).
3044      * @return array    list of timers for the given user in the lesson
3045      * @since  Moodle 3.3
3046      */
3047     public function get_user_timers($userid = null, $sort = '', $fields = '*', $limitfrom = 0, $limitnum = 0) {
3048         global $DB, $USER;
3050         if ($userid === null) {
3051             $userid = $USER->id;
3052         }
3054         $params = array('lessonid' => $this->properties->id, 'userid' => $userid);
3055         return $DB->get_records('lesson_timer', $params, $sort, $fields, $limitfrom, $limitnum);
3056     }
3058     /**
3059      * Check if the user is out of time in a timed lesson.
3060      *
3061      * @param  stdClass $timer timer object
3062      * @return bool True if the user is on time, false is the user ran out of time
3063      * @since  Moodle 3.3
3064      */
3065     public function check_time($timer) {
3066         if ($this->properties->timelimit) {
3067             $timeleft = $timer->starttime + $this->properties->timelimit - time();
3068             if ($timeleft <= 0) {
3069                 // Out of time.
3070                 $this->add_message(get_string('eolstudentoutoftime', 'lesson'));
3071                 return false;
3072             } else if ($timeleft < 60) {
3073                 // One minute warning.
3074                 $this->add_message(get_string('studentoneminwarning', 'lesson'));
3075             }
3076         }
3077         return true;
3078     }
3080     /**
3081      * Add different informative messages to the given page.
3082      *
3083      * @param lesson_page $page page object
3084      * @param reviewmode $bool whether we are in review mode or not
3085      * @since  Moodle 3.3
3086      */
3087     public function add_messages_on_page_view(lesson_page $page, $reviewmode) {
3088         global $DB, $USER;
3090         if (!$this->can_manage()) {
3091             if ($page->qtype == LESSON_PAGE_BRANCHTABLE && $this->properties->minquestions) {
3092                 // Tell student how many questions they have seen, how many are required and their grade.
3093                 $ntries = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
3094                 $gradeinfo = lesson_grade($this, $ntries);
3095                 if ($gradeinfo->attempts) {
3096                     if ($gradeinfo->nquestions < $this->properties->minquestions) {
3097                         $a = new stdClass;
3098                         $a->nquestions   = $gradeinfo->nquestions;
3099                         $a->minquestions = $this->properties->minquestions;
3100                         $this->add_message(get_string('numberofpagesviewednotice', 'lesson', $a));
3101                     }
3103                     if (!$reviewmode && $this->properties->ongoing) {
3104                         $this->add_message(get_string("numberofcorrectanswers", "lesson", $gradeinfo->earned), 'notify');
3105                         if ($this->properties->grade != GRADE_TYPE_NONE) {
3106                             $a = new stdClass;
3107                             $a->grade = number_format($gradeinfo->grade * $this->properties->grade / 100, 1);
3108                             $a->total = $this->properties->grade;
3109                             $this->add_message(get_string('yourcurrentgradeisoutof', 'lesson', $a), 'notify');
3110                         }
3111                     }
3112                 }
3113             }
3114         } else {
3115             if ($this->properties->timelimit) {
3116                 $this->add_message(get_string('teachertimerwarning', 'lesson'));
3117             }
3118             if (lesson_display_teacher_warning($this)) {
3119                 // This is the warning msg for teachers to inform them that cluster
3120                 // and unseen does not work while logged in as a teacher.
3121                 $warningvars = new stdClass();
3122                 $warningvars->cluster = get_string('clusterjump', 'lesson');
3123                 $warningvars->unseen = get_string('unseenpageinbranch', 'lesson');
3124                 $this->add_message(get_string('teacherjumpwarning', 'lesson', $warningvars));
3125             }
3126         }
3127     }
3129     /**
3130      * Get the ongoing score message for the user (depending on the user permission and lesson settings).
3131      *
3132      * @return str the ongoing score message
3133      * @since  Moodle 3.3
3134      */
3135     public function get_ongoing_score_message() {
3136         global $USER, $DB;
3138         $context = $this->get_context();
3140         if (has_capability('mod/lesson:manage', $context)) {
3141             return get_string('teacherongoingwarning', 'lesson');
3142         } else {
3143             $ntries = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
3144             if (isset($USER->modattempts[$this->properties->id])) {
3145                 $ntries--;
3146             }
3147             $gradeinfo = lesson_grade($this, $ntries);
3148             $a = new stdClass;
3149             if ($this->properties->custom) {
3150                 $a->score = $gradeinfo->earned;
3151                 $a->currenthigh = $gradeinfo->total;
3152                 return get_string("ongoingcustom", "lesson", $a);
3153             } else {
3154                 $a->correct = $gradeinfo->earned;
3155                 $a->viewed = $gradeinfo->attempts;
3156                 return get_string("ongoingnormal", "lesson", $a);
3157             }
3158         }
3159     }
3161     /**
3162      * Calculate the progress of the current user in the lesson.
3163      *
3164      * @return int the progress (scale 0-100)
3165      * @since  Moodle 3.3
3166      */
3167     public function calculate_progress() {
3168         global $USER, $DB;
3170         // Check if the user is reviewing the attempt.
3171         if (isset($USER->modattempts[$this->properties->id])) {
3172             return 100;
3173         }
3175         // All of the lesson pages.
3176         $pages = $this->load_all_pages();
3177         foreach ($pages as $page) {
3178             if ($page->prevpageid == 0) {
3179                 $pageid = $page->id;  // Find the first page id.
3180                 break;
3181             }
3182         }
3184         // Current attempt number.
3185         if (!$ntries = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id))) {
3186             $ntries = 0;  // May not be necessary.
3187         }
3189         $viewedpageids = array();
3190         if ($attempts = $this->get_attempts($ntries, false)) {
3191             foreach ($attempts as $attempt) {
3192                 $viewedpageids[$attempt->pageid] = $attempt;
3193             }
3194         }
3196         $viewedbranches = array();
3197         // Collect all of the branch tables viewed.
3198         if ($branches = $this->get_content_pages_viewed($ntries, $USER->id, 'timeseen ASC', 'id, pageid')) {
3199             foreach ($branches as $branch) {
3200                 $viewedbranches[$branch->pageid] = $branch;
3201             }
3202             $viewedpageids = array_merge($viewedpageids, $viewedbranches);
3203         }
3205         // Filter out the following pages:
3206         // - End of Cluster
3207         // - End of Branch
3208         // - Pages found inside of Clusters
3209         // Do not filter out Cluster Page(s) because we count a cluster as one.
3210         // By keeping the cluster page, we get our 1.
3211         $validpages = array();
3212         while ($pageid != 0) {
3213             $pageid = $pages[$pageid]->valid_page_and_view($validpages, $viewedpageids);
3214         }
3216         // Progress calculation as a percent.
3217         $progress = round(count($viewedpageids) / count($validpages), 2) * 100;
3218         return (int) $progress;
3219     }
3221     /**
3222      * Calculate the correct page and prepare contents for a given page id (could be a page jump id).
3223      *
3224      * @param  int $pageid the given page id
3225      * @param  mod_lesson_renderer $lessonoutput the lesson output rendered
3226      * @param  bool $reviewmode whether we are in review mode or not
3227      * @param  bool $redirect  Optional, default to true. Set to false to avoid redirection and return the page to redirect.
3228      * @return array the page object and contents
3229      * @throws moodle_exception
3230      * @since  Moodle 3.3
3231      */
3232     public function prepare_page_and_contents($pageid, $lessonoutput, $reviewmode, $redirect = true) {
3233         global $USER, $CFG;
3235         $page = $this->load_page($pageid);
3236         // Check if the page is of a special type and if so take any nessecary action.
3237         $newpageid = $page->callback_on_view($this->can_manage(), $redirect);
3239         // Avoid redirections returning the jump to special page id.
3240         if (!$redirect && is_numeric($newpageid) && $newpageid < 0) {
3241             return array($newpageid, null, null);
3242         }
3244         if (is_numeric($newpageid)) {
3245             $page = $this->load_page($newpageid);
3246         }
3248         // Add different informative messages to the given page.
3249         $this->add_messages_on_page_view($page, $reviewmode);
3251         if (is_array($page->answers) && count($page->answers) > 0) {
3252             // This is for modattempts option.  Find the users previous answer to this page,
3253             // and then display it below in answer processing.
3254             if (isset($USER->modattempts[$this->properties->id])) {
3255                 $retries = $this->count_user_retries($USER->id);
3256                 if (!$attempts = $this->get_attempts($retries - 1, false, $page->id)) {
3257                     throw new moodle_exception('cannotfindpreattempt', 'lesson');
3258                 }
3259                 $attempt = end($attempts);
3260                 $USER->modattempts[$this->properties->id] = $attempt;
3261             } else {
3262                 $attempt = false;
3263             }
3264             $lessoncontent = $lessonoutput->display_page($this, $page, $attempt);
3265         } else {
3266             require_once($CFG->dirroot . '/mod/lesson/view_form.php');
3267             $data = new stdClass;
3268             $data->id = $this->get_cm()->id;
3269             $data->pageid = $page->id;
3270             $data->newpageid = $this->get_next_page($page->nextpageid);
3272             $customdata = array(
3273                 'title'     => $page->title,
3274                 'contents'  => $page->get_contents()
3275             );
3276             $mform = new lesson_page_without_answers($CFG->wwwroot.'/mod/lesson/continue.php', $customdata);
3277             $mform->set_data($data);
3278             ob_start();
3279             $mform->display();
3280             $lessoncontent = ob_get_contents();
3281             ob_end_clean();
3282         }
3284         return array($page->id, $page, $lessoncontent);
3285     }
3287     /**
3288      * This returns a real page id to jump to (or LESSON_EOL) after processing page responses.
3289      *
3290      * @param  lesson_page $page      lesson page
3291      * @param  int         $newpageid the new page id
3292      * @return int the real page to jump to (or end of lesson)
3293      * @since  Moodle 3.3
3294      */
3295     public function calculate_new_page_on_jump(lesson_page $page, $newpageid) {
3296         global $USER, $DB;
3298         $canmanage = $this->can_manage();
3300         if (isset($USER->modattempts[$this->properties->id])) {
3301             // Make sure if the student is reviewing, that he/she sees the same pages/page path that he/she saw the first time.
3302             if ($USER->modattempts[$this->properties->id]->pageid == $page->id && $page->nextpageid == 0) {
3303                 // Remember, this session variable holds the pageid of the last page that the user saw.
3304                 $newpageid = LESSON_EOL;
3305             } else {
3306                 $nretakes = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
3307                 $nretakes--; // Make sure we are looking at the right try.
3308                 $attempts = $DB->get_records("lesson_attempts", array("lessonid" => $this->properties->id, "userid" => $USER->id, "retry" => $nretakes), "timeseen", "id, pageid");
3309                 $found = false;
3310                 $temppageid = 0;
3311                 // Make sure that the newpageid always defaults to something valid.
3312                 $newpageid = LESSON_EOL;
3313                 foreach ($attempts as $attempt) {
3314                     if ($found && $temppageid != $attempt->pageid) {
3315                         // Now try to find the next page, make sure next few attempts do no belong to current page.
3316                         $newpageid = $attempt->pageid;
3317                         break;
3318                     }
3319                     if ($attempt->pageid == $page->id) {
3320                         $found = true; // If found current page.
3321                         $temppageid = $attempt->pageid;
3322                     }
3323                 }
3324             }
3325         } else if ($newpageid != LESSON_CLUSTERJUMP && $page->id != 0 && $newpageid > 0) {
3326             // Going to check to see if the page that the user is going to view next, is a cluster page.
3327             // If so, dont display, go into the cluster.
3328             // The $newpageid > 0 is used to filter out all of the negative code jumps.
3329             $newpage = $this->load_page($newpageid);
3330             if ($overridenewpageid = $newpage->override_next_page($newpageid)) {
3331                 $newpageid = $overridenewpageid;
3332             }
3333         } else if ($newpageid == LESSON_UNSEENBRANCHPAGE) {
3334             if ($canmanage) {
3335                 if ($page->nextpageid == 0) {
3336                     $newpageid = LESSON_EOL;
3337                 } else {
3338                     $newpageid = $page->nextpageid;
3339                 }
3340             } else {
3341                 $newpageid = lesson_unseen_question_jump($this, $USER->id, $page->id);
3342             }
3343         } else if ($newpageid == LESSON_PREVIOUSPAGE) {
3344             $newpageid = $page->prevpageid;
3345         } else if ($newpageid == LESSON_RANDOMPAGE) {
3346             $newpageid = lesson_random_question_jump($this, $page->id);
3347         } else if ($newpageid == LESSON_CLUSTERJUMP) {
3348             if ($canmanage) {
3349                 if ($page->nextpageid == 0) {  // If teacher, go to next page.
3350                     $newpageid = LESSON_EOL;
3351                 } else {
3352                     $newpageid = $page->nextpageid;
3353                 }
3354             } else {
3355                 $newpageid = $this->cluster_jump($page->id);
3356             }
3357         } else if ($newpageid == 0) {
3358             $newpageid = $page->id;
3359         } else if ($newpageid == LESSON_NEXTPAGE) {
3360             $newpageid = $this->get_next_page($page->nextpageid);
3361         }
3363         return $newpageid;
3364     }
3366     /**
3367      * Process page responses.
3368      *
3369      * @param lesson_page $page page object
3370      * @since  Moodle 3.3
3371      */
3372     public function process_page_responses(lesson_page $page) {
3373         $context = $this->get_context();<