3852d076b8cfd541d73bfc66383f380aaf14315e
[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             $DB->set_field('course_completion_criteria', 'module', 'assign', array('moduleinstance'=>$oldcoursemodule->id));
158             $DB->set_field('course_completion_criteria', 'moduleinstance', $newcoursemodule->id, array('moduleinstance'=>$oldcoursemodule->id));
159             $completiondone = true;
162             // copy all the submission data (and get plugins to do their bit)
163             $oldsubmissions = $DB->get_records('assignment_submissions', array('assignment'=>$oldassignmentid));
165             foreach ($oldsubmissions as $oldsubmission) {
166                 $submission = new stdClass();
167                 $submission->assignment = $newassignment->get_instance()->id;
168                 $submission->userid = $oldsubmission->userid;
169                 $submission->timecreated = $oldsubmission->timecreated;
170                 $submission->timemodified = $oldsubmission->timemodified;
171                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
172                 $submission->id = $DB->insert_record('assign_submission', $submission);
173                 if (!$submission->id) {
174                     $log .= get_string('couldnotinsertsubmission', 'mod_assign', $submission->userid);
175                     $rollback = true;
176                 }
177                 foreach ($newassignment->get_submission_plugins() as $plugin) {
178                     if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
179                         if (!$plugin->upgrade($oldcontext, $oldassignment, $oldsubmission, $submission, $log)) {
180                             $rollback = true;
181                         }
182                     }
183                 }
184                 if ($oldsubmission->timemarked) {
185                     // submission has been graded - create a grade record
186                     $grade = new stdClass();
187                     $grade->assignment = $newassignment->get_instance()->id;
188                     $grade->userid = $oldsubmission->userid;
189                     $grade->grader = $oldsubmission->teacher;
190                     $grade->timemodified = $oldsubmission->timemarked;
191                     $grade->timecreated = $oldsubmission->timecreated;
192                     // $grade->locked = $oldsubmission->locked;
193                     $grade->grade = $oldsubmission->grade;
194                     $grade->mailed = $oldsubmission->mailed;
195                     $grade->id = $DB->insert_record('assign_grades', $grade);
196                     if (!$grade->id) {
197                         $log .= get_string('couldnotinsertgrade', 'mod_assign', $grade->userid);
198                         $rollback = true;
199                     }
201                     // copy any grading instances
202                     if ($gradingarea) {
204                         $gradeidmap[$grade->id] = $oldsubmission->id;
206                         foreach ($gradingdefinitions as $definition) {
207                             $DB->set_field('grading_instances', 'itemid', $grade->id, array('definitionid'=>$definition->id, 'itemid'=>$oldsubmission->id));
208                         }
210                     }
211                     foreach ($newassignment->get_feedback_plugins() as $plugin) {
212                         if ($plugin->can_upgrade($oldassignment->assignmenttype, $oldversion)) {
213                             if (!$plugin->upgrade($oldcontext, $oldassignment, $oldsubmission, $grade, $log)) {
214                                 $rollback = true;
215                             }
216                         }
217                     }
218                 }
219             }
221             $newassignment->update_calendar($newcoursemodule->id);
223             // copy the grades from the old assignment to the new one
224             $DB->set_field('grade_items', 'itemmodule', 'assign', array('iteminstance'=>$oldassignment->id, 'itemmodule'=>'assignment'));
225             $DB->set_field('grade_items', 'iteminstance', $newassignment->get_instance()->id, array('iteminstance'=>$oldassignment->id, 'itemmodule'=>'assign'));
226             $gradesdone = true;
228         } catch (Exception $exception) {
229             $rollback = true;
230             $log .= get_string('conversionexception', 'mod_assign', $exception->error);
231         }
233         if ($rollback) {
234             // roll back the grades changes
235             if ($gradesdone) {
236                 // copy the grades from the old assignment to the new one
237                 $DB->set_field('grade_items', 'itemmodule', 'assignment', array('iteminstance'=>$newassignment->get_instance()->id, 'itemmodule'=>'assign'));
238                 $DB->set_field('grade_items', 'iteminstance', $oldassignment->id, array('iteminstance'=>$newassignment->get_instance()->id, 'itemmodule'=>'assignment'));
239             }
240             // roll back the completion changes
241             if ($completiondone) {
242                 $DB->set_field('course_modules_completion', 'coursemoduleid', $oldcoursemodule->id, array('coursemoduleid'=>$newcoursemodule->id));
243                 $DB->set_field('course_completion_criteria', 'module', 'assignment', array('moduleinstance'=>$newcoursemodule->id));
244                 $DB->set_field('course_completion_criteria', 'moduleinstance', $oldcoursemodule->id, array('moduleinstance'=>$newcoursemodule->id));
245             }
246             // roll back the advanced grading update
247             if ($gradingarea) {
248                 foreach ($gradeidmap as $newgradeid => $oldsubmissionid) {
249                     foreach ($gradingdefinitions as $definition) {
250                         $DB->set_field('grading_instances', 'itemid', $oldsubmissionid, array('definitionid'=>$definition->id, 'itemid'=>$newgradeid));
251                     }
252                 }
253                 $DB->update_record('grading_areas', array('id'=>$gradingarea->id, 'contextid'=>$oldcontext->id, 'component'=>'mod_assignment', 'areaname'=>'submission'));
254             }
255             $newassignment->delete_instance();
257             return false;
258         }
259         // all is well,
260         // delete the old assignment (use object delete)
261         $cm = get_coursemodule_from_id('', $oldcoursemodule->id, $oldcoursemodule->course);
262         if ($cm) {
263             $this->delete_course_module($cm);
264         }
265         rebuild_course_cache($oldcoursemodule->course);
266         return true;
267     }
270     /**
271      * Create a duplicate course module record so we can create the upgraded
272      * assign module alongside the old assignment module.
273      *
274      * @param stdClass $cm The old course module record
275      * @param int $moduleid The id of the new assign module
276      * @param int $newinstanceid The id of the new instance of the assign module
277      * @return mixed stdClass|bool The new course module record or FALSE
278      */
279     private function duplicate_course_module(stdClass $cm, $moduleid, $newinstanceid) {
280         global $DB, $CFG;
282         $newcm = new stdClass();
283         $newcm->course           = $cm->course;
284         $newcm->module           = $moduleid;
285         $newcm->instance         = $newinstanceid;
286         $newcm->visible          = $cm->visible;
287         $newcm->section          = $cm->section;
288         $newcm->score            = $cm->score;
289         $newcm->indent           = $cm->indent;
290         $newcm->groupmode        = $cm->groupmode;
291         $newcm->groupingid       = $cm->groupingid;
292         $newcm->groupmembersonly = $cm->groupmembersonly;
293         $newcm->completion                = $cm->completion;
294         $newcm->completiongradeitemnumber = $cm->completiongradeitemnumber;
295         $newcm->completionview            = $cm->completionview;
296         $newcm->completionexpected        = $cm->completionexpected;
297         if(!empty($CFG->enableavailability)) {
298             $newcm->availablefrom             = $cm->availablefrom;
299             $newcm->availableuntil            = $cm->availableuntil;
300             $newcm->showavailability          = $cm->showavailability;
301         }
302         $newcm->showdescription = $cm->showdescription;
304         $newcmid = add_course_module($newcm);
305         $newcm = get_coursemodule_from_id('', $newcmid, $cm->course);
306         if (!$newcm) {
307             return false;
308         }
309         $section = $DB->get_record("course_sections", array("id"=>$newcm->section));
310         if (!$section) {
311             return false;
312         }
314         $mod = new stdClass();
315         $mod->course = $newcm->course;
316         $mod->section = $section->section;
317         $mod->coursemodule = $newcm->id;
318         $mod->id = $newcm->id;
319         $newcm->section = add_mod_to_section($mod, $cm);
321         // make sure visibility is set correctly (in particular in calendar)
322         // note: allow them to set it even without moodle/course:activityvisibility
323         set_coursemodule_visible($newcm->id, $newcm->visible);
325         return $newcm;
326     }
328     /**
329      * This function deletes the old assignment course module after
330      * it has been upgraded. This code is adapted from "course/mod.php".
331      *
332      * @param stdClass $cm The course module to delete.
333      * @return bool
334      */
335     private function delete_course_module($cm) {
336         global $CFG, $USER, $DB, $OUTPUT;
337         $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
339         $coursecontext = context_course::instance($course->id);
340         $modcontext = context_module::instance($cm->id);
342         $modlib = "$CFG->dirroot/mod/$cm->modname/lib.php";
344         if (file_exists($modlib)) {
345             require_once($modlib);
346         } else {
347             print_error('modulemissingcode', '', '', $modlib);
348         }
350         $deleteinstancefunction = $cm->modname."_delete_instance";
352         if (!$deleteinstancefunction($cm->instance)) {
353             echo $OUTPUT->notification("Could not delete the $cm->modname (instance)");
354         }
356         // remove all module files in case modules forget to do that
357         $fs = get_file_storage();
358         $fs->delete_area_files($modcontext->id);
360         if (!delete_course_module($cm->id)) {
361             echo $OUTPUT->notification("Could not delete the $cm->modname (coursemodule)");
362         }
363         if (!delete_mod_from_section($cm->id, $cm->section)) {
364             echo $OUTPUT->notification("Could not delete the $cm->modname from that section");
365         }
367         // Trigger a mod_deleted event with information about this module.
368         $eventdata = new stdClass();
369         $eventdata->modulename = $cm->modname;
370         $eventdata->cmid       = $cm->id;
371         $eventdata->courseid   = $course->id;
372         $eventdata->userid     = $USER->id;
373         events_trigger('mod_deleted', $eventdata);
375         add_to_log($course->id, 'course', "delete mod",
376                    "view.php?id=$cm->course",
377                    "$cm->modname $cm->instance", $cm->id);
379         return true;
380     }