id = insert_record("lesson", $lesson)) { return false; // bad } lesson_process_post_save($lesson); lesson_grade_item_update(stripslashes_recursive($lesson)); return $lesson->id; } /** * Given an object containing all the necessary data, * (defined by the form in mod_form.php) this function * will update an existing instance with new data. * * @param object $lesson Lesson post data from the form * @return boolean **/ function lesson_update_instance($lesson) { $lesson->id = $lesson->instance; lesson_process_pre_save($lesson); if (!$result = update_record("lesson", $lesson)) { return false; // Awe man! } lesson_process_post_save($lesson); // update grade item definition lesson_grade_item_update(stripslashes_recursive($lesson)); // update grades - TODO: do it only when grading style changes lesson_update_grades(stripslashes_recursive($lesson), 0, false); return $result; } /*******************************************************************/ function lesson_delete_instance($id) { /// Given an ID of an instance of this module, /// this function will permanently delete the instance /// and any data that depends on it. if (! $lesson = get_record("lesson", "id", "$id")) { return false; } $result = true; if (! delete_records("lesson", "id", "$lesson->id")) { $result = false; } if (! delete_records("lesson_pages", "lessonid", "$lesson->id")) { $result = false; } if (! delete_records("lesson_answers", "lessonid", "$lesson->id")) { $result = false; } if (! delete_records("lesson_attempts", "lessonid", "$lesson->id")) { $result = false; } if (! delete_records("lesson_grades", "lessonid", "$lesson->id")) { $result = false; } if (! delete_records("lesson_timer", "lessonid", "$lesson->id")) { $result = false; } if (! delete_records("lesson_branch", "lessonid", "$lesson->id")) { $result = false; } if (! delete_records("lesson_high_scores", "lessonid", "$lesson->id")) { $result = false; } if ($events = get_records_select('event', "modulename = 'lesson' and instance = '$lesson->id'")) { foreach($events as $event) { delete_event($event->id); } } $pagetypes = page_import_types('mod/lesson/'); foreach ($pagetypes as $pagetype) { if (!blocks_delete_all_on_page($pagetype, $lesson->id)) { $result = false; } } lesson_grade_item_delete($lesson); return $result; } /** * Given a course object, this function will clean up anything that * would be leftover after all the instances were deleted. * * As of now, this function just cleans the lesson_default table * * @param object $course an object representing the course that is being deleted * @param boolean $feedback to specify if the process must output a summary of its work * @return boolean */ function lesson_delete_course($course, $feedback=true) { $count = count_records('lesson_default', 'course', $course->id); delete_records('lesson_default', 'course', $course->id); //Inform about changes performed if feedback is enabled if ($feedback) { notify(get_string('deletedefaults', 'lesson', $count)); } return true; } /*******************************************************************/ function lesson_user_outline($course, $user, $mod, $lesson) { /// Return a small object with summary information about what a /// user has done with a given particular instance of this module /// Used for user activity reports. /// $return->time = the time they did it /// $return->info = a short text description global $CFG; require_once("$CFG->libdir/gradelib.php"); $grades = grade_get_grades($course->id, 'mod', 'lesson', $lesson->id, $user->id); if (empty($grades->items[0]->grades)) { $return->info = get_string("no")." ".get_string("attempts", "lesson"); } else { $grade = reset($grades->items[0]->grades); $return->info = get_string("grade") . ': ' . $grade->str_long_grade; $return->time = $grade->dategraded; } return $return; } /*******************************************************************/ function lesson_user_complete($course, $user, $mod, $lesson) { /// Print a detailed representation of what a user has done with /// a given particular instance of this module, for user activity reports. global $CFG; require_once("$CFG->libdir/gradelib.php"); $grades = grade_get_grades($course->id, 'mod', 'lesson', $lesson->id, $user->id); if (!empty($grades->items[0]->grades)) { $grade = reset($grades->items[0]->grades); echo '
'.get_string('grade').': '.$grade->str_long_grade.'
'; if ($grade->str_feedback) { echo ''.get_string('feedback').': '.$grade->str_feedback.'
'; } } if ($attempts = get_records_select("lesson_attempts", "lessonid = $lesson->id AND userid = $user->id", "retry, timeseen")) { print_simple_box_start(); $table->head = array (get_string("attempt", "lesson"), get_string("numberofpagesviewed", "lesson"), get_string("numberofcorrectanswers", "lesson"), get_string("time")); $table->width = "100%"; $table->align = array ("center", "center", "center", "center"); $table->size = array ("*", "*", "*", "*"); $table->cellpadding = 2; $table->cellspacing = 0; $retry = 0; $npages = 0; $ncorrect = 0; foreach ($attempts as $attempt) { if ($attempt->retry == $retry) { $npages++; if ($attempt->correct) { $ncorrect++; } $timeseen = $attempt->timeseen; } else { $table->data[] = array($retry + 1, $npages, $ncorrect, userdate($timeseen)); $retry++; $npages = 1; if ($attempt->correct) { $ncorrect = 1; } else { $ncorrect = 0; } } } if ($npages) { $table->data[] = array($retry + 1, $npages, $ncorrect, userdate($timeseen)); } print_table($table); print_simple_box_end(); } return true; } /** * Prints lesson summaries on MyMoodle Page * * Prints lesson name, due date and attempt information on * lessons that have a deadline that has not already passed * and it is available for taking. * * @param array $courses An array of course objects to get lesson instances from * @param array $htmlarray Store overview output array( course ID => 'lesson' => HTML output ) */ function lesson_print_overview($courses, &$htmlarray) { global $USER, $CFG; if (!$lessons = get_all_instances_in_courses('lesson', $courses)) { return; } /// Get Necessary Strings $strlesson = get_string('modulename', 'lesson'); $strnotattempted = get_string('nolessonattempts', 'lesson'); $strattempted = get_string('lessonattempted', 'lesson'); $now = time(); foreach ($lessons as $lesson) { if ($lesson->deadline != 0 // The lesson has a deadline and $lesson->deadline >= $now // And it is before the deadline has been met and ($lesson->available == 0 or $lesson->available <= $now)) { // And the lesson is available // Lesson name if (!$lesson->visible) { $class = ' class="dimmed"'; } else { $class = ''; } $str = print_box("$strlesson: wwwroot/mod/lesson/view.php?id=$lesson->coursemodule\">". format_string($lesson->name).'', 'name', '', true); // Deadline $str .= print_box(get_string('lessoncloseson', 'lesson', userdate($lesson->deadline)), 'info', '', true); // Attempt information if (has_capability('mod/lesson:manage', get_context_instance(CONTEXT_MODULE, $lesson->coursemodule))) { // Number of user attempts $attempts = count_records('lesson_attempts', 'lessonid', $lesson->id); $str .= print_box(get_string('xattempts', 'lesson', $attempts), 'info', '', true); } else { // Determine if the user has attempted the lesson or not if (count_records('lesson_attempts', 'lessonid', $lesson->id, 'userid', $USER->id)) { $str .= print_box($strattempted, 'info', '', true); } else { $str .= print_box($strnotattempted, 'info', '', true); } } $str = print_box($str, 'lesson overview', '', true); if (empty($htmlarray[$lesson->course]['lesson'])) { $htmlarray[$lesson->course]['lesson'] = $str; } else { $htmlarray[$lesson->course]['lesson'] .= $str; } } } } /*******************************************************************/ function lesson_cron () { /// Function to be run periodically according to the moodle cron /// This function searches for things that need to be done, such /// as sending out mail, toggling flags etc ... global $CFG; return true; } /** * Return grade for given user or all users. * * @param int $lessonid id of lesson * @param int $userid optional user id, 0 means all users * @return array array of grades, false if none */ function lesson_get_user_grades($lesson, $userid=0) { global $CFG; $user = $userid ? "AND u.id = $userid" : ""; $fuser = $userid ? "AND uu.id = $userid" : ""; if ($lesson->retake) { if ($lesson->usemaxgrade) { $sql = "SELECT u.id, u.id AS userid, MAX(g.grade) AS rawgrade FROM {$CFG->prefix}user u, {$CFG->prefix}lesson_grades g WHERE u.id = g.userid AND g.lessonid = $lesson->id $user GROUP BY u.id"; } else { $sql = "SELECT u.id, u.id AS userid, AVG(g.grade) AS rawgrade FROM {$CFG->prefix}user u, {$CFG->prefix}lesson_grades g WHERE u.id = g.userid AND g.lessonid = $lesson->id $user GROUP BY u.id"; } } else { // use only first attempts (with lowest id in lesson_grades table) $firstonly = "SELECT uu.id AS userid, MIN(gg.id) AS firstcompleted FROM {$CFG->prefix}user uu, {$CFG->prefix}lesson_grades gg WHERE uu.id = gg.userid AND gg.lessonid = $lesson->id $fuser GROUP BY uu.id"; $sql = "SELECT u.id, u.id AS userid, g.grade AS rawgrade FROM {$CFG->prefix}user u, {$CFG->prefix}lesson_grades g, ($firstonly) f WHERE u.id = g.userid AND g.lessonid = $lesson->id AND g.id = f.firstcompleted AND g.userid=f.userid $user"; } return get_records_sql($sql); } /** * Update grades in central gradebook * * @param object $lesson null means all lessons * @param int $userid specific user only, 0 mean all */ function lesson_update_grades($lesson=null, $userid=0, $nullifnone=true) { global $CFG; if (!function_exists('grade_update')) { //workaround for buggy PHP versions require_once($CFG->libdir.'/gradelib.php'); } if ($lesson != null) { if ($grades = lesson_get_user_grades($lesson, $userid)) { lesson_grade_item_update($lesson, $grades); } else if ($userid and $nullifnone) { $grade = new object(); $grade->userid = $userid; $grade->rawgrade = NULL; lesson_grade_item_update($lesson, $grade); } else { lesson_grade_item_update($lesson); } } else { $sql = "SELECT l.*, cm.idnumber as cmidnumber, l.course as courseid FROM {$CFG->prefix}lesson l, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m WHERE m.name='lesson' AND m.id=cm.module AND cm.instance=l.id"; if ($rs = get_recordset_sql($sql)) { while ($lesson = rs_fetch_next_record($rs)) { if ($lesson->grade != 0) { lesson_update_grades($lesson, 0, false); } else { lesson_grade_item_update($lesson); } } rs_close($rs); } } } /** * Create grade item for given lesson * * @param object $lesson object with extra cmidnumber * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook * @return int 0 if ok, error code otherwise */ function lesson_grade_item_update($lesson, $grades=NULL) { global $CFG; if (!function_exists('grade_update')) { //workaround for buggy PHP versions require_once($CFG->libdir.'/gradelib.php'); } if (array_key_exists('cmidnumber', $lesson)) { //it may not be always present $params = array('itemname'=>$lesson->name, 'idnumber'=>$lesson->cmidnumber); } else { $params = array('itemname'=>$lesson->name); } if ($lesson->grade > 0) { $params['gradetype'] = GRADE_TYPE_VALUE; $params['grademax'] = $lesson->grade; $params['grademin'] = 0; } else { $params['gradetype'] = GRADE_TYPE_NONE; } if ($grades === 'reset') { $params['reset'] = true; $grades = NULL; } else if (!empty($grades)) { // Need to calculate raw grade (Note: $grades has many forms) if (is_object($grades)) { $grades = array($grades->userid => $grades); } else if (array_key_exists('userid', $grades)) { $grades = array($grades['userid'] => $grades); } foreach ($grades as $key => $grade) { if (!is_array($grade)) { $grades[$key] = $grade = (array) $grade; } $grades[$key]['rawgrade'] = ($grade['rawgrade'] * $lesson->grade / 100); } } return grade_update('mod/lesson', $lesson->course, 'mod', 'lesson', $lesson->id, 0, $grades, $params); } /** * Delete grade item for given lesson * * @param object $lesson object * @return object lesson */ function lesson_grade_item_delete($lesson) { global $CFG; require_once($CFG->libdir.'/gradelib.php'); return grade_update('mod/lesson', $lesson->course, 'mod', 'lesson', $lesson->id, 0, NULL, array('deleted'=>1)); } /*******************************************************************/ function lesson_get_participants($lessonid) { //Must return an array of user records (all data) who are participants //for a given instance of lesson. Must include every user involved //in the instance, independient of his role (student, teacher, admin...) global $CFG; //Get students $students = get_records_sql("SELECT DISTINCT u.id, u.id FROM {$CFG->prefix}user u, {$CFG->prefix}lesson_attempts a WHERE a.lessonid = '$lessonid' and u.id = a.userid"); //Return students array (it contains an array of unique users) return ($students); } function lesson_get_view_actions() { return array('view','view all'); } function lesson_get_post_actions() { return array('end','start', 'update grade attempt'); } /** * Runs any processes that must run before * a lesson insert/update * * @param object $lesson Lesson form data * @return void **/ function lesson_process_pre_save(&$lesson) { $lesson->timemodified = time(); if (empty($lesson->timed)) { $lesson->timed = 0; } if (empty($lesson->timespent) or !is_numeric($lesson->timespent) or $lesson->timespent < 0) { $lesson->timespent = 0; } if (!isset($lesson->completed)) { $lesson->completed = 0; } if (empty($lesson->gradebetterthan) or !is_numeric($lesson->gradebetterthan) or $lesson->gradebetterthan < 0) { $lesson->gradebetterthan = 0; } else if ($lesson->gradebetterthan > 100) { $lesson->gradebetterthan = 100; } // Conditions for dependency $conditions = new stdClass; $conditions->timespent = $lesson->timespent; $conditions->completed = $lesson->completed; $conditions->gradebetterthan = $lesson->gradebetterthan; $lesson->conditions = addslashes(serialize($conditions)); unset($lesson->timespent); unset($lesson->completed); unset($lesson->gradebetterthan); if (empty($lesson->password)) { unset($lesson->password); } if ($lesson->lessondefault) { $default = new stdClass; $default = clone($lesson); unset($default->name); unset($default->timemodified); unset($default->available); unset($default->deadline); if ($default->id = get_field('lesson_default', 'id', 'course', $default->course)) { update_record('lesson_default', $default); } else { insert_record('lesson_default', $default); } } unset($lesson->lessondefault); } /** * Runs any processes that must be run * after a lesson insert/update * * @param object $lesson Lesson form data * @return void **/ function lesson_process_post_save(&$lesson) { if ($events = get_records_select('event', "modulename = 'lesson' and instance = '$lesson->id'")) { foreach($events as $event) { delete_event($event->id); } } $event = new stdClass; $event->description = $lesson->name; $event->courseid = $lesson->course; $event->groupid = 0; $event->userid = 0; $event->modulename = 'lesson'; $event->instance = $lesson->id; $event->eventtype = 'open'; $event->timestart = $lesson->available; $event->visible = instance_is_visible('lesson', $lesson); $event->timeduration = ($lesson->deadline - $lesson->available); if ($lesson->deadline and $lesson->available and $event->timeduration <= LESSON_MAX_EVENT_LENGTH) { // Single event for the whole lesson. $event->name = $lesson->name; add_event($event); } else { // Separate start and end events. $event->timeduration = 0; if ($lesson->available) { $event->name = $lesson->name.' ('.get_string('lessonopens', 'lesson').')'; add_event($event); unset($event->id); // So we can use the same object for the close event. } if ($lesson->deadline) { $event->name = $lesson->name.' ('.get_string('lessoncloses', 'lesson').')'; $event->timestart = $lesson->deadline; $event->eventtype = 'close'; add_event($event); } } } /** * Implementation of the function for printing the form elements that control * whether the course reset functionality affects the lesson. * @param $mform form passed by reference */ function lesson_reset_course_form_definition(&$mform) { $mform->addElement('header', 'lessonheader', get_string('modulenameplural', 'lesson')); $mform->addElement('advcheckbox', 'reset_lesson', get_string('deleteallattempts','lesson')); } /** * Course reset form defaults. */ function lesson_reset_course_form_defaults($course) { return array('reset_lesson'=>1); } /** * Removes all grades from gradebook * @param int $courseid * @param string optional type */ function lesson_reset_gradebook($courseid, $type='') { global $CFG; $sql = "SELECT l.*, cm.idnumber as cmidnumber, l.course as courseid FROM {$CFG->prefix}lesson l, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m WHERE m.name='lesson' AND m.id=cm.module AND cm.instance=l.id AND l.course=$courseid"; if ($lessons = get_records_sql($sql)) { foreach ($lessons as $lesson) { lesson_grade_item_update($lesson, 'reset'); } } } /** * Actual implementation of the rest coures functionality, delete all the * lesson attempts for course $data->courseid. * @param $data the data submitted from the reset course. * @return array status array */ function lesson_reset_userdata($data) { global $CFG; $componentstr = get_string('modulenameplural', 'lesson'); $status = array(); if (!empty($data->reset_lesson)) { $lessonssql = "SELECT l.id FROM {$CFG->prefix}lesson l WHERE l.course={$data->courseid}"; delete_records_select('lesson_timer', "lessonid IN ($lessonssql)"); delete_records_select('lesson_high_scores', "lessonid IN ($lessonssql)"); delete_records_select('lesson_grades', "lessonid IN ($lessonssql)"); delete_records_select('lesson_attempts', "lessonid IN ($lessonssql)"); // remove all grades from gradebook if (empty($data->reset_gradebook_grades)) { lesson_reset_gradebook($data->courseid); } $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'lesson'), 'error'=>false); } /// updating dates - shift may be negative too if ($data->timeshift) { shift_course_mod_dates('lesson', array('available', 'deadline'), $data->timeshift, $data->courseid); $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false); } return $status; } /** * Returns all other caps used in module */ function lesson_get_extra_capabilities() { return array('moodle/site:accessallgroups'); } /** * Tells if files in moddata are trusted and can be served without XSS protection. * @return bool true if file can be submitted by teacher only (trusted), false otherwise */ function lesson_is_moddata_trusted() { return true; } ?>