MDL-33877: Prevent duplicate records in grade items table after running assignment...
[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->preventlatesubmissions = $oldassignment->preventlate;
94         $newassignment = new assign(null, null, null);
96         if (!$newassignment->add_instance($data, false)) {
97             $log = get_string('couldnotcreatenewassignmentinstance', 'mod_assign');
98             return false;
99         }
101         // now create a new coursemodule from the old one
102         $newmodule = $DB->get_record('modules', array('name'=>'assign'), '*', MUST_EXIST);
103         $newcoursemodule = $this->duplicate_course_module($oldcoursemodule, $newmodule->id, $newassignment->get_instance()->id);
104         if (!$newcoursemodule) {
105             $log = get_string('couldnotcreatenewcoursemodule', 'mod_assign');
106             return false;
107         }
109         // convert the base database tables (assignment, submission, grade)
111         // these are used to store information in case a rollback is required
112         $gradingarea = null;
113         $gradingdefinitions = null;
114         $gradeidmap = array();
115         $completiondone = false;
116         $gradesdone = false;
118         // from this point we want to rollback on failure
119         $rollback = false;
120         try {
121             $newassignment->set_context(context_module::instance($newcoursemodule->id));
123             // the course module has now been created - time to update the core tables
125             // copy intro files
126             $newassignment->copy_area_files_for_upgrade($oldcontext->id, 'mod_assignment', 'intro', 0,
127                                             $newassignment->get_context()->id, 'mod_assign', 'intro', 0);
130             // get the plugins to do their bit
131             foreach ($newassignment->get_submission_plugins() as $plugin) {
132                 if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
133                     $plugin->enable();
134                     if (!$plugin->upgrade_settings($oldcontext, $oldassignment, $log)) {
135                         $rollback = true;
136                     }
137                 }
138             }
139             foreach ($newassignment->get_feedback_plugins() as $plugin) {
140                 if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
141                     $plugin->enable();
142                     if (!$plugin->upgrade_settings($oldcontext, $oldassignment, $log)) {
143                         $rollback = true;
144                     }
145                 }
146             }
148             // see if there is advanced grading upgrades required
149             $gradingarea = $DB->get_record('grading_areas', array('contextid'=>$oldcontext->id, 'areaname'=>'submission'), '*', IGNORE_MISSING);
150             if ($gradingarea) {
151                 $DB->update_record('grading_areas', array('id'=>$gradingarea->id, 'contextid'=>$newassignment->get_context()->id, 'component'=>'mod_assign', 'areaname'=>'submissions'));
152                 $gradingdefinitions = $DB->get_records('grading_definitions', array('areaid'=>$gradingarea->id));
153             }
155             // upgrade completion data
156             $DB->set_field('course_modules_completion', 'coursemoduleid', $newcoursemodule->id, array('coursemoduleid'=>$oldcoursemodule->id));
157             $allcriteria = $DB->get_records('course_completion_criteria', array('moduleinstance'=>$oldcoursemodule->id));
158             foreach ($allcriteria as $criteria) {
159                 $criteria->module = 'assign';
160                 $criteria->moduleinstance = $newcoursemodule->id;
161                 $DB->update_record('course_completion_criteria', $criteria);
162             }
163             $completiondone = true;
166             // copy all the submission data (and get plugins to do their bit)
167             $oldsubmissions = $DB->get_records('assignment_submissions', array('assignment'=>$oldassignmentid));
169             foreach ($oldsubmissions as $oldsubmission) {
170                 $submission = new stdClass();
171                 $submission->assignment = $newassignment->get_instance()->id;
172                 $submission->userid = $oldsubmission->userid;
173                 $submission->timecreated = $oldsubmission->timecreated;
174                 $submission->timemodified = $oldsubmission->timemodified;
175                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
176                 $submission->id = $DB->insert_record('assign_submission', $submission);
177                 if (!$submission->id) {
178                     $log .= get_string('couldnotinsertsubmission', 'mod_assign', $submission->userid);
179                     $rollback = true;
180                 }
181                 foreach ($newassignment->get_submission_plugins() as $plugin) {
182                     if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
183                         if (!$plugin->upgrade($oldcontext, $oldassignment, $oldsubmission, $submission, $log)) {
184                             $rollback = true;
185                         }
186                     }
187                 }
188                 if ($oldsubmission->timemarked) {
189                     // submission has been graded - create a grade record
190                     $grade = new stdClass();
191                     $grade->assignment = $newassignment->get_instance()->id;
192                     $grade->userid = $oldsubmission->userid;
193                     $grade->grader = $oldsubmission->teacher;
194                     $grade->timemodified = $oldsubmission->timemarked;
195                     $grade->timecreated = $oldsubmission->timecreated;
196                     // $grade->locked = $oldsubmission->locked;
197                     $grade->grade = $oldsubmission->grade;
198                     $grade->mailed = $oldsubmission->mailed;
199                     $grade->id = $DB->insert_record('assign_grades', $grade);
200                     if (!$grade->id) {
201                         $log .= get_string('couldnotinsertgrade', 'mod_assign', $grade->userid);
202                         $rollback = true;
203                     }
205                     // copy any grading instances
206                     if ($gradingarea) {
208                         $gradeidmap[$grade->id] = $oldsubmission->id;
210                         foreach ($gradingdefinitions as $definition) {
211                             $DB->set_field('grading_instances', 'itemid', $grade->id, array('definitionid'=>$definition->id, 'itemid'=>$oldsubmission->id));
212                         }
214                     }
215                     foreach ($newassignment->get_feedback_plugins() as $plugin) {
216                         if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
217                             if (!$plugin->upgrade($oldcontext, $oldassignment, $oldsubmission, $grade, $log)) {
218                                 $rollback = true;
219                             }
220                         }
221                     }
222                 }
223             }
225             $newassignment->update_calendar($newcoursemodule->id);
227             // copy the grades from the old assignment to the new one
229             $gradeitem = $DB->get_record('grade_items', array('iteminstance'=>$oldassignment->id, 'itemmodule'=>'assignment'), 'id', IGNORE_MISSING);
230             if ($gradeitem) {
231                 $gradeitem->iteminstance = $newassignment->get_instance()->id;
232                 $gradeitem->itemmodule = 'assign';
233                 $DB->update_record('grade_items', $gradeitem);
234             }
235             $gradesdone = true;
237         } catch (Exception $exception) {
238             $rollback = true;
239             $log .= get_string('conversionexception', 'mod_assign', $exception->error);
240         }
242         if ($rollback) {
243             // roll back the grades changes
244             if ($gradesdone) {
245                 // copy the grades from the old assignment to the new one
246                 $gradeitem = $DB->get_record('grade_items', array('iteminstance'=>$newassignment->get_instance()->id, 'itemmodule'=>'assign'), 'id', IGNORE_MISSING);
247                 if ($gradeitem) {
248                     $gradeitem->iteminstance = $oldassignment->id;
249                     $gradeitem->itemmodule = 'assignment';
250                     $DB->update_record('grade_items', $gradeitem);
251                 }
252             }
253             // roll back the completion changes
254             if ($completiondone) {
255                 $DB->set_field('course_modules_completion', 'coursemoduleid', $oldcoursemodule->id, array('coursemoduleid'=>$newcoursemodule->id));
256                 $allcriteria = $DB->get_records('course_completion_criteria', array('moduleinstance'=>$newcoursemodule->id));
257                 foreach ($allcriteria as $criteria) {
258                     $criteria->module = 'assignment';
259                     $criteria->moduleinstance = $oldcoursemodule->id;
260                     $DB->update_record('course_completion_criteria', $criteria);
261                 }
262             }
263             // roll back the advanced grading update
264             if ($gradingarea) {
265                 foreach ($gradeidmap as $newgradeid => $oldsubmissionid) {
266                     foreach ($gradingdefinitions as $definition) {
267                         $DB->set_field('grading_instances', 'itemid', $oldsubmissionid, array('definitionid'=>$definition->id, 'itemid'=>$newgradeid));
268                     }
269                 }
270                 $DB->update_record('grading_areas', array('id'=>$gradingarea->id, 'contextid'=>$oldcontext->id, 'component'=>'mod_assignment', 'areaname'=>'submission'));
271             }
272             $newassignment->delete_instance();
274             return false;
275         }
276         // all is well,
277         // delete the old assignment (use object delete)
278         $cm = get_coursemodule_from_id('', $oldcoursemodule->id, $oldcoursemodule->course);
279         if ($cm) {
280             $this->delete_course_module($cm);
281         }
282         rebuild_course_cache($oldcoursemodule->course);
283         return true;
284     }
287     /**
288      * Create a duplicate course module record so we can create the upgraded
289      * assign module alongside the old assignment module.
290      *
291      * @param stdClass $cm The old course module record
292      * @param int $moduleid The id of the new assign module
293      * @param int $newinstanceid The id of the new instance of the assign module
294      * @return mixed stdClass|bool The new course module record or FALSE
295      */
296     private function duplicate_course_module(stdClass $cm, $moduleid, $newinstanceid) {
297         global $DB, $CFG;
299         $newcm = new stdClass();
300         $newcm->course           = $cm->course;
301         $newcm->module           = $moduleid;
302         $newcm->instance         = $newinstanceid;
303         $newcm->visible          = $cm->visible;
304         $newcm->section          = $cm->section;
305         $newcm->score            = $cm->score;
306         $newcm->indent           = $cm->indent;
307         $newcm->groupmode        = $cm->groupmode;
308         $newcm->groupingid       = $cm->groupingid;
309         $newcm->groupmembersonly = $cm->groupmembersonly;
310         $newcm->completion                = $cm->completion;
311         $newcm->completiongradeitemnumber = $cm->completiongradeitemnumber;
312         $newcm->completionview            = $cm->completionview;
313         $newcm->completionexpected        = $cm->completionexpected;
314         if(!empty($CFG->enableavailability)) {
315             $newcm->availablefrom             = $cm->availablefrom;
316             $newcm->availableuntil            = $cm->availableuntil;
317             $newcm->showavailability          = $cm->showavailability;
318         }
319         $newcm->showdescription = $cm->showdescription;
321         $newcmid = add_course_module($newcm);
322         $newcm = get_coursemodule_from_id('', $newcmid, $cm->course);
323         if (!$newcm) {
324             return false;
325         }
326         $section = $DB->get_record("course_sections", array("id"=>$newcm->section));
327         if (!$section) {
328             return false;
329         }
331         $mod = new stdClass();
332         $mod->course = $newcm->course;
333         $mod->section = $section->section;
334         $mod->coursemodule = $newcm->id;
335         $mod->id = $newcm->id;
336         $newcm->section = add_mod_to_section($mod, $cm);
338         // make sure visibility is set correctly (in particular in calendar)
339         // note: allow them to set it even without moodle/course:activityvisibility
340         set_coursemodule_visible($newcm->id, $newcm->visible);
342         return $newcm;
343     }
345     /**
346      * This function deletes the old assignment course module after
347      * it has been upgraded. This code is adapted from "course/mod.php".
348      *
349      * @param stdClass $cm The course module to delete.
350      * @return bool
351      */
352     private function delete_course_module($cm) {
353         global $CFG, $USER, $DB, $OUTPUT;
354         $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
356         $coursecontext = context_course::instance($course->id);
357         $modcontext = context_module::instance($cm->id);
359         $modlib = "$CFG->dirroot/mod/$cm->modname/lib.php";
361         if (file_exists($modlib)) {
362             require_once($modlib);
363         } else {
364             print_error('modulemissingcode', '', '', $modlib);
365         }
367         $deleteinstancefunction = $cm->modname."_delete_instance";
369         if (!$deleteinstancefunction($cm->instance)) {
370             echo $OUTPUT->notification("Could not delete the $cm->modname (instance)");
371         }
373         // remove all module files in case modules forget to do that
374         $fs = get_file_storage();
375         $fs->delete_area_files($modcontext->id);
377         if (!delete_course_module($cm->id)) {
378             echo $OUTPUT->notification("Could not delete the $cm->modname (coursemodule)");
379         }
380         if (!delete_mod_from_section($cm->id, $cm->section)) {
381             echo $OUTPUT->notification("Could not delete the $cm->modname from that section");
382         }
384         // Trigger a mod_deleted event with information about this module.
385         $eventdata = new stdClass();
386         $eventdata->modulename = $cm->modname;
387         $eventdata->cmid       = $cm->id;
388         $eventdata->courseid   = $course->id;
389         $eventdata->userid     = $USER->id;
390         events_trigger('mod_deleted', $eventdata);
392         add_to_log($course->id, 'course', "delete mod",
393                    "view.php?id=$cm->course",
394                    "$cm->modname $cm->instance", $cm->id);
396         return true;
397     }