MDL-68329 cache: Improve cache performance footer info
[moodle.git] / admin / tool / uploadcourse / classes / course.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  * File containing the course class.
19  *
20  * @package    tool_uploadcourse
21  * @copyright  2013 Frédéric Massart
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
26 require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
27 require_once($CFG->dirroot . '/course/lib.php');
29 /**
30  * Course class.
31  *
32  * @package    tool_uploadcourse
33  * @copyright  2013 Frédéric Massart
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class tool_uploadcourse_course {
38     /** Outcome of the process: creating the course */
39     const DO_CREATE = 1;
41     /** Outcome of the process: updating the course */
42     const DO_UPDATE = 2;
44     /** Outcome of the process: deleting the course */
45     const DO_DELETE = 3;
47     /** @var array final import data. */
48     protected $data = array();
50     /** @var array default values. */
51     protected $defaults = array();
53     /** @var array enrolment data. */
54     protected $enrolmentdata;
56     /** @var array errors. */
57     protected $errors = array();
59     /** @var int the ID of the course that had been processed. */
60     protected $id;
62     /** @var array containing options passed from the processor. */
63     protected $importoptions = array();
65     /** @var int import mode. Matches tool_uploadcourse_processor::MODE_* */
66     protected $mode;
68     /** @var array course import options. */
69     protected $options = array();
71     /** @var int constant value of self::DO_*, what to do with that course */
72     protected $do;
74     /** @var bool set to true once we have prepared the course */
75     protected $prepared = false;
77     /** @var bool set to true once we have started the process of the course */
78     protected $processstarted = false;
80     /** @var array course import data. */
81     protected $rawdata = array();
83     /** @var array restore directory. */
84     protected $restoredata;
86     /** @var string course shortname. */
87     protected $shortname;
89     /** @var array errors. */
90     protected $statuses = array();
92     /** @var int update mode. Matches tool_uploadcourse_processor::UPDATE_* */
93     protected $updatemode;
95     /** @var array fields allowed as course data. */
96     static protected $validfields = array('fullname', 'shortname', 'idnumber', 'category', 'visible', 'startdate', 'enddate',
97         'summary', 'format', 'theme', 'lang', 'newsitems', 'showgrades', 'showreports', 'legacyfiles', 'maxbytes',
98         'groupmode', 'groupmodeforce', 'enablecompletion');
100     /** @var array fields required on course creation. */
101     static protected $mandatoryfields = array('fullname', 'category');
103     /** @var array fields which are considered as options. */
104     static protected $optionfields = array('delete' => false, 'rename' => null, 'backupfile' => null,
105         'templatecourse' => null, 'reset' => false);
107     /** @var array options determining what can or cannot be done at an import level. */
108     static protected $importoptionsdefaults = array('canrename' => false, 'candelete' => false, 'canreset' => false,
109         'reset' => false, 'restoredir' => null, 'shortnametemplate' => null);
111     /**
112      * Constructor
113      *
114      * @param int $mode import mode, constant matching tool_uploadcourse_processor::MODE_*
115      * @param int $updatemode update mode, constant matching tool_uploadcourse_processor::UPDATE_*
116      * @param array $rawdata raw course data.
117      * @param array $defaults default course data.
118      * @param array $importoptions import options.
119      */
120     public function __construct($mode, $updatemode, $rawdata, $defaults = array(), $importoptions = array()) {
122         if ($mode !== tool_uploadcourse_processor::MODE_CREATE_NEW &&
123                 $mode !== tool_uploadcourse_processor::MODE_CREATE_ALL &&
124                 $mode !== tool_uploadcourse_processor::MODE_CREATE_OR_UPDATE &&
125                 $mode !== tool_uploadcourse_processor::MODE_UPDATE_ONLY) {
126             throw new coding_exception('Incorrect mode.');
127         } else if ($updatemode !== tool_uploadcourse_processor::UPDATE_NOTHING &&
128                 $updatemode !== tool_uploadcourse_processor::UPDATE_ALL_WITH_DATA_ONLY &&
129                 $updatemode !== tool_uploadcourse_processor::UPDATE_ALL_WITH_DATA_OR_DEFAUTLS &&
130                 $updatemode !== tool_uploadcourse_processor::UPDATE_MISSING_WITH_DATA_OR_DEFAUTLS) {
131             throw new coding_exception('Incorrect update mode.');
132         }
134         $this->mode = $mode;
135         $this->updatemode = $updatemode;
137         if (isset($rawdata['shortname'])) {
138             $this->shortname = $rawdata['shortname'];
139         }
140         $this->rawdata = $rawdata;
141         $this->defaults = $defaults;
143         // Extract course options.
144         foreach (self::$optionfields as $option => $default) {
145             $this->options[$option] = isset($rawdata[$option]) ? $rawdata[$option] : $default;
146         }
148         // Import options.
149         foreach (self::$importoptionsdefaults as $option => $default) {
150             $this->importoptions[$option] = isset($importoptions[$option]) ? $importoptions[$option] : $default;
151         }
152     }
154     /**
155      * Does the mode allow for course creation?
156      *
157      * @return bool
158      */
159     public function can_create() {
160         return in_array($this->mode, array(tool_uploadcourse_processor::MODE_CREATE_ALL,
161             tool_uploadcourse_processor::MODE_CREATE_NEW,
162             tool_uploadcourse_processor::MODE_CREATE_OR_UPDATE)
163         );
164     }
166     /**
167      * Does the mode allow for course deletion?
168      *
169      * @return bool
170      */
171     public function can_delete() {
172         return $this->importoptions['candelete'];
173     }
175     /**
176      * Does the mode only allow for course creation?
177      *
178      * @return bool
179      */
180     public function can_only_create() {
181         return in_array($this->mode, array(tool_uploadcourse_processor::MODE_CREATE_ALL,
182             tool_uploadcourse_processor::MODE_CREATE_NEW));
183     }
185     /**
186      * Does the mode allow for course rename?
187      *
188      * @return bool
189      */
190     public function can_rename() {
191         return $this->importoptions['canrename'];
192     }
194     /**
195      * Does the mode allow for course reset?
196      *
197      * @return bool
198      */
199     public function can_reset() {
200         return $this->importoptions['canreset'];
201     }
203     /**
204      * Does the mode allow for course update?
205      *
206      * @return bool
207      */
208     public function can_update() {
209         return in_array($this->mode,
210                 array(
211                     tool_uploadcourse_processor::MODE_UPDATE_ONLY,
212                     tool_uploadcourse_processor::MODE_CREATE_OR_UPDATE)
213                 ) && $this->updatemode != tool_uploadcourse_processor::UPDATE_NOTHING;
214     }
216     /**
217      * Can we use default values?
218      *
219      * @return bool
220      */
221     public function can_use_defaults() {
222         return in_array($this->updatemode, array(tool_uploadcourse_processor::UPDATE_MISSING_WITH_DATA_OR_DEFAUTLS,
223             tool_uploadcourse_processor::UPDATE_ALL_WITH_DATA_OR_DEFAUTLS));
224     }
226     /**
227      * Delete the current course.
228      *
229      * @return bool
230      */
231     protected function delete() {
232         global $DB;
233         $this->id = $DB->get_field_select('course', 'id', 'shortname = :shortname',
234             array('shortname' => $this->shortname), MUST_EXIST);
235         return delete_course($this->id, false);
236     }
238     /**
239      * Log an error
240      *
241      * @param string $code error code.
242      * @param lang_string $message error message.
243      * @return void
244      */
245     protected function error($code, lang_string $message) {
246         if (array_key_exists($code, $this->errors)) {
247             throw new coding_exception('Error code already defined');
248         }
249         $this->errors[$code] = $message;
250     }
252     /**
253      * Return whether the course exists or not.
254      *
255      * @param string $shortname the shortname to use to check if the course exists. Falls back on $this->shortname if empty.
256      * @return bool
257      */
258     protected function exists($shortname = null) {
259         global $DB;
260         if (is_null($shortname)) {
261             $shortname = $this->shortname;
262         }
263         if (!empty($shortname) || is_numeric($shortname)) {
264             return $DB->record_exists('course', array('shortname' => $shortname));
265         }
266         return false;
267     }
269     /**
270      * Return the data that will be used upon saving.
271      *
272      * @return null|array
273      */
274     public function get_data() {
275         return $this->data;
276     }
278     /**
279      * Return the errors found during preparation.
280      *
281      * @return array
282      */
283     public function get_errors() {
284         return $this->errors;
285     }
287     /**
288      * Assemble the course data based on defaults.
289      *
290      * This returns the final data to be passed to create_course().
291      *
292      * @param array $data current data.
293      * @return array
294      */
295     protected function get_final_create_data($data) {
296         foreach (self::$validfields as $field) {
297             if (!isset($data[$field]) && isset($this->defaults[$field])) {
298                 $data[$field] = $this->defaults[$field];
299             }
300         }
301         $data['shortname'] = $this->shortname;
302         return $data;
303     }
305     /**
306      * Assemble the course data based on defaults.
307      *
308      * This returns the final data to be passed to update_course().
309      *
310      * @param array $data current data.
311      * @param bool $usedefaults are defaults allowed?
312      * @param bool $missingonly ignore fields which are already set.
313      * @return array
314      */
315     protected function get_final_update_data($data, $usedefaults = false, $missingonly = false) {
316         global $DB;
317         $newdata = array();
318         $existingdata = $DB->get_record('course', array('shortname' => $this->shortname));
319         foreach (self::$validfields as $field) {
320             if ($missingonly) {
321                 if (!is_null($existingdata->$field) and $existingdata->$field !== '') {
322                     continue;
323                 }
324             }
325             if (isset($data[$field])) {
326                 $newdata[$field] = $data[$field];
327             } else if ($usedefaults && isset($this->defaults[$field])) {
328                 $newdata[$field] = $this->defaults[$field];
329             }
330         }
331         $newdata['id'] =  $existingdata->id;
332         return $newdata;
333     }
335     /**
336      * Return the ID of the processed course.
337      *
338      * @return int|null
339      */
340     public function get_id() {
341         if (!$this->processstarted) {
342             throw new coding_exception('The course has not been processed yet!');
343         }
344         return $this->id;
345     }
347     /**
348      * Get the directory of the object to restore.
349      *
350      * @return string|false|null subdirectory in $CFG->backuptempdir/..., false when an error occured
351      *                           and null when there is simply nothing.
352      */
353     protected function get_restore_content_dir() {
354         $backupfile = null;
355         $shortname = null;
357         if (!empty($this->options['backupfile'])) {
358             $backupfile = $this->options['backupfile'];
359         } else if (!empty($this->options['templatecourse']) || is_numeric($this->options['templatecourse'])) {
360             $shortname = $this->options['templatecourse'];
361         }
363         $errors = array();
364         $dir = tool_uploadcourse_helper::get_restore_content_dir($backupfile, $shortname, $errors);
365         if (!empty($errors)) {
366             foreach ($errors as $key => $message) {
367                 $this->error($key, $message);
368             }
369             return false;
370         } else if ($dir === false) {
371             // We want to return null when nothing was wrong, but nothing was found.
372             $dir = null;
373         }
375         if (empty($dir) && !empty($this->importoptions['restoredir'])) {
376             $dir = $this->importoptions['restoredir'];
377         }
379         return $dir;
380     }
382     /**
383      * Return the errors found during preparation.
384      *
385      * @return array
386      */
387     public function get_statuses() {
388         return $this->statuses;
389     }
391     /**
392      * Return whether there were errors with this course.
393      *
394      * @return boolean
395      */
396     public function has_errors() {
397         return !empty($this->errors);
398     }
400     /**
401      * Validates and prepares the data.
402      *
403      * @return bool false is any error occured.
404      */
405     public function prepare() {
406         global $DB, $SITE;
407         $this->prepared = true;
409         // Validate the shortname.
410         if (!empty($this->shortname) || is_numeric($this->shortname)) {
411             if ($this->shortname !== clean_param($this->shortname, PARAM_TEXT)) {
412                 $this->error('invalidshortname', new lang_string('invalidshortname', 'tool_uploadcourse'));
413                 return false;
414             }
416             // Ensure we don't overflow the maximum length of the shortname field.
417             if (core_text::strlen($this->shortname) > 255) {
418                 $this->error('invalidshortnametoolong', new lang_string('invalidshortnametoolong', 'tool_uploadcourse', 255));
419                 return false;
420             }
421         }
423         $exists = $this->exists();
425         // Do we want to delete the course?
426         if ($this->options['delete']) {
427             if (!$exists) {
428                 $this->error('cannotdeletecoursenotexist', new lang_string('cannotdeletecoursenotexist', 'tool_uploadcourse'));
429                 return false;
430             } else if (!$this->can_delete()) {
431                 $this->error('coursedeletionnotallowed', new lang_string('coursedeletionnotallowed', 'tool_uploadcourse'));
432                 return false;
433             }
435             $this->do = self::DO_DELETE;
436             return true;
437         }
439         // Can we create/update the course under those conditions?
440         if ($exists) {
441             if ($this->mode === tool_uploadcourse_processor::MODE_CREATE_NEW) {
442                 $this->error('courseexistsanduploadnotallowed',
443                     new lang_string('courseexistsanduploadnotallowed', 'tool_uploadcourse'));
444                 return false;
445             } else if ($this->can_update()) {
446                 // We can never allow for any front page changes!
447                 if ($this->shortname == $SITE->shortname) {
448                     $this->error('cannotupdatefrontpage', new lang_string('cannotupdatefrontpage', 'tool_uploadcourse'));
449                     return false;
450                 }
451             }
452         } else {
453             if (!$this->can_create()) {
454                 $this->error('coursedoesnotexistandcreatenotallowed',
455                     new lang_string('coursedoesnotexistandcreatenotallowed', 'tool_uploadcourse'));
456                 return false;
457             }
458         }
460         // Basic data.
461         $coursedata = array();
462         foreach ($this->rawdata as $field => $value) {
463             if (!in_array($field, self::$validfields)) {
464                 continue;
465             } else if ($field == 'shortname') {
466                 // Let's leave it apart from now, use $this->shortname only.
467                 continue;
468             }
469             $coursedata[$field] = $value;
470         }
472         $mode = $this->mode;
473         $updatemode = $this->updatemode;
474         $usedefaults = $this->can_use_defaults();
476         // Resolve the category, and fail if not found.
477         $errors = array();
478         $catid = tool_uploadcourse_helper::resolve_category($this->rawdata, $errors);
479         if (empty($errors)) {
480             $coursedata['category'] = $catid;
481         } else {
482             foreach ($errors as $key => $message) {
483                 $this->error($key, $message);
484             }
485             return false;
486         }
488         // Ensure we don't overflow the maximum length of the fullname field.
489         if (!empty($coursedata['fullname']) && core_text::strlen($coursedata['fullname']) > 254) {
490             $this->error('invalidfullnametoolong', new lang_string('invalidfullnametoolong', 'tool_uploadcourse', 254));
491             return false;
492         }
494         // If the course does not exist, or will be forced created.
495         if (!$exists || $mode === tool_uploadcourse_processor::MODE_CREATE_ALL) {
497             // Mandatory fields upon creation.
498             $errors = array();
499             foreach (self::$mandatoryfields as $field) {
500                 if ((!isset($coursedata[$field]) || $coursedata[$field] === '') &&
501                         (!isset($this->defaults[$field]) || $this->defaults[$field] === '')) {
502                     $errors[] = $field;
503                 }
504             }
505             if (!empty($errors)) {
506                 $this->error('missingmandatoryfields', new lang_string('missingmandatoryfields', 'tool_uploadcourse',
507                     implode(', ', $errors)));
508                 return false;
509             }
510         }
512         // Should the course be renamed?
513         if (!empty($this->options['rename']) || is_numeric($this->options['rename'])) {
514             if (!$this->can_update()) {
515                 $this->error('canonlyrenameinupdatemode', new lang_string('canonlyrenameinupdatemode', 'tool_uploadcourse'));
516                 return false;
517             } else if (!$exists) {
518                 $this->error('cannotrenamecoursenotexist', new lang_string('cannotrenamecoursenotexist', 'tool_uploadcourse'));
519                 return false;
520             } else if (!$this->can_rename()) {
521                 $this->error('courserenamingnotallowed', new lang_string('courserenamingnotallowed', 'tool_uploadcourse'));
522                 return false;
523             } else if ($this->options['rename'] !== clean_param($this->options['rename'], PARAM_TEXT)) {
524                 $this->error('invalidshortname', new lang_string('invalidshortname', 'tool_uploadcourse'));
525                 return false;
526             } else if ($this->exists($this->options['rename'])) {
527                 $this->error('cannotrenameshortnamealreadyinuse',
528                     new lang_string('cannotrenameshortnamealreadyinuse', 'tool_uploadcourse'));
529                 return false;
530             } else if (isset($coursedata['idnumber']) &&
531                     $DB->count_records_select('course', 'idnumber = :idn AND shortname != :sn',
532                     array('idn' => $coursedata['idnumber'], 'sn' => $this->shortname)) > 0) {
533                 $this->error('cannotrenameidnumberconflict', new lang_string('cannotrenameidnumberconflict', 'tool_uploadcourse'));
534                 return false;
535             }
536             $coursedata['shortname'] = $this->options['rename'];
537             $this->status('courserenamed', new lang_string('courserenamed', 'tool_uploadcourse',
538                 array('from' => $this->shortname, 'to' => $coursedata['shortname'])));
539         }
541         // Should we generate a shortname?
542         if (empty($this->shortname) && !is_numeric($this->shortname)) {
543             if (empty($this->importoptions['shortnametemplate'])) {
544                 $this->error('missingshortnamenotemplate', new lang_string('missingshortnamenotemplate', 'tool_uploadcourse'));
545                 return false;
546             } else if (!$this->can_only_create()) {
547                 $this->error('cannotgenerateshortnameupdatemode',
548                     new lang_string('cannotgenerateshortnameupdatemode', 'tool_uploadcourse'));
549                 return false;
550             } else {
551                 $newshortname = tool_uploadcourse_helper::generate_shortname($coursedata,
552                     $this->importoptions['shortnametemplate']);
553                 if (is_null($newshortname)) {
554                     $this->error('generatedshortnameinvalid', new lang_string('generatedshortnameinvalid', 'tool_uploadcourse'));
555                     return false;
556                 } else if ($this->exists($newshortname)) {
557                     if ($mode === tool_uploadcourse_processor::MODE_CREATE_NEW) {
558                         $this->error('generatedshortnamealreadyinuse',
559                             new lang_string('generatedshortnamealreadyinuse', 'tool_uploadcourse'));
560                         return false;
561                     }
562                     $exists = true;
563                 }
564                 $this->status('courseshortnamegenerated', new lang_string('courseshortnamegenerated', 'tool_uploadcourse',
565                     $newshortname));
566                 $this->shortname = $newshortname;
567             }
568         }
570         // If exists, but we only want to create courses, increment the shortname.
571         if ($exists && $mode === tool_uploadcourse_processor::MODE_CREATE_ALL) {
572             $original = $this->shortname;
573             $this->shortname = tool_uploadcourse_helper::increment_shortname($this->shortname);
574             $exists = false;
575             if ($this->shortname != $original) {
576                 $this->status('courseshortnameincremented', new lang_string('courseshortnameincremented', 'tool_uploadcourse',
577                     array('from' => $original, 'to' => $this->shortname)));
578                 if (isset($coursedata['idnumber'])) {
579                     $originalidn = $coursedata['idnumber'];
580                     $coursedata['idnumber'] = tool_uploadcourse_helper::increment_idnumber($coursedata['idnumber']);
581                     if ($originalidn != $coursedata['idnumber']) {
582                         $this->status('courseidnumberincremented', new lang_string('courseidnumberincremented', 'tool_uploadcourse',
583                             array('from' => $originalidn, 'to' => $coursedata['idnumber'])));
584                     }
585                 }
586             }
587         }
589         // If the course does not exist, ensure that the ID number is not taken.
590         if (!$exists && isset($coursedata['idnumber'])) {
591             if ($DB->count_records_select('course', 'idnumber = :idn', array('idn' => $coursedata['idnumber'])) > 0) {
592                 $this->error('idnumberalreadyinuse', new lang_string('idnumberalreadyinuse', 'tool_uploadcourse'));
593                 return false;
594             }
595         }
597         // Course start date.
598         if (!empty($coursedata['startdate'])) {
599             $coursedata['startdate'] = strtotime($coursedata['startdate']);
600         }
602         // Course end date.
603         if (!empty($coursedata['enddate'])) {
604             $coursedata['enddate'] = strtotime($coursedata['enddate']);
605         }
607         // If lang is specified, check the user is allowed to set that field.
608         if (!empty($coursedata['lang'])) {
609             if ($exists) {
610                 $courseid = $DB->get_field('course', 'id', ['shortname' => $this->shortname]);
611                 if (!has_capability('moodle/course:setforcedlanguage', context_course::instance($courseid))) {
612                     $this->error('cannotforcelang', new lang_string('cannotforcelang', 'tool_uploadcourse'));
613                     return false;
614                 }
615             } else {
616                 $catcontext = context_coursecat::instance($coursedata['category']);
617                 if (!guess_if_creator_will_have_course_capability('moodle/course:setforcedlanguage', $catcontext)) {
618                     $this->error('cannotforcelang', new lang_string('cannotforcelang', 'tool_uploadcourse'));
619                     return false;
620                 }
621             }
622         }
624         // Ultimate check mode vs. existence.
625         switch ($mode) {
626             case tool_uploadcourse_processor::MODE_CREATE_NEW:
627             case tool_uploadcourse_processor::MODE_CREATE_ALL:
628                 if ($exists) {
629                     $this->error('courseexistsanduploadnotallowed',
630                         new lang_string('courseexistsanduploadnotallowed', 'tool_uploadcourse'));
631                     return false;
632                 }
633                 break;
634             case tool_uploadcourse_processor::MODE_UPDATE_ONLY:
635                 if (!$exists) {
636                     $this->error('coursedoesnotexistandcreatenotallowed',
637                         new lang_string('coursedoesnotexistandcreatenotallowed', 'tool_uploadcourse'));
638                     return false;
639                 }
640                 // No break!
641             case tool_uploadcourse_processor::MODE_CREATE_OR_UPDATE:
642                 if ($exists) {
643                     if ($updatemode === tool_uploadcourse_processor::UPDATE_NOTHING) {
644                         $this->error('updatemodedoessettonothing',
645                             new lang_string('updatemodedoessettonothing', 'tool_uploadcourse'));
646                         return false;
647                     }
648                 }
649                 break;
650             default:
651                 // O_o Huh?! This should really never happen here!
652                 $this->error('unknownimportmode', new lang_string('unknownimportmode', 'tool_uploadcourse'));
653                 return false;
654         }
656         // Get final data.
657         if ($exists) {
658             $missingonly = ($updatemode === tool_uploadcourse_processor::UPDATE_MISSING_WITH_DATA_OR_DEFAUTLS);
659             $coursedata = $this->get_final_update_data($coursedata, $usedefaults, $missingonly);
661             // Make sure we are not trying to mess with the front page, though we should never get here!
662             if ($coursedata['id'] == $SITE->id) {
663                 $this->error('cannotupdatefrontpage', new lang_string('cannotupdatefrontpage', 'tool_uploadcourse'));
664                 return false;
665             }
667             $this->do = self::DO_UPDATE;
668         } else {
669             $coursedata = $this->get_final_create_data($coursedata);
670             $this->do = self::DO_CREATE;
671         }
673         // Validate course start and end dates.
674         if ($exists) {
675             // We also check existing start and end dates if we are updating an existing course.
676             $existingdata = $DB->get_record('course', array('shortname' => $this->shortname));
677             if (empty($coursedata['startdate'])) {
678                 $coursedata['startdate'] = $existingdata->startdate;
679             }
680             if (empty($coursedata['enddate'])) {
681                 $coursedata['enddate'] = $existingdata->enddate;
682             }
683         }
684         if ($errorcode = course_validate_dates($coursedata)) {
685             $this->error($errorcode, new lang_string($errorcode, 'error'));
686             return false;
687         }
689         // Add role renaming.
690         $errors = array();
691         $rolenames = tool_uploadcourse_helper::get_role_names($this->rawdata, $errors);
692         if (!empty($errors)) {
693             foreach ($errors as $key => $message) {
694                 $this->error($key, $message);
695             }
696             return false;
697         }
698         foreach ($rolenames as $rolekey => $rolename) {
699             $coursedata[$rolekey] = $rolename;
700         }
702         // Some validation.
703         if (!empty($coursedata['format']) && !in_array($coursedata['format'], tool_uploadcourse_helper::get_course_formats())) {
704             $this->error('invalidcourseformat', new lang_string('invalidcourseformat', 'tool_uploadcourse'));
705             return false;
706         }
708         // Add data for course format options.
709         if (isset($coursedata['format']) || $exists) {
710             if (isset($coursedata['format'])) {
711                 $courseformat = course_get_format((object)['format' => $coursedata['format']]);
712             } else {
713                 $courseformat = course_get_format($existingdata);
714             }
715             $coursedata += $courseformat->validate_course_format_options($this->rawdata);
716         }
718         // Special case, 'numsections' is not a course format option any more but still should apply from the template course,
719         // if any, and otherwise from defaults.
720         if (!$exists || !array_key_exists('numsections', $coursedata)) {
721             if (isset($this->rawdata['numsections']) && is_numeric($this->rawdata['numsections'])) {
722                 $coursedata['numsections'] = (int)$this->rawdata['numsections'];
723             } else if (isset($this->options['templatecourse'])) {
724                 $numsections = tool_uploadcourse_helper::get_coursesection_count($this->options['templatecourse']);
725                 if ($numsections != 0) {
726                     $coursedata['numsections'] = $numsections;
727                 } else {
728                     $coursedata['numsections'] = get_config('moodlecourse', 'numsections');
729                 }
730             } else {
731                 $coursedata['numsections'] = get_config('moodlecourse', 'numsections');
732             }
733         }
735         // Visibility can only be 0 or 1.
736         if (!empty($coursedata['visible']) AND !($coursedata['visible'] == 0 OR $coursedata['visible'] == 1)) {
737             $this->error('invalidvisibilitymode', new lang_string('invalidvisibilitymode', 'tool_uploadcourse'));
738             return false;
739         }
741         // Saving data.
742         $this->data = $coursedata;
743         $this->enrolmentdata = tool_uploadcourse_helper::get_enrolment_data($this->rawdata);
745         if (isset($this->rawdata['tags']) && strval($this->rawdata['tags']) !== '') {
746             $this->data['tags'] = preg_split('/\s*,\s*/', trim($this->rawdata['tags']), -1, PREG_SPLIT_NO_EMPTY);
747         }
749         // Restore data.
750         // TODO Speed up things by not really extracting the backup just yet, but checking that
751         // the backup file or shortname passed are valid. Extraction should happen in proceed().
752         $this->restoredata = $this->get_restore_content_dir();
753         if ($this->restoredata === false) {
754             return false;
755         }
757         // We can only reset courses when allowed and we are updating the course.
758         if ($this->importoptions['reset'] || $this->options['reset']) {
759             if ($this->do !== self::DO_UPDATE) {
760                 $this->error('canonlyresetcourseinupdatemode',
761                     new lang_string('canonlyresetcourseinupdatemode', 'tool_uploadcourse'));
762                 return false;
763             } else if (!$this->can_reset()) {
764                 $this->error('courseresetnotallowed', new lang_string('courseresetnotallowed', 'tool_uploadcourse'));
765                 return false;
766             }
767         }
769         return true;
770     }
772     /**
773      * Proceed with the import of the course.
774      *
775      * @return void
776      */
777     public function proceed() {
778         global $CFG, $USER;
780         if (!$this->prepared) {
781             throw new coding_exception('The course has not been prepared.');
782         } else if ($this->has_errors()) {
783             throw new moodle_exception('Cannot proceed, errors were detected.');
784         } else if ($this->processstarted) {
785             throw new coding_exception('The process has already been started.');
786         }
787         $this->processstarted = true;
789         if ($this->do === self::DO_DELETE) {
790             if ($this->delete()) {
791                 $this->status('coursedeleted', new lang_string('coursedeleted', 'tool_uploadcourse'));
792             } else {
793                 $this->error('errorwhiledeletingcourse', new lang_string('errorwhiledeletingcourse', 'tool_uploadcourse'));
794             }
795             return true;
796         } else if ($this->do === self::DO_CREATE) {
797             $course = create_course((object) $this->data);
798             $this->id = $course->id;
799             $this->status('coursecreated', new lang_string('coursecreated', 'tool_uploadcourse'));
800         } else if ($this->do === self::DO_UPDATE) {
801             $course = (object) $this->data;
802             update_course($course);
803             $this->id = $course->id;
804             $this->status('courseupdated', new lang_string('courseupdated', 'tool_uploadcourse'));
805         } else {
806             // Strangely the outcome has not been defined, or is unknown!
807             throw new coding_exception('Unknown outcome!');
808         }
810         // Restore a course.
811         if (!empty($this->restoredata)) {
812             $rc = new restore_controller($this->restoredata, $course->id, backup::INTERACTIVE_NO,
813                 backup::MODE_IMPORT, $USER->id, backup::TARGET_CURRENT_ADDING);
815             // Check if the format conversion must happen first.
816             if ($rc->get_status() == backup::STATUS_REQUIRE_CONV) {
817                 $rc->convert();
818             }
819             if ($rc->execute_precheck()) {
820                 $rc->execute_plan();
821                 $this->status('courserestored', new lang_string('courserestored', 'tool_uploadcourse'));
822             } else {
823                 $this->error('errorwhilerestoringcourse', new lang_string('errorwhilerestoringthecourse', 'tool_uploadcourse'));
824             }
825             $rc->destroy();
826         }
828         // Proceed with enrolment data.
829         $this->process_enrolment_data($course);
831         // Reset the course.
832         if ($this->importoptions['reset'] || $this->options['reset']) {
833             if ($this->do === self::DO_UPDATE && $this->can_reset()) {
834                 $this->reset($course);
835                 $this->status('coursereset', new lang_string('coursereset', 'tool_uploadcourse'));
836             }
837         }
839         // Mark context as dirty.
840         $context = context_course::instance($course->id);
841         $context->mark_dirty();
842     }
844     /**
845      * Add the enrolment data for the course.
846      *
847      * @param object $course course record.
848      * @return void
849      */
850     protected function process_enrolment_data($course) {
851         global $DB;
853         $enrolmentdata = $this->enrolmentdata;
854         if (empty($enrolmentdata)) {
855             return;
856         }
858         $enrolmentplugins = tool_uploadcourse_helper::get_enrolment_plugins();
859         $instances = enrol_get_instances($course->id, false);
860         foreach ($enrolmentdata as $enrolmethod => $method) {
862             $instance = null;
863             foreach ($instances as $i) {
864                 if ($i->enrol == $enrolmethod) {
865                     $instance = $i;
866                     break;
867                 }
868             }
870             $todelete = isset($method['delete']) && $method['delete'];
871             $todisable = isset($method['disable']) && $method['disable'];
872             unset($method['delete']);
873             unset($method['disable']);
875             if (!empty($instance) && $todelete) {
876                 // Remove the enrolment method.
877                 foreach ($instances as $instance) {
878                     if ($instance->enrol == $enrolmethod) {
879                         $plugin = $enrolmentplugins[$instance->enrol];
880                         $plugin->delete_instance($instance);
881                         break;
882                     }
883                 }
884             } else if (!empty($instance) && $todisable) {
885                 // Disable the enrolment.
886                 foreach ($instances as $instance) {
887                     if ($instance->enrol == $enrolmethod) {
888                         $plugin = $enrolmentplugins[$instance->enrol];
889                         $plugin->update_status($instance, ENROL_INSTANCE_DISABLED);
890                         $enrol_updated = true;
891                         break;
892                     }
893                 }
894             } else {
895                 $plugin = null;
896                 if (empty($instance)) {
897                     $plugin = $enrolmentplugins[$enrolmethod];
898                     $instance = new stdClass();
899                     $instance->id = $plugin->add_default_instance($course);
900                     $instance->roleid = $plugin->get_config('roleid');
901                     $instance->status = ENROL_INSTANCE_ENABLED;
902                 } else {
903                     $plugin = $enrolmentplugins[$instance->enrol];
904                     $plugin->update_status($instance, ENROL_INSTANCE_ENABLED);
905                 }
907                 // Now update values.
908                 foreach ($method as $k => $v) {
909                     $instance->{$k} = $v;
910                 }
912                 // Sort out the start, end and date.
913                 $instance->enrolstartdate = (isset($method['startdate']) ? strtotime($method['startdate']) : 0);
914                 $instance->enrolenddate = (isset($method['enddate']) ? strtotime($method['enddate']) : 0);
916                 // Is the enrolment period set?
917                 if (isset($method['enrolperiod']) && ! empty($method['enrolperiod'])) {
918                     if (preg_match('/^\d+$/', $method['enrolperiod'])) {
919                         $method['enrolperiod'] = (int) $method['enrolperiod'];
920                     } else {
921                         // Try and convert period to seconds.
922                         $method['enrolperiod'] = strtotime('1970-01-01 GMT + ' . $method['enrolperiod']);
923                     }
924                     $instance->enrolperiod = $method['enrolperiod'];
925                 }
926                 if ($instance->enrolstartdate > 0 && isset($method['enrolperiod'])) {
927                     $instance->enrolenddate = $instance->enrolstartdate + $method['enrolperiod'];
928                 }
929                 if ($instance->enrolenddate > 0) {
930                     $instance->enrolperiod = $instance->enrolenddate - $instance->enrolstartdate;
931                 }
932                 if ($instance->enrolenddate < $instance->enrolstartdate) {
933                     $instance->enrolenddate = $instance->enrolstartdate;
934                 }
936                 // Sort out the given role. This does not filter the roles allowed in the course.
937                 if (isset($method['role'])) {
938                     $roleids = tool_uploadcourse_helper::get_role_ids();
939                     if (isset($roleids[$method['role']])) {
940                         $instance->roleid = $roleids[$method['role']];
941                     }
942                 }
944                 $instance->timemodified = time();
945                 $DB->update_record('enrol', $instance);
946             }
947         }
948     }
950     /**
951      * Reset the current course.
952      *
953      * This does not reset any of the content of the activities.
954      *
955      * @param stdClass $course the course object of the course to reset.
956      * @return array status array of array component, item, error.
957      */
958     protected function reset($course) {
959         global $DB;
961         $resetdata = new stdClass();
962         $resetdata->id = $course->id;
963         $resetdata->reset_start_date = time();
964         $resetdata->reset_events = true;
965         $resetdata->reset_notes = true;
966         $resetdata->delete_blog_associations = true;
967         $resetdata->reset_completion = true;
968         $resetdata->reset_roles_overrides = true;
969         $resetdata->reset_roles_local = true;
970         $resetdata->reset_groups_members = true;
971         $resetdata->reset_groups_remove = true;
972         $resetdata->reset_groupings_members = true;
973         $resetdata->reset_groupings_remove = true;
974         $resetdata->reset_gradebook_items = true;
975         $resetdata->reset_gradebook_grades = true;
976         $resetdata->reset_comments = true;
978         if (empty($course->startdate)) {
979             $course->startdate = $DB->get_field_select('course', 'startdate', 'id = :id', array('id' => $course->id));
980         }
981         $resetdata->reset_start_date_old = $course->startdate;
983         if (empty($course->enddate)) {
984             $course->enddate = $DB->get_field_select('course', 'enddate', 'id = :id', array('id' => $course->id));
985         }
986         $resetdata->reset_end_date_old = $course->enddate;
988         // Add roles.
989         $roles = tool_uploadcourse_helper::get_role_ids();
990         $resetdata->unenrol_users = array_values($roles);
991         $resetdata->unenrol_users[] = 0;    // Enrolled without role.
993         return reset_course_userdata($resetdata);
994     }
996     /**
997      * Log a status
998      *
999      * @param string $code status code.
1000      * @param lang_string $message status message.
1001      * @return void
1002      */
1003     protected function status($code, lang_string $message) {
1004         if (array_key_exists($code, $this->statuses)) {
1005             throw new coding_exception('Status code already defined');
1006         }
1007         $this->statuses[$code] = $message;
1008     }