MDL-50915 Lesson: Behat test for overview report
[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 . '/calendar/lib.php');
112     // Load the old events relating to this lesson.
113     $conds = array('modulename' => 'lesson',
114                    'instance' => $lesson->id);
115     if (!empty($override)) {
116         // Only load events for this override.
117         if (isset($override->userid)) {
118             $conds['userid'] = $override->userid;
119         } else {
120             $conds['groupid'] = $override->groupid;
121         }
122     }
123     $oldevents = $DB->get_records('event', $conds);
125     // Now make a todo list of all that needs to be updated.
126     if (empty($override)) {
127         // We are updating the primary settings for the lesson, so we
128         // 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     foreach ($overrides as $current) {
138         $groupid   = isset($current->groupid) ? $current->groupid : 0;
139         $userid    = isset($current->userid) ? $current->userid : 0;
140         $available  = isset($current->available) ? $current->available : $lesson->available;
141         $deadline = isset($current->deadline) ? $current->deadline : $lesson->deadline;
143         // Only add open/close events for an override if they differ from the lesson default.
144         $addopen  = empty($current->id) || !empty($current->available);
145         $addclose = empty($current->id) || !empty($current->deadline);
147         if (!empty($lesson->coursemodule)) {
148             $cmid = $lesson->coursemodule;
149         } else {
150             $cmid = get_coursemodule_from_instance('lesson', $lesson->id, $lesson->course)->id;
151         }
153         $event = new stdClass();
154         $event->description = format_module_intro('lesson', $lesson, $cmid);
155         // Events module won't show user events when the courseid is nonzero.
156         $event->courseid    = ($userid) ? 0 : $lesson->course;
157         $event->groupid     = $groupid;
158         $event->userid      = $userid;
159         $event->modulename  = 'lesson';
160         $event->instance    = $lesson->id;
161         $event->timestart   = $available;
162         $event->timeduration = max($deadline - $available, 0);
163         $event->visible     = instance_is_visible('lesson', $lesson);
164         $event->eventtype   = 'open';
166         // Determine the event name.
167         if ($groupid) {
168             $params = new stdClass();
169             $params->lesson = $lesson->name;
170             $params->group = groups_get_group_name($groupid);
171             if ($params->group === false) {
172                 // Group doesn't exist, just skip it.
173                 continue;
174             }
175             $eventname = get_string('overridegroupeventname', 'lesson', $params);
176         } else if ($userid) {
177             $params = new stdClass();
178             $params->lesson = $lesson->name;
179             $eventname = get_string('overrideusereventname', 'lesson', $params);
180         } else {
181             $eventname = $lesson->name;
182         }
183         if ($addopen or $addclose) {
184             if ($deadline and $available and $event->timeduration <= LESSON_MAX_EVENT_LENGTH) {
185                 // Single event for the whole lesson.
186                 if ($oldevent = array_shift($oldevents)) {
187                     $event->id = $oldevent->id;
188                 } else {
189                     unset($event->id);
190                 }
191                 $event->name = $eventname;
192                 // The method calendar_event::create will reuse a db record if the id field is set.
193                 calendar_event::create($event);
194             } else {
195                 // Separate start and end events.
196                 $event->timeduration  = 0;
197                 if ($available && $addopen) {
198                     if ($oldevent = array_shift($oldevents)) {
199                         $event->id = $oldevent->id;
200                     } else {
201                         unset($event->id);
202                     }
203                     $event->name = $eventname.' ('.get_string('lessonopens', 'lesson').')';
204                     // The method calendar_event::create will reuse a db record if the id field is set.
205                     calendar_event::create($event);
206                 }
207                 if ($deadline && $addclose) {
208                     if ($oldevent = array_shift($oldevents)) {
209                         $event->id = $oldevent->id;
210                     } else {
211                         unset($event->id);
212                     }
213                     $event->name      = $eventname.' ('.get_string('lessoncloses', 'lesson').')';
214                     $event->timestart = $deadline;
215                     $event->eventtype = 'close';
216                     calendar_event::create($event);
217                 }
218             }
219         }
220     }
222     // Delete any leftover events.
223     foreach ($oldevents as $badevent) {
224         $badevent = calendar_event::load($badevent);
225         $badevent->delete();
226     }
229 /**
230  * This standard function will check all instances of this module
231  * and make sure there are up-to-date events created for each of them.
232  * If courseid = 0, then every lesson event in the site is checked, else
233  * only lesson events belonging to the course specified are checked.
234  * This function is used, in its new format, by restore_refresh_events()
235  *
236  * @param int $courseid
237  * @return bool
238  */
239 function lesson_refresh_events($courseid = 0) {
240     global $DB;
242     if ($courseid == 0) {
243         if (!$lessons = $DB->get_records('lessons')) {
244             return true;
245         }
246     } else {
247         if (!$lessons = $DB->get_records('lesson', array('course' => $courseid))) {
248             return true;
249         }
250     }
252     foreach ($lessons as $lesson) {
253         lesson_update_events($lesson);
254     }
256     return true;
259 /**
260  * Given an ID of an instance of this module,
261  * this function will permanently delete the instance
262  * and any data that depends on it.
263  *
264  * @global object
265  * @param int $id
266  * @return bool
267  */
268 function lesson_delete_instance($id) {
269     global $DB, $CFG;
270     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
272     $lesson = $DB->get_record("lesson", array("id"=>$id), '*', MUST_EXIST);
273     $lesson = new lesson($lesson);
274     return $lesson->delete();
277 /**
278  * Given a course object, this function will clean up anything that
279  * would be leftover after all the instances were deleted
280  *
281  * @global object
282  * @param object $course an object representing the course that is being deleted
283  * @param boolean $feedback to specify if the process must output a summary of its work
284  * @return boolean
285  */
286 function lesson_delete_course($course, $feedback=true) {
287     return true;
290 /**
291  * Return a small object with summary information about what a
292  * user has done with a given particular instance of this module
293  * Used for user activity reports.
294  * $return->time = the time they did it
295  * $return->info = a short text description
296  *
297  * @global object
298  * @param object $course
299  * @param object $user
300  * @param object $mod
301  * @param object $lesson
302  * @return object
303  */
304 function lesson_user_outline($course, $user, $mod, $lesson) {
305     global $CFG, $DB;
307     require_once("$CFG->libdir/gradelib.php");
308     $grades = grade_get_grades($course->id, 'mod', 'lesson', $lesson->id, $user->id);
309     $return = new stdClass();
311     if (empty($grades->items[0]->grades)) {
312         $return->info = get_string("nolessonattempts", "lesson");
313     } else {
314         $grade = reset($grades->items[0]->grades);
315         if (empty($grade->grade)) {
317             // Check to see if it an ungraded / incomplete attempt.
318             $sql = "SELECT *
319                       FROM {lesson_timer}
320                      WHERE lessonid = :lessonid
321                        AND userid = :userid
322                   ORDER BY starttime DESC";
323             $params = array('lessonid' => $lesson->id, 'userid' => $user->id);
325             if ($attempts = $DB->get_records_sql($sql, $params, 0, 1)) {
326                 $attempt = reset($attempts);
327                 if ($attempt->completed) {
328                     $return->info = get_string("completed", "lesson");
329                 } else {
330                     $return->info = get_string("notyetcompleted", "lesson");
331                 }
332                 $return->time = $attempt->lessontime;
333             } else {
334                 $return->info = get_string("nolessonattempts", "lesson");
335             }
336         } else {
337             $return->info = get_string("grade") . ': ' . $grade->str_long_grade;
339             // Datesubmitted == time created. dategraded == time modified or time overridden.
340             // If grade was last modified by the user themselves use date graded. Otherwise use date submitted.
341             // TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704.
342             if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
343                 $return->time = $grade->dategraded;
344             } else {
345                 $return->time = $grade->datesubmitted;
346             }
347         }
348     }
349     return $return;
352 /**
353  * Print a detailed representation of what a  user has done with
354  * a given particular instance of this module, for user activity reports.
355  *
356  * @global object
357  * @param object $course
358  * @param object $user
359  * @param object $mod
360  * @param object $lesson
361  * @return bool
362  */
363 function lesson_user_complete($course, $user, $mod, $lesson) {
364     global $DB, $OUTPUT, $CFG;
366     require_once("$CFG->libdir/gradelib.php");
368     $grades = grade_get_grades($course->id, 'mod', 'lesson', $lesson->id, $user->id);
369     if (!empty($grades->items[0]->grades)) {
370         $grade = reset($grades->items[0]->grades);
371         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
372         if ($grade->str_feedback) {
373             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
374         }
375     }
377     $params = array ("lessonid" => $lesson->id, "userid" => $user->id);
378     if ($attempts = $DB->get_records_select("lesson_attempts", "lessonid = :lessonid AND userid = :userid", $params,
379                 "retry, timeseen")) {
380         echo $OUTPUT->box_start();
381         $table = new html_table();
382         $table->head = array (get_string("attemptheader", "lesson"),  get_string("numberofpagesviewedheader", "lesson"),
383             get_string("numberofcorrectanswersheader", "lesson"), get_string("time"));
384         $table->width = "100%";
385         $table->align = array ("center", "center", "center", "center");
386         $table->size = array ("*", "*", "*", "*");
387         $table->cellpadding = 2;
388         $table->cellspacing = 0;
390         $retry = 0;
391         $npages = 0;
392         $ncorrect = 0;
394         foreach ($attempts as $attempt) {
395             if ($attempt->retry == $retry) {
396                 $npages++;
397                 if ($attempt->correct) {
398                     $ncorrect++;
399                 }
400                 $timeseen = $attempt->timeseen;
401             } else {
402                 $table->data[] = array($retry + 1, $npages, $ncorrect, userdate($timeseen));
403                 $retry++;
404                 $npages = 1;
405                 if ($attempt->correct) {
406                     $ncorrect = 1;
407                 } else {
408                     $ncorrect = 0;
409                 }
410             }
411         }
412         if ($npages) {
413                 $table->data[] = array($retry + 1, $npages, $ncorrect, userdate($timeseen));
414         }
415         echo html_writer::table($table);
416         echo $OUTPUT->box_end();
417     }
419     return true;
422 /**
423  * Prints lesson summaries on MyMoodle Page
424  *
425  * Prints lesson name, due date and attempt information on
426  * lessons that have a deadline that has not already passed
427  * and it is available for taking.
428  *
429  * @global object
430  * @global stdClass
431  * @global object
432  * @uses CONTEXT_MODULE
433  * @param array $courses An array of course objects to get lesson instances from
434  * @param array $htmlarray Store overview output array( course ID => 'lesson' => HTML output )
435  * @return void
436  */
437 function lesson_print_overview($courses, &$htmlarray) {
438     global $USER, $CFG, $DB, $OUTPUT;
440     if (!$lessons = get_all_instances_in_courses('lesson', $courses)) {
441         return;
442     }
444     // Get all of the current users attempts on all lessons.
445     $params = array($USER->id);
446     $sql = 'SELECT lessonid, userid, count(userid) as attempts
447               FROM {lesson_grades}
448              WHERE userid = ?
449           GROUP BY lessonid, userid';
450     $allattempts = $DB->get_records_sql($sql, $params);
451     $completedattempts = array();
452     foreach ($allattempts as $myattempt) {
453         $completedattempts[$myattempt->lessonid] = $myattempt->attempts;
454     }
456     // Get the current course ID.
457     $listoflessons = array();
458     foreach ($lessons as $lesson) {
459         $listoflessons[] = $lesson->id;
460     }
461     // Get the last page viewed by the current user for every lesson in this course.
462     list($insql, $inparams) = $DB->get_in_or_equal($listoflessons, SQL_PARAMS_NAMED);
463     $dbparams = array_merge($inparams, array('userid' => $USER->id));
465     // Get the lesson attempts for the user that have the maximum 'timeseen' value.
466     $select = "SELECT l.id, l.timeseen, l.lessonid, l.userid, l.retry, l.pageid, l.answerid as nextpageid, p.qtype ";
467     $from = "FROM {lesson_attempts} l
468              JOIN (
469                    SELECT idselect.lessonid, idselect.userid, MAX(idselect.id) AS id
470                      FROM {lesson_attempts} idselect
471                      JOIN (
472                            SELECT lessonid, userid, MAX(timeseen) AS timeseen
473                              FROM {lesson_attempts}
474                             WHERE userid = :userid
475                               AND lessonid $insql
476                          GROUP BY userid, lessonid
477                            ) timeselect
478                        ON timeselect.timeseen = idselect.timeseen
479                       AND timeselect.userid = idselect.userid
480                       AND timeselect.lessonid = idselect.lessonid
481                  GROUP BY idselect.userid, idselect.lessonid
482                    ) aid
483                ON l.id = aid.id
484              JOIN {lesson_pages} p
485                ON l.pageid = p.id ";
486     $lastattempts = $DB->get_records_sql($select . $from, $dbparams);
488     // Now, get the lesson branches for the user that have the maximum 'timeseen' value.
489     $select = "SELECT l.id, l.timeseen, l.lessonid, l.userid, l.retry, l.pageid, l.nextpageid, p.qtype ";
490     $from = str_replace('{lesson_attempts}', '{lesson_branch}', $from);
491     $lastbranches = $DB->get_records_sql($select . $from, $dbparams);
493     $lastviewed = array();
494     foreach ($lastattempts as $lastattempt) {
495         $lastviewed[$lastattempt->lessonid] = $lastattempt;
496     }
498     // Go through the branch times and record the 'timeseen' value if it doesn't exist
499     // for the lesson, or replace it if it exceeds the current recorded time.
500     foreach ($lastbranches as $lastbranch) {
501         if (!isset($lastviewed[$lastbranch->lessonid])) {
502             $lastviewed[$lastbranch->lessonid] = $lastbranch;
503         } else if ($lastviewed[$lastbranch->lessonid]->timeseen < $lastbranch->timeseen) {
504             $lastviewed[$lastbranch->lessonid] = $lastbranch;
505         }
506     }
508     // Since we have lessons in this course, now include the constants we need.
509     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
511     $now = time();
512     foreach ($lessons as $lesson) {
513         if ($lesson->deadline != 0                                         // The lesson has a deadline
514             and $lesson->deadline >= $now                                  // And it is before the deadline has been met
515             and ($lesson->available == 0 or $lesson->available <= $now)) { // And the lesson is available
517             // Visibility.
518             $class = (!$lesson->visible) ? 'dimmed' : '';
520             // Context.
521             $context = context_module::instance($lesson->coursemodule);
523             // Link to activity.
524             $url = new moodle_url('/mod/lesson/view.php', array('id' => $lesson->coursemodule));
525             $url = html_writer::link($url, format_string($lesson->name, true, array('context' => $context)), array('class' => $class));
526             $str = $OUTPUT->box(get_string('lessonname', 'lesson', $url), 'name');
528             // Deadline.
529             $str .= $OUTPUT->box(get_string('lessoncloseson', 'lesson', userdate($lesson->deadline)), 'info');
531             // Attempt information.
532             if (has_capability('mod/lesson:manage', $context)) {
533                 // This is a teacher, Get the Number of user attempts.
534                 $attempts = $DB->count_records('lesson_grades', array('lessonid' => $lesson->id));
535                 $str     .= $OUTPUT->box(get_string('xattempts', 'lesson', $attempts), 'info');
536                 $str      = $OUTPUT->box($str, 'lesson overview');
537             } else {
538                 // This is a student, See if the user has at least started the lesson.
539                 if (isset($lastviewed[$lesson->id]->timeseen)) {
540                     // See if the user has finished this attempt.
541                     if (isset($completedattempts[$lesson->id]) &&
542                              ($completedattempts[$lesson->id] == ($lastviewed[$lesson->id]->retry + 1))) {
543                         // Are additional attempts allowed?
544                         if ($lesson->retake) {
545                             // User can retake the lesson.
546                             $str .= $OUTPUT->box(get_string('additionalattemptsremaining', 'lesson'), 'info');
547                             $str = $OUTPUT->box($str, 'lesson overview');
548                         } else {
549                             // User has completed the lesson and no retakes are allowed.
550                             $str = '';
551                         }
553                     } else {
554                         // The last attempt was not finished or the lesson does not contain questions.
555                         // See if the last page viewed was a branchtable.
556                         require_once($CFG->dirroot . '/mod/lesson/pagetypes/branchtable.php');
557                         if ($lastviewed[$lesson->id]->qtype == LESSON_PAGE_BRANCHTABLE) {
558                             // See if the next pageid is the end of lesson.
559                             if ($lastviewed[$lesson->id]->nextpageid == LESSON_EOL) {
560                                 // The last page viewed was the End of Lesson.
561                                 if ($lesson->retake) {
562                                     // User can retake the lesson.
563                                     $str .= $OUTPUT->box(get_string('additionalattemptsremaining', 'lesson'), 'info');
564                                     $str = $OUTPUT->box($str, 'lesson overview');
565                                 } else {
566                                     // User has completed the lesson and no retakes are allowed.
567                                     $str = '';
568                                 }
570                             } else {
571                                 // The last page viewed was NOT the end of lesson.
572                                 $str .= $OUTPUT->box(get_string('notyetcompleted', 'lesson'), 'info');
573                                 $str = $OUTPUT->box($str, 'lesson overview');
574                             }
576                         } else {
577                             // Last page was a question page, so the attempt is not completed yet.
578                             $str .= $OUTPUT->box(get_string('notyetcompleted', 'lesson'), 'info');
579                             $str = $OUTPUT->box($str, 'lesson overview');
580                         }
581                     }
583                 } else {
584                     // User has not yet started this lesson.
585                     $str .= $OUTPUT->box(get_string('nolessonattempts', 'lesson'), 'info');
586                     $str = $OUTPUT->box($str, 'lesson overview');
587                 }
588             }
589             if (!empty($str)) {
590                 if (empty($htmlarray[$lesson->course]['lesson'])) {
591                     $htmlarray[$lesson->course]['lesson'] = $str;
592                 } else {
593                     $htmlarray[$lesson->course]['lesson'] .= $str;
594                 }
595             }
596         }
597     }
600 /**
601  * Function to be run periodically according to the moodle cron
602  * This function searches for things that need to be done, such
603  * as sending out mail, toggling flags etc ...
604  * @global stdClass
605  * @return bool true
606  */
607 function lesson_cron () {
608     global $CFG;
610     return true;
613 /**
614  * Return grade for given user or all users.
615  *
616  * @global stdClass
617  * @global object
618  * @param int $lessonid id of lesson
619  * @param int $userid optional user id, 0 means all users
620  * @return array array of grades, false if none
621  */
622 function lesson_get_user_grades($lesson, $userid=0) {
623     global $CFG, $DB;
625     $params = array("lessonid" => $lesson->id,"lessonid2" => $lesson->id);
627     if (!empty($userid)) {
628         $params["userid"] = $userid;
629         $params["userid2"] = $userid;
630         $user = "AND u.id = :userid";
631         $fuser = "AND uu.id = :userid2";
632     }
633     else {
634         $user="";
635         $fuser="";
636     }
638     if ($lesson->retake) {
639         if ($lesson->usemaxgrade) {
640             $sql = "SELECT u.id, u.id AS userid, MAX(g.grade) AS rawgrade
641                       FROM {user} u, {lesson_grades} g
642                      WHERE u.id = g.userid AND g.lessonid = :lessonid
643                            $user
644                   GROUP BY u.id";
645         } else {
646             $sql = "SELECT u.id, u.id AS userid, AVG(g.grade) AS rawgrade
647                       FROM {user} u, {lesson_grades} g
648                      WHERE u.id = g.userid AND g.lessonid = :lessonid
649                            $user
650                   GROUP BY u.id";
651         }
652         unset($params['lessonid2']);
653         unset($params['userid2']);
654     } else {
655         // use only first attempts (with lowest id in lesson_grades table)
656         $firstonly = "SELECT uu.id AS userid, MIN(gg.id) AS firstcompleted
657                         FROM {user} uu, {lesson_grades} gg
658                        WHERE uu.id = gg.userid AND gg.lessonid = :lessonid2
659                              $fuser
660                        GROUP BY uu.id";
662         $sql = "SELECT u.id, u.id AS userid, g.grade AS rawgrade
663                   FROM {user} u, {lesson_grades} g, ($firstonly) f
664                  WHERE u.id = g.userid AND g.lessonid = :lessonid
665                        AND g.id = f.firstcompleted AND g.userid=f.userid
666                        $user";
667     }
669     return $DB->get_records_sql($sql, $params);
672 /**
673  * Update grades in central gradebook
674  *
675  * @category grade
676  * @param object $lesson
677  * @param int $userid specific user only, 0 means all
678  * @param bool $nullifnone
679  */
680 function lesson_update_grades($lesson, $userid=0, $nullifnone=true) {
681     global $CFG, $DB;
682     require_once($CFG->libdir.'/gradelib.php');
684     if ($lesson->grade == 0 || $lesson->practice) {
685         lesson_grade_item_update($lesson);
687     } else if ($grades = lesson_get_user_grades($lesson, $userid)) {
688         lesson_grade_item_update($lesson, $grades);
690     } else if ($userid and $nullifnone) {
691         $grade = new stdClass();
692         $grade->userid   = $userid;
693         $grade->rawgrade = null;
694         lesson_grade_item_update($lesson, $grade);
696     } else {
697         lesson_grade_item_update($lesson);
698     }
701 /**
702  * Create grade item for given lesson
703  *
704  * @category grade
705  * @uses GRADE_TYPE_VALUE
706  * @uses GRADE_TYPE_NONE
707  * @param object $lesson object with extra cmidnumber
708  * @param array|object $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
709  * @return int 0 if ok, error code otherwise
710  */
711 function lesson_grade_item_update($lesson, $grades=null) {
712     global $CFG;
713     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
714         require_once($CFG->libdir.'/gradelib.php');
715     }
717     if (array_key_exists('cmidnumber', $lesson)) { //it may not be always present
718         $params = array('itemname'=>$lesson->name, 'idnumber'=>$lesson->cmidnumber);
719     } else {
720         $params = array('itemname'=>$lesson->name);
721     }
723     if (!$lesson->practice and $lesson->grade > 0) {
724         $params['gradetype']  = GRADE_TYPE_VALUE;
725         $params['grademax']   = $lesson->grade;
726         $params['grademin']   = 0;
727     } else if (!$lesson->practice and $lesson->grade < 0) {
728         $params['gradetype']  = GRADE_TYPE_SCALE;
729         $params['scaleid']   = -$lesson->grade;
731         // Make sure current grade fetched correctly from $grades
732         $currentgrade = null;
733         if (!empty($grades)) {
734             if (is_array($grades)) {
735                 $currentgrade = reset($grades);
736             } else {
737                 $currentgrade = $grades;
738             }
739         }
741         // When converting a score to a scale, use scale's grade maximum to calculate it.
742         if (!empty($currentgrade) && $currentgrade->rawgrade !== null) {
743             $grade = grade_get_grades($lesson->course, 'mod', 'lesson', $lesson->id, $currentgrade->userid);
744             $params['grademax']   = reset($grade->items)->grademax;
745         }
746     } else {
747         $params['gradetype']  = GRADE_TYPE_NONE;
748     }
750     if ($grades  === 'reset') {
751         $params['reset'] = true;
752         $grades = null;
753     } else if (!empty($grades)) {
754         // Need to calculate raw grade (Note: $grades has many forms)
755         if (is_object($grades)) {
756             $grades = array($grades->userid => $grades);
757         } else if (array_key_exists('userid', $grades)) {
758             $grades = array($grades['userid'] => $grades);
759         }
760         foreach ($grades as $key => $grade) {
761             if (!is_array($grade)) {
762                 $grades[$key] = $grade = (array) $grade;
763             }
764             //check raw grade isnt null otherwise we erroneously insert a grade of 0
765             if ($grade['rawgrade'] !== null) {
766                 $grades[$key]['rawgrade'] = ($grade['rawgrade'] * $params['grademax'] / 100);
767             } else {
768                 //setting rawgrade to null just in case user is deleting a grade
769                 $grades[$key]['rawgrade'] = null;
770             }
771         }
772     }
774     return grade_update('mod/lesson', $lesson->course, 'mod', 'lesson', $lesson->id, 0, $grades, $params);
777 /**
778  * List the actions that correspond to a view of this module.
779  * This is used by the participation report.
780  *
781  * Note: This is not used by new logging system. Event with
782  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
783  *       be considered as view action.
784  *
785  * @return array
786  */
787 function lesson_get_view_actions() {
788     return array('view','view all');
791 /**
792  * List the actions that correspond to a post of this module.
793  * This is used by the participation report.
794  *
795  * Note: This is not used by new logging system. Event with
796  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
797  *       will be considered as post action.
798  *
799  * @return array
800  */
801 function lesson_get_post_actions() {
802     return array('end','start');
805 /**
806  * Runs any processes that must run before
807  * a lesson insert/update
808  *
809  * @global object
810  * @param object $lesson Lesson form data
811  * @return void
812  **/
813 function lesson_process_pre_save(&$lesson) {
814     global $DB;
816     $lesson->timemodified = time();
818     if (empty($lesson->timelimit)) {
819         $lesson->timelimit = 0;
820     }
821     if (empty($lesson->timespent) or !is_numeric($lesson->timespent) or $lesson->timespent < 0) {
822         $lesson->timespent = 0;
823     }
824     if (!isset($lesson->completed)) {
825         $lesson->completed = 0;
826     }
827     if (empty($lesson->gradebetterthan) or !is_numeric($lesson->gradebetterthan) or $lesson->gradebetterthan < 0) {
828         $lesson->gradebetterthan = 0;
829     } else if ($lesson->gradebetterthan > 100) {
830         $lesson->gradebetterthan = 100;
831     }
833     if (empty($lesson->width)) {
834         $lesson->width = 640;
835     }
836     if (empty($lesson->height)) {
837         $lesson->height = 480;
838     }
839     if (empty($lesson->bgcolor)) {
840         $lesson->bgcolor = '#FFFFFF';
841     }
843     // Conditions for dependency
844     $conditions = new stdClass;
845     $conditions->timespent = $lesson->timespent;
846     $conditions->completed = $lesson->completed;
847     $conditions->gradebetterthan = $lesson->gradebetterthan;
848     $lesson->conditions = serialize($conditions);
849     unset($lesson->timespent);
850     unset($lesson->completed);
851     unset($lesson->gradebetterthan);
853     if (empty($lesson->password)) {
854         unset($lesson->password);
855     }
858 /**
859  * Runs any processes that must be run
860  * after a lesson insert/update
861  *
862  * @global object
863  * @param object $lesson Lesson form data
864  * @return void
865  **/
866 function lesson_process_post_save(&$lesson) {
867     // Update the events relating to this lesson.
868     lesson_update_events($lesson);
872 /**
873  * Implementation of the function for printing the form elements that control
874  * whether the course reset functionality affects the lesson.
875  *
876  * @param $mform form passed by reference
877  */
878 function lesson_reset_course_form_definition(&$mform) {
879     $mform->addElement('header', 'lessonheader', get_string('modulenameplural', 'lesson'));
880     $mform->addElement('advcheckbox', 'reset_lesson', get_string('deleteallattempts','lesson'));
881     $mform->addElement('advcheckbox', 'reset_lesson_user_overrides',
882             get_string('removealluseroverrides', 'lesson'));
883     $mform->addElement('advcheckbox', 'reset_lesson_group_overrides',
884             get_string('removeallgroupoverrides', 'lesson'));
887 /**
888  * Course reset form defaults.
889  * @param object $course
890  * @return array
891  */
892 function lesson_reset_course_form_defaults($course) {
893     return array('reset_lesson' => 1,
894             'reset_lesson_group_overrides' => 1,
895             'reset_lesson_user_overrides' => 1);
898 /**
899  * Removes all grades from gradebook
900  *
901  * @global stdClass
902  * @global object
903  * @param int $courseid
904  * @param string optional type
905  */
906 function lesson_reset_gradebook($courseid, $type='') {
907     global $CFG, $DB;
909     $sql = "SELECT l.*, cm.idnumber as cmidnumber, l.course as courseid
910               FROM {lesson} l, {course_modules} cm, {modules} m
911              WHERE m.name='lesson' AND m.id=cm.module AND cm.instance=l.id AND l.course=:course";
912     $params = array ("course" => $courseid);
913     if ($lessons = $DB->get_records_sql($sql,$params)) {
914         foreach ($lessons as $lesson) {
915             lesson_grade_item_update($lesson, 'reset');
916         }
917     }
920 /**
921  * Actual implementation of the reset course functionality, delete all the
922  * lesson attempts for course $data->courseid.
923  *
924  * @global stdClass
925  * @global object
926  * @param object $data the data submitted from the reset course.
927  * @return array status array
928  */
929 function lesson_reset_userdata($data) {
930     global $CFG, $DB;
932     $componentstr = get_string('modulenameplural', 'lesson');
933     $status = array();
935     if (!empty($data->reset_lesson)) {
936         $lessonssql = "SELECT l.id
937                          FROM {lesson} l
938                         WHERE l.course=:course";
940         $params = array ("course" => $data->courseid);
941         $lessons = $DB->get_records_sql($lessonssql, $params);
943         // Get rid of attempts files.
944         $fs = get_file_storage();
945         if ($lessons) {
946             foreach ($lessons as $lessonid => $unused) {
947                 if (!$cm = get_coursemodule_from_instance('lesson', $lessonid)) {
948                     continue;
949                 }
950                 $context = context_module::instance($cm->id);
951                 $fs->delete_area_files($context->id, 'mod_lesson', 'essay_responses');
952             }
953         }
955         $DB->delete_records_select('lesson_timer', "lessonid IN ($lessonssql)", $params);
956         $DB->delete_records_select('lesson_grades', "lessonid IN ($lessonssql)", $params);
957         $DB->delete_records_select('lesson_attempts', "lessonid IN ($lessonssql)", $params);
958         $DB->delete_records_select('lesson_branch', "lessonid IN ($lessonssql)", $params);
960         // remove all grades from gradebook
961         if (empty($data->reset_gradebook_grades)) {
962             lesson_reset_gradebook($data->courseid);
963         }
965         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'lesson'), 'error'=>false);
966     }
968     // Remove user overrides.
969     if (!empty($data->reset_lesson_user_overrides)) {
970         $DB->delete_records_select('lesson_overrides',
971                 'lessonid IN (SELECT id FROM {lesson} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
972         $status[] = array(
973         'component' => $componentstr,
974         'item' => get_string('useroverridesdeleted', 'lesson'),
975         'error' => false);
976     }
977     // Remove group overrides.
978     if (!empty($data->reset_lesson_group_overrides)) {
979         $DB->delete_records_select('lesson_overrides',
980         'lessonid IN (SELECT id FROM {lesson} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
981         $status[] = array(
982         'component' => $componentstr,
983         'item' => get_string('groupoverridesdeleted', 'lesson'),
984         'error' => false);
985     }
986     /// updating dates - shift may be negative too
987     if ($data->timeshift) {
988         $DB->execute("UPDATE {lesson_overrides}
989                          SET available = available + ?
990                        WHERE lessonid IN (SELECT id FROM {lesson} WHERE course = ?)
991                          AND available <> 0", array($data->timeshift, $data->courseid));
992         $DB->execute("UPDATE {lesson_overrides}
993                          SET deadline = deadline + ?
994                        WHERE lessonid IN (SELECT id FROM {lesson} WHERE course = ?)
995                          AND deadline <> 0", array($data->timeshift, $data->courseid));
997         shift_course_mod_dates('lesson', array('available', 'deadline'), $data->timeshift, $data->courseid);
998         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
999     }
1001     return $status;
1004 /**
1005  * Returns all other caps used in module
1006  * @return array
1007  */
1008 function lesson_get_extra_capabilities() {
1009     return array('moodle/site:accessallgroups');
1012 /**
1013  * @uses FEATURE_GROUPS
1014  * @uses FEATURE_GROUPINGS
1015  * @uses FEATURE_MOD_INTRO
1016  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
1017  * @uses FEATURE_GRADE_HAS_GRADE
1018  * @uses FEATURE_GRADE_OUTCOMES
1019  * @param string $feature FEATURE_xx constant for requested feature
1020  * @return mixed True if module supports feature, false if not, null if doesn't know
1021  */
1022 function lesson_supports($feature) {
1023     switch($feature) {
1024         case FEATURE_GROUPS:
1025             return true;
1026         case FEATURE_GROUPINGS:
1027             return true;
1028         case FEATURE_MOD_INTRO:
1029             return true;
1030         case FEATURE_COMPLETION_TRACKS_VIEWS:
1031             return true;
1032         case FEATURE_GRADE_HAS_GRADE:
1033             return true;
1034         case FEATURE_COMPLETION_HAS_RULES:
1035             return true;
1036         case FEATURE_GRADE_OUTCOMES:
1037             return true;
1038         case FEATURE_BACKUP_MOODLE2:
1039             return true;
1040         case FEATURE_SHOW_DESCRIPTION:
1041             return true;
1042         default:
1043             return null;
1044     }
1047 /**
1048  * Obtains the automatic completion state for this lesson based on any conditions
1049  * in lesson settings.
1050  *
1051  * @param object $course Course
1052  * @param object $cm course-module
1053  * @param int $userid User ID
1054  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1055  * @return bool True if completed, false if not, $type if conditions not set.
1056  */
1057 function lesson_get_completion_state($course, $cm, $userid, $type) {
1058     global $CFG, $DB;
1060     // Get lesson details.
1061     $lesson = $DB->get_record('lesson', array('id' => $cm->instance), '*',
1062             MUST_EXIST);
1064     $result = $type; // Default return value.
1065     // If completion option is enabled, evaluate it and return true/false.
1066     if ($lesson->completionendreached) {
1067         $value = $DB->record_exists('lesson_timer', array(
1068                 'lessonid' => $lesson->id, 'userid' => $userid, 'completed' => 1));
1069         if ($type == COMPLETION_AND) {
1070             $result = $result && $value;
1071         } else {
1072             $result = $result || $value;
1073         }
1074     }
1075     if ($lesson->completiontimespent != 0) {
1076         $duration = $DB->get_field_sql(
1077                         "SELECT SUM(lessontime - starttime)
1078                                FROM {lesson_timer}
1079                               WHERE lessonid = :lessonid
1080                                 AND userid = :userid",
1081                         array('userid' => $userid, 'lessonid' => $lesson->id));
1082         if (!$duration) {
1083             $duration = 0;
1084         }
1085         if ($type == COMPLETION_AND) {
1086             $result = $result && ($lesson->completiontimespent < $duration);
1087         } else {
1088             $result = $result || ($lesson->completiontimespent < $duration);
1089         }
1090     }
1091     return $result;
1093 /**
1094  * This function extends the settings navigation block for the site.
1095  *
1096  * It is safe to rely on PAGE here as we will only ever be within the module
1097  * context when this is called
1098  *
1099  * @param settings_navigation $settings
1100  * @param navigation_node $lessonnode
1101  */
1102 function lesson_extend_settings_navigation($settings, $lessonnode) {
1103     global $PAGE, $DB;
1105     // We want to add these new nodes after the Edit settings node, and before the
1106     // Locally assigned roles node. Of course, both of those are controlled by capabilities.
1107     $keys = $lessonnode->get_children_key_list();
1108     $beforekey = null;
1109     $i = array_search('modedit', $keys);
1110     if ($i === false and array_key_exists(0, $keys)) {
1111         $beforekey = $keys[0];
1112     } else if (array_key_exists($i + 1, $keys)) {
1113         $beforekey = $keys[$i + 1];
1114     }
1116     if (has_capability('mod/lesson:manageoverrides', $PAGE->cm->context)) {
1117         $url = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $PAGE->cm->id));
1118         $node = navigation_node::create(get_string('groupoverrides', 'lesson'),
1119                 new moodle_url($url, array('mode' => 'group')),
1120                 navigation_node::TYPE_SETTING, null, 'mod_lesson_groupoverrides');
1121         $lessonnode->add_node($node, $beforekey);
1123         $node = navigation_node::create(get_string('useroverrides', 'lesson'),
1124                 new moodle_url($url, array('mode' => 'user')),
1125                 navigation_node::TYPE_SETTING, null, 'mod_lesson_useroverrides');
1126         $lessonnode->add_node($node, $beforekey);
1127     }
1129     if (has_capability('mod/lesson:edit', $PAGE->cm->context)) {
1130         $url = new moodle_url('/mod/lesson/view.php', array('id' => $PAGE->cm->id));
1131         $lessonnode->add(get_string('preview', 'lesson'), $url);
1132         $editnode = $lessonnode->add(get_string('edit', 'lesson'));
1133         $url = new moodle_url('/mod/lesson/edit.php', array('id' => $PAGE->cm->id, 'mode' => 'collapsed'));
1134         $editnode->add(get_string('collapsed', 'lesson'), $url);
1135         $url = new moodle_url('/mod/lesson/edit.php', array('id' => $PAGE->cm->id, 'mode' => 'full'));
1136         $editnode->add(get_string('full', 'lesson'), $url);
1137     }
1139     if (has_capability('mod/lesson:viewreports', $PAGE->cm->context)) {
1140         $reportsnode = $lessonnode->add(get_string('reports', 'lesson'));
1141         $url = new moodle_url('/mod/lesson/report.php', array('id'=>$PAGE->cm->id, 'action'=>'reportoverview'));
1142         $reportsnode->add(get_string('overview', 'lesson'), $url);
1143         $url = new moodle_url('/mod/lesson/report.php', array('id'=>$PAGE->cm->id, 'action'=>'reportdetail'));
1144         $reportsnode->add(get_string('detailedstats', 'lesson'), $url);
1145     }
1147     if (has_capability('mod/lesson:grade', $PAGE->cm->context)) {
1148         $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$PAGE->cm->id));
1149         $lessonnode->add(get_string('manualgrading', 'lesson'), $url);
1150     }
1154 /**
1155  * Get list of available import or export formats
1156  *
1157  * Copied and modified from lib/questionlib.php
1158  *
1159  * @param string $type 'import' if import list, otherwise export list assumed
1160  * @return array sorted list of import/export formats available
1161  */
1162 function lesson_get_import_export_formats($type) {
1163     global $CFG;
1164     $fileformats = core_component::get_plugin_list("qformat");
1166     $fileformatname=array();
1167     foreach ($fileformats as $fileformat=>$fdir) {
1168         $format_file = "$fdir/format.php";
1169         if (file_exists($format_file) ) {
1170             require_once($format_file);
1171         } else {
1172             continue;
1173         }
1174         $classname = "qformat_$fileformat";
1175         $format_class = new $classname();
1176         if ($type=='import') {
1177             $provided = $format_class->provide_import();
1178         } else {
1179             $provided = $format_class->provide_export();
1180         }
1181         if ($provided) {
1182             $fileformatnames[$fileformat] = get_string('pluginname', 'qformat_'.$fileformat);
1183         }
1184     }
1185     natcasesort($fileformatnames);
1187     return $fileformatnames;
1190 /**
1191  * Serves the lesson attachments. Implements needed access control ;-)
1192  *
1193  * @package mod_lesson
1194  * @category files
1195  * @param stdClass $course course object
1196  * @param stdClass $cm course module object
1197  * @param stdClass $context context object
1198  * @param string $filearea file area
1199  * @param array $args extra arguments
1200  * @param bool $forcedownload whether or not force download
1201  * @param array $options additional options affecting the file serving
1202  * @return bool false if file not found, does not return if found - justsend the file
1203  */
1204 function lesson_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1205     global $CFG, $DB;
1207     if ($context->contextlevel != CONTEXT_MODULE) {
1208         return false;
1209     }
1211     $fileareas = lesson_get_file_areas();
1212     if (!array_key_exists($filearea, $fileareas)) {
1213         return false;
1214     }
1216     if (!$lesson = $DB->get_record('lesson', array('id'=>$cm->instance))) {
1217         return false;
1218     }
1220     require_course_login($course, true, $cm);
1222     if ($filearea === 'page_contents') {
1223         $pageid = (int)array_shift($args);
1224         if (!$page = $DB->get_record('lesson_pages', array('id'=>$pageid))) {
1225             return false;
1226         }
1227         $fullpath = "/$context->id/mod_lesson/$filearea/$pageid/".implode('/', $args);
1229     } else if ($filearea === 'page_answers' || $filearea === 'page_responses') {
1230         $itemid = (int)array_shift($args);
1231         if (!$pageanswers = $DB->get_record('lesson_answers', array('id' => $itemid))) {
1232             return false;
1233         }
1234         $fullpath = "/$context->id/mod_lesson/$filearea/$itemid/".implode('/', $args);
1236     } else if ($filearea === 'essay_responses') {
1237         $itemid = (int)array_shift($args);
1238         if (!$attempt = $DB->get_record('lesson_attempts', array('id' => $itemid))) {
1239             return false;
1240         }
1241         $fullpath = "/$context->id/mod_lesson/$filearea/$itemid/".implode('/', $args);
1243     } else if ($filearea === 'mediafile') {
1244         if (count($args) > 1) {
1245             // Remove the itemid when it appears to be part of the arguments. If there is only one argument
1246             // then it is surely the file name. The itemid is sometimes used to prevent browser caching.
1247             array_shift($args);
1248         }
1249         $fullpath = "/$context->id/mod_lesson/$filearea/0/".implode('/', $args);
1251     } else {
1252         return false;
1253     }
1255     $fs = get_file_storage();
1256     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1257         return false;
1258     }
1260     // finally send the file
1261     send_stored_file($file, 0, 0, $forcedownload, $options); // download MUST be forced - security!
1264 /**
1265  * Returns an array of file areas
1266  *
1267  * @package  mod_lesson
1268  * @category files
1269  * @return array a list of available file areas
1270  */
1271 function lesson_get_file_areas() {
1272     $areas = array();
1273     $areas['page_contents'] = get_string('pagecontents', 'mod_lesson');
1274     $areas['mediafile'] = get_string('mediafile', 'mod_lesson');
1275     $areas['page_answers'] = get_string('pageanswers', 'mod_lesson');
1276     $areas['page_responses'] = get_string('pageresponses', 'mod_lesson');
1277     $areas['essay_responses'] = get_string('essayresponses', 'mod_lesson');
1278     return $areas;
1281 /**
1282  * Returns a file_info_stored object for the file being requested here
1283  *
1284  * @package  mod_lesson
1285  * @category files
1286  * @global stdClass $CFG
1287  * @param file_browse $browser file browser instance
1288  * @param array $areas file areas
1289  * @param stdClass $course course object
1290  * @param stdClass $cm course module object
1291  * @param stdClass $context context object
1292  * @param string $filearea file area
1293  * @param int $itemid item ID
1294  * @param string $filepath file path
1295  * @param string $filename file name
1296  * @return file_info_stored
1297  */
1298 function lesson_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1299     global $CFG, $DB;
1301     if (!has_capability('moodle/course:managefiles', $context)) {
1302         // No peaking here for students!
1303         return null;
1304     }
1306     // Mediafile area does not have sub directories, so let's select the default itemid to prevent
1307     // the user from selecting a directory to access the mediafile content.
1308     if ($filearea == 'mediafile' && is_null($itemid)) {
1309         $itemid = 0;
1310     }
1312     if (is_null($itemid)) {
1313         return new mod_lesson_file_info($browser, $course, $cm, $context, $areas, $filearea);
1314     }
1316     $fs = get_file_storage();
1317     $filepath = is_null($filepath) ? '/' : $filepath;
1318     $filename = is_null($filename) ? '.' : $filename;
1319     if (!$storedfile = $fs->get_file($context->id, 'mod_lesson', $filearea, $itemid, $filepath, $filename)) {
1320         return null;
1321     }
1323     $itemname = $filearea;
1324     if ($filearea == 'page_contents') {
1325         $itemname = $DB->get_field('lesson_pages', 'title', array('lessonid' => $cm->instance, 'id' => $itemid));
1326         $itemname = format_string($itemname, true, array('context' => $context));
1327     } else {
1328         $areas = lesson_get_file_areas();
1329         if (isset($areas[$filearea])) {
1330             $itemname = $areas[$filearea];
1331         }
1332     }
1334     $urlbase = $CFG->wwwroot . '/pluginfile.php';
1335     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemname, $itemid, true, true, false);
1339 /**
1340  * Return a list of page types
1341  * @param string $pagetype current page type
1342  * @param stdClass $parentcontext Block's parent context
1343  * @param stdClass $currentcontext Current context of block
1344  */
1345 function lesson_page_type_list($pagetype, $parentcontext, $currentcontext) {
1346     $module_pagetype = array(
1347         'mod-lesson-*'=>get_string('page-mod-lesson-x', 'lesson'),
1348         'mod-lesson-view'=>get_string('page-mod-lesson-view', 'lesson'),
1349         'mod-lesson-edit'=>get_string('page-mod-lesson-edit', 'lesson'));
1350     return $module_pagetype;
1353 /**
1354  * Update the lesson activity to include any file
1355  * that was uploaded, or if there is none, set the
1356  * mediafile field to blank.
1357  *
1358  * @param int $lessonid the lesson id
1359  * @param stdClass $context the context
1360  * @param int $draftitemid the draft item
1361  */
1362 function lesson_update_media_file($lessonid, $context, $draftitemid) {
1363     global $DB;
1365     // Set the filestorage object.
1366     $fs = get_file_storage();
1367     // Save the file if it exists that is currently in the draft area.
1368     file_save_draft_area_files($draftitemid, $context->id, 'mod_lesson', 'mediafile', 0);
1369     // Get the file if it exists.
1370     $files = $fs->get_area_files($context->id, 'mod_lesson', 'mediafile', 0, 'itemid, filepath, filename', false);
1371     // Check that there is a file to process.
1372     if (count($files) == 1) {
1373         // Get the first (and only) file.
1374         $file = reset($files);
1375         // Set the mediafile column in the lessons table.
1376         $DB->set_field('lesson', 'mediafile', '/' . $file->get_filename(), array('id' => $lessonid));
1377     } else {
1378         // Set the mediafile column in the lessons table.
1379         $DB->set_field('lesson', 'mediafile', '', array('id' => $lessonid));
1380     }