Skip to content

Commit

Permalink
MDL-14232 group import moved to group UI, fixed regressions and impro…
Browse files Browse the repository at this point in the history 
…ved coding style - in future we should definitely improve the navigation structure of groups interface
  • Loading branch information
@skodak
skodak committed Oct 12, 2010
1 parent 19eb73c commit 81ed463
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 137 deletions.
43 changes: 0 additions & 43 deletions course/import/groups/mod.php
View file

This file was deleted.

147 changes: 59 additions & 88 deletions course/import/groups/index.php → group/import.php
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,33 +23,23 @@
* @package course
*/

require_once('../../../config.php');
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

$PAGE->set_url('/course/import/groups/index.php', array('id'=>$id));
$course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);

if (!$course = $DB->get_record('course', array('id'=>$id))) {
print_error('invalidcourseid');
}
$PAGE->set_url('/group/import.php', array('id'=>$id));

require_login($course->id);
require_login($course);
$context = get_context_instance(CONTEXT_COURSE, $id);

if (!has_capability('moodle/course:managegroups', $context)) {
print_error('nopermissiontomanagegroup');
}
require_capability('moodle/course:managegroups', $context);

$stradministration = get_string("administration");
$strimportgroups = get_string("importgroups");
$streditmyprofile = get_string("editmyprofile");
$strchoose = get_string("choose");
$struser = get_string("user");
$strusers = get_string("users");
$strusersnew = get_string("usersnew");

/// Print the header
$PAGE->navbar->add($course->shortname, new moodle_url('/course/view.php', array('id'=>$course->id)));
Expand All @@ -58,18 +48,18 @@

$PAGE->set_title("$course->shortname: $strimportgroups");
$PAGE->set_heading($course->fullname);
echo $OUTPUT->header();

$mform_post = new course_import_groups_form($CFG->wwwroot.'/course/import/groups/index.php?id='.$id);
$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->get_data()) {
echo $OUTPUT->heading($strimportgroups);
/// Print the form
$mform_post ->display();
echo $OUTPUT->footer();
die;
} else {
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;
Expand All @@ -81,63 +71,52 @@
$csv_delimiter = ",";
}

// prepare temp file
$filename = $CFG->dataroot . '/temp/groupimport/importedfile_'.time().'.csv';
make_upload_directory('temp/groupimport');
//Fix mac/dos newlines
$text = $mform_post->get_file_content('userfile');
$text = preg_replace('!\r\n?!',"\n",$text);
$fp = fopen($filename, "w");
fwrite($fp,$text);
fclose($fp);

$fp = fopen($filename, "r");
$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,
"theme" => 1,
"picture" => 1,
"hidepicture" => 1);
"enrolmentkey" => 1);

// --- get header (field names) ---
$header = explode($csv_delimiter, fgets($fp,1024));
$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', 'index.php?id='.$id.'&sesskey='.sesskey(), $h);
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]) ) {
if (isset($required[$h])) {
$required[$h] = 2;
}
}
// check for required fields
foreach ($required as $key => $value) {
if ($value < 2) {
print_error('fieldrequired', 'error', 'uploaduser.php?id='.$id.'&amp;sesskey='.sesskey(), $key);
print_error('fieldrequired', 'error', 'import.php?id='.$id, $key);
}
}
$linenum = 2; // since header is line 1

while (!feof ($fp)) {
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 &#44 (for comma separated csv files)
//Note: semicolon within a field should be encoded as &#59 (for semicolon separated csv files)
$line = explode($csv_delimiter, fgets($fp,1024));
$line = explode($csv_delimiter, $rawline);
foreach ($line as $key => $value) {
//decode encoded commas
$record[$header[$key]] = preg_replace($csv_encode,$csv_delimiter,trim($value));
$record[$header[$key]] = preg_replace($csv_encode, $csv_delimiter, trim($value));
}
if ($record[$header[0]]) {
// add a new group to the database
Expand All @@ -146,77 +125,69 @@
foreach ($record as $name => $value) {
// check for required values
if (isset($required[$name]) and !$value) {
print_error('missingfield', 'error', 'uploaduser.php?sesskey='.sesskey(), $name);
}
else if ($name == "groupname") {
print_error('missingfield', 'error', 'import.php?id='.$id, $name);
} else if ($name == "groupname") {
$newgroup->name = $value;
}
} else {
// normal entry
else {
$newgroup->{$name} = $value;
}
}
///Find the courseid of the course with the given shortname

//if idnumber is set, we use that.
//unset invalid courseid
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 doesnt' get written to database
unset($newgroup->courseid);//unset so 0 doesn't get written to database
}
$newgroup->courseid = $mycourse->id;
}
//else use course short name to look up
//unset invalid coursename (if no id)

