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