Merge branch 'MDL-55611-master' of git://github.com/danpoltawski/moodle
[moodle.git] / mod / lesson / lib.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  * Standard library of functions and constants for lesson
20  *
21  * @package mod_lesson
22  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  **/
26 defined('MOODLE_INTERNAL') || die();
28 /* Do not include any libraries here! */
30 /**
31  * Given an object containing all the necessary data,
32  * (defined by the form in mod_form.php) this function
33  * will create a new instance and return the id number
34  * of the new instance.
35  *
36  * @global object
37  * @global object
38  * @param object $lesson Lesson post data from the form
39  * @return int
40  **/
41 function lesson_add_instance($data, $mform) {
42     global $DB;
44     $cmid = $data->coursemodule;
45     $draftitemid = $data->mediafile;
46     $context = context_module::instance($cmid);
48     lesson_process_pre_save($data);
50     unset($data->mediafile);
51     $lessonid = $DB->insert_record("lesson", $data);
52     $data->id = $lessonid;
54     lesson_update_media_file($lessonid, $context, $draftitemid);
56     lesson_process_post_save($data);
58     lesson_grade_item_update($data);
60     return $lessonid;
61 }
63 /**
64  * Given an object containing all the necessary data,
65  * (defined by the form in mod_form.php) this function
66  * will update an existing instance with new data.
67  *
68  * @global object
69  * @param object $lesson Lesson post data from the form
70  * @return boolean
71  **/
72 function lesson_update_instance($data, $mform) {
73     global $DB;
75     $data->id = $data->instance;
76     $cmid = $data->coursemodule;
77     $draftitemid = $data->mediafile;
78     $context = context_module::instance($cmid);
80     lesson_process_pre_save($data);
82     unset($data->mediafile);
83     $DB->update_record("lesson", $data);
85     lesson_update_media_file($data->id, $context, $draftitemid);
87     lesson_process_post_save($data);
89     // update grade item definition
90     lesson_grade_item_update($data);
92     // update grades - TODO: do it only when grading style changes
93     lesson_update_grades($data, 0, false);
95     return true;
96 }
98 /**
99  * This function updates the events associated to the lesson.
100  * If $override is non-zero, then it updates only the events
101  * associated with the specified override.
102  *
103  * @uses LESSON_MAX_EVENT_LENGTH
104  * @param object $lesson the lesson object.
105  * @param object $override (optional) limit to a specific override
106  */
107 function lesson_update_events($lesson, $override = null) {
108     global $CFG, $DB;
110     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
111     require_once($CFG->dirroot . '/calendar/lib.php');
113     // Load the old events relating to this lesson.
114     $conds = array('modulename' => 'lesson',
115                    'instance' => $lesson->id);
116     if (!empty($override)) {
117         // Only load events for this override.
118         if (isset($override->userid)) {
119             $conds['userid'] = $override->userid;
120         } else {
121             $conds['groupid'] = $override->groupid;
122         }
123     }
124     $oldevents = $DB->get_records('event', $conds);
126     // Now make a to-do list of all that needs to be updated.
127     if (empty($override)) {
128         // We are updating the primary settings for the lesson, so we need to add all the overrides.
129         $overrides = $DB->get_records('lesson_overrides', array('lessonid' => $lesson->id));
130         // As well as the original lesson (empty override).
131         $overrides[] = new stdClass();
132     } else {
133         // Just do the one override.
134         $overrides = array($override);
135     }
137     // Get group override priorities.
138     $grouppriorities = lesson_get_group_override_priorities($lesson->id);
140     foreach ($overrides as $current) {
141         $groupid   = isset($current->groupid) ? $current->groupid : 0;
142         $userid    = isset($current->userid) ? $current->userid : 0;
143         $available  = isset($current->available) ? $current->available : $lesson->available;
144         $deadline = isset($current->deadline) ? $current->deadline : $lesson->deadline;
146         // Only add open/close events for an override if they differ from the lesson default.
147         $addopen  = empty($current->id) || !empty($current->available);
148         $addclose = empty($current->id) || !empty($current->deadline);
150         if (!empty($lesson->coursemodule)) {
151             $cmid = $lesson->coursemodule;
152         } else {
153             $cmid = get_coursemodule_from_instance('lesson', $lesson->id, $lesson->course)->id;
154         }
156         $event = new stdClass();
157         $event->type = !$deadline ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
158         $event->description = format_module_intro('lesson', $lesson, $cmid);
159         // Events module won't show user events when the courseid is nonzero.
160         $event->courseid    = ($userid) ? 0 : $lesson->course;
161         $event->groupid     = $groupid;
162         $event->userid      = $userid;
163         $event->modulename  = 'lesson';
164         $event->instance    = $lesson->id;
165         $event->timestart   = $available;
166         $event->timeduration = max($deadline - $available, 0);
167         $event->timesort    = $available;
168         $event->visible     = instance_is_visible('lesson', $lesson);
169         $event->eventtype   = LESSON_EVENT_TYPE_OPEN;
171         // Determine the event name and priority.
172         if ($groupid) {
173             // Group override event.
174             $params = new stdClass();
175             $params->lesson = $lesson->name;
176             $params->group = groups_get_group_name($groupid);
177             if ($params->group === false) {
178                 // Group doesn't exist, just skip it.
179                 continue;
180             }
181             $eventname = get_string('overridegroupeventname', 'lesson', $params);
182             // Set group override priority.
183             if ($grouppriorities !== null) {
184                 $openpriorities = $grouppriorities['open'];
185                 if (isset($openpriorities[$available])) {
186                     $event->priority = $openpriorities[$available];
187                 }
188             }
189         } else if ($userid) {
190             // User override event.
191             $params = new stdClass();
192             $params->lesson = $lesson->name;
193             $eventname = get_string('overrideusereventname', 'lesson', $params);
194             // Set user override priority.
195             $event->priority = CALENDAR_EVENT_USER_OVERRIDE_PRIORITY;
196         } else {
197             // The parent event.
198             $eventname = $lesson->name;
199         }
201         if ($addopen or $addclose) {
202             // Separate start and end events.
203             $event->timeduration  = 0;
204             if ($available && $addopen) {
205                 if ($oldevent = array_shift($oldevents)) {
206                     $event->id = $oldevent->id;
207                 } else {
208                     unset($event->id);
209                 }
210                 $event->name = $eventname.' ('.get_string('lessonopens', 'lesson').')';
211                 // The method calendar_event::create will reuse a db record if the id field is set.
212                 calendar_event::create($event);
213             }
214             if ($deadline && $addclose) {
215                 if ($oldevent = array_shift($oldevents)) {
216                     $event->id = $oldevent->id;
217                 } else {
218                     unset($event->id);
219                 }
220                 $event->type      = CALENDAR_EVENT_TYPE_ACTION;
221                 $event->name      = $eventname.' ('.get_string('lessoncloses', 'lesson').')';
222                 $event->timestart = $deadline;
223                 $event->timesort  = $deadline;
224                 $event->eventtype = LESSON_EVENT_TYPE_CLOSE;
225                 if ($groupid && $grouppriorities !== null) {
226                     $closepriorities = $grouppriorities['close'];
227                     if (isset($closepriorities[$deadline])) {
228                         $event->priority = $closepriorities[$deadline];
229                     }
230                 }
231                 calendar_event::create($event);
232             }
233         }
234     }
236     // Delete any leftover events.
237     foreach ($oldevents as $badevent) {
238         $badevent = calendar_event::load($badevent);
239         $badevent->delete();
240     }
243 /**
244  * Calculates the priorities of timeopen and timeclose values for group overrides for a lesson.
245  *
246  * @param int $lessonid The quiz ID.
247  * @return array|null Array of group override priorities for open and close times. Null if there are no group overrides.
248  */
249 function lesson_get_group_override_priorities($lessonid) {
250     global $DB;
252     // Fetch group overrides.
253     $where = 'lessonid = :lessonid AND groupid IS NOT NULL';
254     $params = ['lessonid' => $lessonid];
255     $overrides = $DB->get_records_select('lesson_overrides', $where, $params, '', 'id, groupid, available, deadline');
256     if (!$overrides) {
257         return null;
258     }
260     $grouptimeopen = [];
261     $grouptimeclose = [];
262     foreach ($overrides as $override) {
263         if ($override->available !== null && !in_array($override->available, $grouptimeopen)) {
264             $grouptimeopen[] = $override->available;
265         }
266         if ($override->deadline !== null && !in_array($override->deadline, $grouptimeclose)) {
267             $grouptimeclose[] = $override->deadline;
268         }
269     }
271     // Sort open times in descending manner. The earlier open time gets higher priority.
272     rsort($grouptimeopen);
273     // Set priorities.
274     $opengrouppriorities = [];
275     $openpriority = 1;
276     foreach ($grouptimeopen as $timeopen) {
277         $opengrouppriorities[$timeopen] = $openpriority++;
278     }
280     // Sort close times in ascending manner. The later close time gets higher priority.
281     sort($grouptimeclose);
282     // Set priorities.
283     $closegrouppriorities = [];
284     $closepriority = 1;
285     foreach ($grouptimeclose as $timeclose) {
286         $closegrouppriorities[$timeclose] = $closepriority++;
287     }
289     return [
290         'open' => $opengrouppriorities,
291         'close' => $closegrouppriorities
292     ];
295 /**
296  * This standard function will check all instances of this module
297  * and make sure there are up-to-date events created for each of them.
298  * If courseid = 0, then every lesson event in the site is checked, else
299  * only lesson events belonging to the course specified are checked.
300  * This function is used, in its new format, by restore_refresh_events()
301  *
302  * @param int $courseid
303  * @return bool
304  */
305 function lesson_refresh_events($courseid = 0) {
306     global $DB;
308     if ($courseid == 0) {
309         if (!$lessons = $DB->get_records('lesson')) {
310             return true;
311         }
312     } else {
313         if (!$lessons = $DB->get_records('lesson', array('course' => $courseid))) {
314             return true;
315         }
316     }
318     foreach ($lessons as $lesson) {
319         lesson_update_events($lesson);
320     }
322     return true;
325 /**
326  * Given an ID of an instance of this module,
327  * this function will permanently delete the instance
328  * and any data that depends on it.
329  *
330  * @global object
331  * @param int $id
332  * @return bool
333  */
334 function lesson_delete_instance($id) {
335     global $DB, $CFG;
336     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
338     $lesson = $DB->get_record("lesson", array("id"=>$id), '*', MUST_EXIST);
339     $lesson = new lesson($lesson);
340     return $lesson->delete();
343 /**
344  * Return a small object with summary information about what a
345  * user has done with a given particular instance of this module
346  * Used for user activity reports.
347  * $return->time = the time they did it
348  * $return->info = a short text description
349  *
350  * @global object
351  * @param object $course
352  * @param object $user
353  * @param object $mod
354  * @param object $lesson
355  * @return object
356  */
357 function lesson_user_outline($course, $user, $mod, $lesson) {
358     global $CFG, $DB;
360     require_once("$CFG->libdir/gradelib.php");
361     $grades = grade_get_grades($course->id, 'mod', 'lesson', $lesson->id, $user->id);
362     $return = new stdClass();
364     if (empty($grades->items[0]->grades)) {
365         $return->info = get_string("nolessonattempts", "lesson");
366     } else {
367         $grade = reset($grades->items[0]->grades);
368         if (empty($grade->grade)) {
370             // Check to see if it an ungraded / incomplete attempt.
371             $sql = "SELECT *
372                       FROM {lesson_timer}
373                      WHERE lessonid = :lessonid
374                        AND userid = :userid
375                   ORDER BY starttime DESC";
376             $params = array('lessonid' => $lesson->id, 'userid' => $user->id);
378             if ($attempts = $DB->get_records_sql($sql, $params, 0, 1)) {
379                 $attempt = reset($attempts);
380                 if ($attempt->completed) {
381                     $return->info = get_string("completed", "lesson");
382                 } else {
383                     $return->info = get_string("notyetcompleted", "lesson");
384                 }
385                 $return->time = $attempt->lessontime;
386             } else {
387                 $return->info = get_string("nolessonattempts", "lesson");
388             }
389         } else {
390             $return->info = get_string("grade") . ': ' . $grade->str_long_grade;
392             // Datesubmitted == time created. dategraded == time modified or time overridden.
393             // If grade was last modified by the user themselves use date graded. Otherwise use date submitted.
394             // TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704.
395             if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
396                 $return->time = $grade->dategraded;
397             } else {
398                 $return->time = $grade->datesubmitted;
399             }
400         }
401     }
402     return $return;
405 /**
406  * Print a detailed representation of what a  user has done with
407  * a given particular instance of this module, for user activity reports.
408  *
409  * @global object
410  * @param object $course
411  * @param object $user
412  * @param object $mod
413  * @param object $lesson
414  * @return bool
415  */
416 function lesson_user_complete($course, $user, $mod, $lesson) {
417     global $DB, $OUTPUT, $CFG;
419     require_once("$CFG->libdir/gradelib.php");
421     $grades = grade_get_grades($course->id, 'mod', 'lesson', $lesson->id, $user->id);
423     // Display the grade and feedback.
424     if (empty($grades->items[0]->grades)) {
425         echo $OUTPUT->container(get_string("nolessonattempts", "lesson"));
426     } else {
427         $grade = reset($grades->items[0]->grades);
428         if (empty($grade->grade)) {
429             // Check to see if it an ungraded / incomplete attempt.
430             $sql = "SELECT *
431                       FROM {lesson_timer}
432                      WHERE lessonid = :lessonid
433                        AND userid = :userid
434                      ORDER by starttime desc";
435             $params = array('lessonid' => $lesson->id, 'userid' => $user->id);
437             if ($attempt = $DB->get_record_sql($sql, $params, IGNORE_MULTIPLE)) {
438                 if ($attempt->completed) {
439                     $status = get_string("completed", "lesson");
440                 } else {
441                     $status = get_string("notyetcompleted", "lesson");
442                 }
443             } else {
444                 $status = get_string("nolessonattempts", "lesson");
445             }
446         } else {
447             $status = get_string("grade") . ': ' . $grade->str_long_grade;
448         }
450         // Display the grade or lesson status if there isn't one.
451         echo $OUTPUT->container($status);
453         if ($grade->str_feedback) {
454             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
455         }
456     }
458     // Display the lesson progress.
459     // Attempt, pages viewed, questions answered, correct answers, time.
460     $params = array ("lessonid" => $lesson->id, "userid" => $user->id);
461     $attempts = $DB->get_records_select("lesson_attempts", "lessonid = :lessonid AND userid = :userid", $params, "retry, timeseen");
462     $branches = $DB->get_records_select("lesson_branch", "lessonid = :lessonid AND userid = :userid", $params, "retry, timeseen");
463     if (!empty($attempts) or !empty($branches)) {
464         echo $OUTPUT->box_start();
465         $table = new html_table();
466         // Table Headings.
467         $table->head = array (get_string("attemptheader", "lesson"),
468             get_string("totalpagesviewedheader", "lesson"),
469             get_string("numberofpagesviewedheader", "lesson"),
470             get_string("numberofcorrectanswersheader", "lesson"),
471             get_string("time"));
472         $table->width = "100%";
473         $table->align = array ("center", "center", "center", "center", "center");
474         $table->size = array ("*", "*", "*", "*", "*");
475         $table->cellpadding = 2;
476         $table->cellspacing = 0;
478         $retry = 0;
479         $nquestions = 0;
480         $npages = 0;
481         $ncorrect = 0;
483         // Filter question pages (from lesson_attempts).
484         foreach ($attempts as $attempt) {
485             if ($attempt->retry == $retry) {
486                 $npages++;
487                 $nquestions++;
488                 if ($attempt->correct) {
489                     $ncorrect++;
490                 }
491                 $timeseen = $attempt->timeseen;
492             } else {
493                 $table->data[] = array($retry + 1, $npages, $nquestions, $ncorrect, userdate($timeseen));
494                 $retry++;
495                 $nquestions = 1;
496                 $npages = 1;
497                 if ($attempt->correct) {
498                     $ncorrect = 1;
499                 } else {
500                     $ncorrect = 0;
501                 }
502             }
503         }
505         // Filter content pages (from lesson_branch).
506         foreach ($branches as $branch) {
507             if ($branch->retry == $retry) {
508                 $npages++;
510                 $timeseen = $branch->timeseen;
511             } else {
512                 $table->data[] = array($retry + 1, $npages, $nquestions, $ncorrect, userdate($timeseen));
513                 $retry++;
514                 $npages = 1;
515             }
516         }
517         if ($npages > 0) {
518                 $table->data[] = array($retry + 1, $npages, $nquestions, $ncorrect, userdate($timeseen));
519         }
520         echo html_writer::table($table);
521         echo $OUTPUT->box_end();
522     }
524     return true;
527 /**
528  * Prints lesson summaries on MyMoodle Page
529  *
530  * Prints lesson name, due date and attempt information on
531  * lessons that have a deadline that has not already passed
532  * and it is available for taking.
533  *
534  * @deprecated since 3.3
535  *
536  * @global object
537  * @global stdClass
538  * @global object
539  * @uses CONTEXT_MODULE
540  * @param array $courses An array of course objects to get lesson instances from
541  * @param array $htmlarray Store overview output array( course ID => 'lesson' => HTML output )
542  * @return void
543  */
544 function lesson_print_overview($courses, &$htmlarray) {
545     global $USER, $CFG, $DB, $OUTPUT;
547     debugging('The function lesson_print_overview() is now deprecated.', DEBUG_DEVELOPER);
549     if (!$lessons = get_all_instances_in_courses('lesson', $courses)) {
550         return;
551     }
553     // Get all of the current users attempts on all lessons.
554     $params = array($USER->id);
555     $sql = 'SELECT lessonid, userid, count(userid) as attempts
556               FROM {lesson_grades}
557              WHERE userid = ?
558           GROUP BY lessonid, userid';
559     $allattempts = $DB->get_records_sql($sql, $params);
560     $completedattempts = array();
561     foreach ($allattempts as $myattempt) {
562         $completedattempts[$myattempt->lessonid] = $myattempt->attempts;
563     }
565     // Get the current course ID.
566     $listoflessons = array();
567     foreach ($lessons as $lesson) {
568         $listoflessons[] = $lesson->id;
569     }
570     // Get the last page viewed by the current user for every lesson in this course.
571     list($insql, $inparams) = $DB->get_in_or_equal($listoflessons, SQL_PARAMS_NAMED);
572     $dbparams = array_merge($inparams, array('userid' => $USER->id));
574     // Get the lesson attempts for the user that have the maximum 'timeseen' value.
575     $select = "SELECT l.id, l.timeseen, l.lessonid, l.userid, l.retry, l.pageid, l.answerid as nextpageid, p.qtype ";
576     $from = "FROM {lesson_attempts} l
577              JOIN (
578                    SELECT idselect.lessonid, idselect.userid, MAX(idselect.id) AS id
579                      FROM {lesson_attempts} idselect
580                      JOIN (
581                            SELECT lessonid, userid, MAX(timeseen) AS timeseen
582                              FROM {lesson_attempts}
583                             WHERE userid = :userid
584                               AND lessonid $insql
585                          GROUP BY userid, lessonid
586                            ) timeselect
587                        ON timeselect.timeseen = idselect.timeseen
588                       AND timeselect.userid = idselect.userid
589                       AND timeselect.lessonid = idselect.lessonid
590                  GROUP BY idselect.userid, idselect.lessonid
591                    ) aid
592                ON l.id = aid.id
593              JOIN {lesson_pages} p
594                ON l.pageid = p.id ";
595     $lastattempts = $DB->get_records_sql($select . $from, $dbparams);
597     // Now, get the lesson branches for the user that have the maximum 'timeseen' value.
598     $select = "SELECT l.id, l.timeseen, l.lessonid, l.userid, l.retry, l.pageid, l.nextpageid, p.qtype ";
599     $from = str_replace('{lesson_attempts}', '{lesson_branch}', $from);
600     $lastbranches = $DB->get_records_sql($select . $from, $dbparams);
602     $lastviewed = array();
603     foreach ($lastattempts as $lastattempt) {
604         $lastviewed[$lastattempt->lessonid] = $lastattempt;
605     }
607     // Go through the branch times and record the 'timeseen' value if it doesn't exist
608     // for the lesson, or replace it if it exceeds the current recorded time.
609     foreach ($lastbranches as $lastbranch) {
610         if (!isset($lastviewed[$lastbranch->lessonid])) {
611             $lastviewed[$lastbranch->lessonid] = $lastbranch;
612         } else if ($lastviewed[$lastbranch->lessonid]->timeseen < $lastbranch->timeseen) {
613             $lastviewed[$lastbranch->lessonid] = $lastbranch;
614         }
615     }
617     // Since we have lessons in this course, now include the constants we need.
618     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
620     $now = time();
621     foreach ($lessons as $lesson) {
622         if ($lesson->deadline != 0                                         // The lesson has a deadline
623             and $lesson->deadline >= $now                                  // And it is before the deadline has been met
624             and ($lesson->available == 0 or $lesson->available <= $now)) { // And the lesson is available
626             // Visibility.
627             $class = (!$lesson->visible) ? 'dimmed' : '';
629             // Context.
630             $context = context_module::instance($lesson->coursemodule);
632             // Link to activity.
633             $url = new moodle_url('/mod/lesson/view.php', array('id' => $lesson->coursemodule));
634             $url = html_writer::link($url, format_string($lesson->name, true, array('context' => $context)), array('class' => $class));
635             $str = $OUTPUT->box(get_string('lessonname', 'lesson', $url), 'name');
637             // Deadline.
638             $str .= $OUTPUT->box(get_string('lessoncloseson', 'lesson', userdate($lesson->deadline)), 'info');
640             // Attempt information.
641             if (has_capability('mod/lesson:manage', $context)) {
642                 // This is a teacher, Get the Number of user attempts.
643                 $attempts = $DB->count_records('lesson_grades', array('lessonid' => $lesson->id));
644                 $str     .= $OUTPUT->box(get_string('xattempts', 'lesson', $attempts), 'info');
645                 $str      = $OUTPUT->box($str, 'lesson overview');
646             } else {
647                 // This is a student, See if the user has at least started the lesson.
648                 if (isset($lastviewed[$lesson->id]->timeseen)) {
649                     // See if the user has finished this attempt.
650                     if (isset($completedattempts[$lesson->id]) &&
651                              ($completedattempts[$lesson->id] == ($lastviewed[$lesson->id]->retry + 1))) {
652                         // Are additional attempts allowed?
653                         if ($lesson->retake) {
654                             // User can retake the lesson.
655                             $str .= $OUTPUT->box(get_string('additionalattemptsremaining', 'lesson'), 'info');
656                             $str = $OUTPUT->box($str, 'lesson overview');
657                         } else {
658                             // User has completed the lesson and no retakes are allowed.
659                             $str = '';
660                         }
662                     } else {
663                         // The last attempt was not finished or the lesson does not contain questions.
664                         // See if the last page viewed was a branchtable.
665                         require_once($CFG->dirroot . '/mod/lesson/pagetypes/branchtable.php');
666                         if ($lastviewed[$lesson->id]->qtype == LESSON_PAGE_BRANCHTABLE) {
667                             // See if the next pageid is the end of lesson.
668                             if ($lastviewed[$lesson->id]->nextpageid == LESSON_EOL) {
669                                 // The last page viewed was the End of Lesson.
670                                 if ($lesson->retake) {
671                                     // User can retake the lesson.
672                                     $str .= $OUTPUT->box(get_string('additionalattemptsremaining', 'lesson'), 'info');
673                                     $str = $OUTPUT->box($str, 'lesson overview');
674                                 } else {
675                                     // User has completed the lesson and no retakes are allowed.
676                                     $str = '';
677                                 }
679                             } else {
680                                 // The last page viewed was NOT the end of lesson.
681                                 $str .= $OUTPUT->box(get_string('notyetcompleted', 'lesson'), 'info');
682                                 $str = $OUTPUT->box($str, 'lesson overview');
683                             }
685                         } else {
686                             // Last page was a question page, so the attempt is not completed yet.
687                             $str .= $OUTPUT->box(get_string('notyetcompleted', 'lesson'), 'info');
688                             $str = $OUTPUT->box($str, 'lesson overview');
689                         }
690                     }
692                 } else {
693                     // User has not yet started this lesson.
694                     $str .= $OUTPUT->box(get_string('nolessonattempts', 'lesson'), 'info');
695                     $str = $OUTPUT->box($str, 'lesson overview');
696                 }
697             }
698             if (!empty($str)) {
699                 if (empty($htmlarray[$lesson->course]['lesson'])) {
700                     $htmlarray[$lesson->course]['lesson'] = $str;
701                 } else {
702                     $htmlarray[$lesson->course]['lesson'] .= $str;
703                 }
704             }
705         }
706     }
709 /**
710  * Function to be run periodically according to the moodle cron
711  * This function searches for things that need to be done, such
712  * as sending out mail, toggling flags etc ...
713  * @global stdClass
714  * @return bool true
715  */
716 function lesson_cron () {
717     global $CFG;
719     return true;
722 /**
723  * Return grade for given user or all users.
724  *
725  * @global stdClass
726  * @global object
727  * @param int $lessonid id of lesson
728  * @param int $userid optional user id, 0 means all users
729  * @return array array of grades, false if none
730  */
731 function lesson_get_user_grades($lesson, $userid=0) {
732     global $CFG, $DB;
734     $params = array("lessonid" => $lesson->id,"lessonid2" => $lesson->id);
736     if (!empty($userid)) {
737         $params["userid"] = $userid;
738         $params["userid2"] = $userid;
739         $user = "AND u.id = :userid";
740         $fuser = "AND uu.id = :userid2";
741     }
742     else {
743         $user="";
744         $fuser="";
745     }
747     if ($lesson->retake) {
748         if ($lesson->usemaxgrade) {
749             $sql = "SELECT u.id, u.id AS userid, MAX(g.grade) AS rawgrade
750                       FROM {user} u, {lesson_grades} g
751                      WHERE u.id = g.userid AND g.lessonid = :lessonid
752                            $user
753                   GROUP BY u.id";
754         } else {
755             $sql = "SELECT u.id, u.id AS userid, AVG(g.grade) AS rawgrade
756                       FROM {user} u, {lesson_grades} g
757                      WHERE u.id = g.userid AND g.lessonid = :lessonid
758                            $user
759                   GROUP BY u.id";
760         }
761         unset($params['lessonid2']);
762         unset($params['userid2']);
763     } else {
764         // use only first attempts (with lowest id in lesson_grades table)
765         $firstonly = "SELECT uu.id AS userid, MIN(gg.id) AS firstcompleted
766                         FROM {user} uu, {lesson_grades} gg
767                        WHERE uu.id = gg.userid AND gg.lessonid = :lessonid2
768                              $fuser
769                        GROUP BY uu.id";
771         $sql = "SELECT u.id, u.id AS userid, g.grade AS rawgrade
772                   FROM {user} u, {lesson_grades} g, ($firstonly) f
773                  WHERE u.id = g.userid AND g.lessonid = :lessonid
774                        AND g.id = f.firstcompleted AND g.userid=f.userid
775                        $user";
776     }
778     return $DB->get_records_sql($sql, $params);
781 /**
782  * Update grades in central gradebook
783  *
784  * @category grade
785  * @param object $lesson
786  * @param int $userid specific user only, 0 means all
787  * @param bool $nullifnone
788  */
789 function lesson_update_grades($lesson, $userid=0, $nullifnone=true) {
790     global $CFG, $DB;
791     require_once($CFG->libdir.'/gradelib.php');
793     if ($lesson->grade == 0 || $lesson->practice) {
794         lesson_grade_item_update($lesson);
796     } else if ($grades = lesson_get_user_grades($lesson, $userid)) {
797         lesson_grade_item_update($lesson, $grades);
799     } else if ($userid and $nullifnone) {
800         $grade = new stdClass();
801         $grade->userid   = $userid;
802         $grade->rawgrade = null;
803         lesson_grade_item_update($lesson, $grade);
805     } else {
806         lesson_grade_item_update($lesson);
807     }
810 /**
811  * Create grade item for given lesson
812  *
813  * @category grade
814  * @uses GRADE_TYPE_VALUE
815  * @uses GRADE_TYPE_NONE
816  * @param object $lesson object with extra cmidnumber
817  * @param array|object $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
818  * @return int 0 if ok, error code otherwise
819  */
820 function lesson_grade_item_update($lesson, $grades=null) {
821     global $CFG;
822     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
823         require_once($CFG->libdir.'/gradelib.php');
824     }
826     if (array_key_exists('cmidnumber', $lesson)) { //it may not be always present
827         $params = array('itemname'=>$lesson->name, 'idnumber'=>$lesson->cmidnumber);
828     } else {
829         $params = array('itemname'=>$lesson->name);
830     }
832     if (!$lesson->practice and $lesson->grade > 0) {
833         $params['gradetype']  = GRADE_TYPE_VALUE;
834         $params['grademax']   = $lesson->grade;
835         $params['grademin']   = 0;
836     } else if (!$lesson->practice and $lesson->grade < 0) {
837         $params['gradetype']  = GRADE_TYPE_SCALE;
838         $params['scaleid']   = -$lesson->grade;
840         // Make sure current grade fetched correctly from $grades
841         $currentgrade = null;
842         if (!empty($grades)) {
843             if (is_array($grades)) {
844                 $currentgrade = reset($grades);
845             } else {
846                 $currentgrade = $grades;
847             }
848         }
850         // When converting a score to a scale, use scale's grade maximum to calculate it.
851         if (!empty($currentgrade) && $currentgrade->rawgrade !== null) {
852             $grade = grade_get_grades($lesson->course, 'mod', 'lesson', $lesson->id, $currentgrade->userid);
853             $params['grademax']   = reset($grade->items)->grademax;
854         }
855     } else {
856         $params['gradetype']  = GRADE_TYPE_NONE;
857     }
859     if ($grades  === 'reset') {
860         $params['reset'] = true;
861         $grades = null;
862     } else if (!empty($grades)) {
863         // Need to calculate raw grade (Note: $grades has many forms)
864         if (is_object($grades)) {
865             $grades = array($grades->userid => $grades);
866         } else if (array_key_exists('userid', $grades)) {
867             $grades = array($grades['userid'] => $grades);
868         }
869         foreach ($grades as $key => $grade) {
870             if (!is_array($grade)) {
871                 $grades[$key] = $grade = (array) $grade;
872             }
873             //check raw grade isnt null otherwise we erroneously insert a grade of 0
874             if ($grade['rawgrade'] !== null) {
875                 $grades[$key]['rawgrade'] = ($grade['rawgrade'] * $params['grademax'] / 100);
876             } else {
877                 //setting rawgrade to null just in case user is deleting a grade
878                 $grades[$key]['rawgrade'] = null;
879             }
880         }
881     }
883     return grade_update('mod/lesson', $lesson->course, 'mod', 'lesson', $lesson->id, 0, $grades, $params);
886 /**
887  * List the actions that correspond to a view of this module.
888  * This is used by the participation report.
889  *
890  * Note: This is not used by new logging system. Event with
891  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
892  *       be considered as view action.
893  *
894  * @return array
895  */
896 function lesson_get_view_actions() {
897     return array('view','view all');
900 /**
901  * List the actions that correspond to a post of this module.
902  * This is used by the participation report.
903  *
904  * Note: This is not used by new logging system. Event with
905  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
906  *       will be considered as post action.
907  *
908  * @return array
909  */
910 function lesson_get_post_actions() {
911     return array('end','start');
914 /**
915  * Runs any processes that must run before
916  * a lesson insert/update
917  *
918  * @global object
919  * @param object $lesson Lesson form data
920  * @return void
921  **/
922 function lesson_process_pre_save(&$lesson) {
923     global $DB;
925     $lesson->timemodified = time();
927     if (empty($lesson->timelimit)) {
928         $lesson->timelimit = 0;
929     }
930     if (empty($lesson->timespent) or !is_numeric($lesson->timespent) or $lesson->timespent < 0) {
931         $lesson->timespent = 0;
932     }
933     if (!isset($lesson->completed)) {
934         $lesson->completed = 0;
935     }
936     if (empty($lesson->gradebetterthan) or !is_numeric($lesson->gradebetterthan) or $lesson->gradebetterthan < 0) {
937         $lesson->gradebetterthan = 0;
938     } else if ($lesson->gradebetterthan > 100) {
939         $lesson->gradebetterthan = 100;
940     }
942     if (empty($lesson->width)) {
943         $lesson->width = 640;
944     }
945     if (empty($lesson->height)) {
946         $lesson->height = 480;
947     }
948     if (empty($lesson->bgcolor)) {
949         $lesson->bgcolor = '#FFFFFF';
950     }
952     // Conditions for dependency
953     $conditions = new stdClass;
954     $conditions->timespent = $lesson->timespent;
955     $conditions->completed = $lesson->completed;
956     $conditions->gradebetterthan = $lesson->gradebetterthan;
957     $lesson->conditions = serialize($conditions);
958     unset($lesson->timespent);
959     unset($lesson->completed);
960     unset($lesson->gradebetterthan);
962     if (empty($lesson->password)) {
963         unset($lesson->password);
964     }
967 /**
968  * Runs any processes that must be run
969  * after a lesson insert/update
970  *
971  * @global object
972  * @param object $lesson Lesson form data
973  * @return void
974  **/
975 function lesson_process_post_save(&$lesson) {
976     // Update the events relating to this lesson.
977     lesson_update_events($lesson);
981 /**
982  * Implementation of the function for printing the form elements that control
983  * whether the course reset functionality affects the lesson.
984  *
985  * @param $mform form passed by reference
986  */
987 function lesson_reset_course_form_definition(&$mform) {
988     $mform->addElement('header', 'lessonheader', get_string('modulenameplural', 'lesson'));
989     $mform->addElement('advcheckbox', 'reset_lesson', get_string('deleteallattempts','lesson'));
990     $mform->addElement('advcheckbox', 'reset_lesson_user_overrides',
991             get_string('removealluseroverrides', 'lesson'));
992     $mform->addElement('advcheckbox', 'reset_lesson_group_overrides',
993             get_string('removeallgroupoverrides', 'lesson'));
996 /**
997  * Course reset form defaults.
998  * @param object $course
999  * @return array
1000  */
1001 function lesson_reset_course_form_defaults($course) {
1002     return array('reset_lesson' => 1,
1003             'reset_lesson_group_overrides' => 1,
1004             'reset_lesson_user_overrides' => 1);
1007 /**
1008  * Removes all grades from gradebook
1009  *
1010  * @global stdClass
1011  * @global object
1012  * @param int $courseid
1013  * @param string optional type
1014  */
1015 function lesson_reset_gradebook($courseid, $type='') {
1016     global $CFG, $DB;
1018     $sql = "SELECT l.*, cm.idnumber as cmidnumber, l.course as courseid
1019               FROM {lesson} l, {course_modules} cm, {modules} m
1020              WHERE m.name='lesson' AND m.id=cm.module AND cm.instance=l.id AND l.course=:course";
1021     $params = array ("course" => $courseid);
1022     if ($lessons = $DB->get_records_sql($sql,$params)) {
1023         foreach ($lessons as $lesson) {
1024             lesson_grade_item_update($lesson, 'reset');
1025         }
1026     }
1029 /**
1030  * Actual implementation of the reset course functionality, delete all the
1031  * lesson attempts for course $data->courseid.
1032  *
1033  * @global stdClass
1034  * @global object
1035  * @param object $data the data submitted from the reset course.
1036  * @return array status array
1037  */
1038 function lesson_reset_userdata($data) {
1039     global $CFG, $DB;
1041     $componentstr = get_string('modulenameplural', 'lesson');
1042     $status = array();
1044     if (!empty($data->reset_lesson)) {
1045         $lessonssql = "SELECT l.id
1046                          FROM {lesson} l
1047                         WHERE l.course=:course";
1049         $params = array ("course" => $data->courseid);
1050         $lessons = $DB->get_records_sql($lessonssql, $params);
1052         // Get rid of attempts files.
1053         $fs = get_file_storage();
1054         if ($lessons) {
1055             foreach ($lessons as $lessonid => $unused) {
1056                 if (!$cm = get_coursemodule_from_instance('lesson', $lessonid)) {
1057                     continue;
1058                 }
1059                 $context = context_module::instance($cm->id);
1060                 $fs->delete_area_files($context->id, 'mod_lesson', 'essay_responses');
1061             }
1062         }
1064         $DB->delete_records_select('lesson_timer', "lessonid IN ($lessonssql)", $params);
1065         $DB->delete_records_select('lesson_grades', "lessonid IN ($lessonssql)", $params);
1066         $DB->delete_records_select('lesson_attempts', "lessonid IN ($lessonssql)", $params);
1067         $DB->delete_records_select('lesson_branch', "lessonid IN ($lessonssql)", $params);
1069         // remove all grades from gradebook
1070         if (empty($data->reset_gradebook_grades)) {
1071             lesson_reset_gradebook($data->courseid);
1072         }
1074         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'lesson'), 'error'=>false);
1075     }
1077     // Remove user overrides.
1078     if (!empty($data->reset_lesson_user_overrides)) {
1079         $DB->delete_records_select('lesson_overrides',
1080                 'lessonid IN (SELECT id FROM {lesson} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1081         $status[] = array(
1082         'component' => $componentstr,
1083         'item' => get_string('useroverridesdeleted', 'lesson'),
1084         'error' => false);
1085     }
1086     // Remove group overrides.
1087     if (!empty($data->reset_lesson_group_overrides)) {
1088         $DB->delete_records_select('lesson_overrides',
1089         'lessonid IN (SELECT id FROM {lesson} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1090         $status[] = array(
1091         'component' => $componentstr,
1092         'item' => get_string('groupoverridesdeleted', 'lesson'),
1093         'error' => false);
1094     }
1095     /// updating dates - shift may be negative too
1096     if ($data->timeshift) {
1097         $DB->execute("UPDATE {lesson_overrides}
1098                          SET available = available + ?
1099                        WHERE lessonid IN (SELECT id FROM {lesson} WHERE course = ?)
1100                          AND available <> 0", array($data->timeshift, $data->courseid));
1101         $DB->execute("UPDATE {lesson_overrides}
1102                          SET deadline = deadline + ?
1103                        WHERE lessonid IN (SELECT id FROM {lesson} WHERE course = ?)
1104                          AND deadline <> 0", array($data->timeshift, $data->courseid));
1106         shift_course_mod_dates('lesson', array('available', 'deadline'), $data->timeshift, $data->courseid);
1107         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
1108     }
1110     return $status;
1113 /**
1114  * Returns all other caps used in module
1115  * @return array
1116  */
1117 function lesson_get_extra_capabilities() {
1118     return array('moodle/site:accessallgroups');
1121 /**
1122  * @uses FEATURE_GROUPS
1123  * @uses FEATURE_GROUPINGS
1124  * @uses FEATURE_MOD_INTRO
1125  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
1126  * @uses FEATURE_GRADE_HAS_GRADE
1127  * @uses FEATURE_GRADE_OUTCOMES
1128  * @param string $feature FEATURE_xx constant for requested feature
1129  * @return mixed True if module supports feature, false if not, null if doesn't know
1130  */
1131 function lesson_supports($feature) {
1132     switch($feature) {
1133         case FEATURE_GROUPS:
1134             return true;
1135         case FEATURE_GROUPINGS:
1136             return true;
1137         case FEATURE_MOD_INTRO:
1138             return true;
1139         case FEATURE_COMPLETION_TRACKS_VIEWS:
1140             return true;
1141         case FEATURE_GRADE_HAS_GRADE:
1142             return true;
1143         case FEATURE_COMPLETION_HAS_RULES:
1144             return true;
1145         case FEATURE_GRADE_OUTCOMES:
1146             return true;
1147         case FEATURE_BACKUP_MOODLE2:
1148             return true;
1149         case FEATURE_SHOW_DESCRIPTION:
1150             return true;
1151         default:
1152             return null;
1153     }
1156 /**
1157  * Obtains the automatic completion state for this lesson based on any conditions
1158  * in lesson settings.
1159  *
1160  * @param object $course Course
1161  * @param object $cm course-module
1162  * @param int $userid User ID
1163  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1164  * @return bool True if completed, false if not, $type if conditions not set.
1165  */
1166 function lesson_get_completion_state($course, $cm, $userid, $type) {
1167     global $CFG, $DB;
1169     // Get lesson details.
1170     $lesson = $DB->get_record('lesson', array('id' => $cm->instance), '*',
1171             MUST_EXIST);
1173     $result = $type; // Default return value.
1174     // If completion option is enabled, evaluate it and return true/false.
1175     if ($lesson->completionendreached) {
1176         $value = $DB->record_exists('lesson_timer', array(
1177                 'lessonid' => $lesson->id, 'userid' => $userid, 'completed' => 1));
1178         if ($type == COMPLETION_AND) {
1179             $result = $result && $value;
1180         } else {
1181             $result = $result || $value;
1182         }
1183     }
1184     if ($lesson->completiontimespent != 0) {
1185         $duration = $DB->get_field_sql(
1186                         "SELECT SUM(lessontime - starttime)
1187                                FROM {lesson_timer}
1188                               WHERE lessonid = :lessonid
1189                                 AND userid = :userid",
1190                         array('userid' => $userid, 'lessonid' => $lesson->id));
1191         if (!$duration) {
1192             $duration = 0;
1193         }
1194         if ($type == COMPLETION_AND) {
1195             $result = $result && ($lesson->completiontimespent < $duration);
1196         } else {
1197             $result = $result || ($lesson->completiontimespent < $duration);
1198         }
1199     }
1200     return $result;
1202 /**
1203  * This function extends the settings navigation block for the site.
1204  *
1205  * It is safe to rely on PAGE here as we will only ever be within the module
1206  * context when this is called
1207  *
1208  * @param settings_navigation $settings
1209  * @param navigation_node $lessonnode
1210  */
1211 function lesson_extend_settings_navigation($settings, $lessonnode) {
1212     global $PAGE, $DB;
1214     // We want to add these new nodes after the Edit settings node, and before the
1215     // Locally assigned roles node. Of course, both of those are controlled by capabilities.
1216     $keys = $lessonnode->get_children_key_list();
1217     $beforekey = null;
1218     $i = array_search('modedit', $keys);
1219     if ($i === false and array_key_exists(0, $keys)) {
1220         $beforekey = $keys[0];
1221     } else if (array_key_exists($i + 1, $keys)) {
1222         $beforekey = $keys[$i + 1];
1223     }
1225     if (has_capability('mod/lesson:manageoverrides', $PAGE->cm->context)) {
1226         $url = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $PAGE->cm->id));
1227         $node = navigation_node::create(get_string('groupoverrides', 'lesson'),
1228                 new moodle_url($url, array('mode' => 'group')),
1229                 navigation_node::TYPE_SETTING, null, 'mod_lesson_groupoverrides');
1230         $lessonnode->add_node($node, $beforekey);
1232         $node = navigation_node::create(get_string('useroverrides', 'lesson'),
1233                 new moodle_url($url, array('mode' => 'user')),
1234                 navigation_node::TYPE_SETTING, null, 'mod_lesson_useroverrides');
1235         $lessonnode->add_node($node, $beforekey);
1236     }
1238     if (has_capability('mod/lesson:edit', $PAGE->cm->context)) {
1239         $url = new moodle_url('/mod/lesson/view.php', array('id' => $PAGE->cm->id));
1240         $lessonnode->add(get_string('preview', 'lesson'), $url);
1241         $editnode = $lessonnode->add(get_string('edit', 'lesson'));
1242         $url = new moodle_url('/mod/lesson/edit.php', array('id' => $PAGE->cm->id, 'mode' => 'collapsed'));
1243         $editnode->add(get_string('collapsed', 'lesson'), $url);
1244         $url = new moodle_url('/mod/lesson/edit.php', array('id' => $PAGE->cm->id, 'mode' => 'full'));
1245         $editnode->add(get_string('full', 'lesson'), $url);
1246     }
1248     if (has_capability('mod/lesson:viewreports', $PAGE->cm->context)) {
1249         $reportsnode = $lessonnode->add(get_string('reports', 'lesson'));
1250         $url = new moodle_url('/mod/lesson/report.php', array('id'=>$PAGE->cm->id, 'action'=>'reportoverview'));
1251         $reportsnode->add(get_string('overview', 'lesson'), $url);
1252         $url = new moodle_url('/mod/lesson/report.php', array('id'=>$PAGE->cm->id, 'action'=>'reportdetail'));
1253         $reportsnode->add(get_string('detailedstats', 'lesson'), $url);
1254     }
1256     if (has_capability('mod/lesson:grade', $PAGE->cm->context)) {
1257         $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$PAGE->cm->id));
1258         $lessonnode->add(get_string('manualgrading', 'lesson'), $url);
1259     }
1263 /**
1264  * Get list of available import or export formats
1265  *
1266  * Copied and modified from lib/questionlib.php
1267  *
1268  * @param string $type 'import' if import list, otherwise export list assumed
1269  * @return array sorted list of import/export formats available
1270  */
1271 function lesson_get_import_export_formats($type) {
1272     global $CFG;
1273     $fileformats = core_component::get_plugin_list("qformat");
1275     $fileformatname=array();
1276     foreach ($fileformats as $fileformat=>$fdir) {
1277         $format_file = "$fdir/format.php";
1278         if (file_exists($format_file) ) {
1279             require_once($format_file);
1280         } else {
1281             continue;
1282         }
1283         $classname = "qformat_$fileformat";
1284         $format_class = new $classname();
1285         if ($type=='import') {
1286             $provided = $format_class->provide_import();
1287         } else {
1288             $provided = $format_class->provide_export();
1289         }
1290         if ($provided) {
1291             $fileformatnames[$fileformat] = get_string('pluginname', 'qformat_'.$fileformat);
1292         }
1293     }
1294     natcasesort($fileformatnames);
1296     return $fileformatnames;
1299 /**
1300  * Serves the lesson attachments. Implements needed access control ;-)
1301  *
1302  * @package mod_lesson
1303  * @category files
1304  * @param stdClass $course course object
1305  * @param stdClass $cm course module object
1306  * @param stdClass $context context object
1307  * @param string $filearea file area
1308  * @param array $args extra arguments
1309  * @param bool $forcedownload whether or not force download
1310  * @param array $options additional options affecting the file serving
1311  * @return bool false if file not found, does not return if found - justsend the file
1312  */
1313 function lesson_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1314     global $CFG, $DB;
1316     if ($context->contextlevel != CONTEXT_MODULE) {
1317         return false;
1318     }
1320     $fileareas = lesson_get_file_areas();
1321     if (!array_key_exists($filearea, $fileareas)) {
1322         return false;
1323     }
1325     if (!$lesson = $DB->get_record('lesson', array('id'=>$cm->instance))) {
1326         return false;
1327     }
1329     require_course_login($course, true, $cm);
1331     if ($filearea === 'page_contents') {
1332         $pageid = (int)array_shift($args);
1333         if (!$page = $DB->get_record('lesson_pages', array('id'=>$pageid))) {
1334             return false;
1335         }
1336         $fullpath = "/$context->id/mod_lesson/$filearea/$pageid/".implode('/', $args);
1338     } else if ($filearea === 'page_answers' || $filearea === 'page_responses') {
1339         $itemid = (int)array_shift($args);
1340         if (!$pageanswers = $DB->get_record('lesson_answers', array('id' => $itemid))) {
1341             return false;
1342         }
1343         $fullpath = "/$context->id/mod_lesson/$filearea/$itemid/".implode('/', $args);
1345     } else if ($filearea === 'essay_responses') {
1346         $itemid = (int)array_shift($args);
1347         if (!$attempt = $DB->get_record('lesson_attempts', array('id' => $itemid))) {
1348             return false;
1349         }
1350         $fullpath = "/$context->id/mod_lesson/$filearea/$itemid/".implode('/', $args);
1352     } else if ($filearea === 'mediafile') {
1353         if (count($args) > 1) {
1354             // Remove the itemid when it appears to be part of the arguments. If there is only one argument
1355             // then it is surely the file name. The itemid is sometimes used to prevent browser caching.
1356             array_shift($args);
1357         }
1358         $fullpath = "/$context->id/mod_lesson/$filearea/0/".implode('/', $args);
1360     } else {
1361         return false;
1362     }
1364     $fs = get_file_storage();
1365     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1366         return false;
1367     }
1369     // finally send the file
1370     send_stored_file($file, 0, 0, $forcedownload, $options); // download MUST be forced - security!
1373 /**
1374  * Returns an array of file areas
1375  *
1376  * @package  mod_lesson
1377  * @category files
1378  * @return array a list of available file areas
1379  */
1380 function lesson_get_file_areas() {
1381     $areas = array();
1382     $areas['page_contents'] = get_string('pagecontents', 'mod_lesson');
1383     $areas['mediafile'] = get_string('mediafile', 'mod_lesson');
1384     $areas['page_answers'] = get_string('pageanswers', 'mod_lesson');
1385     $areas['page_responses'] = get_string('pageresponses', 'mod_lesson');
1386     $areas['essay_responses'] = get_string('essayresponses', 'mod_lesson');
1387     return $areas;
1390 /**
1391  * Returns a file_info_stored object for the file being requested here
1392  *
1393  * @package  mod_lesson
1394  * @category files
1395  * @global stdClass $CFG
1396  * @param file_browse $browser file browser instance
1397  * @param array $areas file areas
1398  * @param stdClass $course course object
1399  * @param stdClass $cm course module object
1400  * @param stdClass $context context object
1401  * @param string $filearea file area
1402  * @param int $itemid item ID
1403  * @param string $filepath file path
1404  * @param string $filename file name
1405  * @return file_info_stored
1406  */
1407 function lesson_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1408     global $CFG, $DB;
1410     if (!has_capability('moodle/course:managefiles', $context)) {
1411         // No peaking here for students!
1412         return null;
1413     }
1415     // Mediafile area does not have sub directories, so let's select the default itemid to prevent
1416     // the user from selecting a directory to access the mediafile content.
1417     if ($filearea == 'mediafile' && is_null($itemid)) {
1418         $itemid = 0;
1419     }
1421     if (is_null($itemid)) {
1422         return new mod_lesson_file_info($browser, $course, $cm, $context, $areas, $filearea);
1423     }
1425     $fs = get_file_storage();
1426     $filepath = is_null($filepath) ? '/' : $filepath;
1427     $filename = is_null($filename) ? '.' : $filename;
1428     if (!$storedfile = $fs->get_file($context->id, 'mod_lesson', $filearea, $itemid, $filepath, $filename)) {
1429         return null;
1430     }
1432     $itemname = $filearea;
1433     if ($filearea == 'page_contents') {
1434         $itemname = $DB->get_field('lesson_pages', 'title', array('lessonid' => $cm->instance, 'id' => $itemid));
1435         $itemname = format_string($itemname, true, array('context' => $context));
1436     } else {
1437         $areas = lesson_get_file_areas();
1438         if (isset($areas[$filearea])) {
1439             $itemname = $areas[$filearea];
1440         }
1441     }
1443     $urlbase = $CFG->wwwroot . '/pluginfile.php';
1444     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemname, $itemid, true, true, false);
1448 /**
1449  * Return a list of page types
1450  * @param string $pagetype current page type
1451  * @param stdClass $parentcontext Block's parent context
1452  * @param stdClass $currentcontext Current context of block
1453  */
1454 function lesson_page_type_list($pagetype, $parentcontext, $currentcontext) {
1455     $module_pagetype = array(
1456         'mod-lesson-*'=>get_string('page-mod-lesson-x', 'lesson'),
1457         'mod-lesson-view'=>get_string('page-mod-lesson-view', 'lesson'),
1458         'mod-lesson-edit'=>get_string('page-mod-lesson-edit', 'lesson'));
1459     return $module_pagetype;
1462 /**
1463  * Update the lesson activity to include any file
1464  * that was uploaded, or if there is none, set the
1465  * mediafile field to blank.
1466  *
1467  * @param int $lessonid the lesson id
1468  * @param stdClass $context the context
1469  * @param int $draftitemid the draft item
1470  */
1471 function lesson_update_media_file($lessonid, $context, $draftitemid) {
1472     global $DB;
1474     // Set the filestorage object.
1475     $fs = get_file_storage();
1476     // Save the file if it exists that is currently in the draft area.
1477     file_save_draft_area_files($draftitemid, $context->id, 'mod_lesson', 'mediafile', 0);
1478     // Get the file if it exists.
1479     $files = $fs->get_area_files($context->id, 'mod_lesson', 'mediafile', 0, 'itemid, filepath, filename', false);
1480     // Check that there is a file to process.
1481     if (count($files) == 1) {
1482         // Get the first (and only) file.
1483         $file = reset($files);
1484         // Set the mediafile column in the lessons table.
1485         $DB->set_field('lesson', 'mediafile', '/' . $file->get_filename(), array('id' => $lessonid));
1486     } else {
1487         // Set the mediafile column in the lessons table.
1488         $DB->set_field('lesson', 'mediafile', '', array('id' => $lessonid));
1489     }
1492 /**
1493  * Get icon mapping for font-awesome.
1494  */
1495 function mod_lesson_get_fontawesome_icon_map() {
1496     return [
1497         'mod_lesson:e/copy' => 'fa-clone',
1498     ];
1501 /*
1502  * Check if the module has any update that affects the current user since a given time.
1503  *
1504  * @param  cm_info $cm course module data
1505  * @param  int $from the time to check updates from
1506  * @param  array $filter  if we need to check only specific updates
1507  * @return stdClass an object with the different type of areas indicating if they were updated or not
1508  * @since Moodle 3.3
1509  */
1510 function lesson_check_updates_since(cm_info $cm, $from, $filter = array()) {
1511     global $DB, $USER;
1513     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
1515     // Check if there are new pages or answers in the lesson.
1516     $updates->pages = (object) array('updated' => false);
1517     $updates->answers = (object) array('updated' => false);
1518     $select = 'lessonid = ? AND (timecreated > ? OR timemodified > ?)';
1519     $params = array($cm->instance, $from, $from);
1521     $pages = $DB->get_records_select('lesson_pages', $select, $params, '', 'id');
1522     if (!empty($pages)) {
1523         $updates->pages->updated = true;
1524         $updates->pages->itemids = array_keys($pages);
1525     }
1526     $answers = $DB->get_records_select('lesson_answers', $select, $params, '', 'id');
1527     if (!empty($answers)) {
1528         $updates->answers->updated = true;
1529         $updates->answers->itemids = array_keys($answers);
1530     }
1532     // Check for new question attempts, grades, pages viewed and timers.
1533     $updates->questionattempts = (object) array('updated' => false);
1534     $updates->grades = (object) array('updated' => false);
1535     $updates->pagesviewed = (object) array('updated' => false);
1536     $updates->timers = (object) array('updated' => false);
1538     $select = 'lessonid = ? AND userid = ? AND timeseen > ?';
1539     $params = array($cm->instance, $USER->id, $from);
1541     $questionattempts = $DB->get_records_select('lesson_attempts', $select, $params, '', 'id');
1542     if (!empty($questionattempts)) {
1543         $updates->questionattempts->updated = true;
1544         $updates->questionattempts->itemids = array_keys($questionattempts);
1545     }
1546     $pagesviewed = $DB->get_records_select('lesson_branch', $select, $params, '', 'id');
1547     if (!empty($pagesviewed)) {
1548         $updates->pagesviewed->updated = true;
1549         $updates->pagesviewed->itemids = array_keys($pagesviewed);
1550     }
1552     $select = 'lessonid = ? AND userid = ? AND completed > ?';
1553     $grades = $DB->get_records_select('lesson_grades', $select, $params, '', 'id');
1554     if (!empty($grades)) {
1555         $updates->grades->updated = true;
1556         $updates->grades->itemids = array_keys($grades);
1557     }
1559     $select = 'lessonid = ? AND userid = ? AND (starttime > ? OR lessontime > ? OR timemodifiedoffline > ?)';
1560     $params = array($cm->instance, $USER->id, $from, $from, $from);
1561     $timers = $DB->get_records_select('lesson_timer', $select, $params, '', 'id');
1562     if (!empty($timers)) {
1563         $updates->timers->updated = true;
1564         $updates->timers->itemids = array_keys($timers);
1565     }
1567     // Now, teachers should see other students updates.
1568     if (has_capability('mod/lesson:viewreports', $cm->context)) {
1569         $select = 'lessonid = ? AND timeseen > ?';
1570         $params = array($cm->instance, $from);
1572         $insql = '';
1573         $inparams = [];
1574         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
1575             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
1576             if (empty($groupusers)) {
1577                 return $updates;
1578             }
1579             list($insql, $inparams) = $DB->get_in_or_equal($groupusers);
1580             $select .= ' AND userid ' . $insql;
1581             $params = array_merge($params, $inparams);
1582         }
1584         $updates->userquestionattempts = (object) array('updated' => false);
1585         $updates->usergrades = (object) array('updated' => false);
1586         $updates->userpagesviewed = (object) array('updated' => false);
1587         $updates->usertimers = (object) array('updated' => false);
1589         $questionattempts = $DB->get_records_select('lesson_attempts', $select, $params, '', 'id');
1590         if (!empty($questionattempts)) {
1591             $updates->userquestionattempts->updated = true;
1592             $updates->userquestionattempts->itemids = array_keys($questionattempts);
1593         }
1594         $pagesviewed = $DB->get_records_select('lesson_branch', $select, $params, '', 'id');
1595         if (!empty($pagesviewed)) {
1596             $updates->userpagesviewed->updated = true;
1597             $updates->userpagesviewed->itemids = array_keys($pagesviewed);
1598         }
1600         $select = 'lessonid = ? AND completed > ? ' . $insql;
1601         $grades = $DB->get_records_select('lesson_grades', $select, $params, '', 'id');
1602         if (!empty($grades)) {
1603             $updates->usergrades->updated = true;
1604             $updates->usergrades->itemids = array_keys($grades);
1605         }
1607         $select = 'lessonid = ? AND (starttime > ? OR lessontime > ? OR timemodifiedoffline > ?) ' . $insql;
1608         $params = array($cm->instance, $from, $from, $from);
1609         $params = array_merge($params, $inparams);
1610         $timers = $DB->get_records_select('lesson_timer', $select, $params, '', 'id');
1611         if (!empty($timers)) {
1612             $updates->usertimers->updated = true;
1613             $updates->usertimers->itemids = array_keys($timers);
1614         }
1615     }
1616     return $updates;
1619 /**
1620  * Handles creating actions for events.
1621  *
1622  * @param calendar_event $event
1623  * @param \core_calendar\action_factory $factory
1624  * @return \core_calendar\local\event\value_objects\action|\core_calendar\local\interfaces\action_interface|null
1625  */
1626 function mod_lesson_core_calendar_provide_event_action(calendar_event $event,
1627                                                        \core_calendar\action_factory $factory) {
1628     global $DB, $CFG, $USER;
1629     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
1631     $cm = get_fast_modinfo($event->courseid)->instances['lesson'][$event->instance];
1632     $lesson = new lesson($DB->get_record('lesson', array('id' => $cm->instance), '*', MUST_EXIST));
1634     // Apply overrides.
1635     $lesson->update_effective_access($USER->id);
1637     return $factory->create_instance(
1638         get_string('startlesson', 'lesson'),
1639         new \moodle_url('/mod/lesson/view.php', ['id' => $cm->id]),
1640         1,
1641         $lesson->is_accessible()
1642     );