ff6ee6d79732ea3ed5ffdd4293229e295f334e4f
[moodle.git] / mod / assign / upgradelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the upgrade code to upgrade from mod_assignment to mod_assign
19  *
20  * @package   mod_assign
21  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /** Include locallib.php */
28 require_once($CFG->dirroot.'/mod/assign/locallib.php');
29 /** Include accesslib.php */
30 require_once($CFG->libdir.'/accesslib.php');
32 /**
33  * The maximum amount of time to spend upgrading a single assignment.
34  * This is intentionally generous (5 mins) as the effect of a timeout
35  * for a legitimate upgrade would be quite harsh (roll back code will not run)
36  */
37 define('ASSIGN_MAX_UPGRADE_TIME_SECS', 300);
39 /**
40  * Class to manage upgrades from mod_assignment to mod_assign
41  *
42  * @package   mod_assign
43  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
44  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 class assign_upgrade_manager {
48     /**
49      * This function converts all of the base settings for an instance of
50      * the old assignment to the new format. Then it calls each of the plugins
51      * to see if they can help upgrade this assignment.
52      * @param int $oldassignmentid (don't rely on the old assignment type even being installed)
53      * @param string $log This string gets appended to during the conversion process
54      * @return bool true or false
55      */
56     public function upgrade_assignment($oldassignmentid, & $log) {
57         // steps to upgrade an assignment
58         global $DB, $CFG, $USER;
59         // steps to upgrade an assignment
61         // is the user the admin? admin check goes here
62         if (!is_siteadmin($USER->id)) {
63               return false;
64         }
66         // should we use a shutdown handler to rollback on timeout?
67         @set_time_limit(ASSIGN_MAX_UPGRADE_TIME_SECS);
70         // get the module details
71         $oldmodule = $DB->get_record('modules', array('name'=>'assignment'), '*', MUST_EXIST);
72         $oldcoursemodule = $DB->get_record('course_modules', array('module'=>$oldmodule->id, 'instance'=>$oldassignmentid), '*', MUST_EXIST);
73         $oldcontext = context_module::instance($oldcoursemodule->id);
75         // first insert an assign instance to get the id
76         $oldassignment = $DB->get_record('assignment', array('id'=>$oldassignmentid), '*', MUST_EXIST);
78         $oldversion = get_config('assignment_' . $oldassignment->assignmenttype, 'version');
80         $data = new stdClass();
81         $data->course = $oldassignment->course;
82         $data->name = $oldassignment->name;
83         $data->intro = $oldassignment->intro;
84         $data->introformat = $oldassignment->introformat;
85         $data->alwaysshowdescription = 1;
86         $data->sendnotifications = $oldassignment->emailteachers;
87         $data->sendlatenotifications = $oldassignment->emailteachers;
88         $data->duedate = $oldassignment->timedue;
89         $data->allowsubmissionsfromdate = $oldassignment->timeavailable;
90         $data->grade = $oldassignment->grade;
91         $data->submissiondrafts = $oldassignment->resubmit;
92         $data->requiresubmissionstatement = 0;
93         $data->cutoffdate = 0;
94         // New way to specify no late submissions.
95         if ($oldassignment->preventlate) {
96             $data->cutoffdate = $data->duedate;
97         }
98         $data->teamsubmission = 0;
99         $data->requireallteammemberssubmit = 0;
100         $data->teamsubmissiongroupingid = 0;
101         $data->blindmarking = 0;
103         $newassignment = new assign(null, null, null);
105         if (!$newassignment->add_instance($data, false)) {
106             $log = get_string('couldnotcreatenewassignmentinstance', 'mod_assign');
107             return false;
108         }
110         // now create a new coursemodule from the old one
111         $newmodule = $DB->get_record('modules', array('name'=>'assign'), '*', MUST_EXIST);
112         $newcoursemodule = $this->duplicate_course_module($oldcoursemodule, $newmodule->id, $newassignment->get_instance()->id);
113         if (!$newcoursemodule) {
114             $log = get_string('couldnotcreatenewcoursemodule', 'mod_assign');
115             return false;
116         }
118         // convert the base database tables (assignment, submission, grade)
120         // these are used to store information in case a rollback is required
121         $gradingarea = null;
122         $gradingdefinitions = null;
123         $gradeidmap = array();
124         $completiondone = false;
125         $gradesdone = false;
127         // from this point we want to rollback on failure
128         $rollback = false;
129         try {
130             $newassignment->set_context(context_module::instance($newcoursemodule->id));
132             // the course module has now been created - time to update the core tables
134             // copy intro files
135             $newassignment->copy_area_files_for_upgrade($oldcontext->id, 'mod_assignment', 'intro', 0,
136                                             $newassignment->get_context()->id, 'mod_assign', 'intro', 0);
139             // get the plugins to do their bit
140             foreach ($newassignment->get_submission_plugins() as $plugin) {
141                 if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
142                     $plugin->enable();
143                     if (!$plugin->upgrade_settings($oldcontext, $oldassignment, $log)) {
144                         $rollback = true;
145                     }
146                 }
147             }
148             foreach ($newassignment->get_feedback_plugins() as $plugin) {
149                 if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
150                     $plugin->enable();
151                     if (!$plugin->upgrade_settings($oldcontext, $oldassignment, $log)) {
152                         $rollback = true;
153                     }
154                 }
155             }
157             // see if there is advanced grading upgrades required
158             $gradingarea = $DB->get_record('grading_areas', array('contextid'=>$oldcontext->id, 'areaname'=>'submission'), '*', IGNORE_MISSING);
159             if ($gradingarea) {
160                 $DB->update_record('grading_areas', array('id'=>$gradingarea->id, 'contextid'=>$newassignment->get_context()->id, 'component'=>'mod_assign', 'areaname'=>'submissions'));
161                 $gradingdefinitions = $DB->get_records('grading_definitions', array('areaid'=>$gradingarea->id));
162             }
164             // upgrade completion data
165             $DB->set_field('course_modules_completion', 'coursemoduleid', $newcoursemodule->id, array('coursemoduleid'=>$oldcoursemodule->id));
166             $allcriteria = $DB->get_records('course_completion_criteria', array('moduleinstance'=>$oldcoursemodule->id));
167             foreach ($allcriteria as $criteria) {
168                 $criteria->module = 'assign';
169                 $criteria->moduleinstance = $newcoursemodule->id;
170                 $DB->update_record('course_completion_criteria', $criteria);
171             }
172             $completiondone = true;
174             // Migrate log entries so we don't lose them.
175             $logparams = array('cmid' => $oldcoursemodule->id, 'course' => $oldcoursemodule->course);
176             $DB->set_field('log', 'module', 'assign', $logparams);
177             $DB->set_field('log', 'cmid', $newcoursemodule->id, $logparams);
180             // copy all the submission data (and get plugins to do their bit)
181             $oldsubmissions = $DB->get_records('assignment_submissions', array('assignment'=>$oldassignmentid));
183             foreach ($oldsubmissions as $oldsubmission) {
184                 $submission = new stdClass();
185                 $submission->assignment = $newassignment->get_instance()->id;
186                 $submission->userid = $oldsubmission->userid;
187                 $submission->timecreated = $oldsubmission->timecreated;
188                 $submission->timemodified = $oldsubmission->timemodified;
189                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
190                 $submission->id = $DB->insert_record('assign_submission', $submission);
191                 if (!$submission->id) {
192                     $log .= get_string('couldnotinsertsubmission', 'mod_assign', $submission->userid);
193                     $rollback = true;
194                 }
195                 foreach ($newassignment->get_submission_plugins() as $plugin) {
196                     if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
197                         if (!$plugin->upgrade($oldcontext, $oldassignment, $oldsubmission, $submission, $log)) {
198                             $rollback = true;
199                         }
200                     }
201                 }
202                 if ($oldsubmission->timemarked) {
203                     // submission has been graded - create a grade record
204                     $grade = new stdClass();
205                     $grade->assignment = $newassignment->get_instance()->id;
206                     $grade->userid = $oldsubmission->userid;
207                     $grade->grader = $oldsubmission->teacher;
208                     $grade->timemodified = $oldsubmission->timemarked;
209                     $grade->timecreated = $oldsubmission->timecreated;
210                     // $grade->locked = $oldsubmission->locked;
211                     $grade->grade = $oldsubmission->grade;
212                     $grade->mailed = $oldsubmission->mailed;
213                     $grade->id = $DB->insert_record('assign_grades', $grade);
214                     if (!$grade->id) {
215                         $log .= get_string('couldnotinsertgrade', 'mod_assign', $grade->userid);
216                         $rollback = true;
217                     }
219                     // copy any grading instances
220                     if ($gradingarea) {
222                         $gradeidmap[$grade->id] = $oldsubmission->id;
224                         foreach ($gradingdefinitions as $definition) {
225                             $DB->set_field('grading_instances', 'itemid', $grade->id, array('definitionid'=>$definition->id, 'itemid'=>$oldsubmission->id));
226                         }
228                     }
229                     foreach ($newassignment->get_feedback_plugins() as $plugin) {
230                         if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
231                             if (!$plugin->upgrade($oldcontext, $oldassignment, $oldsubmission, $grade, $log)) {
232                                 $rollback = true;
233                             }
234                         }
235                     }
236                 }
237             }
239             $newassignment->update_calendar($newcoursemodule->id);
241             // copy the grades from the old assignment to the new one
243             $gradeitem = $DB->get_record('grade_items', array('iteminstance'=>$oldassignment->id, 'itemmodule'=>'assignment'), 'id', IGNORE_MISSING);
244             if ($gradeitem) {
245                 $gradeitem->iteminstance = $newassignment->get_instance()->id;
246                 $gradeitem->itemmodule = 'assign';
247                 $DB->update_record('grade_items', $gradeitem);
248             }
249             $gradesdone = true;
251         } catch (Exception $exception) {
252             $rollback = true;
253             $log .= get_string('conversionexception', 'mod_assign', $exception->error);
254         }
256         if ($rollback) {
257             // roll back the grades changes
258             if ($gradesdone) {
259                 // copy the grades from the old assignment to the new one
260                 $gradeitem = $DB->get_record('grade_items', array('iteminstance'=>$newassignment->get_instance()->id, 'itemmodule'=>'assign'), 'id', IGNORE_MISSING);
261                 if ($gradeitem) {
262                     $gradeitem->iteminstance = $oldassignment->id;
263                     $gradeitem->itemmodule = 'assignment';
264                     $DB->update_record('grade_items', $gradeitem);
265                 }
266             }
267             // roll back the completion changes
268             if ($completiondone) {
269                 $DB->set_field('course_modules_completion', 'coursemoduleid', $oldcoursemodule->id, array('coursemoduleid'=>$newcoursemodule->id));
270                 $allcriteria = $DB->get_records('course_completion_criteria', array('moduleinstance'=>$newcoursemodule->id));
271                 foreach ($allcriteria as $criteria) {
272                     $criteria->module = 'assignment';
273                     $criteria->moduleinstance = $oldcoursemodule->id;
274                     $DB->update_record('course_completion_criteria', $criteria);
275                 }
276             }
277             // Roll back the log changes
278             $logparams = array('cmid' => $newcoursemodule->id, 'course' => $newcoursemodule->course);
279             $DB->set_field('log', 'module', 'assignment', $logparams);
280             $DB->set_field('log', 'cmid', $oldcoursemodule->id, $logparams);
281             // roll back the advanced grading update
282             if ($gradingarea) {
283                 foreach ($gradeidmap as $newgradeid => $oldsubmissionid) {
284                     foreach ($gradingdefinitions as $definition) {
285                         $DB->set_field('grading_instances', 'itemid', $oldsubmissionid, array('definitionid'=>$definition->id, 'itemid'=>$newgradeid));
286                     }
287                 }
288                 $DB->update_record('grading_areas', array('id'=>$gradingarea->id, 'contextid'=>$oldcontext->id, 'component'=>'mod_assignment', 'areaname'=>'submission'));
289             }
290             $newassignment->delete_instance();
292             return false;
293         }
294         // all is well,
295         // delete the old assignment (use object delete)
296         $cm = get_coursemodule_from_id('', $oldcoursemodule->id, $oldcoursemodule->course);
297         if ($cm) {
298             $this->delete_course_module($cm);
299         }
300         rebuild_course_cache($oldcoursemodule->course);
301         return true;
302     }
305     /**
306      * Create a duplicate course module record so we can create the upgraded
307      * assign module alongside the old assignment module.
308      *
309      * @param stdClass $cm The old course module record
310      * @param int $moduleid The id of the new assign module
311      * @param int $newinstanceid The id of the new instance of the assign module
312      * @return mixed stdClass|bool The new course module record or FALSE
313      */
314     private function duplicate_course_module(stdClass $cm, $moduleid, $newinstanceid) {
315         global $DB, $CFG;
317         $newcm = new stdClass();
318         $newcm->course           = $cm->course;
319         $newcm->module           = $moduleid;
320         $newcm->instance         = $newinstanceid;
321         $newcm->visible          = $cm->visible;
322         $newcm->section          = $cm->section;
323         $newcm->score            = $cm->score;
324         $newcm->indent           = $cm->indent;
325         $newcm->groupmode        = $cm->groupmode;
326         $newcm->groupingid       = $cm->groupingid;
327         $newcm->groupmembersonly = $cm->groupmembersonly;
328         $newcm->completion                = $cm->completion;
329         $newcm->completiongradeitemnumber = $cm->completiongradeitemnumber;
330         $newcm->completionview            = $cm->completionview;
331         $newcm->completionexpected        = $cm->completionexpected;
332         if(!empty($CFG->enableavailability)) {
333             $newcm->availablefrom             = $cm->availablefrom;
334             $newcm->availableuntil            = $cm->availableuntil;
335             $newcm->showavailability          = $cm->showavailability;
336         }
337         $newcm->showdescription = $cm->showdescription;
339         $newcmid = add_course_module($newcm);
340         $newcm = get_coursemodule_from_id('', $newcmid, $cm->course);
341         if (!$newcm) {
342             return false;
343         }
344         $section = $DB->get_record("course_sections", array("id"=>$newcm->section));
345         if (!$section) {
346             return false;
347         }
349         $newcm->section = course_add_cm_to_section($newcm->course, $newcm->id, $section->section);
351         // make sure visibility is set correctly (in particular in calendar)
352         // note: allow them to set it even without moodle/course:activityvisibility
353         set_coursemodule_visible($newcm->id, $newcm->visible);
355         return $newcm;
356     }
358     /**
359      * This function deletes the old assignment course module after
360      * it has been upgraded. This code is adapted from "course/mod.php".
361      *
362      * @param stdClass $cm The course module to delete.
363      * @return bool
364      */
365     private function delete_course_module($cm) {
366         global $CFG, $USER, $DB, $OUTPUT;
367         $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
369         $coursecontext = context_course::instance($course->id);
370         $modcontext = context_module::instance($cm->id);
372         $modlib = "$CFG->dirroot/mod/$cm->modname/lib.php";
374         if (file_exists($modlib)) {
375             require_once($modlib);
376         } else {
377             print_error('modulemissingcode', '', '', $modlib);
378         }
380         $deleteinstancefunction = $cm->modname."_delete_instance";
382         if (!$deleteinstancefunction($cm->instance)) {
383             echo $OUTPUT->notification("Could not delete the $cm->modname (instance)");
384         }
386         // remove all module files in case modules forget to do that
387         $fs = get_file_storage();
388         $fs->delete_area_files($modcontext->id);
390         if (!delete_course_module($cm->id)) {
391             echo $OUTPUT->notification("Could not delete the $cm->modname (coursemodule)");
392         }
393         if (!delete_mod_from_section($cm->id, $cm->section)) {
394             echo $OUTPUT->notification("Could not delete the $cm->modname from that section");
395         }
397         // Trigger a mod_deleted event with information about this module.
398         $eventdata = new stdClass();
399         $eventdata->modulename = $cm->modname;
400         $eventdata->cmid       = $cm->id;
401         $eventdata->courseid   = $course->id;
402         $eventdata->userid     = $USER->id;
403         events_trigger('mod_deleted', $eventdata);
405         add_to_log($course->id, 'course', "delete mod",
406                    "view.php?id=$cm->course",
407                    "$cm->modname $cm->instance", $cm->id);
409         return true;
410     }