Merge branch 'wip-MDL-34344-m25' of git://github.com/samhemelryk/moodle
[moodle.git] / group / import.php
1 <?php
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/>.
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  */
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');
31 $id = required_param('id', PARAM_INT);    // Course id
33 $course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
35 $PAGE->set_url('/group/import.php', array('id'=>$id));
37 require_login($course);
38 $context = context_course::instance($id);
40 require_capability('moodle/course:managegroups', $context);
42 $strimportgroups = get_string('importgroups', 'core_group');
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('standard');
50 $returnurl = new moodle_url('/group/index.php', array('id'=>$id));
52 $mform_post = new groups_import_form(null, array('id'=>$id));
54 // If a file has been uploaded, then process it
55 if ($mform_post->is_cancelled()) {
56     redirect($returnurl);
58 } else if ($mform_post->get_data()) {
59     echo $OUTPUT->header();
61     $csv_encode = '/\&\#44/';
62     if (isset($CFG->CSV_DELIMITER)) {
63         $csv_delimiter = $CFG->CSV_DELIMITER;
65         if (isset($CFG->CSV_ENCODE)) {
66             $csv_encode = '/\&\#' . $CFG->CSV_ENCODE . '/';
67         }
68     } else {
69         $csv_delimiter = ",";
70     }
72     $text = $mform_post->get_file_content('userfile');
73     $text = preg_replace('!\r\n?!',"\n",$text);
75     $rawlines = explode("\n", $text);
76     unset($text);
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);
87     // --- get header (field names) ---
88     $header = explode($csv_delimiter, array_shift($rawlines));
89     // check for valid field names
90     foreach ($header as $i => $h) {
91         $h = trim($h); $header[$i] = $h; // remove whitespace
92         if (!(isset($required[$h]) or isset($optionalDefaults[$h]) or isset($optional[$h]))) {
93                 print_error('invalidfieldname', 'error', 'import.php?id='.$id, $h);
94             }
95         if (isset($required[$h])) {
96             $required[$h] = 2;
97         }
98     }
99     // check for required fields
100     foreach ($required as $key => $value) {
101         if ($value < 2) {
102             print_error('fieldrequired', 'error', 'import.php?id='.$id, $key);
103         }
104     }
105     $linenum = 2; // since header is line 1
107     foreach ($rawlines as $rawline) {
109         $newgroup = new stdClass();//to make Martin happy
110         foreach ($optionalDefaults as $key => $value) {
111             $newgroup->$key = current_language(); //defaults to current language
112         }
113         //Note: commas within a field should be encoded as &#44 (for comma separated csv files)
114         //Note: semicolon within a field should be encoded as &#59 (for semicolon separated csv files)
115         $line = explode($csv_delimiter, $rawline);
116         foreach ($line as $key => $value) {
117             //decode encoded commas
118             $record[$header[$key]] = preg_replace($csv_encode, $csv_delimiter, trim($value));
119         }
120         if ($record[$header[0]]) {
121             // add a new group to the database
123             // add fields to object $user
124             foreach ($record as $name => $value) {
125                 // check for required values
126                 if (isset($required[$name]) and !$value) {
127                     print_error('missingfield', 'error', 'import.php?id='.$id, $name);
128                 } else if ($name == "groupname") {
129                     $newgroup->name = $value;
130                 } else {
131                 // normal entry
132                     $newgroup->{$name} = $value;
133                 }
134             }
136             if (isset($newgroup->idnumber)){
137                 //if idnumber is set, we use that.
138                 //unset invalid courseid
139                 if (!$mycourse = $DB->get_record('course', array('idnumber'=>$newgroup->idnumber))) {
140                     echo $OUTPUT->notification(get_string('unknowncourseidnumber', 'error', $newgroup->idnumber));
141                     unset($newgroup->courseid);//unset so 0 doesn't get written to database
142                 }
143                 $newgroup->courseid = $mycourse->id;
145             } else if (isset($newgroup->coursename)){
146                 //else use course short name to look up
147                 //unset invalid coursename (if no id)
148                 if (!$mycourse = $DB->get_record('course', array('shortname', $newgroup->coursename))) {
149                     echo $OUTPUT->notification(get_string('unknowncourse', 'error', $newgroup->coursename));
150                     unset($newgroup->courseid);//unset so 0 doesn't get written to database
151                 }
152                 $newgroup->courseid = $mycourse->id;
154             } else {
155                 //else use use current id
156                 $newgroup->courseid = $id;
157             }
159             //if courseid is set
160             if (isset($newgroup->courseid)) {
161                 $linenum++;
162                 $groupname = $newgroup->name;
163                 $newgrpcoursecontext = context_course::instance($newgroup->courseid);
165                 ///Users cannot upload groups in courses they cannot update.
166                 if (!has_capability('moodle/course:managegroups', $newgrpcoursecontext) or (!is_enrolled($newgrpcoursecontext) and !has_capability('moodle/course:view', $newgrpcoursecontext))) {
167                     echo $OUTPUT->notification(get_string('nopermissionforcreation', 'group', $groupname));
169                 } else {
170                     if (isset($newgroup->groupidnumber)) {
171                         // The CSV field for the group idnumber is groupidnumber rather than
172                         // idnumber as that field is already in use for the course idnumber.
173                         $newgroup->groupidnumber = trim($newgroup->groupidnumber);
174                         if (has_capability('moodle/course:changeidnumber', $newgrpcoursecontext)) {
175                             $newgroup->idnumber = $newgroup->groupidnumber;
176                             if ($existing = groups_get_group_by_idnumber($newgroup->courseid, $newgroup->idnumber)) {
177                                 // idnumbers must be unique to a course but we shouldn't ignore group creation for duplicates
178                                 $existing->name = s($existing->name);
179                                 $existing->idnumber = s($existing->idnumber);
180                                 $existing->problemgroup = $groupname;
181                                 echo $OUTPUT->notification(get_string('groupexistforcoursewithidnumber', 'error', $existing));
182                                 unset($newgroup->idnumber);
183                             }
184                         }
185                         // Always drop the groupidnumber key. It's not a valid database field
186                         unset($newgroup->groupidnumber);
187                     }
188                     if ($groupid = groups_get_group_by_name($newgroup->courseid, $groupname)) {
189                         echo $OUTPUT->notification("$groupname :".get_string('groupexistforcourse', 'error', $groupname));
190                     } else if (groups_create_group($newgroup)) {
191                         echo $OUTPUT->notification(get_string('groupaddedsuccesfully', 'group', $groupname), 'notifysuccess');
192                     } else {
193                         echo $OUTPUT->notification(get_string('groupnotaddederror', 'error', $groupname));
194                     }
195                 }
196             }
197             unset ($newgroup);
198         }
199     }
201     echo $OUTPUT->single_button($returnurl, get_string('continue'), 'get');
202     echo $OUTPUT->footer();
203     die;
206 /// Print the form
207 echo $OUTPUT->header();
208 echo $OUTPUT->heading_with_help($strimportgroups, 'importgroups', 'core_group');
209 $mform_post ->display();
210 echo $OUTPUT->footer();