else if (isset($newgroup->coursename)){
} 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 doesnt' get written to database
unset($newgroup->courseid);//unset so 0 doesn't get written to database
}
$newgroup->courseid = $mycourse->id;
}
//else use use current id
else{

} else {
//else use use current id
$newgroup->courseid = $id;
}

//if courseid is set
if (isset($newgroup->courseid)){

$newgroup->courseid = (int)$newgroup->courseid;
$newgroup->timecreated = time();
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)){
echo $OUTPUT->notification(get_string('nopermissionforcreation','group',$groupname));
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) || !($newgroup->id = groups_create_group($newgroup)) ) {

//Record not added - probably because group is already registered
//In this case, output groupname from previous registration
if ($groupid) {
echo $OUTPUT->notification("$groupname :".get_string('groupexistforcourse', 'error', $groupname));
} else {
echo $OUTPUT->notification(get_string('groupnotaddederror', 'error', $groupname));
}
}
else {
echo $OUTPUT->notification(get_string('groupaddedsuccesfully', 'group', $groupname));
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));
}
}
} //close courseid validity check
}
unset ($newgroup);
}//close if ($record[$header[0]])
}//close while($fp)
fclose($fp);
// remove temp file
unlink($filename);
}
}

echo '<hr />';
echo $OUTPUT->single_button($returnurl, get_string('continue'), 'get');
echo $OUTPUT->footer();
die;
}

/// Print the form
echo $OUTPUT->header();
echo $OUTPUT->heading($strimportgroups);
$mform_post ->display();
echo $OUTPUT->footer();
14 changes: 8 additions & 6 deletions course/import/groups/import_form.php → group/import_form.php
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,26 @@

require_once($CFG->libdir.'/formslib.php');

class course_import_groups_form extends moodleform {
class groups_import_form extends moodleform {

function definition() {
global $CFG, $USER;
$mform =& $this->_form;
$strimportgroups = get_string('importgroups');
$maxsize = get_max_upload_file_size();
$data = $this->_customdata;

//fill in the data depending on page params
//later using set_data
$mform->addElement('header', 'general');

$filepickeroptions = array();
$filepickeroptions['filetypes'] = '*';
$filepickeroptions['maxbytes'] = $maxsize;
$filepickeroptions['maxbytes'] = get_max_upload_file_size();
$mform->addElement('filepicker', 'userfile', get_string('import'), null, $filepickeroptions);

$this->add_action_buttons(false, $strimportgroups);
$mform->addElement('hidden', 'id');

$this->add_action_buttons(true, get_string('importgroups'));

$this->set_data($data);
}
}

7 changes: 7 additions & 0 deletions group/index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@
redirect(new moodle_url('/group/autogroup.php', array('courseid'=>$courseid)));
break;

case 'showimportgroups':
redirect(new moodle_url('/group/import.php', array('id'=>$courseid)));
break;

case 'showgroupsettingsform':
redirect(new moodle_url('/group/group.php', array('courseid'=>$courseid, 'id'=>$groupids[0])));
break;
Expand Down Expand Up @@ -210,6 +214,9 @@
echo '<p><input type="submit" name="act_showautocreategroupsform" id="showautocreategroupsform" value="'
. get_string('autocreategroups', 'group') . '" /></p>'."\n";

echo '<p><input type="submit" name="act_showimportgroups" id="showimportgroups" value="'
. get_string('importgroups') . '" /></p>'."\n";

echo '</td>'."\n";
echo '<td>'."\n";

Expand Down

0 comments on commit 81ed463

Please sign in to comment.