Merge branch 'MDL-50915_m31v5' of https://github.com/sbourget/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 . '/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);
370     // Display the grade and feedback.
371     if (empty($grades->items[0]->grades)) {
372         echo $OUTPUT->container(get_string("nolessonattempts", "lesson"));
373     } else {
374         $grade = reset($grades->items[0]->grades);
375         if (empty($grade->grade)) {
376             // Check to see if it an ungraded / incomplete attempt.
377             $sql = "SELECT *
378                       FROM {lesson_timer}
379                      WHERE lessonid = :lessonid
380                        AND userid = :userid
381                      ORDER by starttime desc";
382             $params = array('lessonid' => $lesson->id, 'userid' => $user->id);
384             if ($attempt = $DB->get_record_sql($sql, $params, IGNORE_MULTIPLE)) {
385                 if ($attempt->completed) {
386                     $status = get_string("completed", "lesson");
387                 } else {
388                     $status = get_string("notyetcompleted", "lesson");
389                 }
390             } else {
391                 $status = get_string("nolessonattempts", "lesson");
392             }
393         } else {
394             $status = get_string("grade") . ': ' . $grade->str_long_grade;
395         }
397         // Display the grade or lesson status if there isn't one.
398         echo $OUTPUT->container($status);
400         if ($grade->str_feedback) {
401             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
402         }
403     }
405     // Display the lesson progress.
406     // Attempt, pages viewed, questions answered, correct answers, time.
407     $params = array ("lessonid" => $lesson->id, "userid" => $user->id);
408     $attempts = $DB->get_records_select("lesson_attempts", "lessonid = :lessonid AND userid = :userid", $params, "retry, timeseen");
409     $branches = $DB->get_records_select("lesson_branch", "lessonid = :lessonid AND userid = :userid", $params, "retry, timeseen");
410     if (!empty($attempts) or !empty($branches)) {
411         echo $OUTPUT->box_start();
412         $table = new html_table();
413         // Table Headings.
414         $table->head = array (get_string("attemptheader", "lesson"),
415             get_string("totalpagesviewedheader", "lesson"),
416             get_string("numberofpagesviewedheader", "lesson"),
417             get_string("numberofcorrectanswersheader", "lesson"),
418             get_string("time"));
419         $table->width = "100%";
420         $table->align = array ("center", "center", "center", "center", "center");
421         $table->size = array ("*", "*", "*", "*", "*");
422         $table->cellpadding = 2;
423         $table->cellspacing = 0;
425         $retry = 0;
426         $nquestions = 0;
427         $npages = 0;
428         $ncorrect = 0;
430         // Filter question pages (from lesson_attempts).
431         foreach ($attempts as $attempt) {
432             if ($attempt->retry == $retry) {
433                 $npages++;
434                 $nquestions++;
435                 if ($attempt->correct) {
436                     $ncorrect++;
437                 }
438                 $timeseen = $attempt->timeseen;
439             } else {
440                 $table->data[] = array($retry + 1, $npages, $nquestions, $ncorrect, userdate($timeseen));
441                 $retry++;
442                 $nquestions = 1;
443                 $npages = 1;
444                 if ($attempt->correct) {
445                     $ncorrect = 1;
446                 } else {
447                     $ncorrect = 0;
448                 }
449             }
450         }
452         // Filter content pages (from lesson_branch).
453         foreach ($branches as $branch) {
454             if ($branch->retry == $retry) {
455                 $npages++;
457                 $timeseen = $branch->timeseen;
458             } else {
459                 $table->data[] = array($retry + 1, $npages, $nquestions, $ncorrect, userdate($timeseen));
460                 $retry++;
461                 $npages = 1;
462             }
463         }
464         if ($npages > 0) {
465                 $table->data[] = array($retry + 1, $npages, $nquestions, $ncorrect, userdate($timeseen));
466         }
467         echo html_writer::table($table);
468         echo $OUTPUT->box_end();
469     }
471     return true;
474 /**
475  * Prints lesson summaries on MyMoodle Page
476  *
477  * Prints lesson name, due date and attempt information on
478  * lessons that have a deadline that has not already passed
479  * and it is available for taking.
480  *
481  * @global object
482  * @global stdClass
483  * @global object
484  * @uses CONTEXT_MODULE
485  * @param array $courses An array of course objects to get lesson instances from
486  * @param array $htmlarray Store overview output array( course ID => 'lesson' => HTML output )
487  * @return void
488  */
489 function lesson_print_overview($courses, &$htmlarray) {
490     global $USER, $CFG, $DB, $OUTPUT;
492     if (!$lessons = get_all_instances_in_courses('lesson', $courses)) {
493         return;
494     }
496     // Get all of the current users attempts on all lessons.
497     $params = array($USER->id);
498     $sql = 'SELECT lessonid, userid, count(userid) as attempts
499               FROM {lesson_grades}
500              WHERE userid = ?
501           GROUP BY lessonid, userid';
502     $allattempts = $DB->get_records_sql($sql, $params);
503     $completedattempts = array();
504     foreach ($allattempts as $myattempt) {
505         $completedattempts[$myattempt->lessonid] = $myattempt->attempts;
506     }
508     // Get the current course ID.
509     $listoflessons = array();
510     foreach ($lessons as $lesson) {
511         $listoflessons[] = $lesson->id;
512     }
513     // Get the last page viewed by the current user for every lesson in this course.
514     list($insql, $inparams) = $DB->get_in_or_equal($listoflessons, SQL_PARAMS_NAMED);
515     $dbparams = array_merge($inparams, array('userid' => $USER->id));
517     // Get the lesson attempts for the user that have the maximum 'timeseen' value.
518     $select = "SELECT l.id, l.timeseen, l.lessonid, l.userid, l.retry, l.pageid, l.answerid as nextpageid, p.qtype ";
519     $from = "FROM {lesson_attempts} l
520              JOIN (
521                    SELECT idselect.lessonid, idselect.userid, MAX(idselect.id) AS id
522                      FROM {lesson_attempts} idselect
523                      JOIN (
524                            SELECT lessonid, userid, MAX(timeseen) AS timeseen
525                              FROM {lesson_attempts}
526                             WHERE userid = :userid
527                               AND lessonid $insql
528                          GROUP BY userid, lessonid
529                            ) timeselect
530                        ON timeselect.timeseen = idselect.timeseen
531                       AND timeselect.userid = idselect.userid
532                       AND timeselect.lessonid = idselect.lessonid
533                  GROUP BY idselect.userid, idselect.lessonid
534                    ) aid
535                ON l.id = aid.id
536              JOIN {lesson_pages} p
537                ON l.pageid = p.id ";
538     $lastattempts = $DB->get_records_sql($select . $from, $dbparams);
540     // Now, get the lesson branches for the user that have the maximum 'timeseen' value.
541     $select = "SELECT l.id, l.timeseen, l.lessonid, l.userid, l.retry, l.pageid, l.nextpageid, p.qtype ";
542     $from = str_replace('{lesson_attempts}', '{lesson_branch}', $from);
543     $lastbranches = $DB->get_records_sql($select . $from, $dbparams);
545     $lastviewed = array();
546     foreach ($lastattempts as $lastattempt) {
547         $lastviewed[$lastattempt->lessonid] = $lastattempt;
548     }
550     // Go through the branch times and record the 'timeseen' value if it doesn't exist
551     // for the lesson, or replace it if it exceeds the current recorded time.
552     foreach ($lastbranches as $lastbranch) {
553         if (!isset($lastviewed[$lastbranch->lessonid])) {
554             $lastviewed[$lastbranch->lessonid] = $lastbranch;
555         } else if ($lastviewed[$lastbranch->lessonid]->timeseen < $lastbranch->timeseen) {
556             $lastviewed[$lastbranch->lessonid] = $lastbranch;
557         }
558     }
560     // Since we have lessons in this course, now include the constants we need.
561     require_once($CFG->dirroot . '/mod/lesson/locallib.php');
563     $now = time();
564     foreach ($lessons as $lesson) {
565         if ($lesson->deadline != 0                                         // The lesson has a deadline
566             and $lesson->deadline >= $now                                  // And it is before the deadline has been met
567             and ($lesson->available == 0 or $lesson->available <= $now)) { // And the lesson is available
569             // Visibility.
570             $class = (!$lesson->visible) ? 'dimmed' : '';
572             // Context.
573             $context = context_module::instance($lesson->coursemodule);
575             // Link to activity.
576             $url = new moodle_url('/mod/lesson/view.php', array('id' => $lesson->coursemodule));
577             $url = html_writer::link($url, format_string($lesson->name, true, array('context' => $context)), array('class' => $class));
578             $str = $OUTPUT->box(get_string('lessonname', 'lesson', $url), 'name');
580             // Deadline.
581             $str .= $OUTPUT->box(get_string('lessoncloseson', 'lesson', userdate($lesson->deadline)), 'info');
583             // Attempt information.
584             if (has_capability('mod/lesson:manage', $context)) {
585                 // This is a teacher, Get the Number of user attempts.
586                 $attempts = $DB->count_records('lesson_grades', array('lessonid' => $lesson->id));
587                 $str     .= $OUTPUT->box(get_string('xattempts', 'lesson', $attempts), 'info');
588                 $str      = $OUTPUT->box($str, 'lesson overview');
589             } else {
590                 // This is a student, See if the user has at least started the lesson.
591                 if (isset($lastviewed[$lesson->id]->timeseen)) {
592                     // See if the user has finished this attempt.
593                     if (isset($completedattempts[$lesson->id]) &&
594                              ($completedattempts[$lesson->id] == ($lastviewed[$lesson->id]->retry + 1))) {
595                         // Are additional attempts allowed?
596                         if ($lesson->retake) {
597                             // User can retake the lesson.
598                             $str .= $OUTPUT->box(get_string('additionalattemptsremaining', 'lesson'), 'info');
599                             $str = $OUTPUT->box($str, 'lesson overview');
600                         } else {
601                             // User has completed the lesson and no retakes are allowed.
602                             $str = '';
603                         }
605                     } else {
606                         // The last attempt was not finished or the lesson does not contain questions.
607                         // See if the last page viewed was a branchtable.
608                         require_once($CFG->dirroot . '/mod/lesson/pagetypes/branchtable.php');
609                         if ($lastviewed[$lesson->id]->qtype == LESSON_PAGE_BRANCHTABLE) {
610                             // See if the next pageid is the end of lesson.
611                             if ($lastviewed[$lesson->id]->nextpageid == LESSON_EOL) {
612                                 // The last page viewed was the End of Lesson.
613                                 if ($lesson->retake) {
614                                     // User can retake the lesson.
615                                     $str .= $OUTPUT->box(get_string('additionalattemptsremaining', 'lesson'), 'info');
616                                     $str = $OUTPUT->box($str, 'lesson overview');
617                                 } else {
618                                     // User has completed the lesson and no retakes are allowed.
619                                     $str = '';
620                                 }
622                             } else {
623                                 // The last page viewed was NOT the end of lesson.
624                                 $str .= $OUTPUT->box(get_string('notyetcompleted', 'lesson'), 'info');
625                                 $str = $OUTPUT->box($str, 'lesson overview');
626                             }
628                         } else {
629                             // Last page was a question page, so the attempt is not completed yet.
630                             $str .= $OUTPUT->box(get_string('notyetcompleted', 'lesson'), 'info');
631                             $str = $OUTPUT->box($str, 'lesson overview');
632                         }
633                     }
635                 } else {
636                     // User has not yet started this lesson.
637                     $str .= $OUTPUT->box(get_string('nolessonattempts', 'lesson'), 'info');
638                     $str = $OUTPUT->box($str, 'lesson overview');
639                 }
640             }
641             if (!empty($str)) {
642                 if (empty($htmlarray[$lesson->course]['lesson'])) {
643                     $htmlarray[$lesson->course]['lesson'] = $str;
644                 } else {
645                     $htmlarray[$lesson->course]['lesson'] .= $str;
646                 }
647             }
648         }
649     }
652 /**
653  * Function to be run periodically according to the moodle cron
654  * This function searches for things that need to be done, such
655  * as sending out mail, toggling flags etc ...
656  * @global stdClass
657  * @return bool true
658  */
659 function lesson_cron () {
660     global $CFG;
662     return true;
665 /**
666  * Return grade for given user or all users.
667  *
668  * @global stdClass
669  * @global object
670  * @param int $lessonid id of lesson
671  * @param int $userid optional user id, 0 means all users
672  * @return array array of grades, false if none
673  */
674 function lesson_get_user_grades($lesson, $userid=0) {
675     global $CFG, $DB;
677     $params = array("lessonid" => $lesson->id,"lessonid2" => $lesson->id);
679     if (!empty($userid)) {
680         $params["userid"] = $userid;
681         $params["userid2"] = $userid;
682         $user = "AND u.id = :userid";
683         $fuser = "AND uu.id = :userid2";
684     }
685     else {
686         $user="";
687         $fuser="";
688     }
690     if ($lesson->retake) {
691         if ($lesson->usemaxgrade) {
692             $sql = "SELECT u.id, u.id AS userid, MAX(g.grade) AS rawgrade
693                       FROM {user} u, {lesson_grades} g
694                      WHERE u.id = g.userid AND g.lessonid = :lessonid
695                            $user
696                   GROUP BY u.id";
697         } else {
698             $sql = "SELECT u.id, u.id AS userid, AVG(g.grade) AS rawgrade
699                       FROM {user} u, {lesson_grades} g
700                      WHERE u.id = g.userid AND g.lessonid = :lessonid
701                            $user
702                   GROUP BY u.id";
703         }
704         unset($params['lessonid2']);
705         unset($params['userid2']);
706     } else {
707         // use only first attempts (with lowest id in lesson_grades table)
708         $firstonly = "SELECT uu.id AS userid, MIN(gg.id) AS firstcompleted
709                         FROM {user} uu, {lesson_grades} gg
710                        WHERE uu.id = gg.userid AND gg.lessonid = :lessonid2
711                              $fuser
712                        GROUP BY uu.id";
714         $sql = "SELECT u.id, u.id AS userid, g.grade AS rawgrade
715                   FROM {user} u, {lesson_grades} g, ($firstonly) f
716                  WHERE u.id = g.userid AND g.lessonid = :lessonid
717                        AND g.id = f.firstcompleted AND g.userid=f.userid
718                        $user";
719     }
721     return $DB->get_records_sql($sql, $params);
724 /**
725  * Update grades in central gradebook
726  *
727  * @category grade
728  * @param object $lesson
729  * @param int $userid specific user only, 0 means all
730  * @param bool $nullifnone
731  */
732 function lesson_update_grades($lesson, $userid=0, $nullifnone=true) {
733     global $CFG, $DB;
734     require_once($CFG->libdir.'/gradelib.php');
736     if ($lesson->grade == 0 || $lesson->practice) {
737         lesson_grade_item_update($lesson);
739     } else if ($grades = lesson_get_user_grades($lesson, $userid)) {
740         lesson_grade_item_update($lesson, $grades);
742     } else if ($userid and $nullifnone) {
743         $grade = new stdClass();
744         $grade->userid   = $userid;
745         $grade->rawgrade = null;
746         lesson_grade_item_update($lesson, $grade);
748     } else {
749         lesson_grade_item_update($lesson);
750     }
753 /**
754  * Create grade item for given lesson
755  *
756  * @category grade
757  * @uses GRADE_TYPE_VALUE
758  * @uses GRADE_TYPE_NONE
759  * @param object $lesson object with extra cmidnumber
760  * @param array|object $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
761  * @return int 0 if ok, error code otherwise
762  */
763 function lesson_grade_item_update($lesson, $grades=null) {
764     global $CFG;
765     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
766         require_once($CFG->libdir.'/gradelib.php');
767     }
769     if (array_key_exists('cmidnumber', $lesson)) { //it may not be always present
770         $params = array('itemname'=>$lesson->name, 'idnumber'=>$lesson->cmidnumber);
771     } else {
772         $params = array('itemname'=>$lesson->name);
773     }
775     if (!$lesson->practice and $lesson->grade > 0) {
776         $params['gradetype']  = GRADE_TYPE_VALUE;
777         $params['grademax']   = $lesson->grade;
778         $params['grademin']   = 0;
779     } else if (!$lesson->practice and $lesson->grade < 0) {
780         $params['gradetype']  = GRADE_TYPE_SCALE;
781         $params['scaleid']   = -$lesson->grade;
783         // Make sure current grade fetched correctly from $grades
784         $currentgrade = null;
785         if (!empty($grades)) {
786             if (is_array($grades)) {
787                 $currentgrade = reset($grades);
788             } else {
789                 $currentgrade = $grades;
790             }
791         }
793         // When converting a score to a scale, use scale's grade maximum to calculate it.
794         if (!empty($currentgrade) && $currentgrade->rawgrade !== null) {
795             $grade = grade_get_grades($lesson->course, 'mod', 'lesson', $lesson->id, $currentgrade->userid);
796             $params['grademax']   = reset($grade->items)->grademax;
797         }
798     } else {
799         $params['gradetype']  = GRADE_TYPE_NONE;
800     }
802     if ($grades  === 'reset') {
803         $params['reset'] = true;
804         $grades = null;
805     } else if (!empty($grades)) {
806         // Need to calculate raw grade (Note: $grades has many forms)
807         if (is_object($grades)) {
808             $grades = array($grades->userid => $grades);
809         } else if (array_key_exists('userid', $grades)) {
810             $grades = array($grades['userid'] => $grades);
811         }
812         foreach ($grades as $key => $grade) {
813             if (!is_array($grade)) {
814                 $grades[$key] = $grade = (array) $grade;
815             }
816             //check raw grade isnt null otherwise we erroneously insert a grade of 0
817             if ($grade['rawgrade'] !== null) {
818                 $grades[$key]['rawgrade'] = ($grade['rawgrade'] * $params['grademax'] / 100);
819             } else {
820                 //setting rawgrade to null just in case user is deleting a grade
821                 $grades[$key]['rawgrade'] = null;
822             }
823         }
824     }
826     return grade_update('mod/lesson', $lesson->course, 'mod', 'lesson', $lesson->id, 0, $grades, $params);
829 /**
830  * List the actions that correspond to a view of this module.
831  * This is used by the participation report.
832  *
833  * Note: This is not used by new logging system. Event with
834  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
835  *       be considered as view action.
836  *
837  * @return array
838  */
839 function lesson_get_view_actions() {
840     return array('view','view all');
843 /**
844  * List the actions that correspond to a post of this module.
845  * This is used by the participation report.
846  *
847  * Note: This is not used by new logging system. Event with
848  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
849  *       will be considered as post action.
850  *
851  * @return array
852  */
853 function lesson_get_post_actions() {
854     return array('end','start');
857 /**
858  * Runs any processes that must run before
859  * a lesson insert/update
860  *
861  * @global object
862  * @param object $lesson Lesson form data
863  * @return void
864  **/
865 function lesson_process_pre_save(&$lesson) {
866     global $DB;
868     $lesson->timemodified = time();
870     if (empty($lesson->timelimit)) {
871         $lesson->timelimit = 0;
872     }
873     if (empty($lesson->timespent) or !is_numeric($lesson->timespent) or $lesson->timespent < 0) {
874         $lesson->timespent = 0;
875     }
876     if (!isset($lesson->completed)) {
877         $lesson->completed = 0;
878     }
879     if (empty($lesson->gradebetterthan) or !is_numeric($lesson->gradebetterthan) or $lesson->gradebetterthan < 0) {
880         $lesson->gradebetterthan = 0;
881     } else if ($lesson->gradebetterthan > 100) {
882         $lesson->gradebetterthan = 100;
883     }
885     if (empty($lesson->width)) {
886         $lesson->width = 640;
887     }
888     if (empty($lesson->height)) {
889         $lesson->height = 480;
890     }
891     if (empty($lesson->bgcolor)) {
892         $lesson->bgcolor = '#FFFFFF';
893     }
895     // Conditions for dependency
896     $conditions = new stdClass;
897     $conditions->timespent = $lesson->timespent;
898     $conditions->completed = $lesson->completed;
899     $conditions->gradebetterthan = $lesson->gradebetterthan;
900     $lesson->conditions = serialize($conditions);
901     unset($lesson->timespent);
902     unset($lesson->completed);
903     unset($lesson->gradebetterthan);
905     if (empty($lesson->password)) {
906         unset($lesson->password);
907     }
910 /**
911  * Runs any processes that must be run
912  * after a lesson insert/update
913  *
914  * @global object
915  * @param object $lesson Lesson form data
916  * @return void
917  **/
918 function lesson_process_post_save(&$lesson) {
919     // Update the events relating to this lesson.
920     lesson_update_events($lesson);
924 /**
925  * Implementation of the function for printing the form elements that control
926  * whether the course reset functionality affects the lesson.
927  *
928  * @param $mform form passed by reference
929  */
930 function lesson_reset_course_form_definition(&$mform) {
931     $mform->addElement('header', 'lessonheader', get_string('modulenameplural', 'lesson'));
932     $mform->addElement('advcheckbox', 'reset_lesson', get_string('deleteallattempts','lesson'));
933     $mform->addElement('advcheckbox', 'reset_lesson_user_overrides',
934             get_string('removealluseroverrides', 'lesson'));
935     $mform->addElement('advcheckbox', 'reset_lesson_group_overrides',
936             get_string('removeallgroupoverrides', 'lesson'));
939 /**
940  * Course reset form defaults.
941  * @param object $course
942  * @return array
943  */
944 function lesson_reset_course_form_defaults($course) {
945     return array('reset_lesson' => 1,
946             'reset_lesson_group_overrides' => 1,
947             'reset_lesson_user_overrides' => 1);
950 /**
951  * Removes all grades from gradebook
952  *
953  * @global stdClass
954  * @global object
955  * @param int $courseid
956  * @param string optional type
957  */
958 function lesson_reset_gradebook($courseid, $type='') {
959     global $CFG, $DB;
961     $sql = "SELECT l.*, cm.idnumber as cmidnumber, l.course as courseid
962               FROM {lesson} l, {course_modules} cm, {modules} m
963              WHERE m.name='lesson' AND m.id=cm.module AND cm.instance=l.id AND l.course=:course";
964     $params = array ("course" => $courseid);
965     if ($lessons = $DB->get_records_sql($sql,$params)) {
966         foreach ($lessons as $lesson) {
967             lesson_grade_item_update($lesson, 'reset');
968         }
969     }
972 /**
973  * Actual implementation of the reset course functionality, delete all the
974  * lesson attempts for course $data->courseid.
975  *
976  * @global stdClass
977  * @global object
978  * @param object $data the data submitted from the reset course.
979  * @return array status array
980  */
981 function lesson_reset_userdata($data) {
982     global $CFG, $DB;
984     $componentstr = get_string('modulenameplural', 'lesson');
985     $status = array();
987     if (!empty($data->reset_lesson)) {
988         $lessonssql = "SELECT l.id
989                          FROM {lesson} l
990                         WHERE l.course=:course";
992         $params = array ("course" => $data->courseid);
993         $lessons = $DB->get_records_sql($lessonssql, $params);
995         // Get rid of attempts files.
996         $fs = get_file_storage();
997         if ($lessons) {
998             foreach ($lessons as $lessonid => $unused) {
999                 if (!$cm = get_coursemodule_from_instance('lesson', $lessonid)) {
1000                     continue;
1001                 }
1002                 $context = context_module::instance($cm->id);
1003                 $fs->delete_area_files($context->id, 'mod_lesson', 'essay_responses');
1004             }
1005         }
1007         $DB->delete_records_select('lesson_timer', "lessonid IN ($lessonssql)", $params);
1008         $DB->delete_records_select('lesson_grades', "lessonid IN ($lessonssql)", $params);
1009         $DB->delete_records_select('lesson_attempts', "lessonid IN ($lessonssql)", $params);
1010         $DB->delete_records_select('lesson_branch', "lessonid IN ($lessonssql)", $params);
1012         // remove all grades from gradebook
1013         if (empty($data->reset_gradebook_grades)) {
1014             lesson_reset_gradebook($data->courseid);
1015         }
1017         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'lesson'), 'error'=>false);
1018     }
1020     // Remove user overrides.
1021     if (!empty($data->reset_lesson_user_overrides)) {
1022         $DB->delete_records_select('lesson_overrides',
1023                 'lessonid IN (SELECT id FROM {lesson} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1024         $status[] = array(
1025         'component' => $componentstr,
1026         'item' => get_string('useroverridesdeleted', 'lesson'),
1027         'error' => false);
1028     }
1029     // Remove group overrides.
1030     if (!empty($data->reset_lesson_group_overrides)) {
1031         $DB->delete_records_select('lesson_overrides',
1032         'lessonid IN (SELECT id FROM {lesson} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1033         $status[] = array(
1034         'component' => $componentstr,
1035         'item' => get_string('groupoverridesdeleted', 'lesson'),
1036         'error' => false);
1037     }
1038     /// updating dates - shift may be negative too
1039     if ($data->timeshift) {
1040         $DB->execute("UPDATE {lesson_overrides}
1041                          SET available = available + ?
1042                        WHERE lessonid IN (SELECT id FROM {lesson} WHERE course = ?)
1043                          AND available <> 0", array($data->timeshift, $data->courseid));
1044         $DB->execute("UPDATE {lesson_overrides}
1045                          SET deadline = deadline + ?
1046                        WHERE lessonid IN (SELECT id FROM {lesson} WHERE course = ?)
1047                          AND deadline <> 0", array($data->timeshift, $data->courseid));
1049         shift_course_mod_dates('lesson', array('available', 'deadline'), $data->timeshift, $data->courseid);
1050         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
1051     }
1053     return $status;
1056 /**
1057  * Returns all other caps used in module
1058  * @return array
1059  */
1060 function lesson_get_extra_capabilities() {
1061     return array('moodle/site:accessallgroups');
1064 /**
1065  * @uses FEATURE_GROUPS
1066  * @uses FEATURE_GROUPINGS
1067  * @uses FEATURE_MOD_INTRO
1068  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
1069  * @uses FEATURE_GRADE_HAS_GRADE
1070  * @uses FEATURE_GRADE_OUTCOMES
1071  * @param string $feature FEATURE_xx constant for requested feature
1072  * @return mixed True if module supports feature, false if not, null if doesn't know
1073  */
1074 function lesson_supports($feature) {
1075     switch($feature) {
1076         case FEATURE_GROUPS:
1077             return true;
1078         case FEATURE_GROUPINGS:
1079             return true;
1080         case FEATURE_MOD_INTRO:
1081             return true;
1082         case FEATURE_COMPLETION_TRACKS_VIEWS:
1083             return true;
1084         case FEATURE_GRADE_HAS_GRADE:
1085             return true;
1086         case FEATURE_COMPLETION_HAS_RULES:
1087             return true;
1088         case FEATURE_GRADE_OUTCOMES:
1089             return true;
1090         case FEATURE_BACKUP_MOODLE2:
1091             return true;
1092         case FEATURE_SHOW_DESCRIPTION:
1093             return true;
1094         default:
1095             return null;
1096     }
1099 /**
1100  * Obtains the automatic completion state for this lesson based on any conditions
1101  * in lesson settings.
1102  *
1103  * @param object $course Course
1104  * @param object $cm course-module
1105  * @param int $userid User ID
1106  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1107  * @return bool True if completed, false if not, $type if conditions not set.
1108  */
1109 function lesson_get_completion_state($course, $cm, $userid, $type) {
1110     global $CFG, $DB;
1112     // Get lesson details.
1113     $lesson = $DB->get_record('lesson', array('id' => $cm->instance), '*',
1114             MUST_EXIST);
1116     $result = $type; // Default return value.
1117     // If completion option is enabled, evaluate it and return true/false.
1118     if ($lesson->completionendreached) {
1119         $value = $DB->record_exists('lesson_timer', array(
1120                 'lessonid' => $lesson->id, 'userid' => $userid, 'completed' => 1));
1121         if ($type == COMPLETION_AND) {
1122             $result = $result && $value;
1123         } else {
1124             $result = $result || $value;
1125         }
1126     }
1127     if ($lesson->completiontimespent != 0) {
1128         $duration = $DB->get_field_sql(
1129                         "SELECT SUM(lessontime - starttime)
1130                                FROM {lesson_timer}
1131                               WHERE lessonid = :lessonid
1132                                 AND userid = :userid",
1133                         array('userid' => $userid, 'lessonid' => $lesson->id));
1134         if (!$duration) {
1135             $duration = 0;
1136         }
1137         if ($type == COMPLETION_AND) {
1138             $result = $result && ($lesson->completiontimespent < $duration);
1139         } else {
1140             $result = $result || ($lesson->completiontimespent < $duration);
1141         }
1142     }
1143     return $result;
1145 /**
1146  * This function extends the settings navigation block for the site.
1147  *
1148  * It is safe to rely on PAGE here as we will only ever be within the module
1149  * context when this is called
1150  *
1151  * @param settings_navigation $settings
1152  * @param navigation_node $lessonnode
1153  */
1154 function lesson_extend_settings_navigation($settings, $lessonnode) {
1155     global $PAGE, $DB;
1157     // We want to add these new nodes after the Edit settings node, and before the
1158     // Locally assigned roles node. Of course, both of those are controlled by capabilities.
1159     $keys = $lessonnode->get_children_key_list();
1160     $beforekey = null;
1161     $i = array_search('modedit', $keys);
1162     if ($i === false and array_key_exists(0, $keys)) {
1163         $beforekey = $keys[0];
1164     } else if (array_key_exists($i + 1, $keys)) {
1165         $beforekey = $keys[$i + 1];
1166     }
1168     if (has_capability('mod/lesson:manageoverrides', $PAGE->cm->context)) {
1169         $url = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $PAGE->cm->id));
1170         $node = navigation_node::create(get_string('groupoverrides', 'lesson'),
1171                 new moodle_url($url, array('mode' => 'group')),
1172                 navigation_node::TYPE_SETTING, null, 'mod_lesson_groupoverrides');
1173         $lessonnode->add_node($node, $beforekey);
1175         $node = navigation_node::create(get_string('useroverrides', 'lesson'),
1176                 new moodle_url($url, array('mode' => 'user')),
1177                 navigation_node::TYPE_SETTING, null, 'mod_lesson_useroverrides');
1178         $lessonnode->add_node($node, $beforekey);
1179     }
1181     if (has_capability('mod/lesson:edit', $PAGE->cm->context)) {
1182         $url = new moodle_url('/mod/lesson/view.php', array('id' => $PAGE->cm->id));
1183         $lessonnode->add(get_string('preview', 'lesson'), $url);
1184         $editnode = $lessonnode->add(get_string('edit', 'lesson'));
1185         $url = new moodle_url('/mod/lesson/edit.php', array('id' => $PAGE->cm->id, 'mode' => 'collapsed'));
1186         $editnode->add(get_string('collapsed', 'lesson'), $url);
1187         $url = new moodle_url('/mod/lesson/edit.php', array('id' => $PAGE->cm->id, 'mode' => 'full'));
1188         $editnode->add(get_string('full', 'lesson'), $url);
1189     }
1191     if (has_capability('mod/lesson:viewreports', $PAGE->cm->context)) {
1192         $reportsnode = $lessonnode->add(get_string('reports', 'lesson'));
1193         $url = new moodle_url('/mod/lesson/report.php', array('id'=>$PAGE->cm->id, 'action'=>'reportoverview'));
1194         $reportsnode->add(get_string('overview', 'lesson'), $url);
1195         $url = new moodle_url('/mod/lesson/report.php', array('id'=>$PAGE->cm->id, 'action'=>'reportdetail'));
1196         $reportsnode->add(get_string('detailedstats', 'lesson'), $url);
1197     }
1199     if (has_capability('mod/lesson:grade', $PAGE->cm->context)) {
1200         $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$PAGE->cm->id));
1201         $lessonnode->add(get_string('manualgrading', 'lesson'), $url);
1202     }
1206 /**
1207  * Get list of available import or export formats
1208  *
1209  * Copied and modified from lib/questionlib.php
1210  *
1211  * @param string $type 'import' if import list, otherwise export list assumed
1212  * @return array sorted list of import/export formats available
1213  */
1214 function lesson_get_import_export_formats($type) {
1215     global $CFG;
1216     $fileformats = core_component::get_plugin_list("qformat");
1218     $fileformatname=array();
1219     foreach ($fileformats as $fileformat=>$fdir) {
1220         $format_file = "$fdir/format.php";
1221         if (file_exists($format_file) ) {
1222             require_once($format_file);
1223         } else {
1224             continue;
1225         }
1226         $classname = "qformat_$fileformat";
1227         $format_class = new $classname();
1228         if ($type=='import') {
1229             $provided = $format_class->provide_import();
1230         } else {
1231             $provided = $format_class->provide_export();
1232         }
1233         if ($provided) {
1234             $fileformatnames[$fileformat] = get_string('pluginname', 'qformat_'.$fileformat);
1235         }
1236     }
1237     natcasesort($fileformatnames);
1239     return $fileformatnames;
1242 /**
1243  * Serves the lesson attachments. Implements needed access control ;-)
1244  *
1245  * @package mod_lesson
1246  * @category files
1247  * @param stdClass $course course object
1248  * @param stdClass $cm course module object
1249  * @param stdClass $context context object
1250  * @param string $filearea file area
1251  * @param array $args extra arguments
1252  * @param bool $forcedownload whether or not force download
1253  * @param array $options additional options affecting the file serving
1254  * @return bool false if file not found, does not return if found - justsend the file
1255  */
1256 function lesson_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1257     global $CFG, $DB;
1259     if ($context->contextlevel != CONTEXT_MODULE) {
1260         return false;
1261     }
1263     $fileareas = lesson_get_file_areas();
1264     if (!array_key_exists($filearea, $fileareas)) {
1265         return false;
1266     }
1268     if (!$lesson = $DB->get_record('lesson', array('id'=>$cm->instance))) {
1269         return false;
1270     }
1272     require_course_login($course, true, $cm);
1274     if ($filearea === 'page_contents') {
1275         $pageid = (int)array_shift($args);
1276         if (!$page = $DB->get_record('lesson_pages', array('id'=>$pageid))) {
1277             return false;
1278         }
1279         $fullpath = "/$context->id/mod_lesson/$filearea/$pageid/".implode('/', $args);
1281     } else if ($filearea === 'page_answers' || $filearea === 'page_responses') {
1282         $itemid = (int)array_shift($args);
1283         if (!$pageanswers = $DB->get_record('lesson_answers', array('id' => $itemid))) {
1284             return false;
1285         }
1286         $fullpath = "/$context->id/mod_lesson/$filearea/$itemid/".implode('/', $args);
1288     } else if ($filearea === 'essay_responses') {
1289         $itemid = (int)array_shift($args);
1290         if (!$attempt = $DB->get_record('lesson_attempts', array('id' => $itemid))) {
1291             return false;
1292         }
1293         $fullpath = "/$context->id/mod_lesson/$filearea/$itemid/".implode('/', $args);
1295     } else if ($filearea === 'mediafile') {
1296         if (count($args) > 1) {
1297             // Remove the itemid when it appears to be part of the arguments. If there is only one argument
1298             // then it is surely the file name. The itemid is sometimes used to prevent browser caching.
1299             array_shift($args);
1300         }
1301         $fullpath = "/$context->id/mod_lesson/$filearea/0/".implode('/', $args);
1303     } else {
1304         return false;
1305     }
1307     $fs = get_file_storage();
1308     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1309         return false;
1310     }
1312     // finally send the file
1313     send_stored_file($file, 0, 0, $forcedownload, $options); // download MUST be forced - security!
1316 /**
1317  * Returns an array of file areas
1318  *
1319  * @package  mod_lesson
1320  * @category files
1321  * @return array a list of available file areas
1322  */
1323 function lesson_get_file_areas() {
1324     $areas = array();
1325     $areas['page_contents'] = get_string('pagecontents', 'mod_lesson');
1326     $areas['mediafile'] = get_string('mediafile', 'mod_lesson');
1327     $areas['page_answers'] = get_string('pageanswers', 'mod_lesson');
1328     $areas['page_responses'] = get_string('pageresponses', 'mod_lesson');
1329     $areas['essay_responses'] = get_string('essayresponses', 'mod_lesson');
1330     return $areas;
1333 /**
1334  * Returns a file_info_stored object for the file being requested here
1335  *
1336  * @package  mod_lesson
1337  * @category files
1338  * @global stdClass $CFG
1339  * @param file_browse $browser file browser instance
1340  * @param array $areas file areas
1341  * @param stdClass $course course object
1342  * @param stdClass $cm course module object
1343  * @param stdClass $context context object
1344  * @param string $filearea file area
1345  * @param int $itemid item ID
1346  * @param string $filepath file path
1347  * @param string $filename file name
1348  * @return file_info_stored
1349  */
1350 function lesson_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1351     global $CFG, $DB;
1353     if (!has_capability('moodle/course:managefiles', $context)) {
1354         // No peaking here for students!
1355         return null;
1356     }
1358     // Mediafile area does not have sub directories, so let's select the default itemid to prevent
1359     // the user from selecting a directory to access the mediafile content.
1360     if ($filearea == 'mediafile' && is_null($itemid)) {
1361         $itemid = 0;
1362     }
1364     if (is_null($itemid)) {
1365         return new mod_lesson_file_info($browser, $course, $cm, $context, $areas, $filearea);
1366     }
1368     $fs = get_file_storage();
1369     $filepath = is_null($filepath) ? '/' : $filepath;
1370     $filename = is_null($filename) ? '.' : $filename;
1371     if (!$storedfile = $fs->get_file($context->id, 'mod_lesson', $filearea, $itemid, $filepath, $filename)) {
1372         return null;
1373     }
1375     $itemname = $filearea;
1376     if ($filearea == 'page_contents') {
1377         $itemname = $DB->get_field('lesson_pages', 'title', array('lessonid' => $cm->instance, 'id' => $itemid));
1378         $itemname = format_string($itemname, true, array('context' => $context));
1379     } else {
1380         $areas = lesson_get_file_areas();
1381         if (isset($areas[$filearea])) {
1382             $itemname = $areas[$filearea];
1383         }
1384     }
1386     $urlbase = $CFG->wwwroot . '/pluginfile.php';
1387     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemname, $itemid, true, true, false);
1391 /**
1392  * Return a list of page types
1393  * @param string $pagetype current page type
1394  * @param stdClass $parentcontext Block's parent context
1395  * @param stdClass $currentcontext Current context of block
1396  */
1397 function lesson_page_type_list($pagetype, $parentcontext, $currentcontext) {
1398     $module_pagetype = array(
1399         'mod-lesson-*'=>get_string('page-mod-lesson-x', 'lesson'),
1400         'mod-lesson-view'=>get_string('page-mod-lesson-view', 'lesson'),
1401         'mod-lesson-edit'=>get_string('page-mod-lesson-edit', 'lesson'));
1402     return $module_pagetype;
1405 /**
1406  * Update the lesson activity to include any file
1407  * that was uploaded, or if there is none, set the
1408  * mediafile field to blank.
1409  *
1410  * @param int $lessonid the lesson id
1411  * @param stdClass $context the context
1412  * @param int $draftitemid the draft item
1413  */
1414 function lesson_update_media_file($lessonid, $context, $draftitemid) {
1415     global $DB;
1417     // Set the filestorage object.
1418     $fs = get_file_storage();
1419     // Save the file if it exists that is currently in the draft area.
1420     file_save_draft_area_files($draftitemid, $context->id, 'mod_lesson', 'mediafile', 0);
1421     // Get the file if it exists.
1422     $files = $fs->get_area_files($context->id, 'mod_lesson', 'mediafile', 0, 'itemid, filepath, filename', false);
1423     // Check that there is a file to process.
1424     if (count($files) == 1) {
1425         // Get the first (and only) file.
1426         $file = reset($files);
1427         // Set the mediafile column in the lessons table.
1428         $DB->set_field('lesson', 'mediafile', '/' . $file->get_filename(), array('id' => $lessonid));
1429     } else {
1430         // Set the mediafile column in the lessons table.
1431         $DB->set_field('lesson', 'mediafile', '', array('id' => $lessonid));
1432     }