group/import.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Bulk group creation registration script from a comma separated file
  20  *
  21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  * @package core_group
  24  */
  25
  26 require_once('../config.php');
  27 require_once($CFG->dirroot.'/course/lib.php');
  28 require_once($CFG->dirroot.'/group/lib.php');
  29 include_once('import_form.php');
  30
  31 $id = required_param('id', PARAM_INT);    // Course id
  32
  33 $course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
  34
  35 $PAGE->set_url('/group/import.php', array('id'=>$id));
  36
  37 require_login($course);
  38 $context = context_course::instance($id);
  39
  40 require_capability('moodle/course:managegroups', $context);
  41
  42 $strimportgroups = get_string('importgroups', 'core_group');
  43
  44 $PAGE->navbar->add($strimportgroups);
  45 navigation_node::override_active_url(new moodle_url('/group/index.php', array('id' => $course->id)));
  46 $PAGE->set_title("$course->shortname: $strimportgroups");
  47 $PAGE->set_heading($course->fullname);
  48 $PAGE->set_pagelayout('admin');
  49
  50 $returnurl = new moodle_url('/group/index.php', array('id'=>$id));
  51
  52 $mform_post = new groups_import_form(null, array('id'=>$id));
  53
  54 // If a file has been uploaded, then process it
  55 if ($mform_post->is_cancelled()) {
  56     redirect($returnurl);
  57
  58 } else if ($mform_post->get_data()) {
  59     echo $OUTPUT->header();
  60
  61     $csv_encode = '/\&\#44/';
  62     if (isset($CFG->CSV_DELIMITER)) {
  63         $csv_delimiter = $CFG->CSV_DELIMITER;
  64
  65         if (isset($CFG->CSV_ENCODE)) {
  66             $csv_encode = '/\&\#' . $CFG->CSV_ENCODE . '/';
  67         }
  68     } else {
  69         $csv_delimiter = ",";
  70     }
  71
  72     $text = $mform_post->get_file_content('userfile');
  73     $text = preg_replace('!\r\n?!',"\n",$text);
  74
  75     $rawlines = explode("\n", $text);
  76     unset($text);
  77
  78     // make arrays of valid fields for error checking
  79     $required = array("groupname" => 1);
  80     $optionalDefaults = array("lang" => 1);
  81     $optional = array("coursename" => 1,
  82             "idnumber" => 1,
  83             "groupidnumber" => 1,
  84             "description" => 1,
  85             "enrolmentkey" => 1,
  86             "groupingname" => 1);
  87
  88     // --- get header (field names) ---
  89     $header = explode($csv_delimiter, array_shift($rawlines));
  90     // check for valid field names
  91     foreach ($header as $i => $h) {
  92         $h = trim($h); $header[$i] = $h; // remove whitespace
  93         if (!(isset($required[$h]) or isset($optionalDefaults[$h]) or isset($optional[$h]))) {
  94                 print_error('invalidfieldname', 'error', 'import.php?id='.$id, $h);
  95             }
  96         if (isset($required[$h])) {
  97             $required[$h] = 2;
  98         }
  99     }
 100     // check for required fields
 101     foreach ($required as $key => $value) {
 102         if ($value < 2) {
 103             print_error('fieldrequired', 'error', 'import.php?id='.$id, $key);
 104         }
 105     }
 106     $linenum = 2; // since header is line 1
 107
 108     foreach ($rawlines as $rawline) {
 109
 110         $newgroup = new stdClass();//to make Martin happy
 111         foreach ($optionalDefaults as $key => $value) {
 112             $newgroup->$key = current_language(); //defaults to current language
 113         }
 114         //Note: commas within a field should be encoded as &#44 (for comma separated csv files)
 115         //Note: semicolon within a field should be encoded as &#59 (for semicolon separated csv files)
 116         $line = explode($csv_delimiter, $rawline);
 117         foreach ($line as $key => $value) {
 118             //decode encoded commas
 119             $record[$header[$key]] = preg_replace($csv_encode, $csv_delimiter, trim($value));
 120         }
 121         if (trim($rawline) !== '') {
 122             // add a new group to the database
 123
 124             // add fields to object $user
 125             foreach ($record as $name => $value) {
 126                 // check for required values
 127                 if (isset($required[$name]) and !$value) {
 128                     print_error('missingfield', 'error', 'import.php?id='.$id, $name);
 129                 } else if ($name == "groupname") {
 130                     $newgroup->name = $value;
 131                 } else {
 132                 // normal entry
 133                     $newgroup->{$name} = $value;
 134                 }
 135             }
 136
 137             if (isset($newgroup->idnumber) && strlen($newgroup->idnumber)) {
 138                 //if idnumber is set, we use that.
 139                 //unset invalid courseid
 140                 if (!$mycourse = $DB->get_record('course', array('idnumber'=>$newgroup->idnumber))) {
 141                     echo $OUTPUT->notification(get_string('unknowncourseidnumber', 'error', $newgroup->idnumber));
 142                     unset($newgroup->courseid);//unset so 0 doesn't get written to database
 143                 } else {
 144                     $newgroup->courseid = $mycourse->id;
 145                 }
 146
 147             } else if (isset($newgroup->coursename) && strlen($newgroup->coursename)) {
 148                 //else use course short name to look up
 149                 //unset invalid coursename (if no id)
 150                 if (!$mycourse = $DB->get_record('course', array('shortname' => $newgroup->coursename))) {
 151                     echo $OUTPUT->notification(get_string('unknowncourse', 'error', $newgroup->coursename));
 152                     unset($newgroup->courseid);//unset so 0 doesn't get written to database
 153                 } else {
 154                     $newgroup->courseid = $mycourse->id;
 155                 }
 156
 157             } else {
 158                 //else use use current id
 159                 $newgroup->courseid = $id;
 160             }
 161             unset($newgroup->idnumber);
 162             unset($newgroup->coursename);
 163
 164             //if courseid is set
 165             if (isset($newgroup->courseid)) {
 166                 $linenum++;
 167                 $groupname = $newgroup->name;
 168                 $newgrpcoursecontext = context_course::instance($newgroup->courseid);
 169
 170                 ///Users cannot upload groups in courses they cannot update.
 171                 if (!has_capability('moodle/course:managegroups', $newgrpcoursecontext) or (!is_enrolled($newgrpcoursecontext) and !has_capability('moodle/course:view', $newgrpcoursecontext))) {
 172                     echo $OUTPUT->notification(get_string('nopermissionforcreation', 'group', $groupname));
 173
 174                 } else {
 175                     if (isset($newgroup->groupidnumber)) {
 176                         // The CSV field for the group idnumber is groupidnumber rather than
 177                         // idnumber as that field is already in use for the course idnumber.
 178                         $newgroup->groupidnumber = trim($newgroup->groupidnumber);
 179                         if (has_capability('moodle/course:changeidnumber', $newgrpcoursecontext)) {
 180                             $newgroup->idnumber = $newgroup->groupidnumber;
 181                             if ($existing = groups_get_group_by_idnumber($newgroup->courseid, $newgroup->idnumber)) {
 182                                 // idnumbers must be unique to a course but we shouldn't ignore group creation for duplicates
 183                                 $existing->name = s($existing->name);
 184                                 $existing->idnumber = s($existing->idnumber);
 185                                 $existing->problemgroup = $groupname;
 186                                 echo $OUTPUT->notification(get_string('groupexistforcoursewithidnumber', 'error', $existing));
 187                                 unset($newgroup->idnumber);
 188                             }
 189                         }
 190                         // Always drop the groupidnumber key. It's not a valid database field
 191                         unset($newgroup->groupidnumber);
 192                     }
 193                     if ($groupid = groups_get_group_by_name($newgroup->courseid, $groupname)) {
 194                         echo $OUTPUT->notification("$groupname :".get_string('groupexistforcourse', 'error', $groupname));
 195                     } else if ($groupid = groups_create_group($newgroup)) {
 196                         echo $OUTPUT->notification(get_string('groupaddedsuccesfully', 'group', $groupname), 'notifysuccess');
 197                     } else {
 198                         echo $OUTPUT->notification(get_string('groupnotaddederror', 'error', $groupname));
 199                         continue;
 200                     }
 201
 202                     // Add group to grouping
 203                     if (isset($newgroup->groupingname) && strlen($newgroup->groupingname)) {
 204                         $groupingname = $newgroup->groupingname;
 205                         if (! $groupingid = groups_get_grouping_by_name($newgroup->courseid, $groupingname)) {
 206                             $data = new stdClass();
 207                             $data->courseid = $newgroup->courseid;
 208                             $data->name = $groupingname;
 209                             if ($groupingid = groups_create_grouping($data)) {
 210                                 echo $OUTPUT->notification(get_string('groupingaddedsuccesfully', 'group', $groupingname), 'notifysuccess');
 211                             } else {
 212                                 echo $OUTPUT->notification(get_string('groupingnotaddederror', 'error', $groupingname));
 213                                 continue;
 214                             }
 215                         }
 216
 217                         // if we have reached here we definitely have a groupingid
 218                         $a = array('groupname' => $groupname, 'groupingname' => $groupingname);
 219                         try {
 220                             groups_assign_grouping($groupingid, $groupid);
 221                             echo $OUTPUT->notification(get_string('groupaddedtogroupingsuccesfully', 'group', $a), 'notifysuccess');
 222                         } catch (Exception $e) {
 223                             echo $OUTPUT->notification(get_string('groupnotaddedtogroupingerror', 'error', $a));
 224                         }
 225
 226                     }
 227                 }
 228             }
 229             unset ($newgroup);
 230         }
 231     }
 232
 233     echo $OUTPUT->single_button($returnurl, get_string('continue'), 'get');
 234     echo $OUTPUT->footer();
 235     die;
 236 }
 237
 238 /// Print the form
 239 echo $OUTPUT->header();
 240 echo $OUTPUT->heading_with_help($strimportgroups, 'importgroups', 'core_group');
 241 $mform_post ->display();
 242 echo $OUTPUT->footer();