/**
* Adds an seplment instance
*
* This is done by calling the add_instance() method of the seplment type class
* @param stdClass $data
* @param mod_sepl_mod_form $form
* @return int The instance id of the new seplment
*/
function sepl_add_instance(stdClass $data, mod_sepl_mod_form $form = null)
{
global $CFG;
require_once $CFG->dirroot . '/mod/sepl/locallib.php';
$seplment = new sepl(context_module::instance($data->coursemodule), null, null);
return $seplment->add_instance($data, true);
}
/**
* This function converts all of the base settings for an instance of
* the old seplment to the new format. Then it calls each of the plugins
* to see if they can help upgrade this seplment.
* @param int $oldseplmentid (don't rely on the old seplment type even being installed)
* @param string $log This string gets appended to during the conversion process
* @return bool true or false
*/
public function upgrade_seplment($oldseplmentid, &$log)
{
global $DB, $CFG, $USER;
// Steps to upgrade an seplment.
core_php_time_limit::raise(ASSIGN_MAX_UPGRADE_TIME_SECS);
// Get the module details.
$oldmodule = $DB->get_record('modules', array('name' => 'seplment'), '*', MUST_EXIST);
$params = array('module' => $oldmodule->id, 'instance' => $oldseplmentid);
$oldcoursemodule = $DB->get_record('course_modules', $params, '*', MUST_EXIST);
$oldcontext = context_module::instance($oldcoursemodule->id);
// We used to check for admin capability, but since Moodle 2.7 this is called
// during restore of a mod_seplment module.
// Also note that we do not check for any mod_seplment capabilities, because they can
// be removed so that users don't add new instances of the broken old thing.
if (!has_capability('mod/sepl:addinstance', $oldcontext)) {
$log = get_string('couldnotcreatenewseplmentinstance', 'mod_sepl');
return false;
}
// First insert an sepl instance to get the id.
$oldseplment = $DB->get_record('seplment', array('id' => $oldseplmentid), '*', MUST_EXIST);
$oldversion = get_config('seplment_' . $oldseplment->seplmenttype, 'version');
$data = new stdClass();
$data->course = $oldseplment->course;
$data->name = $oldseplment->name;
$data->intro = $oldseplment->intro;
$data->introformat = $oldseplment->introformat;
$data->alwaysshowdescription = 1;
$data->sendnotifications = $oldseplment->emailteachers;
$data->sendlatenotifications = $oldseplment->emailteachers;
$data->duedate = $oldseplment->timedue;
$data->allowsubmissionsfromdate = $oldseplment->timeavailable;
$data->grade = $oldseplment->grade;
$data->submissiondrafts = $oldseplment->resubmit;
$data->requiresubmissionstatement = 0;
$data->markingworkflow = 0;
$data->markingallocation = 0;
$data->cutoffdate = 0;
// New way to specify no late submissions.
if ($oldseplment->preventlate) {
$data->cutoffdate = $data->duedate;
}
$data->teamsubmission = 0;
$data->requireallteammemberssubmit = 0;
$data->teamsubmissiongroupingid = 0;
$data->blindmarking = 0;
$data->attemptreopenmethod = 'none';
$data->maxattempts = ASSIGN_UNLIMITED_ATTEMPTS;
$newseplment = new sepl(null, null, null);
if (!$newseplment->add_instance($data, false)) {
$log = get_string('couldnotcreatenewseplmentinstance', 'mod_sepl');
return false;
}
// Now create a new coursemodule from the old one.
$newmodule = $DB->get_record('modules', array('name' => 'sepl'), '*', MUST_EXIST);
$newcoursemodule = $this->duplicate_course_module($oldcoursemodule, $newmodule->id, $newseplment->get_instance()->id);
if (!$newcoursemodule) {
$log = get_string('couldnotcreatenewcoursemodule', 'mod_sepl');
return false;
}
// Convert the base database tables (seplment, submission, grade).
// These are used to store information in case a rollback is required.
$gradingarea = null;
$gradingdefinitions = null;
$gradeidmap = array();
$completiondone = false;
$gradesdone = false;
// From this point we want to rollback on failure.
$rollback = false;
try {
$newseplment->set_context(context_module::instance($newcoursemodule->id));
// The course module has now been created - time to update the core tables.
// Copy intro files.
$newseplment->copy_area_files_for_upgrade($oldcontext->id, 'mod_seplment', 'intro', 0, $newseplment->get_context()->id, 'mod_sepl', 'intro', 0);
// Get the plugins to do their bit.
foreach ($newseplment->get_submission_plugins() as $plugin) {
if ($plugin->can_upgrade($oldseplment->seplmenttype, $oldversion)) {
$plugin->enable();
if (!$plugin->upgrade_settings($oldcontext, $oldseplment, $log)) {
$rollback = true;
}
} else {
$plugin->disable();
}
}
foreach ($newseplment->get_feedback_plugins() as $plugin) {
if ($plugin->can_upgrade($oldseplment->seplmenttype, $oldversion)) {
$plugin->enable();
if (!$plugin->upgrade_settings($oldcontext, $oldseplment, $log)) {
$rollback = true;
}
} else {
$plugin->disable();
}
}
// See if there is advanced grading upgrades required.
$gradingarea = $DB->get_record('grading_areas', array('contextid' => $oldcontext->id, 'areaname' => 'submission'), '*', IGNORE_MISSING);
if ($gradingarea) {
$params = array('id' => $gradingarea->id, 'contextid' => $newseplment->get_context()->id, 'component' => 'mod_sepl', 'areaname' => 'submissions');
$DB->update_record('grading_areas', $params);
$gradingdefinitions = $DB->get_records('grading_definitions', array('areaid' => $gradingarea->id));
}
// Upgrade availability data.
\core_availability\info::update_dependency_id_across_course($newcoursemodule->course, 'course_modules', $oldcoursemodule->id, $newcoursemodule->id);
// Upgrade completion data.
$DB->set_field('course_modules_completion', 'coursemoduleid', $newcoursemodule->id, array('coursemoduleid' => $oldcoursemodule->id));
$allcriteria = $DB->get_records('course_completion_criteria', array('moduleinstance' => $oldcoursemodule->id));
foreach ($allcriteria as $criteria) {
$criteria->module = 'sepl';
$criteria->moduleinstance = $newcoursemodule->id;
$DB->update_record('course_completion_criteria', $criteria);
}
$completiondone = true;
// Migrate log entries so we don't lose them.
$logparams = array('cmid' => $oldcoursemodule->id, 'course' => $oldcoursemodule->course);
$DB->set_field('log', 'module', 'sepl', $logparams);
$DB->set_field('log', 'cmid', $newcoursemodule->id, $logparams);
// Copy all the submission data (and get plugins to do their bit).
$oldsubmissions = $DB->get_records('seplment_submissions', array('seplment' => $oldseplmentid));
foreach ($oldsubmissions as $oldsubmission) {
$submission = new stdClass();
$submission->seplment = $newseplment->get_instance()->id;
$submission->userid = $oldsubmission->userid;
$submission->timecreated = $oldsubmission->timecreated;
$submission->timemodified = $oldsubmission->timemodified;
$submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
// Because in mod_seplment there could only be one submission per student, it is always the latest.
$submission->latest = 1;
$submission->id = $DB->insert_record('sepl_submission', $submission);
if (!$submission->id) {
$log .= get_string('couldnotinsertsubmission', 'mod_sepl', $submission->userid);
$rollback = true;
}
foreach ($newseplment->get_submission_plugins() as $plugin) {
if ($plugin->can_upgrade($oldseplment->seplmenttype, $oldversion)) {
if (!$plugin->upgrade($oldcontext, $oldseplment, $oldsubmission, $submission, $log)) {
$rollback = true;
}
}
}
if ($oldsubmission->timemarked) {
// Submission has been graded - create a grade record.
$grade = new stdClass();
$grade->seplment = $newseplment->get_instance()->id;
$grade->userid = $oldsubmission->userid;
$grade->grader = $oldsubmission->teacher;
$grade->timemodified = $oldsubmission->timemarked;
$grade->timecreated = $oldsubmission->timecreated;
$grade->grade = $oldsubmission->grade;
if ($oldsubmission->mailed) {
// The mailed flag goes in the flags table.
$flags = new stdClass();
$flags->userid = $oldsubmission->userid;
$flags->seplment = $newseplment->get_instance()->id;
$flags->mailed = 1;
$DB->insert_record('sepl_user_flags', $flags);
}
$grade->id = $DB->insert_record('sepl_grades', $grade);
if (!$grade->id) {
$log .= get_string('couldnotinsertgrade', 'mod_sepl', $grade->userid);
$rollback = true;
}
// Copy any grading instances.
if ($gradingarea) {
$gradeidmap[$grade->id] = $oldsubmission->id;
foreach ($gradingdefinitions as $definition) {
$params = array('definitionid' => $definition->id, 'itemid' => $oldsubmission->id);
$DB->set_field('grading_instances', 'itemid', $grade->id, $params);
}
}
foreach ($newseplment->get_feedback_plugins() as $plugin) {
if ($plugin->can_upgrade($oldseplment->seplmenttype, $oldversion)) {
if (!$plugin->upgrade($oldcontext, $oldseplment, $oldsubmission, $grade, $log)) {
$rollback = true;
}
}
}
}
}
$newseplment->update_calendar($newcoursemodule->id);
// Reassociate grade_items from the old seplment instance to the new sepl instance.
// This includes outcome linked grade_items.
$params = array('sepl', $newseplment->get_instance()->id, 'seplment', $oldseplment->id);
$sql = 'UPDATE {grade_items} SET itemmodule = ?, iteminstance = ? WHERE itemmodule = ? AND iteminstance = ?';
$DB->execute($sql, $params);
// Create a mapping record to map urls from the old to the new seplment.
$mapping = new stdClass();
$mapping->oldcmid = $oldcoursemodule->id;
$mapping->oldinstance = $oldseplment->id;
$mapping->newcmid = $newcoursemodule->id;
$mapping->newinstance = $newseplment->get_instance()->id;
$mapping->timecreated = time();
$DB->insert_record('seplment_upgrade', $mapping);
$gradesdone = true;
} catch (Exception $exception) {
$rollback = true;
$log .= get_string('conversionexception', 'mod_sepl', $exception->getMessage());
}
if ($rollback) {
// Roll back the grades changes.
if ($gradesdone) {
// Reassociate grade_items from the new sepl instance to the old seplment instance.
$params = array('seplment', $oldseplment->id, 'sepl', $newseplment->get_instance()->id);
$sql = 'UPDATE {grade_items} SET itemmodule = ?, iteminstance = ? WHERE itemmodule = ? AND iteminstance = ?';
$DB->execute($sql, $params);
}
// Roll back the completion changes.
if ($completiondone) {
$DB->set_field('course_modules_completion', 'coursemoduleid', $oldcoursemodule->id, array('coursemoduleid' => $newcoursemodule->id));
$allcriteria = $DB->get_records('course_completion_criteria', array('moduleinstance' => $newcoursemodule->id));
foreach ($allcriteria as $criteria) {
$criteria->module = 'seplment';
$criteria->moduleinstance = $oldcoursemodule->id;
$DB->update_record('course_completion_criteria', $criteria);
}
}
// Roll back the log changes.
$logparams = array('cmid' => $newcoursemodule->id, 'course' => $newcoursemodule->course);
$DB->set_field('log', 'module', 'seplment', $logparams);
$DB->set_field('log', 'cmid', $oldcoursemodule->id, $logparams);
// Roll back the advanced grading update.
if ($gradingarea) {
foreach ($gradeidmap as $newgradeid => $oldsubmissionid) {
foreach ($gradingdefinitions as $definition) {
$DB->set_field('grading_instances', 'itemid', $oldsubmissionid, array('definitionid' => $definition->id, 'itemid' => $newgradeid));
}
}
$params = array('id' => $gradingarea->id, 'contextid' => $oldcontext->id, 'component' => 'mod_seplment', 'areaname' => 'submission');
$DB->update_record('grading_areas', $params);
}
$newseplment->delete_instance();
return false;
}
// Delete the old seplment (use object delete).
$cm = get_coursemodule_from_id('', $oldcoursemodule->id, $oldcoursemodule->course);
if ($cm) {
course_delete_module($cm->id);
}
rebuild_course_cache($oldcoursemodule->course);
return true;
}