. /** * Bulk group creation registration script from a comma separated file * * @copyright 1999 Martin Dougiamas http://dougiamas.com * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @package course */ require_once('../config.php'); require_once($CFG->dirroot.'/course/lib.php'); require_once($CFG->dirroot.'/group/lib.php'); include_once('import_form.php'); $id = required_param('id', PARAM_INT); // Course id $course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST); $PAGE->set_url('/group/import.php', array('id'=>$id)); require_login($course); $context = get_context_instance(CONTEXT_COURSE, $id); require_capability('moodle/course:managegroups', $context); $strimportgroups = get_string('importgroups', 'core_group'); $PAGE->navbar->add($strimportgroups); navigation_node::override_active_url(new moodle_url('/group/index.php', array('id' => $course->id))); $PAGE->set_title("$course->shortname: $strimportgroups"); $PAGE->set_heading($course->fullname); $PAGE->set_pagelayout('standard'); $returnurl = new moodle_url('/group/index.php', array('id'=>$id)); $mform_post = new groups_import_form(null, array('id'=>$id)); // If a file has been uploaded, then process it if ($mform_post->is_cancelled()) { redirect($returnurl); } else if ($mform_post->get_data()) { echo $OUTPUT->header(); $csv_encode = '/\&\#44/'; if (isset($CFG->CSV_DELIMITER)) { $csv_delimiter = $CFG->CSV_DELIMITER; if (isset($CFG->CSV_ENCODE)) { $csv_encode = '/\&\#' . $CFG->CSV_ENCODE . '/'; } } else { $csv_delimiter = ","; } $text = $mform_post->get_file_content('userfile'); $text = preg_replace('!\r\n?!',"\n",$text); $rawlines = explode("\n", $text); unset($text); // make arrays of valid fields for error checking $required = array("groupname" => 1); $optionalDefaults = array("lang" => 1); $optional = array("coursename" => 1, "idnumber" => 1, "description" => 1, "enrolmentkey" => 1); // --- get header (field names) --- $header = explode($csv_delimiter, array_shift($rawlines)); // check for valid field names foreach ($header as $i => $h) { $h = trim($h); $header[$i] = $h; // remove whitespace if (!(isset($required[$h]) or isset($optionalDefaults[$h]) or isset($optional[$h]))) { print_error('invalidfieldname', 'error', 'import.php?id='.$id, $h); } if (isset($required[$h])) { $required[$h] = 2; } } // check for required fields foreach ($required as $key => $value) { if ($value < 2) { print_error('fieldrequired', 'error', 'import.php?id='.$id, $key); } } $linenum = 2; // since header is line 1 foreach ($rawlines as $rawline) { $newgroup = new stdClass();//to make Martin happy foreach ($optionalDefaults as $key => $value) { $newgroup->$key = current_language(); //defaults to current language } //Note: commas within a field should be encoded as , (for comma separated csv files) //Note: semicolon within a field should be encoded as ; (for semicolon separated csv files) $line = explode($csv_delimiter, $rawline); foreach ($line as $key => $value) { //decode encoded commas $record[$header[$key]] = preg_replace($csv_encode, $csv_delimiter, trim($value)); } if ($record[$header[0]]) { // add a new group to the database // add fields to object $user foreach ($record as $name => $value) { // check for required values if (isset($required[$name]) and !$value) { print_error('missingfield', 'error', 'import.php?id='.$id, $name); } else if ($name == "groupname") { $newgroup->name = $value; } else { // normal entry $newgroup->{$name} = $value; } } if (isset($newgroup->idnumber)){ //if idnumber is set, we use that. //unset invalid courseid if (!$mycourse = $DB->get_record('course', array('idnumber'=>$newgroup->idnumber))) { echo $OUTPUT->notification(get_string('unknowncourseidnumber', 'error', $newgroup->idnumber)); unset($newgroup->courseid);//unset so 0 doesn't get written to database } $newgroup->courseid = $mycourse->id; } else if (isset($newgroup->coursename)){ //else use course short name to look up //unset invalid coursename (if no id) if (!$mycourse = $DB->get_record('course', array('shortname', $newgroup->coursename))) { echo $OUTPUT->notification(get_string('unknowncourse', 'error', $newgroup->coursename)); unset($newgroup->courseid);//unset so 0 doesn't get written to database } $newgroup->courseid = $mycourse->id; } else { //else use use current id $newgroup->courseid = $id; } //if courseid is set if (isset($newgroup->courseid)) { $linenum++; $groupname = $newgroup->name; $newgrpcoursecontext = get_context_instance(CONTEXT_COURSE, $newgroup->courseid); ///Users cannot upload groups in courses they cannot update. if (!has_capability('moodle/course:managegroups', $newgrpcoursecontext) or (!is_enrolled($newgrpcoursecontext) and !has_capability('moodle/course:view', $newgrpcoursecontext))) { echo $OUTPUT->notification(get_string('nopermissionforcreation', 'group', $groupname)); } else { if ($groupid = groups_get_group_by_name($newgroup->courseid, $groupname)) { echo $OUTPUT->notification("$groupname :".get_string('groupexistforcourse', 'error', $groupname)); } else if (groups_create_group($newgroup)) { echo $OUTPUT->notification(get_string('groupaddedsuccesfully', 'group', $groupname), 'notifysuccess'); } else { echo $OUTPUT->notification(get_string('groupnotaddederror', 'error', $groupname)); } } } unset ($newgroup); } } echo $OUTPUT->single_button($returnurl, get_string('continue'), 'get'); echo $OUTPUT->footer(); die; } /// Print the form echo $OUTPUT->header(); echo $OUTPUT->heading_with_help($strimportgroups, 'importgroups', 'core_group'); $mform_post ->display(); echo $OUTPUT->footer();