MDL-49327 marking guide: Added condition on definitionid.
[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     $params = array ("lessonid" => $lesson->id, "userid" => $userid, "retry" => $retakes);
183     if (!$seenbranches = $DB->get_records_select("lesson_branch", "lessonid = :lessonid AND userid = :userid AND retry = :retry", $params,
184                 "timeseen DESC")) {
185         print_error('cannotfindrecords', 'lesson');
186     }
188     // get the lesson pages
189     $lessonpages = $lesson->load_all_pages();
191     // this loads all the viewed branch tables into $seen until it finds the branch table with the flag
192     // which is the branch table that starts the unseenbranch function
193     $seen = array();
194     foreach ($seenbranches as $seenbranch) {
195         if (!$seenbranch->flag) {
196             $seen[$seenbranch->pageid] = $seenbranch->pageid;
197         } else {
198             $start = $seenbranch->pageid;
199             break;
200         }
201     }
202     // this function searches through the lesson pages to find all the branch tables
203     // that follow the flagged branch table
204     $pageid = $lessonpages[$start]->nextpageid; // move down from the flagged branch table
205     $branchtables = array();
206     while ($pageid != 0) {  // grab all of the branch table till eol
207         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
208             $branchtables[] = $lessonpages[$pageid]->id;
209         }
210         $pageid = $lessonpages[$pageid]->nextpageid;
211     }
212     $unseen = array();
213     foreach ($branchtables as $branchtable) {
214         // load all of the unseen branch tables into unseen
215         if (!array_key_exists($branchtable, $seen)) {
216             $unseen[] = $branchtable;
217         }
218     }
219     if (count($unseen) > 0) {
220         return $unseen[rand(0, count($unseen)-1)];  // returns a random page id for the next page
221     } else {
222         return LESSON_EOL;  // has viewed all of the branch tables
223     }
226 /**
227  * Handles the random jump between a branch table and end of branch or end of lesson (LESSON_RANDOMPAGE).
228  *
229  * @param lesson $lesson
230  * @param int $pageid The id of the page that we are jumping from (?)
231  * @return int The pageid of a random page that is within a branch table
232  **/
233 function lesson_random_question_jump($lesson, $pageid) {
234     global $DB;
236     // get the lesson pages
237     $params = array ("lessonid" => $lesson->id);
238     if (!$lessonpages = $DB->get_records_select("lesson_pages", "lessonid = :lessonid", $params)) {
239         print_error('cannotfindpages', 'lesson');
240     }
242     // go up the pages till branch table
243     while ($pageid != 0) { // this condition should never be satisfied... only happens if there are no branch tables above this page
245         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
246             break;
247         }
248         $pageid = $lessonpages[$pageid]->prevpageid;
249     }
251     // get the pages within the branch
252     $pagesinbranch = $lesson->get_sub_pages_of($pageid, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
254     if(count($pagesinbranch) == 0) {
255         // there are no pages inside the branch, so return the next page
256         return $lessonpages[$pageid]->nextpageid;
257     } else {
258         return $pagesinbranch[rand(0, count($pagesinbranch)-1)]->id;  // returns a random page id for the next page
259     }
262 /**
263  * Calculates a user's grade for a lesson.
264  *
265  * @param object $lesson The lesson that the user is taking.
266  * @param int $retries The attempt number.
267  * @param int $userid Id of the user (optional, default current user).
268  * @return object { nquestions => number of questions answered
269                     attempts => number of question attempts
270                     total => max points possible
271                     earned => points earned by student
272                     grade => calculated percentage grade
273                     nmanual => number of manually graded questions
274                     manualpoints => point value for manually graded questions }
275  */
276 function lesson_grade($lesson, $ntries, $userid = 0) {
277     global $USER, $DB;
279     if (empty($userid)) {
280         $userid = $USER->id;
281     }
283     // Zero out everything
284     $ncorrect     = 0;
285     $nviewed      = 0;
286     $score        = 0;
287     $nmanual      = 0;
288     $manualpoints = 0;
289     $thegrade     = 0;
290     $nquestions   = 0;
291     $total        = 0;
292     $earned       = 0;
294     $params = array ("lessonid" => $lesson->id, "userid" => $userid, "retry" => $ntries);
295     if ($useranswers = $DB->get_records_select("lesson_attempts",  "lessonid = :lessonid AND
296             userid = :userid AND retry = :retry", $params, "timeseen")) {
297         // group each try with its page
298         $attemptset = array();
299         foreach ($useranswers as $useranswer) {
300             $attemptset[$useranswer->pageid][] = $useranswer;
301         }
303         // Drop all attempts that go beyond max attempts for the lesson
304         foreach ($attemptset as $key => $set) {
305             $attemptset[$key] = array_slice($set, 0, $lesson->maxattempts);
306         }
308         // get only the pages and their answers that the user answered
309         list($usql, $parameters) = $DB->get_in_or_equal(array_keys($attemptset));
310         array_unshift($parameters, $lesson->id);
311         $pages = $DB->get_records_select("lesson_pages", "lessonid = ? AND id $usql", $parameters);
312         $answers = $DB->get_records_select("lesson_answers", "lessonid = ? AND pageid $usql", $parameters);
314         // Number of pages answered
315         $nquestions = count($pages);
317         foreach ($attemptset as $attempts) {
318             $page = lesson_page::load($pages[end($attempts)->pageid], $lesson);
319             if ($lesson->custom) {
320                 $attempt = end($attempts);
321                 // If essay question, handle it, otherwise add to score
322                 if ($page->requires_manual_grading()) {
323                     $useranswerobj = unserialize($attempt->useranswer);
324                     if (isset($useranswerobj->score)) {
325                         $earned += $useranswerobj->score;
326                     }
327                     $nmanual++;
328                     $manualpoints += $answers[$attempt->answerid]->score;
329                 } else if (!empty($attempt->answerid)) {
330                     $earned += $page->earned_score($answers, $attempt);
331                 }
332             } else {
333                 foreach ($attempts as $attempt) {
334                     $earned += $attempt->correct;
335                 }
336                 $attempt = end($attempts); // doesn't matter which one
337                 // If essay question, increase numbers
338                 if ($page->requires_manual_grading()) {
339                     $nmanual++;
340                     $manualpoints++;
341                 }
342             }
343             // Number of times answered
344             $nviewed += count($attempts);
345         }
347         if ($lesson->custom) {
348             $bestscores = array();
349             // Find the highest possible score per page to get our total
350             foreach ($answers as $answer) {
351                 if(!isset($bestscores[$answer->pageid])) {
352                     $bestscores[$answer->pageid] = $answer->score;
353                 } else if ($bestscores[$answer->pageid] < $answer->score) {
354                     $bestscores[$answer->pageid] = $answer->score;
355                 }
356             }
357             $total = array_sum($bestscores);
358         } else {
359             // Check to make sure the student has answered the minimum questions
360             if ($lesson->minquestions and $nquestions < $lesson->minquestions) {
361                 // Nope, increase number viewed by the amount of unanswered questions
362                 $total =  $nviewed + ($lesson->minquestions - $nquestions);
363             } else {
364                 $total = $nviewed;
365             }
366         }
367     }
369     if ($total) { // not zero
370         $thegrade = round(100 * $earned / $total, 5);
371     }
373     // Build the grade information object
374     $gradeinfo               = new stdClass;
375     $gradeinfo->nquestions   = $nquestions;
376     $gradeinfo->attempts     = $nviewed;
377     $gradeinfo->total        = $total;
378     $gradeinfo->earned       = $earned;
379     $gradeinfo->grade        = $thegrade;
380     $gradeinfo->nmanual      = $nmanual;
381     $gradeinfo->manualpoints = $manualpoints;
383     return $gradeinfo;
386 /**
387  * Determines if a user can view the left menu.  The determining factor
388  * is whether a user has a grade greater than or equal to the lesson setting
389  * of displayleftif
390  *
391  * @param object $lesson Lesson object of the current lesson
392  * @return boolean 0 if the user cannot see, or $lesson->displayleft to keep displayleft unchanged
393  **/
394 function lesson_displayleftif($lesson) {
395     global $CFG, $USER, $DB;
397     if (!empty($lesson->displayleftif)) {
398         // get the current user's max grade for this lesson
399         $params = array ("userid" => $USER->id, "lessonid" => $lesson->id);
400         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)) {
401             if ($maxgrade->maxgrade < $lesson->displayleftif) {
402                 return 0;  // turn off the displayleft
403             }
404         } else {
405             return 0; // no grades
406         }
407     }
409     // if we get to here, keep the original state of displayleft lesson setting
410     return $lesson->displayleft;
413 /**
414  *
415  * @param $cm
416  * @param $lesson
417  * @param $page
418  * @return unknown_type
419  */
420 function lesson_add_fake_blocks($page, $cm, $lesson, $timer = null) {
421     $bc = lesson_menu_block_contents($cm->id, $lesson);
422     if (!empty($bc)) {
423         $regions = $page->blocks->get_regions();
424         $firstregion = reset($regions);
425         $page->blocks->add_fake_block($bc, $firstregion);
426     }
428     $bc = lesson_mediafile_block_contents($cm->id, $lesson);
429     if (!empty($bc)) {
430         $page->blocks->add_fake_block($bc, $page->blocks->get_default_region());
431     }
433     if (!empty($timer)) {
434         $bc = lesson_clock_block_contents($cm->id, $lesson, $timer, $page);
435         if (!empty($bc)) {
436             $page->blocks->add_fake_block($bc, $page->blocks->get_default_region());
437         }
438     }
441 /**
442  * If there is a media file associated with this
443  * lesson, return a block_contents that displays it.
444  *
445  * @param int $cmid Course Module ID for this lesson
446  * @param object $lesson Full lesson record object
447  * @return block_contents
448  **/
449 function lesson_mediafile_block_contents($cmid, $lesson) {
450     global $OUTPUT;
451     if (empty($lesson->mediafile)) {
452         return null;
453     }
455     $options = array();
456     $options['menubar'] = 0;
457     $options['location'] = 0;
458     $options['left'] = 5;
459     $options['top'] = 5;
460     $options['scrollbars'] = 1;
461     $options['resizable'] = 1;
462     $options['width'] = $lesson->mediawidth;
463     $options['height'] = $lesson->mediaheight;
465     $link = new moodle_url('/mod/lesson/mediafile.php?id='.$cmid);
466     $action = new popup_action('click', $link, 'lessonmediafile', $options);
467     $content = $OUTPUT->action_link($link, get_string('mediafilepopup', 'lesson'), $action, array('title'=>get_string('mediafilepopup', 'lesson')));
469     $bc = new block_contents();
470     $bc->title = get_string('linkedmedia', 'lesson');
471     $bc->attributes['class'] = 'mediafile block';
472     $bc->content = $content;
474     return $bc;
477 /**
478  * If a timed lesson and not a teacher, then
479  * return a block_contents containing the clock.
480  *
481  * @param int $cmid Course Module ID for this lesson
482  * @param object $lesson Full lesson record object
483  * @param object $timer Full timer record object
484  * @return block_contents
485  **/
486 function lesson_clock_block_contents($cmid, $lesson, $timer, $page) {
487     // Display for timed lessons and for students only
488     $context = context_module::instance($cmid);
489     if ($lesson->timelimit == 0 || has_capability('mod/lesson:manage', $context)) {
490         return null;
491     }
493     $content = '<div id="lesson-timer">';
494     $content .=  $lesson->time_remaining($timer->starttime);
495     $content .= '</div>';
497     $clocksettings = array('starttime' => $timer->starttime, 'servertime' => time(), 'testlength' => $lesson->timelimit);
498     $page->requires->data_for_js('clocksettings', $clocksettings, true);
499     $page->requires->strings_for_js(array('timeisup'), 'lesson');
500     $page->requires->js('/mod/lesson/timer.js');
501     $page->requires->js_init_call('show_clock');
503     $bc = new block_contents();
504     $bc->title = get_string('timeremaining', 'lesson');
505     $bc->attributes['class'] = 'clock block';
506     $bc->content = $content;
508     return $bc;
511 /**
512  * If left menu is turned on, then this will
513  * print the menu in a block
514  *
515  * @param int $cmid Course Module ID for this lesson
516  * @param lesson $lesson Full lesson record object
517  * @return void
518  **/
519 function lesson_menu_block_contents($cmid, $lesson) {
520     global $CFG, $DB;
522     if (!$lesson->displayleft) {
523         return null;
524     }
526     $pages = $lesson->load_all_pages();
527     foreach ($pages as $page) {
528         if ((int)$page->prevpageid === 0) {
529             $pageid = $page->id;
530             break;
531         }
532     }
533     $currentpageid = optional_param('pageid', $pageid, PARAM_INT);
535     if (!$pageid || !$pages) {
536         return null;
537     }
539     $content = '<a href="#maincontent" class="skip">'.get_string('skip', 'lesson')."</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('id'=>$cm->id, 'pageid'=>$lessonpageid, 'edit'=>1));
581             $PAGE->set_button($OUTPUT->single_button($url, get_string('editpagecontent', 'lesson')));
582         }
583     }
586 /**
587  * This is a function used to detect media types and generate html code.
588  *
589  * @global object $CFG
590  * @global object $PAGE
591  * @param object $lesson
592  * @param object $context
593  * @return string $code the html code of media
594  */
595 function lesson_get_media_html($lesson, $context) {
596     global $CFG, $PAGE, $OUTPUT;
597     require_once("$CFG->libdir/resourcelib.php");
599     // get the media file link
600     if (strpos($lesson->mediafile, '://') !== false) {
601         $url = new moodle_url($lesson->mediafile);
602     } else {
603         // the timemodified is used to prevent caching problems, instead of '/' we should better read from files table and use sortorder
604         $url = moodle_url::make_pluginfile_url($context->id, 'mod_lesson', 'mediafile', $lesson->timemodified, '/', ltrim($lesson->mediafile, '/'));
605     }
606     $title = $lesson->mediafile;
608     $clicktoopen = html_writer::link($url, get_string('download'));
610     $mimetype = resourcelib_guess_url_mimetype($url);
612     $extension = resourcelib_get_extension($url->out(false));
614     $mediarenderer = $PAGE->get_renderer('core', 'media');
615     $embedoptions = array(
616         core_media::OPTION_TRUSTED => true,
617         core_media::OPTION_BLOCK => true
618     );
620     // find the correct type and print it out
621     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
622         $code = resourcelib_embed_image($url, $title);
624     } else if ($mediarenderer->can_embed_url($url, $embedoptions)) {
625         // Media (audio/video) file.
626         $code = $mediarenderer->embed_url($url, $title, 0, 0, $embedoptions);
628     } else {
629         // anything else - just try object tag enlarged as much as possible
630         $code = resourcelib_embed_general($url, $title, $clicktoopen, $mimetype);
631     }
633     return $code;
637 /**
638  * Abstract class that page type's MUST inherit from.
639  *
640  * This is the abstract class that ALL add page type forms must extend.
641  * You will notice that all but two of the methods this class contains are final.
642  * Essentially the only thing that extending classes can do is extend custom_definition.
643  * OR if it has a special requirement on creation it can extend construction_override
644  *
645  * @abstract
646  * @copyright  2009 Sam Hemelryk
647  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
648  */
649 abstract class lesson_add_page_form_base extends moodleform {
651     /**
652      * This is the classic define that is used to identify this pagetype.
653      * Will be one of LESSON_*
654      * @var int
655      */
656     public $qtype;
658     /**
659      * The simple string that describes the page type e.g. truefalse, multichoice
660      * @var string
661      */
662     public $qtypestring;
664     /**
665      * An array of options used in the htmleditor
666      * @var array
667      */
668     protected $editoroptions = array();
670     /**
671      * True if this is a standard page of false if it does something special.
672      * Questions are standard pages, branch tables are not
673      * @var bool
674      */
675     protected $standard = true;
677     /**
678      * Each page type can and should override this to add any custom elements to
679      * the basic form that they want
680      */
681     public function custom_definition() {}
683     /**
684      * Used to determine if this is a standard page or a special page
685      * @return bool
686      */
687     public final function is_standard() {
688         return (bool)$this->standard;
689     }
691     /**
692      * Add the required basic elements to the form.
693      *
694      * This method adds the basic elements to the form including title and contents
695      * and then calls custom_definition();
696      */
697     public final function definition() {
698         $mform = $this->_form;
699         $editoroptions = $this->_customdata['editoroptions'];
701         $mform->addElement('header', 'qtypeheading', get_string('createaquestionpage', 'lesson', get_string($this->qtypestring, 'lesson')));
703         $mform->addElement('hidden', 'id');
704         $mform->setType('id', PARAM_INT);
706         $mform->addElement('hidden', 'pageid');
707         $mform->setType('pageid', PARAM_INT);
709         if ($this->standard === true) {
710             $mform->addElement('hidden', 'qtype');
711             $mform->setType('qtype', PARAM_INT);
713             $mform->addElement('text', 'title', get_string('pagetitle', 'lesson'), array('size'=>70));
714             $mform->setType('title', PARAM_TEXT);
715             $mform->addRule('title', get_string('required'), 'required', null, 'client');
717             $this->editoroptions = array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$this->_customdata['maxbytes']);
718             $mform->addElement('editor', 'contents_editor', get_string('pagecontents', 'lesson'), null, $this->editoroptions);
719             $mform->setType('contents_editor', PARAM_RAW);
720             $mform->addRule('contents_editor', get_string('required'), 'required', null, 'client');
721         }
723         $this->custom_definition();
725         if ($this->_customdata['edit'] === true) {
726             $mform->addElement('hidden', 'edit', 1);
727             $mform->setType('edit', PARAM_BOOL);
728             $this->add_action_buttons(get_string('cancel'), get_string('savepage', 'lesson'));
729         } else if ($this->qtype === 'questiontype') {
730             $this->add_action_buttons(get_string('cancel'), get_string('addaquestionpage', 'lesson'));
731         } else {
732             $this->add_action_buttons(get_string('cancel'), get_string('savepage', 'lesson'));
733         }
734     }
736     /**
737      * Convenience function: Adds a jumpto select element
738      *
739      * @param string $name
740      * @param string|null $label
741      * @param int $selected The page to select by default
742      */
743     protected final function add_jumpto($name, $label=null, $selected=LESSON_NEXTPAGE) {
744         $title = get_string("jump", "lesson");
745         if ($label === null) {
746             $label = $title;
747         }
748         if (is_int($name)) {
749             $name = "jumpto[$name]";
750         }
751         $this->_form->addElement('select', $name, $label, $this->_customdata['jumpto']);
752         $this->_form->setDefault($name, $selected);
753         $this->_form->addHelpButton($name, 'jumps', 'lesson');
754     }
756     /**
757      * Convenience function: Adds a score input element
758      *
759      * @param string $name
760      * @param string|null $label
761      * @param mixed $value The default value
762      */
763     protected final function add_score($name, $label=null, $value=null) {
764         if ($label === null) {
765             $label = get_string("score", "lesson");
766         }
768         if (is_int($name)) {
769             $name = "score[$name]";
770         }
771         $this->_form->addElement('text', $name, $label, array('size'=>5));
772         $this->_form->setType($name, PARAM_INT);
773         if ($value !== null) {
774             $this->_form->setDefault($name, $value);
775         }
776         $this->_form->addHelpButton($name, 'score', 'lesson');
778         // Score is only used for custom scoring. Disable the element when not in use to stop some confusion.
779         if (!$this->_customdata['lesson']->custom) {
780             $this->_form->freeze($name);
781         }
782     }
784     /**
785      * Convenience function: Adds an answer editor
786      *
787      * @param int $count The count of the element to add
788      * @param string $label, null means default
789      * @param bool $required
790      * @param string $format
791      * @return void
792      */
793     protected final function add_answer($count, $label = null, $required = false, $format= '') {
794         if ($label === null) {
795             $label = get_string('answer', 'lesson');
796         }
798         if ($format == LESSON_ANSWER_HTML) {
799             $this->_form->addElement('editor', 'answer_editor['.$count.']', $label,
800                     array('rows' => '4', 'columns' => '80'),
801                     array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $this->_customdata['maxbytes']));
802             $this->_form->setType('answer_editor['.$count.']', PARAM_RAW);
803             $this->_form->setDefault('answer_editor['.$count.']', array('text' => '', 'format' => FORMAT_HTML));
804         } else {
805             $this->_form->addElement('text', 'answer_editor['.$count.']', $label,
806                     array('size' => '50', 'maxlength' => '200'));
807             $this->_form->setType('answer_editor['.$count.']', PARAM_TEXT);
808         }
810         if ($required) {
811             $this->_form->addRule('answer_editor['.$count.']', get_string('required'), 'required', null, 'client');
812         }
813     }
814     /**
815      * Convenience function: Adds an response editor
816      *
817      * @param int $count The count of the element to add
818      * @param string $label, null means default
819      * @param bool $required
820      * @return void
821      */
822     protected final function add_response($count, $label = null, $required = false) {
823         if ($label === null) {
824             $label = get_string('response', 'lesson');
825         }
826         $this->_form->addElement('editor', 'response_editor['.$count.']', $label,
827                  array('rows' => '4', 'columns' => '80'),
828                  array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $this->_customdata['maxbytes']));
829         $this->_form->setType('response_editor['.$count.']', PARAM_RAW);
830         $this->_form->setDefault('response_editor['.$count.']', array('text' => '', 'format' => FORMAT_HTML));
832         if ($required) {
833             $this->_form->addRule('response_editor['.$count.']', get_string('required'), 'required', null, 'client');
834         }
835     }
837     /**
838      * A function that gets called upon init of this object by the calling script.
839      *
840      * This can be used to process an immediate action if required. Currently it
841      * is only used in special cases by non-standard page types.
842      *
843      * @return bool
844      */
845     public function construction_override($pageid, lesson $lesson) {
846         return true;
847     }
852 /**
853  * Class representation of a lesson
854  *
855  * This class is used the interact with, and manage a lesson once instantiated.
856  * If you need to fetch a lesson object you can do so by calling
857  *
858  * <code>
859  * lesson::load($lessonid);
860  * // or
861  * $lessonrecord = $DB->get_record('lesson', $lessonid);
862  * $lesson = new lesson($lessonrecord);
863  * </code>
864  *
865  * The class itself extends lesson_base as all classes within the lesson module should
866  *
867  * These properties are from the database
868  * @property int $id The id of this lesson
869  * @property int $course The ID of the course this lesson belongs to
870  * @property string $name The name of this lesson
871  * @property int $practice Flag to toggle this as a practice lesson
872  * @property int $modattempts Toggle to allow the user to go back and review answers
873  * @property int $usepassword Toggle the use of a password for entry
874  * @property string $password The password to require users to enter
875  * @property int $dependency ID of another lesson this lesson is dependent on
876  * @property string $conditions Conditions of the lesson dependency
877  * @property int $grade The maximum grade a user can achieve (%)
878  * @property int $custom Toggle custom scoring on or off
879  * @property int $ongoing Toggle display of an ongoing score
880  * @property int $usemaxgrade How retakes are handled (max=1, mean=0)
881  * @property int $maxanswers The max number of answers or branches
882  * @property int $maxattempts The maximum number of attempts a user can record
883  * @property int $review Toggle use or wrong answer review button
884  * @property int $nextpagedefault Override the default next page
885  * @property int $feedback Toggles display of default feedback
886  * @property int $minquestions Sets a minimum value of pages seen when calculating grades
887  * @property int $maxpages Maximum number of pages this lesson can contain
888  * @property int $retake Flag to allow users to retake a lesson
889  * @property int $activitylink Relate this lesson to another lesson
890  * @property string $mediafile File to pop up to or webpage to display
891  * @property int $mediaheight Sets the height of the media file popup
892  * @property int $mediawidth Sets the width of the media file popup
893  * @property int $mediaclose Toggle display of a media close button
894  * @property int $slideshow Flag for whether branch pages should be shown as slideshows
895  * @property int $width Width of slideshow
896  * @property int $height Height of slideshow
897  * @property string $bgcolor Background colour of slideshow
898  * @property int $displayleft Display a left menu
899  * @property int $displayleftif Sets the condition on which the left menu is displayed
900  * @property int $progressbar Flag to toggle display of a lesson progress bar
901  * @property int $highscores Flag to toggle collection of high scores
902  * @property int $maxhighscores Number of high scores to limit to
903  * @property int $available Timestamp of when this lesson becomes available
904  * @property int $deadline Timestamp of when this lesson is no longer available
905  * @property int $timemodified Timestamp when lesson was last modified
906  *
907  * These properties are calculated
908  * @property int $firstpageid Id of the first page of this lesson (prevpageid=0)
909  * @property int $lastpageid Id of the last page of this lesson (nextpageid=0)
910  *
911  * @copyright  2009 Sam Hemelryk
912  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
913  */
914 class lesson extends lesson_base {
916     /**
917      * The id of the first page (where prevpageid = 0) gets set and retrieved by
918      * {@see get_firstpageid()} by directly calling <code>$lesson->firstpageid;</code>
919      * @var int
920      */
921     protected $firstpageid = null;
922     /**
923      * The id of the last page (where nextpageid = 0) gets set and retrieved by
924      * {@see get_lastpageid()} by directly calling <code>$lesson->lastpageid;</code>
925      * @var int
926      */
927     protected $lastpageid = null;
928     /**
929      * An array used to cache the pages associated with this lesson after the first
930      * time they have been loaded.
931      * A note to developers: If you are going to be working with MORE than one or
932      * two pages from a lesson you should probably call {@see $lesson->load_all_pages()}
933      * in order to save excess database queries.
934      * @var array An array of lesson_page objects
935      */
936     protected $pages = array();
937     /**
938      * Flag that gets set to true once all of the pages associated with the lesson
939      * have been loaded.
940      * @var bool
941      */
942     protected $loadedallpages = false;
944     /**
945      * Simply generates a lesson object given an array/object of properties
946      * Overrides {@see lesson_base->create()}
947      * @static
948      * @param object|array $properties
949      * @return lesson
950      */
951     public static function create($properties) {
952         return new lesson($properties);
953     }
955     /**
956      * Generates a lesson object from the database given its id
957      * @static
958      * @param int $lessonid
959      * @return lesson
960      */
961     public static function load($lessonid) {
962         global $DB;
964         if (!$lesson = $DB->get_record('lesson', array('id' => $lessonid))) {
965             print_error('invalidcoursemodule');
966         }
967         return new lesson($lesson);
968     }
970     /**
971      * Deletes this lesson from the database
972      */
973     public function delete() {
974         global $CFG, $DB;
975         require_once($CFG->libdir.'/gradelib.php');
976         require_once($CFG->dirroot.'/calendar/lib.php');
978         $cm = get_coursemodule_from_instance('lesson', $this->properties->id, $this->properties->course);
979         $context = context_module::instance($cm->id);
981         $DB->delete_records("lesson", array("id"=>$this->properties->id));
982         $DB->delete_records("lesson_pages", array("lessonid"=>$this->properties->id));
983         $DB->delete_records("lesson_answers", array("lessonid"=>$this->properties->id));
984         $DB->delete_records("lesson_attempts", array("lessonid"=>$this->properties->id));
985         $DB->delete_records("lesson_grades", array("lessonid"=>$this->properties->id));
986         $DB->delete_records("lesson_timer", array("lessonid"=>$this->properties->id));
987         $DB->delete_records("lesson_branch", array("lessonid"=>$this->properties->id));
988         $DB->delete_records("lesson_high_scores", array("lessonid"=>$this->properties->id));
989         if ($events = $DB->get_records('event', array("modulename"=>'lesson', "instance"=>$this->properties->id))) {
990             foreach($events as $event) {
991                 $event = calendar_event::load($event);
992                 $event->delete();
993             }
994         }
996         // Delete files associated with this module.
997         $fs = get_file_storage();
998         $fs->delete_area_files($context->id);
1000         grade_update('mod/lesson', $this->properties->course, 'mod', 'lesson', $this->properties->id, 0, null, array('deleted'=>1));
1001         return true;
1002     }
1004     /**
1005      * Fetches messages from the session that may have been set in previous page
1006      * actions.
1007      *
1008      * <code>
1009      * // Do not call this method directly instead use
1010      * $lesson->messages;
1011      * </code>
1012      *
1013      * @return array
1014      */
1015     protected function get_messages() {
1016         global $SESSION;
1018         $messages = array();
1019         if (!empty($SESSION->lesson_messages) && is_array($SESSION->lesson_messages) && array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
1020             $messages = $SESSION->lesson_messages[$this->properties->id];
1021             unset($SESSION->lesson_messages[$this->properties->id]);
1022         }
1024         return $messages;
1025     }
1027     /**
1028      * Get all of the attempts for the current user.
1029      *
1030      * @param int $retries
1031      * @param bool $correct Optional: only fetch correct attempts
1032      * @param int $pageid Optional: only fetch attempts at the given page
1033      * @param int $userid Optional: defaults to the current user if not set
1034      * @return array|false
1035      */
1036     public function get_attempts($retries, $correct=false, $pageid=null, $userid=null) {
1037         global $USER, $DB;
1038         $params = array("lessonid"=>$this->properties->id, "userid"=>$userid, "retry"=>$retries);
1039         if ($correct) {
1040             $params['correct'] = 1;
1041         }
1042         if ($pageid !== null) {
1043             $params['pageid'] = $pageid;
1044         }
1045         if ($userid === null) {
1046             $params['userid'] = $USER->id;
1047         }
1048         return $DB->get_records('lesson_attempts', $params, 'timeseen ASC');
1049     }
1051     /**
1052      * Returns the first page for the lesson or false if there isn't one.
1053      *
1054      * This method should be called via the magic method __get();
1055      * <code>
1056      * $firstpage = $lesson->firstpage;
1057      * </code>
1058      *
1059      * @return lesson_page|bool Returns the lesson_page specialised object or false
1060      */
1061     protected function get_firstpage() {
1062         $pages = $this->load_all_pages();
1063         if (count($pages) > 0) {
1064             foreach ($pages as $page) {
1065                 if ((int)$page->prevpageid === 0) {
1066                     return $page;
1067                 }
1068             }
1069         }
1070         return false;
1071     }
1073     /**
1074      * Returns the last page for the lesson or false if there isn't one.
1075      *
1076      * This method should be called via the magic method __get();
1077      * <code>
1078      * $lastpage = $lesson->lastpage;
1079      * </code>
1080      *
1081      * @return lesson_page|bool Returns the lesson_page specialised object or false
1082      */
1083     protected function get_lastpage() {
1084         $pages = $this->load_all_pages();
1085         if (count($pages) > 0) {
1086             foreach ($pages as $page) {
1087                 if ((int)$page->nextpageid === 0) {
1088                     return $page;
1089                 }
1090             }
1091         }
1092         return false;
1093     }
1095     /**
1096      * Returns the id of the first page of this lesson. (prevpageid = 0)
1097      * @return int
1098      */
1099     protected function get_firstpageid() {
1100         global $DB;
1101         if ($this->firstpageid == null) {
1102             if (!$this->loadedallpages) {
1103                 $firstpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'prevpageid'=>0));
1104                 if (!$firstpageid) {
1105                     print_error('cannotfindfirstpage', 'lesson');
1106                 }
1107                 $this->firstpageid = $firstpageid;
1108             } else {
1109                 $firstpage = $this->get_firstpage();
1110                 $this->firstpageid = $firstpage->id;
1111             }
1112         }
1113         return $this->firstpageid;
1114     }
1116     /**
1117      * Returns the id of the last page of this lesson. (nextpageid = 0)
1118      * @return int
1119      */
1120     public function get_lastpageid() {
1121         global $DB;
1122         if ($this->lastpageid == null) {
1123             if (!$this->loadedallpages) {
1124                 $lastpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'nextpageid'=>0));
1125                 if (!$lastpageid) {
1126                     print_error('cannotfindlastpage', 'lesson');
1127                 }
1128                 $this->lastpageid = $lastpageid;
1129             } else {
1130                 $lastpageid = $this->get_lastpage();
1131                 $this->lastpageid = $lastpageid->id;
1132             }
1133         }
1135         return $this->lastpageid;
1136     }
1138      /**
1139      * Gets the next page id to display after the one that is provided.
1140      * @param int $nextpageid
1141      * @return bool
1142      */
1143     public function get_next_page($nextpageid) {
1144         global $USER, $DB;
1145         $allpages = $this->load_all_pages();
1146         if ($this->properties->nextpagedefault) {
1147             // in Flash Card mode...first get number of retakes
1148             $nretakes = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
1149             shuffle($allpages);
1150             $found = false;
1151             if ($this->properties->nextpagedefault == LESSON_UNSEENPAGE) {
1152                 foreach ($allpages as $nextpage) {
1153                     if (!$DB->count_records("lesson_attempts", array("pageid" => $nextpage->id, "userid" => $USER->id, "retry" => $nretakes))) {
1154                         $found = true;
1155                         break;
1156                     }
1157                 }
1158             } elseif ($this->properties->nextpagedefault == LESSON_UNANSWEREDPAGE) {
1159                 foreach ($allpages as $nextpage) {
1160                     if (!$DB->count_records("lesson_attempts", array('pageid' => $nextpage->id, 'userid' => $USER->id, 'correct' => 1, 'retry' => $nretakes))) {
1161                         $found = true;
1162                         break;
1163                     }
1164                 }
1165             }
1166             if ($found) {
1167                 if ($this->properties->maxpages) {
1168                     // check number of pages viewed (in the lesson)
1169                     if ($DB->count_records("lesson_attempts", array("lessonid" => $this->properties->id, "userid" => $USER->id, "retry" => $nretakes)) >= $this->properties->maxpages) {
1170                         return LESSON_EOL;
1171                     }
1172                 }
1173                 return $nextpage->id;
1174             }
1175         }
1176         // In a normal lesson mode
1177         foreach ($allpages as $nextpage) {
1178             if ((int)$nextpage->id === (int)$nextpageid) {
1179                 return $nextpage->id;
1180             }
1181         }
1182         return LESSON_EOL;
1183     }
1185     /**
1186      * Sets a message against the session for this lesson that will displayed next
1187      * time the lesson processes messages
1188      *
1189      * @param string $message
1190      * @param string $class
1191      * @param string $align
1192      * @return bool
1193      */
1194     public function add_message($message, $class="notifyproblem", $align='center') {
1195         global $SESSION;
1197         if (empty($SESSION->lesson_messages) || !is_array($SESSION->lesson_messages)) {
1198             $SESSION->lesson_messages = array();
1199             $SESSION->lesson_messages[$this->properties->id] = array();
1200         } else if (!array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
1201             $SESSION->lesson_messages[$this->properties->id] = array();
1202         }
1204         $SESSION->lesson_messages[$this->properties->id][] = array($message, $class, $align);
1206         return true;
1207     }
1209     /**
1210      * Check if the lesson is accessible at the present time
1211      * @return bool True if the lesson is accessible, false otherwise
1212      */
1213     public function is_accessible() {
1214         $available = $this->properties->available;
1215         $deadline = $this->properties->deadline;
1216         return (($available == 0 || time() >= $available) && ($deadline == 0 || time() < $deadline));
1217     }
1219     /**
1220      * Starts the lesson time for the current user
1221      * @return bool Returns true
1222      */
1223     public function start_timer() {
1224         global $USER, $DB;
1226         $cm = get_coursemodule_from_instance('lesson', $this->properties()->id, $this->properties()->course,
1227             false, MUST_EXIST);
1229         // Trigger lesson started event.
1230         $event = \mod_lesson\event\lesson_started::create(array(
1231             'objectid' => $this->properties()->id,
1232             'context' => context_module::instance($cm->id),
1233             'courseid' => $this->properties()->course
1234         ));
1235         $event->trigger();
1237         $USER->startlesson[$this->properties->id] = true;
1238         $startlesson = new stdClass;
1239         $startlesson->lessonid = $this->properties->id;
1240         $startlesson->userid = $USER->id;
1241         $startlesson->starttime = time();
1242         $startlesson->lessontime = time();
1243         $DB->insert_record('lesson_timer', $startlesson);
1244         if ($this->properties->timelimit) {
1245             $this->add_message(get_string('timelimitwarning', 'lesson', format_time($this->properties->timelimit)), 'center');
1246         }
1247         return true;
1248     }
1250     /**
1251      * Updates the timer to the current time and returns the new timer object
1252      * @param bool $restart If set to true the timer is restarted
1253      * @param bool $continue If set to true AND $restart=true then the timer
1254      *                        will continue from a previous attempt
1255      * @return stdClass The new timer
1256      */
1257     public function update_timer($restart=false, $continue=false, $endreached =false) {
1258         global $USER, $DB;
1259         // clock code
1260         // get time information for this user
1261         $params = array("lessonid" => $this->properties->id, "userid" => $USER->id);
1262         if (!$timer = $DB->get_records('lesson_timer', $params, 'starttime DESC', '*', 0, 1)) {
1263             $this->start_timer();
1264             $timer = $DB->get_records('lesson_timer', $params, 'starttime DESC', '*', 0, 1);
1265         }
1266         $timer = current($timer); // This will get the latest start time record.
1268         if ($restart) {
1269             if ($continue) {
1270                 // continue a previous test, need to update the clock  (think this option is disabled atm)
1271                 $timer->starttime = time() - ($timer->lessontime - $timer->starttime);
1272             } else {
1273                 // starting over, so reset the clock
1274                 $timer->starttime = time();
1275             }
1276         }
1278         $timer->lessontime = time();
1279         $timer->completed = $endreached;
1280         $DB->update_record('lesson_timer', $timer);
1282         // Update completion state.
1283         $cm = get_coursemodule_from_instance('lesson', $this->properties()->id, $this->properties()->course,
1284             false, MUST_EXIST);
1285         $course = get_course($cm->course);
1286         $completion = new completion_info($course);
1287         if ($completion->is_enabled($cm) && $this->properties()->completiontimespent > 0) {
1288             $completion->update_state($cm, COMPLETION_COMPLETE);
1289         }
1290         return $timer;
1291     }
1293     /**
1294      * Updates the timer to the current time then stops it by unsetting the user var
1295      * @return bool Returns true
1296      */
1297     public function stop_timer() {
1298         global $USER, $DB;
1299         unset($USER->startlesson[$this->properties->id]);
1301         $cm = get_coursemodule_from_instance('lesson', $this->properties()->id, $this->properties()->course,
1302             false, MUST_EXIST);
1304         // Trigger lesson ended event.
1305         $event = \mod_lesson\event\lesson_ended::create(array(
1306             'objectid' => $this->properties()->id,
1307             'context' => context_module::instance($cm->id),
1308             'courseid' => $this->properties()->course
1309         ));
1310         $event->trigger();
1312         return $this->update_timer(false, false, true);
1313     }
1315     /**
1316      * Checks to see if the lesson has pages
1317      */
1318     public function has_pages() {
1319         global $DB;
1320         $pagecount = $DB->count_records('lesson_pages', array('lessonid'=>$this->properties->id));
1321         return ($pagecount>0);
1322     }
1324     /**
1325      * Returns the link for the related activity
1326      * @return array|false
1327      */
1328     public function link_for_activitylink() {
1329         global $DB;
1330         $module = $DB->get_record('course_modules', array('id' => $this->properties->activitylink));
1331         if ($module) {
1332             $modname = $DB->get_field('modules', 'name', array('id' => $module->module));
1333             if ($modname) {
1334                 $instancename = $DB->get_field($modname, 'name', array('id' => $module->instance));
1335                 if ($instancename) {
1336                     return html_writer::link(new moodle_url('/mod/'.$modname.'/view.php', array('id'=>$this->properties->activitylink)),
1337                         get_string('activitylinkname', 'lesson', $instancename),
1338                         array('class'=>'centerpadded lessonbutton standardbutton'));
1339                 }
1340             }
1341         }
1342         return '';
1343     }
1345     /**
1346      * Loads the requested page.
1347      *
1348      * This function will return the requested page id as either a specialised
1349      * lesson_page object OR as a generic lesson_page.
1350      * If the page has been loaded previously it will be returned from the pages
1351      * array, otherwise it will be loaded from the database first
1352      *
1353      * @param int $pageid
1354      * @return lesson_page A lesson_page object or an object that extends it
1355      */
1356     public function load_page($pageid) {
1357         if (!array_key_exists($pageid, $this->pages)) {
1358             $manager = lesson_page_type_manager::get($this);
1359             $this->pages[$pageid] = $manager->load_page($pageid, $this);
1360         }
1361         return $this->pages[$pageid];
1362     }
1364     /**
1365      * Loads ALL of the pages for this lesson
1366      *
1367      * @return array An array containing all pages from this lesson
1368      */
1369     public function load_all_pages() {
1370         if (!$this->loadedallpages) {
1371             $manager = lesson_page_type_manager::get($this);
1372             $this->pages = $manager->load_all_pages($this);
1373             $this->loadedallpages = true;
1374         }
1375         return $this->pages;
1376     }
1378     /**
1379      * Determines if a jumpto value is correct or not.
1380      *
1381      * returns true if jumpto page is (logically) after the pageid page or
1382      * if the jumpto value is a special value.  Returns false in all other cases.
1383      *
1384      * @param int $pageid Id of the page from which you are jumping from.
1385      * @param int $jumpto The jumpto number.
1386      * @return boolean True or false after a series of tests.
1387      **/
1388     public function jumpto_is_correct($pageid, $jumpto) {
1389         global $DB;
1391         // first test the special values
1392         if (!$jumpto) {
1393             // same page
1394             return false;
1395         } elseif ($jumpto == LESSON_NEXTPAGE) {
1396             return true;
1397         } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
1398             return true;
1399         } elseif ($jumpto == LESSON_RANDOMPAGE) {
1400             return true;
1401         } elseif ($jumpto == LESSON_CLUSTERJUMP) {
1402             return true;
1403         } elseif ($jumpto == LESSON_EOL) {
1404             return true;
1405         }
1407         $pages = $this->load_all_pages();
1408         $apageid = $pages[$pageid]->nextpageid;
1409         while ($apageid != 0) {
1410             if ($jumpto == $apageid) {
1411                 return true;
1412             }
1413             $apageid = $pages[$apageid]->nextpageid;
1414         }
1415         return false;
1416     }
1418     /**
1419      * Returns the time a user has remaining on this lesson
1420      * @param int $starttime Starttime timestamp
1421      * @return string
1422      */
1423     public function time_remaining($starttime) {
1424         $timeleft = $starttime + $this->timelimit - time();
1425         $hours = floor($timeleft/3600);
1426         $timeleft = $timeleft - ($hours * 3600);
1427         $minutes = floor($timeleft/60);
1428         $secs = $timeleft - ($minutes * 60);
1430         if ($minutes < 10) {
1431             $minutes = "0$minutes";
1432         }
1433         if ($secs < 10) {
1434             $secs = "0$secs";
1435         }
1436         $output   = array();
1437         $output[] = $hours;
1438         $output[] = $minutes;
1439         $output[] = $secs;
1440         $output = implode(':', $output);
1441         return $output;
1442     }
1444     /**
1445      * Interprets LESSON_CLUSTERJUMP jumpto value.
1446      *
1447      * This will select a page randomly
1448      * and the page selected will be inbetween a cluster page and end of clutter or end of lesson
1449      * and the page selected will be a page that has not been viewed already
1450      * and if any pages are within a branch table or end of branch then only 1 page within
1451      * the branch table or end of branch will be randomly selected (sub clustering).
1452      *
1453      * @param int $pageid Id of the current page from which we are jumping from.
1454      * @param int $userid Id of the user.
1455      * @return int The id of the next page.
1456      **/
1457     public function cluster_jump($pageid, $userid=null) {
1458         global $DB, $USER;
1460         if ($userid===null) {
1461             $userid = $USER->id;
1462         }
1463         // get the number of retakes
1464         if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->properties->id, "userid"=>$userid))) {
1465             $retakes = 0;
1466         }
1467         // get all the lesson_attempts aka what the user has seen
1468         $seenpages = array();
1469         if ($attempts = $this->get_attempts($retakes)) {
1470             foreach ($attempts as $attempt) {
1471                 $seenpages[$attempt->pageid] = $attempt->pageid;
1472             }
1474         }
1476         // get the lesson pages
1477         $lessonpages = $this->load_all_pages();
1478         // find the start of the cluster
1479         while ($pageid != 0) { // this condition should not be satisfied... should be a cluster page
1480             if ($lessonpages[$pageid]->qtype == LESSON_PAGE_CLUSTER) {
1481                 break;
1482             }
1483             $pageid = $lessonpages[$pageid]->prevpageid;
1484         }
1486         $clusterpages = array();
1487         $clusterpages = $this->get_sub_pages_of($pageid, array(LESSON_PAGE_ENDOFCLUSTER));
1488         $unseen = array();
1489         foreach ($clusterpages as $key=>$cluster) {
1490             // Remove the page if  it is in a branch table or is an endofbranch.
1491             if ($this->is_sub_page_of_type($cluster->id,
1492                     array(LESSON_PAGE_BRANCHTABLE), array(LESSON_PAGE_ENDOFBRANCH, LESSON_PAGE_CLUSTER))
1493                     || $cluster->qtype == LESSON_PAGE_ENDOFBRANCH) {
1494                 unset($clusterpages[$key]);
1495             } else if ($cluster->qtype == LESSON_PAGE_BRANCHTABLE) {
1496                 // If branchtable, check to see if any pages inside have been viewed.
1497                 $branchpages = $this->get_sub_pages_of($cluster->id, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
1498                 $flag = true;
1499                 foreach ($branchpages as $branchpage) {
1500                     if (array_key_exists($branchpage->id, $seenpages)) {  // Check if any of the pages have been viewed.
1501                         $flag = false;
1502                     }
1503                 }
1504                 if ($flag && count($branchpages) > 0) {
1505                     // Add branch table.
1506                     $unseen[] = $cluster;
1507                 }
1508             } elseif ($cluster->is_unseen($seenpages)) {
1509                 $unseen[] = $cluster;
1510             }
1511         }
1513         if (count($unseen) > 0) {
1514             // it does not contain elements, then use exitjump, otherwise find out next page/branch
1515             $nextpage = $unseen[rand(0, count($unseen)-1)];
1516             if ($nextpage->qtype == LESSON_PAGE_BRANCHTABLE) {
1517                 // if branch table, then pick a random page inside of it
1518                 $branchpages = $this->get_sub_pages_of($nextpage->id, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
1519                 return $branchpages[rand(0, count($branchpages)-1)]->id;
1520             } else { // otherwise, return the page's id
1521                 return $nextpage->id;
1522             }
1523         } else {
1524             // seen all there is to see, leave the cluster
1525             if (end($clusterpages)->nextpageid == 0) {
1526                 return LESSON_EOL;
1527             } else {
1528                 $clusterendid = $pageid;
1529                 while ($clusterendid != 0) { // This condition should not be satisfied... should be an end of cluster page.
1530                     if ($lessonpages[$clusterendid]->qtype == LESSON_PAGE_ENDOFCLUSTER) {
1531                         break;
1532                     }
1533                     $clusterendid = $lessonpages[$clusterendid]->nextpageid;
1534                 }
1535                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $clusterendid, "lessonid" => $this->properties->id));
1536                 if ($exitjump == LESSON_NEXTPAGE) {
1537                     $exitjump = $lessonpages[$clusterendid]->nextpageid;
1538                 }
1539                 if ($exitjump == 0) {
1540                     return LESSON_EOL;
1541                 } else if (in_array($exitjump, array(LESSON_EOL, LESSON_PREVIOUSPAGE))) {
1542                     return $exitjump;
1543                 } else {
1544                     if (!array_key_exists($exitjump, $lessonpages)) {
1545                         $found = false;
1546                         foreach ($lessonpages as $page) {
1547                             if ($page->id === $clusterendid) {
1548                                 $found = true;
1549                             } else if ($page->qtype == LESSON_PAGE_ENDOFCLUSTER) {
1550                                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $page->id, "lessonid" => $this->properties->id));
1551                                 if ($exitjump == LESSON_NEXTPAGE) {
1552                                     $exitjump = $lessonpages[$page->id]->nextpageid;
1553                                 }
1554                                 break;
1555                             }
1556                         }
1557                     }
1558                     if (!array_key_exists($exitjump, $lessonpages)) {
1559                         return LESSON_EOL;
1560                     }
1561                     return $exitjump;
1562                 }
1563             }
1564         }
1565     }
1567     /**
1568      * Finds all pages that appear to be a subtype of the provided pageid until
1569      * an end point specified within $ends is encountered or no more pages exist
1570      *
1571      * @param int $pageid
1572      * @param array $ends An array of LESSON_PAGE_* types that signify an end of
1573      *               the subtype
1574      * @return array An array of specialised lesson_page objects
1575      */
1576     public function get_sub_pages_of($pageid, array $ends) {
1577         $lessonpages = $this->load_all_pages();
1578         $pageid = $lessonpages[$pageid]->nextpageid;  // move to the first page after the branch table
1579         $pages = array();
1581         while (true) {
1582             if ($pageid == 0 || in_array($lessonpages[$pageid]->qtype, $ends)) {
1583                 break;
1584             }
1585             $pages[] = $lessonpages[$pageid];
1586             $pageid = $lessonpages[$pageid]->nextpageid;
1587         }
1589         return $pages;
1590     }
1592     /**
1593      * Checks to see if the specified page[id] is a subpage of a type specified in
1594      * the $types array, until either there are no more pages of we find a type
1595      * corresponding to that of a type specified in $ends
1596      *
1597      * @param int $pageid The id of the page to check
1598      * @param array $types An array of types that would signify this page was a subpage
1599      * @param array $ends An array of types that mean this is not a subpage
1600      * @return bool
1601      */
1602     public function is_sub_page_of_type($pageid, array $types, array $ends) {
1603         $pages = $this->load_all_pages();
1604         $pageid = $pages[$pageid]->prevpageid; // move up one
1606         array_unshift($ends, 0);
1607         // go up the pages till branch table
1608         while (true) {
1609             if ($pageid==0 || in_array($pages[$pageid]->qtype, $ends)) {
1610                 return false;
1611             } else if (in_array($pages[$pageid]->qtype, $types)) {
1612                 return true;
1613             }
1614             $pageid = $pages[$pageid]->prevpageid;
1615         }
1616     }
1620 /**
1621  * Abstract class to provide a core functions to the all lesson classes
1622  *
1623  * This class should be abstracted by ALL classes with the lesson module to ensure
1624  * that all classes within this module can be interacted with in the same way.
1625  *
1626  * This class provides the user with a basic properties array that can be fetched
1627  * or set via magic methods, or alternatively by defining methods get_blah() or
1628  * set_blah() within the extending object.
1629  *
1630  * @copyright  2009 Sam Hemelryk
1631  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1632  */
1633 abstract class lesson_base {
1635     /**
1636      * An object containing properties
1637      * @var stdClass
1638      */
1639     protected $properties;
1641     /**
1642      * The constructor
1643      * @param stdClass $properties
1644      */
1645     public function __construct($properties) {
1646         $this->properties = (object)$properties;
1647     }
1649     /**
1650      * Magic property method
1651      *
1652      * Attempts to call a set_$key method if one exists otherwise falls back
1653      * to simply set the property
1654      *
1655      * @param string $key
1656      * @param mixed $value
1657      */
1658     public function __set($key, $value) {
1659         if (method_exists($this, 'set_'.$key)) {
1660             $this->{'set_'.$key}($value);
1661         }
1662         $this->properties->{$key} = $value;
1663     }
1665     /**
1666      * Magic get method
1667      *
1668      * Attempts to call a get_$key method to return the property and ralls over
1669      * to return the raw property
1670      *
1671      * @param str $key
1672      * @return mixed
1673      */
1674     public function __get($key) {
1675         if (method_exists($this, 'get_'.$key)) {
1676             return $this->{'get_'.$key}();
1677         }
1678         return $this->properties->{$key};
1679     }
1681     /**
1682      * Stupid PHP needs an isset magic method if you use the get magic method and
1683      * still want empty calls to work.... blah ~!
1684      *
1685      * @param string $key
1686      * @return bool
1687      */
1688     public function __isset($key) {
1689         if (method_exists($this, 'get_'.$key)) {
1690             $val = $this->{'get_'.$key}();
1691             return !empty($val);
1692         }
1693         return !empty($this->properties->{$key});
1694     }
1696     //NOTE: E_STRICT does not allow to change function signature!
1698     /**
1699      * If implemented should create a new instance, save it in the DB and return it
1700      */
1701     //public static function create() {}
1702     /**
1703      * If implemented should load an instance from the DB and return it
1704      */
1705     //public static function load() {}
1706     /**
1707      * Fetches all of the properties of the object
1708      * @return stdClass
1709      */
1710     public function properties() {
1711         return $this->properties;
1712     }
1716 /**
1717  * Abstract class representation of a page associated with a lesson.
1718  *
1719  * This class should MUST be extended by all specialised page types defined in
1720  * mod/lesson/pagetypes/.
1721  * There are a handful of abstract methods that need to be defined as well as
1722  * severl methods that can optionally be defined in order to make the page type
1723  * operate in the desired way
1724  *
1725  * Database properties
1726  * @property int $id The id of this lesson page
1727  * @property int $lessonid The id of the lesson this page belongs to
1728  * @property int $prevpageid The id of the page before this one
1729  * @property int $nextpageid The id of the next page in the page sequence
1730  * @property int $qtype Identifies the page type of this page
1731  * @property int $qoption Used to record page type specific options
1732  * @property int $layout Used to record page specific layout selections
1733  * @property int $display Used to record page specific display selections
1734  * @property int $timecreated Timestamp for when the page was created
1735  * @property int $timemodified Timestamp for when the page was last modified
1736  * @property string $title The title of this page
1737  * @property string $contents The rich content shown to describe the page
1738  * @property int $contentsformat The format of the contents field
1739  *
1740  * Calculated properties
1741  * @property-read array $answers An array of answers for this page
1742  * @property-read bool $displayinmenublock Toggles display in the left menu block
1743  * @property-read array $jumps An array containing all the jumps this page uses
1744  * @property-read lesson $lesson The lesson this page belongs to
1745  * @property-read int $type The type of the page [question | structure]
1746  * @property-read typeid The unique identifier for the page type
1747  * @property-read typestring The string that describes this page type
1748  *
1749  * @abstract
1750  * @copyright  2009 Sam Hemelryk
1751  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1752  */
1753 abstract class lesson_page extends lesson_base {
1755     /**
1756      * A reference to the lesson this page belongs to
1757      * @var lesson
1758      */
1759     protected $lesson = null;
1760     /**
1761      * Contains the answers to this lesson_page once loaded
1762      * @var null|array
1763      */
1764     protected $answers = null;
1765     /**
1766      * This sets the type of the page, can be one of the constants defined below
1767      * @var int
1768      */
1769     protected $type = 0;
1771     /**
1772      * Constants used to identify the type of the page
1773      */
1774     const TYPE_QUESTION = 0;
1775     const TYPE_STRUCTURE = 1;
1777     /**
1778      * This method should return the integer used to identify the page type within
1779      * the database and throughout code. This maps back to the defines used in 1.x
1780      * @abstract
1781      * @return int
1782      */
1783     abstract protected function get_typeid();
1784     /**
1785      * This method should return the string that describes the pagetype
1786      * @abstract
1787      * @return string
1788      */
1789     abstract protected function get_typestring();
1791     /**
1792      * This method gets called to display the page to the user taking the lesson
1793      * @abstract
1794      * @param object $renderer
1795      * @param object $attempt
1796      * @return string
1797      */
1798     abstract public function display($renderer, $attempt);
1800     /**
1801      * Creates a new lesson_page within the database and returns the correct pagetype
1802      * object to use to interact with the new lesson
1803      *
1804      * @final
1805      * @static
1806      * @param object $properties
1807      * @param lesson $lesson
1808      * @return lesson_page Specialised object that extends lesson_page
1809      */
1810     final public static function create($properties, lesson $lesson, $context, $maxbytes) {
1811         global $DB;
1812         $newpage = new stdClass;
1813         $newpage->title = $properties->title;
1814         $newpage->contents = $properties->contents_editor['text'];
1815         $newpage->contentsformat = $properties->contents_editor['format'];
1816         $newpage->lessonid = $lesson->id;
1817         $newpage->timecreated = time();
1818         $newpage->qtype = $properties->qtype;
1819         $newpage->qoption = (isset($properties->qoption))?1:0;
1820         $newpage->layout = (isset($properties->layout))?1:0;
1821         $newpage->display = (isset($properties->display))?1:0;
1822         $newpage->prevpageid = 0; // this is a first page
1823         $newpage->nextpageid = 0; // this is the only page
1825         if ($properties->pageid) {
1826             $prevpage = $DB->get_record("lesson_pages", array("id" => $properties->pageid), 'id, nextpageid');
1827             if (!$prevpage) {
1828                 print_error('cannotfindpages', 'lesson');
1829             }
1830             $newpage->prevpageid = $prevpage->id;
1831             $newpage->nextpageid = $prevpage->nextpageid;
1832         } else {
1833             $nextpage = $DB->get_record('lesson_pages', array('lessonid'=>$lesson->id, 'prevpageid'=>0), 'id');
1834             if ($nextpage) {
1835                 // This is the first page, there are existing pages put this at the start
1836                 $newpage->nextpageid = $nextpage->id;
1837             }
1838         }
1840         $newpage->id = $DB->insert_record("lesson_pages", $newpage);
1842         $editor = new stdClass;
1843         $editor->id = $newpage->id;
1844         $editor->contents_editor = $properties->contents_editor;
1845         $editor = file_postupdate_standard_editor($editor, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$maxbytes), $context, 'mod_lesson', 'page_contents', $editor->id);
1846         $DB->update_record("lesson_pages", $editor);
1848         if ($newpage->prevpageid > 0) {
1849             $DB->set_field("lesson_pages", "nextpageid", $newpage->id, array("id" => $newpage->prevpageid));
1850         }
1851         if ($newpage->nextpageid > 0) {
1852             $DB->set_field("lesson_pages", "prevpageid", $newpage->id, array("id" => $newpage->nextpageid));
1853         }
1855         $page = lesson_page::load($newpage, $lesson);
1856         $page->create_answers($properties);
1858         // Trigger an event: page created.
1859         $eventparams = array(
1860             'context' => $context,
1861             'objectid' => $newpage->id,
1862             'other' => array(
1863                 'pagetype' => $page->get_typestring()
1864                 )
1865             );
1866         $event = \mod_lesson\event\page_created::create($eventparams);
1867         $snapshot = clone($newpage);
1868         $snapshot->timemodified = 0;
1869         $event->add_record_snapshot('lesson_pages', $snapshot);
1870         $event->trigger();
1872         $lesson->add_message(get_string('insertedpage', 'lesson').': '.format_string($newpage->title, true), 'notifysuccess');
1874         return $page;
1875     }
1877     /**
1878      * This method loads a page object from the database and returns it as a
1879      * specialised object that extends lesson_page
1880      *
1881      * @final
1882      * @static
1883      * @param int $id
1884      * @param lesson $lesson
1885      * @return lesson_page Specialised lesson_page object
1886      */
1887     final public static function load($id, lesson $lesson) {
1888         global $DB;
1890         if (is_object($id) && !empty($id->qtype)) {
1891             $page = $id;
1892         } else {
1893             $page = $DB->get_record("lesson_pages", array("id" => $id));
1894             if (!$page) {
1895                 print_error('cannotfindpages', 'lesson');
1896             }
1897         }
1898         $manager = lesson_page_type_manager::get($lesson);
1900         $class = 'lesson_page_type_'.$manager->get_page_type_idstring($page->qtype);
1901         if (!class_exists($class)) {
1902             $class = 'lesson_page';
1903         }
1905         return new $class($page, $lesson);
1906     }
1908     /**
1909      * Deletes a lesson_page from the database as well as any associated records.
1910      * @final
1911      * @return bool
1912      */
1913     final public function delete() {
1914         global $DB;
1916         $cm = get_coursemodule_from_instance('lesson', $this->lesson->id, $this->lesson->course);
1917         $context = context_module::instance($cm->id);
1919         // Delete files associated with attempts.
1920         $fs = get_file_storage();
1921         if ($attempts = $DB->get_records('lesson_attempts', array("pageid" => $this->properties->id))) {
1922             foreach ($attempts as $attempt) {
1923                 $fs->delete_area_files($context->id, 'mod_lesson', 'essay_responses', $attempt->id);
1924             }
1925         }
1927         // Then delete all the associated records...
1928         $DB->delete_records("lesson_attempts", array("pageid" => $this->properties->id));
1929         // ...now delete the answers...
1930         $DB->delete_records("lesson_answers", array("pageid" => $this->properties->id));
1931         // ..and the page itself
1932         $DB->delete_records("lesson_pages", array("id" => $this->properties->id));
1934         // Trigger an event: page deleted.
1935         $eventparams = array(
1936             'context' => $context,
1937             'objectid' => $this->properties->id,
1938             'other' => array(
1939                 'pagetype' => $this->get_typestring()
1940                 )
1941             );
1942         $event = \mod_lesson\event\page_deleted::create($eventparams);
1943         $event->add_record_snapshot('lesson_pages', $this->properties);
1944         $event->trigger();
1946         // Delete files associated with this page.
1947         $fs->delete_area_files($context->id, 'mod_lesson', 'page_contents', $this->properties->id);
1948         $fs->delete_area_files($context->id, 'mod_lesson', 'page_answers', $this->properties->id);
1949         $fs->delete_area_files($context->id, 'mod_lesson', 'page_responses', $this->properties->id);
1951         // repair the hole in the linkage
1952         if (!$this->properties->prevpageid && !$this->properties->nextpageid) {
1953             //This is the only page, no repair needed
1954         } elseif (!$this->properties->prevpageid) {
1955             // this is the first page...
1956             $page = $this->lesson->load_page($this->properties->nextpageid);
1957             $page->move(null, 0);
1958         } elseif (!$this->properties->nextpageid) {
1959             // this is the last page...
1960             $page = $this->lesson->load_page($this->properties->prevpageid);
1961             $page->move(0);
1962         } else {
1963             // page is in the middle...
1964             $prevpage = $this->lesson->load_page($this->properties->prevpageid);
1965             $nextpage = $this->lesson->load_page($this->properties->nextpageid);
1967             $prevpage->move($nextpage->id);
1968             $nextpage->move(null, $prevpage->id);
1969         }
1970         return true;
1971     }
1973     /**
1974      * Moves a page by updating its nextpageid and prevpageid values within
1975      * the database
1976      *
1977      * @final
1978      * @param int $nextpageid
1979      * @param int $prevpageid
1980      */
1981     final public function move($nextpageid=null, $prevpageid=null) {
1982         global $DB;
1983         if ($nextpageid === null) {
1984             $nextpageid = $this->properties->nextpageid;
1985         }
1986         if ($prevpageid === null) {
1987             $prevpageid = $this->properties->prevpageid;
1988         }
1989         $obj = new stdClass;
1990         $obj->id = $this->properties->id;
1991         $obj->prevpageid = $prevpageid;
1992         $obj->nextpageid = $nextpageid;
1993         $DB->update_record('lesson_pages', $obj);
1994     }
1996     /**
1997      * Returns the answers that are associated with this page in the database
1998      *
1999      * @final
2000      * @return array
2001      */
2002     final public function get_answers() {
2003         global $DB;
2004         if ($this->answers === null) {
2005             $this->answers = array();
2006             $answers = $DB->get_records('lesson_answers', array('pageid'=>$this->properties->id, 'lessonid'=>$this->lesson->id), 'id');
2007             if (!$answers) {
2008                 // It is possible that a lesson upgraded from Moodle 1.9 still
2009                 // contains questions without any answers [MDL-25632].
2010                 // debugging(get_string('cannotfindanswer', 'lesson'));
2011                 return array();
2012             }
2013             foreach ($answers as $answer) {
2014                 $this->answers[count($this->answers)] = new lesson_page_answer($answer);
2015             }
2016         }
2017         return $this->answers;
2018     }
2020     /**
2021      * Returns the lesson this page is associated with
2022      * @final
2023      * @return lesson
2024      */
2025     final protected function get_lesson() {
2026         return $this->lesson;
2027     }
2029     /**
2030      * Returns the type of page this is. Not to be confused with page type
2031      * @final
2032      * @return int
2033      */
2034     final protected function get_type() {
2035         return $this->type;
2036     }
2038     /**
2039      * Records an attempt at this page
2040      *
2041      * @final
2042      * @global moodle_database $DB
2043      * @param stdClass $context
2044      * @return stdClass Returns the result of the attempt
2045      */
2046     final public function record_attempt($context) {
2047         global $DB, $USER, $OUTPUT, $PAGE;
2049         /**
2050          * This should be overridden by each page type to actually check the response
2051          * against what ever custom criteria they have defined
2052          */
2053         $result = $this->check_answer();
2055         $result->attemptsremaining  = 0;
2056         $result->maxattemptsreached = false;
2058         if ($result->noanswer) {
2059             $result->newpageid = $this->properties->id; // display same page again
2060             $result->feedback  = get_string('noanswer', 'lesson');
2061         } else {
2062             if (!has_capability('mod/lesson:manage', $context)) {
2063                 $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->lesson->id, "userid"=>$USER->id));
2064                 // record student's attempt
2065                 $attempt = new stdClass;
2066                 $attempt->lessonid = $this->lesson->id;
2067                 $attempt->pageid = $this->properties->id;
2068                 $attempt->userid = $USER->id;
2069                 $attempt->answerid = $result->answerid;
2070                 $attempt->retry = $nretakes;
2071                 $attempt->correct = $result->correctanswer;
2072                 if($result->userresponse !== null) {
2073                     $attempt->useranswer = $result->userresponse;
2074                 }
2076                 $attempt->timeseen = time();
2077                 // if allow modattempts, then update the old attempt record, otherwise, insert new answer record
2078                 $userisreviewing = false;
2079                 if (isset($USER->modattempts[$this->lesson->id])) {
2080                     $attempt->retry = $nretakes - 1; // they are going through on review, $nretakes will be too high
2081                     $userisreviewing = true;
2082                 }
2084                 // Only insert a record if we are not reviewing the lesson.
2085                 if (!$userisreviewing) {
2086                     if ($this->lesson->retake || (!$this->lesson->retake && $nretakes == 0)) {
2087                         $attempt->id = $DB->insert_record("lesson_attempts", $attempt);
2088                         // Trigger an event: question answered.
2089                         $eventparams = array(
2090                             'context' => context_module::instance($PAGE->cm->id),
2091                             'objectid' => $this->properties->id,
2092                             'other' => array(
2093                                 'pagetype' => $this->get_typestring()
2094                                 )
2095                             );
2096                         $event = \mod_lesson\event\question_answered::create($eventparams);
2097                         $event->add_record_snapshot('lesson_attempts', $attempt);
2098                         $event->trigger();
2100                     }
2101                 }
2102                 // "number of attempts remaining" message if $this->lesson->maxattempts > 1
2103                 // displaying of message(s) is at the end of page for more ergonomic display
2104                 if (!$result->correctanswer && ($result->newpageid == 0)) {
2105                     // wrong answer and student is stuck on this page - check how many attempts
2106                     // the student has had at this page/question
2107                     $nattempts = $DB->count_records("lesson_attempts", array("pageid"=>$this->properties->id, "userid"=>$USER->id, "retry" => $attempt->retry));
2108                     // retreive the number of attempts left counter for displaying at bottom of feedback page
2109                     if ($nattempts >= $this->lesson->maxattempts) {
2110                         if ($this->lesson->maxattempts > 1) { // don't bother with message if only one attempt
2111                             $result->maxattemptsreached = true;
2112                         }
2113                         $result->newpageid = LESSON_NEXTPAGE;
2114                     } else if ($this->lesson->maxattempts > 1) { // don't bother with message if only one attempt
2115                         $result->attemptsremaining = $this->lesson->maxattempts - $nattempts;
2116                     }
2117                 }
2118             }
2119             // TODO: merge this code with the jump code below.  Convert jumpto page into a proper page id
2120             if ($result->newpageid == 0) {
2121                 $result->newpageid = $this->properties->id;
2122             } elseif ($result->newpageid == LESSON_NEXTPAGE) {
2123                 $result->newpageid = $this->lesson->get_next_page($this->properties->nextpageid);
2124             }
2126             // Determine default feedback if necessary
2127             if (empty($result->response)) {
2128                 if (!$this->lesson->feedback && !$result->noanswer && !($this->lesson->review & !$result->correctanswer && !$result->isessayquestion)) {
2129                     // These conditions have been met:
2130                     //  1. The lesson manager has not supplied feedback to the student
2131                     //  2. Not displaying default feedback
2132                     //  3. The user did provide an answer
2133                     //  4. We are not reviewing with an incorrect answer (and not reviewing an essay question)
2135                     $result->nodefaultresponse = true;  // This will cause a redirect below
2136                 } else if ($result->isessayquestion) {
2137                     $result->response = get_string('defaultessayresponse', 'lesson');
2138                 } else if ($result->correctanswer) {
2139                     $result->response = get_string('thatsthecorrectanswer', 'lesson');
2140                 } else {
2141                     $result->response = get_string('thatsthewronganswer', 'lesson');
2142                 }
2143             }
2145             if ($result->response) {
2146                 if ($this->lesson->review && !$result->correctanswer && !$result->isessayquestion) {
2147                     $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->lesson->id, "userid"=>$USER->id));
2148                     $qattempts = $DB->count_records("lesson_attempts", array("userid"=>$USER->id, "retry"=>$nretakes, "pageid"=>$this->properties->id));
2149                     if ($qattempts == 1) {
2150                         $result->feedback = $OUTPUT->box(get_string("firstwrong", "lesson"), 'feedback');
2151                     } else {
2152                         $result->feedback = $OUTPUT->box(get_string("secondpluswrong", "lesson"), 'feedback');
2153                     }
2154                 } else {
2155                     $class = 'response';
2156                     if ($result->correctanswer) {
2157                         $class .= ' correct'; //CSS over-ride this if they exist (!important)
2158                     } else if (!$result->isessayquestion) {
2159                         $class .= ' incorrect'; //CSS over-ride this if they exist (!important)
2160                     }
2161                     $options = new stdClass;
2162                     $options->noclean = true;
2163                     $options->para = true;
2164                     $options->overflowdiv = true;
2165                     $options->context = $context;
2167                     $result->feedback = $OUTPUT->box(format_text($this->get_contents(), $this->properties->contentsformat, $options), 'generalbox boxaligncenter');
2168                     if (isset($result->studentanswerformat)) {
2169                         // This is the student's answer so it should be cleaned.
2170                         $studentanswer = format_text($result->studentanswer, $result->studentanswerformat,
2171                                 array('context' => $context, 'para' => true));
2172                     } else {
2173                         $studentanswer = format_string($result->studentanswer);
2174                     }
2175                     $result->feedback .= '<div class="correctanswer generalbox"><em>'
2176                             . get_string("youranswer", "lesson").'</em> : ' . $studentanswer;
2177                     if (isset($result->responseformat)) {
2178                         $result->response = file_rewrite_pluginfile_urls($result->response, 'pluginfile.php', $context->id,
2179                             'mod_lesson', 'page_responses', $result->answerid);
2180                         $result->feedback .= $OUTPUT->box(format_text($result->response, $result->responseformat, $options)
2181                             , $class);
2182                     } else {
2183                         $result->feedback .= $OUTPUT->box($result->response, $class);
2184                     }
2185                     $result->feedback .= '</div>';
2186                 }
2187             }
2188         }
2190         return $result;
2191     }
2193     /**
2194      * Returns the string for a jump name
2195      *
2196      * @final
2197      * @param int $jumpto Jump code or page ID
2198      * @return string
2199      **/
2200     final protected function get_jump_name($jumpto) {
2201         global $DB;
2202         static $jumpnames = array();
2204         if (!array_key_exists($jumpto, $jumpnames)) {
2205             if ($jumpto == LESSON_THISPAGE) {
2206                 $jumptitle = get_string('thispage', 'lesson');
2207             } elseif ($jumpto == LESSON_NEXTPAGE) {
2208                 $jumptitle = get_string('nextpage', 'lesson');
2209             } elseif ($jumpto == LESSON_EOL) {
2210                 $jumptitle = get_string('endoflesson', 'lesson');
2211             } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
2212                 $jumptitle = get_string('unseenpageinbranch', 'lesson');
2213             } elseif ($jumpto == LESSON_PREVIOUSPAGE) {
2214                 $jumptitle = get_string('previouspage', 'lesson');
2215             } elseif ($jumpto == LESSON_RANDOMPAGE) {
2216                 $jumptitle = get_string('randompageinbranch', 'lesson');
2217             } elseif ($jumpto == LESSON_RANDOMBRANCH) {
2218                 $jumptitle = get_string('randombranch', 'lesson');
2219             } elseif ($jumpto == LESSON_CLUSTERJUMP) {
2220                 $jumptitle = get_string('clusterjump', 'lesson');
2221             } else {
2222                 if (!$jumptitle = $DB->get_field('lesson_pages', 'title', array('id' => $jumpto))) {
2223                     $jumptitle = '<strong>'.get_string('notdefined', 'lesson').'</strong>';
2224                 }
2225             }
2226             $jumpnames[$jumpto] = format_string($jumptitle,true);
2227         }
2229         return $jumpnames[$jumpto];
2230     }
2232     /**
2233      * Constructor method
2234      * @param object $properties
2235      * @param lesson $lesson
2236      */
2237     public function __construct($properties, lesson $lesson) {
2238         parent::__construct($properties);
2239         $this->lesson = $lesson;
2240     }
2242     /**
2243      * Returns the score for the attempt
2244      * This may be overridden by page types that require manual grading
2245      * @param array $answers
2246      * @param object $attempt
2247      * @return int
2248      */
2249     public function earned_score($answers, $attempt) {
2250         return $answers[$attempt->answerid]->score;
2251     }
2253     /**
2254      * This is a callback method that can be override and gets called when ever a page
2255      * is viewed
2256      *
2257      * @param bool $canmanage True if the user has the manage cap
2258      * @return mixed
2259      */
2260     public function callback_on_view($canmanage) {
2261         return true;
2262     }
2264     /**
2265      * save editor answers files and update answer record
2266      *
2267      * @param object $context
2268      * @param int $maxbytes
2269      * @param object $answer
2270      * @param object $answereditor
2271      * @param object $responseeditor
2272      */
2273     public function save_answers_files($context, $maxbytes, &$answer, $answereditor = '', $responseeditor = '') {
2274         global $DB;
2275         if (isset($answereditor['itemid'])) {
2276             $answer->answer = file_save_draft_area_files($answereditor['itemid'],
2277                     $context->id, 'mod_lesson', 'page_answers', $answer->id,
2278                     array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $maxbytes),
2279                     $answer->answer, null);
2280             $DB->set_field('lesson_answers', 'answer', $answer->answer, array('id' => $answer->id));
2281         }
2282         if (isset($responseeditor['itemid'])) {
2283             $answer->response = file_save_draft_area_files($responseeditor['itemid'],
2284                     $context->id, 'mod_lesson', 'page_responses', $answer->id,
2285                     array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $maxbytes),
2286                     $answer->response, null);
2287             $DB->set_field('lesson_answers', 'response', $answer->response, array('id' => $answer->id));
2288         }
2289     }
2291     /**
2292      * Rewrite urls in response and optionality answer of a question answer
2293      *
2294      * @param object $answer
2295      * @param bool $rewriteanswer must rewrite answer
2296      * @return object answer with rewritten urls
2297      */
2298     public static function rewrite_answers_urls($answer, $rewriteanswer = true) {
2299         global $PAGE;
2301         $context = context_module::instance($PAGE->cm->id);
2302         if ($rewriteanswer) {
2303             $answer->answer = file_rewrite_pluginfile_urls($answer->answer, 'pluginfile.php', $context->id,
2304                     'mod_lesson', 'page_answers', $answer->id);
2305         }
2306         $answer->response = file_rewrite_pluginfile_urls($answer->response, 'pluginfile.php', $context->id,
2307                 'mod_lesson', 'page_responses', $answer->id);
2309         return $answer;
2310     }
2312     /**
2313      * Updates a lesson page and its answers within the database
2314      *
2315      * @param object $properties
2316      * @return bool
2317      */
2318     public function update($properties, $context = null, $maxbytes = null) {
2319         global $DB, $PAGE;
2320         $answers  = $this->get_answers();
2321         $properties->id = $this->properties->id;
2322         $properties->lessonid = $this->lesson->id;
2323         if (empty($properties->qoption)) {
2324             $properties->qoption = '0';
2325         }
2326         if (empty($context)) {
2327             $context = $PAGE->context;
2328         }
2329         if ($maxbytes === null) {
2330             $maxbytes = get_user_max_upload_file_size($context);
2331         }
2332         $properties->timemodified = time();
2333         $properties = file_postupdate_standard_editor($properties, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$maxbytes), $context, 'mod_lesson', 'page_contents', $properties->id);
2334         $DB->update_record("lesson_pages", $properties);
2336         // Trigger an event: page updated.
2337         \mod_lesson\event\page_updated::create_from_lesson_page($this, $context)->trigger();
2339         if ($this->type == self::TYPE_STRUCTURE && $this->get_typeid() != LESSON_PAGE_BRANCHTABLE) {
2340             // These page types have only one answer to save the jump and score.
2341             if (count($answers) > 1) {
2342                 $answer = array_shift($answers);
2343                 foreach ($answers as $a) {
2344                     $DB->delete_record('lesson_answers', array('id' => $a->id));
2345                 }
2346             } else if (count($answers) == 1) {
2347                 $answer = array_shift($answers);
2348             } else {
2349                 $answer = new stdClass;
2350                 $answer->lessonid = $properties->lessonid;
2351                 $answer->pageid = $properties->id;
2352                 $answer->timecreated = time();
2353             }
2355             $answer->timemodified = time();
2356             if (isset($properties->jumpto[0])) {
2357                 $answer->jumpto = $properties->jumpto[0];
2358             }
2359             if (isset($properties->score[0])) {
2360                 $answer->score = $properties->score[0];
2361             }
2362             if (!empty($answer->id)) {
2363                 $DB->update_record("lesson_answers", $answer->properties());
2364             } else {
2365                 $DB->insert_record("lesson_answers", $answer);
2366             }
2367         } else {
2368             for ($i = 0; $i < $this->lesson->maxanswers; $i++) {
2369                 if (!array_key_exists($i, $this->answers)) {
2370                     $this->answers[$i] = new stdClass;
2371                     $this->answers[$i]->lessonid = $this->lesson->id;
2372                     $this->answers[$i]->pageid = $this->id;
2373                     $this->answers[$i]->timecreated = $this->timecreated;
2374                 }
2376                 if (!empty($properties->answer_editor[$i])) {
2377                     if (is_array($properties->answer_editor[$i])) {
2378                         // Multichoice and true/false pages have an HTML editor.
2379                         $this->answers[$i]->answer = $properties->answer_editor[$i]['text'];
2380                         $this->answers[$i]->answerformat = $properties->answer_editor[$i]['format'];
2381                     } else {
2382                         // Branch tables, shortanswer and mumerical pages have only a text field.
2383                         $this->answers[$i]->answer = $properties->answer_editor[$i];
2384                         $this->answers[$i]->answerformat = FORMAT_MOODLE;
2385                     }
2386                 }
2388                 if (!empty($properties->response_editor[$i]) && is_array($properties->response_editor[$i])) {
2389                     $this->answers[$i]->response = $properties->response_editor[$i]['text'];
2390                     $this->answers[$i]->responseformat = $properties->response_editor[$i]['format'];
2391                 }
2393                 if (isset($this->answers[$i]->answer) && $this->answers[$i]->answer != '') {
2394                     if (isset($properties->jumpto[$i])) {
2395                         $this->answers[$i]->jumpto = $properties->jumpto[$i];
2396                     }
2397                     if ($this->lesson->custom && isset($properties->score[$i])) {
2398                         $this->answers[$i]->score = $properties->score[$i];
2399                     }
2400                     if (!isset($this->answers[$i]->id)) {
2401                         $this->answers[$i]->id = $DB->insert_record("lesson_answers", $this->answers[$i]);
2402                     } else {
2403                         $DB->update_record("lesson_answers", $this->answers[$i]->properties());
2404                     }
2406                     // Save files in answers and responses.
2407                     if (isset($properties->response_editor[$i])) {
2408                         $this->save_answers_files($context, $maxbytes, $this->answers[$i],
2409                                 $properties->answer_editor[$i], $properties->response_editor[$i]);
2410                     } else {
2411                         $this->save_answers_files($context, $maxbytes, $this->answers[$i],
2412                                 $properties->answer_editor[$i]);
2413                     }
2415                 } else if (isset($this->answers[$i]->id)) {
2416                     $DB->delete_records('lesson_answers', array('id' => $this->answers[$i]->id));
2417                     unset($this->answers[$i]);
2418                 }
2419             }
2420         }
2421         return true;
2422     }
2424     /**
2425      * Can be set to true if the page requires a static link to create a new instance
2426      * instead of simply being included in the dropdown
2427      * @param int $previd
2428      * @return bool
2429      */
2430     public function add_page_link($previd) {
2431         return false;
2432     }
2434     /**
2435      * Returns true if a page has been viewed before
2436      *
2437      * @param array|int $param Either an array of pages that have been seen or the
2438      *                   number of retakes a user has had
2439      * @return bool
2440      */
2441     public function is_unseen($param) {
2442         global $USER, $DB;
2443         if (is_array($param)) {
2444             $seenpages = $param;
2445             return (!array_key_exists($this->properties->id, $seenpages));
2446         } else {
2447             $nretakes = $param;
2448             if (!$DB->count_records("lesson_attempts", array("pageid"=>$this->properties->id, "userid"=>$USER->id, "retry"=>$nretakes))) {
2449                 return true;
2450             }
2451         }
2452         return false;
2453     }
2455     /**
2456      * Checks to see if a page has been answered previously
2457      * @param int $nretakes
2458      * @return bool
2459      */
2460     public function is_unanswered($nretakes) {
2461         global $DB, $USER;
2462         if (!$DB->count_records("lesson_attempts", array('pageid'=>$this->properties->id, 'userid'=>$USER->id, 'correct'=>1, 'retry'=>$nretakes))) {
2463             return true;
2464         }
2465         return false;
2466     }
2468     /**
2469      * Creates answers within the database for this lesson_page. Usually only ever
2470      * called when creating a new page instance
2471      * @param object $properties
2472      * @return array
2473      */
2474     public function create_answers($properties) {
2475         global $DB, $PAGE;
2476         // now add the answers
2477         $newanswer = new stdClass;
2478         $newanswer->lessonid = $this->lesson->id;
2479         $newanswer->pageid = $this->properties->id;
2480         $newanswer->timecreated = $this->properties->timecreated;
2482         $cm = get_coursemodule_from_instance('lesson', $this->lesson->id, $this->lesson->course);
2483         $context = context_module::instance($cm->id);
2485         $answers = array();
2487         for ($i = 0; $i < $this->lesson->maxanswers; $i++) {
2488             $answer = clone($newanswer);
2490             if (!empty($properties->answer_editor[$i])) {
2491                 if (is_array($properties->answer_editor[$i])) {
2492                     // Multichoice and true/false pages have an HTML editor.
2493                     $answer->answer = $properties->answer_editor[$i]['text'];
2494                     $answer->answerformat = $properties->answer_editor[$i]['format'];
2495                 } else {
2496                     // Branch tables, shortanswer and mumerical pages have only a text field.
2497                     $answer->answer = $properties->answer_editor[$i];
2498                     $answer->answerformat = FORMAT_MOODLE;
2499                 }
2500             }
2501             if (!empty($properties->response_editor[$i]) && is_array($properties->response_editor[$i])) {
2502                 $answer->response = $properties->response_editor[$i]['text'];
2503                 $answer->responseformat = $properties->response_editor[$i]['format'];
2504             }
2506             if (isset($answer->answer) && $answer->answer != '') {
2507                 if (isset($properties->jumpto[$i])) {
2508                     $answer->jumpto = $properties->jumpto[$i];
2509                 }
2510                 if ($this->lesson->custom && isset($properties->score[$i])) {
2511                     $answer->score = $properties->score[$i];
2512                 }
2513                 $answer->id = $DB->insert_record("lesson_answers", $answer);
2514                 if (isset($properties->response_editor[$i])) {
2515                     $this->save_answers_files($context, $PAGE->course->maxbytes, $answer,
2516                             $properties->answer_editor[$i], $properties->response_editor[$i]);
2517                 } else {
2518                     $this->save_answers_files($context, $PAGE->course->maxbytes, $answer,
2519                             $properties->answer_editor[$i]);
2520                 }
2521                 $answers[$answer->id] = new lesson_page_answer($answer);
2522             } else {
2523                 break;
2524             }
2525         }
2527         $this->answers = $answers;
2528         return $answers;
2529     }
2531     /**
2532      * This method MUST be overridden by all question page types, or page types that
2533      * wish to score a page.
2534      *
2535      * The structure of result should always be the same so it is a good idea when
2536      * overriding this method on a page type to call
2537      * <code>
2538      * $result = parent::check_answer();
2539      * </code>
2540      * before modifying it as required.
2541      *
2542      * @return stdClass
2543      */
2544     public function check_answer() {
2545         $result = new stdClass;
2546         $result->answerid        = 0;
2547         $result->noanswer        = false;
2548         $result->correctanswer   = false;
2549         $result->isessayquestion = false;   // use this to turn off review button on essay questions
2550         $result->response        = '';
2551         $result->newpageid       = 0;       // stay on the page
2552         $result->studentanswer   = '';      // use this to store student's answer(s) in order to display it on feedback page
2553         $result->userresponse    = null;
2554         $result->feedback        = '';
2555         $result->nodefaultresponse  = false; // Flag for redirecting when default feedback is turned off
2556         return $result;
2557     }
2559     /**
2560      * True if the page uses a custom option
2561      *
2562      * Should be override and set to true if the page uses a custom option.
2563      *
2564      * @return bool
2565      */
2566     public function has_option() {
2567         return false;
2568     }
2570     /**
2571      * Returns the maximum number of answers for this page given the maximum number
2572      * of answers permitted by the lesson.
2573      *
2574      * @param int $default
2575      * @return int
2576      */
2577     public function max_answers($default) {
2578         return $default;
2579     }
2581     /**
2582      * Returns the properties of this lesson page as an object
2583      * @return stdClass;
2584      */
2585     public function properties() {
2586         $properties = clone($this->properties);
2587         if ($this->answers === null) {
2588             $this->get_answers();
2589         }
2590         if (count($this->answers)>0) {
2591             $count = 0;
2592             $qtype = $properties->qtype;
2593             foreach ($this->answers as $answer) {
2594                 $properties->{'answer_editor['.$count.']'} = array('text' => $answer->answer, 'format' => $answer->answerformat);
2595                 if ($qtype != LESSON_PAGE_MATCHING) {
2596                     $properties->{'response_editor['.$count.']'} = array('text' => $answer->response, 'format' => $answer->responseformat);
2597                 } else {
2598                     $properties->{'response_editor['.$count.']'} = $answer->response;
2599                 }
2600                 $properties->{'jumpto['.$count.']'} = $answer->jumpto;
2601                 $properties->{'score['.$count.']'} = $answer->score;
2602                 $count++;
2603             }
2604         }
2605         return $properties;
2606     }
2608     /**
2609      * Returns an array of options to display when choosing the jumpto for a page/answer
2610      * @static
2611      * @param int $pageid
2612      * @param lesson $lesson
2613      * @return array
2614      */
2615     public static function get_jumptooptions($pageid, lesson $lesson) {
2616         global $DB;
2617         $jump = array();
2618         $jump[0] = get_string("thispage", "lesson");
2619         $jump[LESSON_NEXTPAGE] = get_string("nextpage", "lesson");
2620         $jump[LESSON_PREVIOUSPAGE] = get_string("previouspage", "lesson");
2621         $jump[LESSON_EOL] = get_string("endoflesson", "lesson");
2623         if ($pageid == 0) {
2624             return $jump;
2625         }
2627         $pages = $lesson->load_all_pages();
2628         if ($pages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE || $lesson->is_sub_page_of_type($pageid, array(LESSON_PAGE_BRANCHTABLE), array(LESSON_PAGE_ENDOFBRANCH, LESSON_PAGE_CLUSTER))) {
2629             $jump[LESSON_UNSEENBRANCHPAGE] = get_string("unseenpageinbranch", "lesson");
2630             $jump[LESSON_RANDOMPAGE] = get_string("randompageinbranch", "lesson");
2631         }
2632         if($pages[$pageid]->qtype == LESSON_PAGE_CLUSTER || $lesson->is_sub_page_of_type($pageid, array(LESSON_PAGE_CLUSTER), array(LESSON_PAGE_ENDOFCLUSTER))) {
2633             $jump[LESSON_CLUSTERJUMP] = get_string("clusterjump", "lesson");
2634         }
2635         if (!optional_param('firstpage', 0, PARAM_INT)) {
2636             $apageid = $DB->get_field("lesson_pages", "id", array("lessonid" => $lesson->id, "prevpageid" => 0));
2637             while (true) {
2638                 if ($apageid) {
2639                     $title = $DB->get_field("lesson_pages", "title", array("id" => $apageid));
2640                     $jump[$apageid] = strip_tags(format_string($title,true));
2641                     $apageid = $DB->get_field("lesson_pages", "nextpageid", array("id" => $apageid));
2642                 } else {
2643                     // last page reached
2644                     break;
2645                 }
2646             }
2647         }
2648         return $jump;
2649     }
2650     /**
2651      * Returns the contents field for the page properly formatted and with plugin
2652      * file url's converted
2653      * @return string
2654      */
2655     public function get_contents() {
2656         global $PAGE;
2657         if (!empty($this->properties->contents)) {
2658             if (!isset($this->properties->contentsformat)) {
2659                 $this->properties->contentsformat = FORMAT_HTML;
2660             }
2661             $context = context_module::instance($PAGE->cm->id);
2662             $contents = file_rewrite_pluginfile_urls($this->properties->contents, 'pluginfile.php', $context->id, 'mod_lesson',
2663                                                      'page_contents', $this->properties->id);  // Must do this BEFORE format_text()!
2664             return format_text($contents, $this->properties->contentsformat,
2665                                array('context' => $context, 'noclean' => true,
2666                                      'overflowdiv' => true));  // Page edit is marked with XSS, we want all content here.
2667         } else {
2668             return '';
2669         }
2670     }
2672     /**
2673      * Set to true if this page should display in the menu block
2674      * @return bool
2675      */
2676     protected function get_displayinmenublock() {
2677         return false;
2678     }
2680     /**
2681      * Get the string that describes the options of this page type
2682      * @return string
2683      */
2684     public function option_description_string() {
2685         return '';
2686     }
2688     /**
2689      * Updates a table with the answers for this page
2690      * @param html_table $table
2691      * @return html_table
2692      */
2693     public function display_answers(html_table $table) {
2694         $answers = $this->get_answers();
2695         $i = 1;
2696         foreach ($answers as $answer) {
2697             $cells = array();
2698             $cells[] = "<span class=\"label\">".get_string("jump", "lesson")." $i<span>: ";
2699             $cells[] = $this->get_jump_name($answer->jumpto);
2700             $table->data[] = new html_table_row($cells);
2701             if ($i === 1){
2702                 $table->data[count($table->data)-1]->cells[0]->style = 'width:20%;';
2703             }
2704             $i++;
2705         }
2706         return $table;
2707     }
2709     /**
2710      * Determines if this page should be grayed out on the management/report screens
2711      * @return int 0 or 1
2712      */
2713     protected function get_grayout() {
2714         return 0;
2715     }
2717     /**
2718      * Adds stats for this page to the &pagestats object. This should be defined
2719      * for all page types that grade
2720      * @param array $pagestats
2721      * @param int $tries
2722      * @return bool
2723      */
2724     public function stats(array &$pagestats, $tries) {
2725         return true;
2726     }
2728     /**
2729      * Formats the answers of this page for a report
2730      *
2731      * @param object $answerpage
2732      * @param object $answerdata
2733      * @param object $useranswer
2734      * @param array $pagestats
2735      * @param int $i Count of first level answers
2736      * @param int $n Count of second level answers
2737      * @return object The answer page for this
2738      */
2739     public function report_answers($answerpage, $answerdata, $useranswer, $pagestats, &$i, &$n) {
2740         $answers = $this->get_answers();
2741         $formattextdefoptions = new stdClass;
2742         $formattextdefoptions->para = false;  //I'll use it widely in this page
2743         foreach ($answers as $answer) {
2744             $data = get_string('jumpsto', 'lesson', $this->get_jump_name($answer->jumpto));
2745             $answerdata->answers[] = array($data, "");
2746             $answerpage->answerdata = $answerdata;
2747         }
2748         return $answerpage;
2749     }
2751     /**
2752      * Gets an array of the jumps used by the answers of this page
2753      *
2754      * @return array
2755      */
2756     public function get_jumps() {
2757         global $DB;
2758         $jumps = array();
2759         $params = array ("lessonid" => $this->lesson->id, "pageid" => $this->properties->id);
2760         if ($answers = $this->get_answers()) {
2761             foreach ($answers as $answer) {
2762                 $jumps[] = $this->get_jump_name($answer->jumpto);
2763             }
2764         } else {
2765             $jumps[] = $this->get_jump_name($this->properties->nextpageid);
2766         }
2767         return $jumps;
2768     }
2769     /**
2770      * Informs whether this page type require manual grading or not
2771      * @return bool
2772      */
2773     public function requires_manual_grading() {
2774         return false;
2775     }
2777     /**
2778      * A callback method that allows a page to override the next page a user will
2779      * see during when this page is being completed.
2780      * @return false|int
2781      */
2782     public function override_next_page() {
2783         return false;
2784     }
2786     /**
2787      * This method is used to determine if this page is a valid page
2788      *
2789      * @param array $validpages
2790      * @param array $pageviews
2791      * @return int The next page id to check
2792      */
2793     public function valid_page_and_view(&$validpages, &$pageviews) {
2794         $validpages[$this->properties->id] = 1;
2795         return $this->properties->nextpageid;
2796     }
2801 /**
2802  * Class used to represent an answer to a page
2803  *
2804  * @property int $id The ID of this answer in the database
2805  * @property int $lessonid The ID of the lesson this answer belongs to
2806  * @property int $pageid The ID of the page this answer belongs to
2807  * @property int $jumpto Identifies where the user goes upon completing a page with this answer
2808  * @property int $grade The grade this answer is worth
2809  * @property int $score The score this answer will give
2810  * @property int $flags Used to store options for the answer
2811  * @property int $timecreated A timestamp of when the answer was created
2812  * @property int $timemodified A timestamp of when the answer was modified
2813  * @property string $answer The answer itself
2814  * @property string $response The response the user sees if selecting this answer
2815  *
2816  * @copyright  2009 Sam Hemelryk
2817  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2818  */
2819 class lesson_page_answer extends lesson_base {
2821     /**
2822      * Loads an page answer from the DB
2823      *
2824      * @param int $id
2825      * @return lesson_page_answer
2826      */
2827     public static function load($id) {
2828         global $DB;
2829         $answer = $DB->get_record("lesson_answers", array("id" => $id));
2830         return new lesson_page_answer($answer);
2831     }
2833     /**
2834      * Given an object of properties and a page created answer(s) and saves them
2835      * in the database.
2836      *
2837      * @param stdClass $properties
2838      * @param lesson_page $page
2839      * @return array
2840      */
2841     public static function create($properties, lesson_page $page) {
2842         return $page->create_answers($properties);
2843     }
2847 /**
2848  * A management class for page types
2849  *
2850  * This class is responsible for managing the different pages. A manager object can
2851  * be retrieved by calling the following line of code:
2852  * <code>
2853  * $manager  = lesson_page_type_manager::get($lesson);
2854  * </code>
2855  * The first time the page type manager is retrieved the it includes all of the
2856  * different page types located in mod/lesson/pagetypes.
2857  *
2858  * @copyright  2009 Sam Hemelryk
2859  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2860  */
2861 class lesson_page_type_manager {
2863     /**
2864      * An array of different page type classes
2865      * @var array
2866      */
2867     protected $types = array();
2869     /**
2870      * Retrieves the lesson page type manager object
2871      *
2872      * If the object hasn't yet been created it is created here.
2873      *
2874      * @staticvar lesson_page_type_manager $pagetypemanager
2875      * @param lesson $lesson
2876      * @return lesson_page_type_manager
2877      */
2878     public static function get(lesson $lesson) {
2879         static $pagetypemanager;
2880         if (!($pagetypemanager instanceof lesson_page_type_manager)) {
2881             $pagetypemanager = new lesson_page_type_manager();
2882             $pagetypemanager->load_lesson_types($lesson);
2883         }
2884         return $pagetypemanager;
2885     }
2887     /**
2888      * Finds and loads all lesson page types in mod/lesson/pagetypes
2889      *
2890      * @param lesson $lesson
2891      */
2892     public function load_lesson_types(lesson $lesson) {
2893         global $CFG;
2894         $basedir = $CFG->dirroot.'/mod/lesson/pagetypes/';
2895         $dir = dir($basedir);
2896         while (false !== ($entry = $dir->read())) {
2897             if (strpos($entry, '.')===0 || !preg_match('#^[a-zA-Z]+\.php#i', $entry)) {
2898                 continue;
2899             }
2900             require_once($basedir.$entry);
2901             $class = 'lesson_page_type_'.strtok($entry,'.');
2902             if (class_exists($class)) {
2903                 $pagetype = new $class(new stdClass, $lesson);
2904                 $this->types[$pagetype->typeid] = $pagetype;
2905             }
2906         }
2908     }
2910     /**
2911      * Returns an array of strings to describe the loaded page types
2912      *
2913      * @param int $type Can be used to return JUST the string for the requested type
2914      * @return array
2915      */
2916     public function get_page_type_strings($type=null, $special=true) {
2917         $types = array();
2918         foreach ($this->types as $pagetype) {
2919             if (($type===null || $pagetype->type===$type) && ($special===true || $pagetype->is_standard())) {
2920                 $types[$pagetype->typeid] = $pagetype->typestring;
2921             }
2922         }
2923         return $types;
2924     }
2926     /**
2927      * Returns the basic string used to identify a page type provided with an id
2928      *
2929      * This string can be used to instantiate or identify the page type class.
2930      * If the page type id is unknown then 'unknown' is returned
2931      *
2932      * @param int $id
2933      * @return string
2934      */
2935     public function get_page_type_idstring($id) {
2936         foreach ($this->types as $pagetype) {
2937             if ((int)$pagetype->typeid === (int)$id) {
2938                 return $pagetype->idstring;
2939             }
2940         }
2941         return 'unknown';
2942     }
2944     /**
2945      * Loads a page for the provided lesson given it's id
2946      *
2947      * This function loads a page from the lesson when given both the lesson it belongs
2948      * to as well as the page's id.
2949      * If the page doesn't exist an error is thrown
2950      *
2951      * @param int $pageid The id of the page to load
2952      * @param lesson $lesson The lesson the page belongs to
2953      * @return lesson_page A class that extends lesson_page
2954      */
2955     public function load_page($pageid, lesson $lesson) {
2956         global $DB;
2957         if (!($page =$DB->get_record('lesson_pages', array('id'=>$pageid, 'lessonid'=>$lesson->id)))) {
2958             print_error('cannotfindpages', 'lesson');
2959         }
2960         $pagetype = get_class($this->types[$page->qtype]);
2961         $page = new $pagetype($page, $lesson);
2962         return $page;
2963     }
2965     /**
2966      * This function detects errors in the ordering between 2 pages and updates the page records.
2967      *
2968      * @param stdClass $page1 Either the first of 2 pages or null if the $page2 param is the first in the list.
2969      * @param stdClass $page1 Either the second of 2 pages or null if the $page1 param is the last in the list.
2970      */
2971     protected function check_page_order($page1, $page2) {
2972         global $DB;
2973         if (empty($page1)) {
2974             if ($page2->prevpageid != 0) {
2975                 debugging("***prevpageid of page " . $page2->id . " set to 0***");
2976                 $page2->prevpageid = 0;
2977                 $DB->set_field("lesson_pages", "prevpageid", 0, array("id" => $page2->id));
2978             }
2979         } else if (empty($page2)) {
2980             if ($page1->nextpageid != 0) {
2981                 debugging("***nextpageid of page " . $page1->id . " set to 0***");
2982                 $page1->nextpageid = 0;
2983                 $DB->set_field("lesson_pages", "nextpageid", 0, array("id" => $page1->id));
2984             }
2985         } else {
2986             if ($page1->nextpageid != $page2->id) {
2987                 debugging("***nextpageid of page " . $page1->id . " set to " . $page2->id . "***");
2988                 $page1->nextpageid = $page2->id;
2989                 $DB->set_field("lesson_pages", "nextpageid", $page2->id, array("id" => $page1->id));
2990             }
2991             if ($page2->prevpageid != $page1->id) {
2992                 debugging("***prevpageid of page " . $page2->id . " set to " . $page1->id . "***");
2993                 $page2->prevpageid = $page1->id;
2994                 $DB->set_field("lesson_pages", "prevpageid", $page1->id, array("id" => $page2->id));
2995             }
2996         }
2997     }
2999     /**
3000      * This function loads ALL pages that belong to the lesson.
3001      *
3002      * @param lesson $lesson
3003      * @return array An array of lesson_page_type_*
3004      */
3005     public function load_all_pages(lesson $lesson) {
3006         global $DB;
3007         if (!($pages =$DB->get_records('lesson_pages', array('lessonid'=>$lesson->id)))) {
3008             return array(); // Records returned empty.
3009         }
3010         foreach ($pages as $key=>$page) {
3011             $pagetype = get_class($this->types[$page->qtype]);
3012             $pages[$key] = new $pagetype($page, $lesson);
3013         }
3015         $orderedpages = array();
3016         $lastpageid = 0;
3017         $morepages = true;
3018         while ($morepages) {
3019             $morepages = false;
3020             foreach ($pages as $page) {
3021                 if ((int)$page->prevpageid === (int)$lastpageid) {
3022                     // Check for errors in page ordering and fix them on the fly.
3023                     $prevpage = null;
3024                     if ($lastpageid !== 0) {
3025                         $prevpage = $orderedpages[$lastpageid];
3026                     }
3027                     $this->check_page_order($prevpage, $page);
3028                     $morepages = true;
3029                     $orderedpages[$page->id] = $page;
3030                     unset($pages[$page->id]);
3031                     $lastpageid = $page->id;
3032                     if ((int)$page->nextpageid===0) {
3033                         break 2;
3034                     } else {
3035                         break 1;
3036                     }
3037                 }
3038             }
3039         }
3041         // Add remaining pages and fix the nextpageid links for each page.
3042         foreach ($pages as $page) {
3043             // Check for errors in page ordering and fix them on the fly.
3044             $prevpage = null;
3045             if ($lastpageid !== 0) {
3046                 $prevpage = $orderedpages[$lastpageid];
3047             }
3048             $this->check_page_order($prevpage, $page);
3049             $orderedpages[$page->id] = $page;
3050             unset($pages[$page->id]);
3051             $lastpageid = $page->id;
3052         }
3054         if ($lastpageid !== 0) {
3055             $this->check_page_order($orderedpages[$lastpageid], null);
3056         }
3058         return $orderedpages;
3059     }
3061     /**
3062      * Fetches an mform that can be used to create/edit an page
3063      *
3064      * @param int $type The id for the page type
3065      * @param array $arguments Any arguments to pass to the mform
3066      * @return lesson_add_page_form_base
3067      */
3068     public function get_page_form($type, $arguments) {
3069         $class = 'lesson_add_page_form_'.$this->get_page_type_idstring($type);
3070         if (!class_exists($class) || get_parent_class($class)!=='lesson_add_page_form_base') {
3071             debugging('Lesson page type unknown class requested '.$class, DEBUG_DEVELOPER);
3072             $class = 'lesson_add_page_form_selection';
3073         } else if ($class === 'lesson_add_page_form_unknown') {
3074             $class = 'lesson_add_page_form_selection';
3075         }
3076         return new $class(null, $arguments);
3077     }
3079     /**
3080      * Returns an array of links to use as add page links
3081      * @param int $previd The id of the previous page
3082      * @return array
3083      */
3084     public function get_add_page_type_links($previd) {
3085         global $OUTPUT;
3087         $links = array();
3089         foreach ($this->types as $key=>$type) {
3090             if ($link = $type->add_page_link($previd)) {
3091                 $links[$key] = $link;
3092             }
3093         }
3095         return $links;
3096     }