public function test_get_course_formats()
{
$result = tool_uploadcourse_helper::get_course_formats();
$this->assertSame(array_keys(core_component::get_plugin_list('format')), $result);
// Should be similar as first result, as cached.
$this->assertSame($result, tool_uploadcourse_helper::get_course_formats());
}
/**
* Validates and prepares the data.
*
* @return bool false is any error occured.
*/
public function prepare()
{
global $DB, $SITE;
$this->prepared = true;
// Validate the shortname.
if (!empty($this->shortname) || is_numeric($this->shortname)) {
if ($this->shortname !== clean_param($this->shortname, PARAM_TEXT)) {
$this->error('invalidshortname', new lang_string('invalidshortname', 'tool_uploadcourse'));
return false;
}
}
$exists = $this->exists();
// Do we want to delete the course?
if ($this->options['delete']) {
if (!$exists) {
$this->error('cannotdeletecoursenotexist', new lang_string('cannotdeletecoursenotexist', 'tool_uploadcourse'));
return false;
} else {
if (!$this->can_delete()) {
$this->error('coursedeletionnotallowed', new lang_string('coursedeletionnotallowed', 'tool_uploadcourse'));
return false;
}
}
$this->do = self::DO_DELETE;
return true;
}
// Can we create/update the course under those conditions?
if ($exists) {
if ($this->mode === tool_uploadcourse_processor::MODE_CREATE_NEW) {
$this->error('courseexistsanduploadnotallowed', new lang_string('courseexistsanduploadnotallowed', 'tool_uploadcourse'));
return false;
} else {
if ($this->can_update()) {
// We can never allow for any front page changes!
if ($this->shortname == $SITE->shortname) {
$this->error('cannotupdatefrontpage', new lang_string('cannotupdatefrontpage', 'tool_uploadcourse'));
return false;
}
}
}
} else {
if (!$this->can_create()) {
$this->error('coursedoesnotexistandcreatenotallowed', new lang_string('coursedoesnotexistandcreatenotallowed', 'tool_uploadcourse'));
return false;
}
}
// Basic data.
$coursedata = array();
foreach ($this->rawdata as $field => $value) {
if (!in_array($field, self::$validfields)) {
continue;
} else {
if ($field == 'shortname') {
// Let's leave it apart from now, use $this->shortname only.
continue;
}
}
$coursedata[$field] = $value;
}
$mode = $this->mode;
$updatemode = $this->updatemode;
$usedefaults = $this->can_use_defaults();
// Resolve the category, and fail if not found.
$errors = array();
$catid = tool_uploadcourse_helper::resolve_category($this->rawdata, $errors);
if (empty($errors)) {
$coursedata['category'] = $catid;
} else {
foreach ($errors as $key => $message) {
$this->error($key, $message);
}
return false;
}
// If the course does not exist, or will be forced created.
if (!$exists || $mode === tool_uploadcourse_processor::MODE_CREATE_ALL) {
// Mandatory fields upon creation.
$errors = array();
foreach (self::$mandatoryfields as $field) {
if ((!isset($coursedata[$field]) || $coursedata[$field] === '') && (!isset($this->defaults[$field]) || $this->defaults[$field] === '')) {
$errors[] = $field;
}
}
if (!empty($errors)) {
$this->error('missingmandatoryfields', new lang_string('missingmandatoryfields', 'tool_uploadcourse', implode(', ', $errors)));
return false;
}
}
// Should the course be renamed?
if (!empty($this->options['rename']) || is_numeric($this->options['rename'])) {
if (!$this->can_update()) {
$this->error('canonlyrenameinupdatemode', new lang_string('canonlyrenameinupdatemode', 'tool_uploadcourse'));
return false;
} else {
if (!$exists) {
$this->error('cannotrenamecoursenotexist', new lang_string('cannotrenamecoursenotexist', 'tool_uploadcourse'));
return false;
} else {
if (!$this->can_rename()) {
$this->error('courserenamingnotallowed', new lang_string('courserenamingnotallowed', 'tool_uploadcourse'));
return false;
} else {
if ($this->options['rename'] !== clean_param($this->options['rename'], PARAM_TEXT)) {
$this->error('invalidshortname', new lang_string('invalidshortname', 'tool_uploadcourse'));
return false;
} else {
if ($this->exists($this->options['rename'])) {
$this->error('cannotrenameshortnamealreadyinuse', new lang_string('cannotrenameshortnamealreadyinuse', 'tool_uploadcourse'));
return false;
} else {
if (isset($coursedata['idnumber']) && $DB->count_records_select('course', 'idnumber = :idn AND shortname != :sn', array('idn' => $coursedata['idnumber'], 'sn' => $this->shortname)) > 0) {
$this->error('cannotrenameidnumberconflict', new lang_string('cannotrenameidnumberconflict', 'tool_uploadcourse'));
return false;
}
}
}
}
}
}
$coursedata['shortname'] = $this->options['rename'];
$this->status('courserenamed', new lang_string('courserenamed', 'tool_uploadcourse', array('from' => $this->shortname, 'to' => $coursedata['shortname'])));
}
// Should we generate a shortname?
if (empty($this->shortname) && !is_numeric($this->shortname)) {
if (empty($this->importoptions['shortnametemplate'])) {
$this->error('missingshortnamenotemplate', new lang_string('missingshortnamenotemplate', 'tool_uploadcourse'));
return false;
} else {
if (!$this->can_only_create()) {
$this->error('cannotgenerateshortnameupdatemode', new lang_string('cannotgenerateshortnameupdatemode', 'tool_uploadcourse'));
return false;
} else {
$newshortname = tool_uploadcourse_helper::generate_shortname($coursedata, $this->importoptions['shortnametemplate']);
if (is_null($newshortname)) {
$this->error('generatedshortnameinvalid', new lang_string('generatedshortnameinvalid', 'tool_uploadcourse'));
return false;
} else {
if ($this->exists($newshortname)) {
if ($mode === tool_uploadcourse_processor::MODE_CREATE_NEW) {
$this->error('generatedshortnamealreadyinuse', new lang_string('generatedshortnamealreadyinuse', 'tool_uploadcourse'));
return false;
}
$exists = true;
}
}
$this->status('courseshortnamegenerated', new lang_string('courseshortnamegenerated', 'tool_uploadcourse', $newshortname));
$this->shortname = $newshortname;
}
}
}
// If exists, but we only want to create courses, increment the shortname.
if ($exists && $mode === tool_uploadcourse_processor::MODE_CREATE_ALL) {
$original = $this->shortname;
$this->shortname = tool_uploadcourse_helper::increment_shortname($this->shortname);
$exists = false;
if ($this->shortname != $original) {
$this->status('courseshortnameincremented', new lang_string('courseshortnameincremented', 'tool_uploadcourse', array('from' => $original, 'to' => $this->shortname)));
if (isset($coursedata['idnumber'])) {
$originalidn = $coursedata['idnumber'];
$coursedata['idnumber'] = tool_uploadcourse_helper::increment_idnumber($coursedata['idnumber']);
if ($originalidn != $coursedata['idnumber']) {
$this->status('courseidnumberincremented', new lang_string('courseidnumberincremented', 'tool_uploadcourse', array('from' => $originalidn, 'to' => $coursedata['idnumber'])));
}
}
}
}
// If the course does not exist, ensure that the ID number is not taken.
if (!$exists && isset($coursedata['idnumber'])) {
if ($DB->count_records_select('course', 'idnumber = :idn', array('idn' => $coursedata['idnumber'])) > 0) {
$this->error('idnumberalreadyinuse', new lang_string('idnumberalreadyinuse', 'tool_uploadcourse'));
return false;
}
}
// Ultimate check mode vs. existence.
switch ($mode) {
case tool_uploadcourse_processor::MODE_CREATE_NEW:
case tool_uploadcourse_processor::MODE_CREATE_ALL:
if ($exists) {
$this->error('courseexistsanduploadnotallowed', new lang_string('courseexistsanduploadnotallowed', 'tool_uploadcourse'));
return false;
}
break;
case tool_uploadcourse_processor::MODE_UPDATE_ONLY:
if (!$exists) {
$this->error('coursedoesnotexistandcreatenotallowed', new lang_string('coursedoesnotexistandcreatenotallowed', 'tool_uploadcourse'));
return false;
}
// No break!
// No break!
case tool_uploadcourse_processor::MODE_CREATE_OR_UPDATE:
if ($exists) {
if ($updatemode === tool_uploadcourse_processor::UPDATE_NOTHING) {
$this->error('updatemodedoessettonothing', new lang_string('updatemodedoessettonothing', 'tool_uploadcourse'));
return false;
}
}
break;
default:
// O_o Huh?! This should really never happen here!
$this->error('unknownimportmode', new lang_string('unknownimportmode', 'tool_uploadcourse'));
return false;
}
// Get final data.
if ($exists) {
$missingonly = $updatemode === tool_uploadcourse_processor::UPDATE_MISSING_WITH_DATA_OR_DEFAUTLS;
$coursedata = $this->get_final_update_data($coursedata, $usedefaults, $missingonly);
// Make sure we are not trying to mess with the front page, though we should never get here!
if ($coursedata['id'] == $SITE->id) {
$this->error('cannotupdatefrontpage', new lang_string('cannotupdatefrontpage', 'tool_uploadcourse'));
return false;
}
$this->do = self::DO_UPDATE;
} else {
$coursedata = $this->get_final_create_data($coursedata);
$this->do = self::DO_CREATE;
}
// Course start date.
if (!empty($coursedata['startdate'])) {
$coursedata['startdate'] = strtotime($coursedata['startdate']);
}
// Add role renaming.
$errors = array();
$rolenames = tool_uploadcourse_helper::get_role_names($this->rawdata, $errors);
if (!empty($errors)) {
foreach ($errors as $key => $message) {
$this->error($key, $message);
}
return false;
}
foreach ($rolenames as $rolekey => $rolename) {
$coursedata[$rolekey] = $rolename;
}
// Some validation.
if (!empty($coursedata['format']) && !in_array($coursedata['format'], tool_uploadcourse_helper::get_course_formats())) {
$this->error('invalidcourseformat', new lang_string('invalidcourseformat', 'tool_uploadcourse'));
return false;
}
// Saving data.
$this->data = $coursedata;
$this->enrolmentdata = tool_uploadcourse_helper::get_enrolment_data($this->rawdata);
if (isset($this->rawdata['tags']) && strval($this->rawdata['tags']) !== '') {
$this->data['tags'] = preg_split('/\\s*,\\s*/', trim($this->rawdata['tags']), -1, PREG_SPLIT_NO_EMPTY);
}
// Restore data.
// TODO Speed up things by not really extracting the backup just yet, but checking that
// the backup file or shortname passed are valid. Extraction should happen in proceed().
$this->restoredata = $this->get_restore_content_dir();
if ($this->restoredata === false) {
return false;
}
// We can only reset courses when allowed and we are updating the course.
if ($this->importoptions['reset'] || $this->options['reset']) {
if ($this->do !== self::DO_UPDATE) {
$this->error('canonlyresetcourseinupdatemode', new lang_string('canonlyresetcourseinupdatemode', 'tool_uploadcourse'));
return false;
} else {
if (!$this->can_reset()) {
$this->error('courseresetnotallowed', new lang_string('courseresetnotallowed', 'tool_uploadcourse'));
return false;
}
}
}
return true;
}
