course/import/groups/index.php

   1 <?php // $Id: uploadgroups.php, 2005/10/31 19:09:31
   2
   3 /// Bulk group creation registration script from a comma separated file
   4
   5     require_once('../../../config.php');
   6     require_once('../../lib.php');
   7     require_once($CFG->dirroot . '/group/lib/basicgrouplib.php');
   8
   9     $id = required_param('id', PARAM_INT);    // Course id
  10
  11     if (! $course = get_record('course', 'id', $id) ) {
  12         error("That's an invalid course id");
  13     }
  14
  15     require_login($course->id);
  16     $context = get_context_instance(CONTEXT_COURSE, $id);
  17
  18
  19     if (!has_capability('moodle/course:managegroups', $context)) {
  20         error("You do not have the required permissions to manage groups.");
  21     }
  22
  23     //if (!confirm_sesskey()) {
  24     //    error(get_string('confirmsesskeybad', 'error'));
  25     //}
  26
  27       $strimportgroups = get_string("importgroups");
  28
  29     $csv_encode = '/\&\#44/';
  30     if (isset($CFG->CSV_DELIMITER)) {
  31         $csv_delimiter = '\\' . $CFG->CSV_DELIMITER;
  32         $csv_delimiter2 = $CFG->CSV_DELIMITER;
  33
  34         if (isset($CFG->CSV_ENCODE)) {
  35             $csv_encode = '/\&\#' . $CFG->CSV_ENCODE . '/';
  36         }
  37     } else {
  38         $csv_delimiter = "\,";
  39         $csv_delimiter2 = ",";
  40     }
  41
  42 /// Print the header
  43
  44     print_header("$course->shortname: $strimportgroups", $course->fullname,
  45                  "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ".
  46                  "-> <a href=\"$CFG->wwwroot/course/import.php?id=$course->id\">".get_string('import')."</a> ".
  47                  "-> $strimportgroups");
  48
  49 /// If a file has been uploaded, then process it
  50
  51     require_once($CFG->dirroot.'/lib/uploadlib.php');
  52     $um = new upload_manager('userfile',false,false,null,false,0);
  53     if ($um->preprocess_files()) {
  54         $filename = $um->files['userfile']['tmp_name'];
  55
  56         //Fix mac/dos newlines
  57         $text = my_file_get_contents($filename);
  58         $text = preg_replace('!\r\n?!',"\n",$text);
  59         $fp = fopen($filename, "w");
  60         fwrite($fp,$text);
  61         fclose($fp);
  62
  63         $fp = fopen($filename, "r");
  64
  65         // make arrays of valid fields for error checking
  66         $required = array("groupname" => 1, );
  67         $optionalDefaults = array("lang" => 1, );
  68         $optional = array("coursename" => 1,
  69                           "idnumber" =>1,
  70                           "description" => 1,
  71                           "enrolmentkey" => 1,
  72                           "theme" => 1,
  73                           "picture" => 1,
  74                           "hidepicture" => 1, );
  75
  76         // --- get header (field names) ---
  77         $header = split($csv_delimiter, fgets($fp,1024));
  78         // check for valid field names
  79         foreach ($header as $i => $h) {
  80             $h = trim($h); $header[$i] = $h; // remove whitespace
  81             if ( !(isset($required[$h]) or
  82                 isset($optionalDefaults[$h]) or
  83                 isset($optional[$h])) ) {
  84                 error(get_string('invalidfieldname', 'error', $h), 'index.php?id='.$id.'&amp;sesskey='.$USER->sesskey);
  85             }
  86             if ( isset($required[$h]) ) {
  87                 $required[$h] = 2;
  88             }
  89         }
  90         // check for required fields
  91         foreach ($required as $key => $value) {
  92             if ($value < 2) {
  93                 error(get_string('fieldrequired', 'error', $key), 'uploaduser.php?id='.$id.'&amp;sesskey='.$USER->sesskey);
  94             }
  95         }
  96         $linenum = 2; // since header is line 1
  97
  98         while (!feof ($fp)) {
  99
 100             $newgroup = new object();//to make Martin happy
 101             foreach ($optionalDefaults as $key => $value) {
 102                 $newgroup->$key = current_language(); //defaults to current language
 103             }
 104            //Note: commas within a field should be encoded as &#44 (for comma separated csv files)
 105            //Note: semicolon within a field should be encoded as &#59 (for semicolon separated csv files)
 106             $line = split($csv_delimiter, fgets($fp,1024));
 107             foreach ($line as $key => $value) {
 108                 //decode encoded commas
 109                 $record[$header[$key]] = preg_replace($csv_encode,$csv_delimiter2,trim($value));
 110             }
 111             if ($record[$header[0]]) {
 112                 // add a new group to the database
 113
 114                 // add fields to object $user
 115                 foreach ($record as $name => $value) {
 116                     // check for required values
 117                     if (isset($required[$name]) and !$value) {
 118                         error(get_string('missingfield', 'error', $name). " ".
 119                               get_string('erroronline', 'error', $linenum) .". ".
 120                               get_string('processingstops', 'error'),
 121                               'uploaduser.php?sesskey='.$USER->sesskey);
 122                     }
 123                     else if ($name == "groupname") {
 124                         $newgroup->name = addslashes($value);
 125                     }
 126                     // normal entry
 127                     else {
 128                         $newgroup->{$name} = addslashes($value);
 129                     }
 130                 }
 131                 ///Find the courseid of the course with the given shortname
 132
 133                 //if idnumber is set, we use that.
 134                 //unset invalid courseid
 135                 if (isset($newgroup->idnumber)){
 136                     if (!$mycourse = get_record('course', 'idnumber',$newgroup->idnumber)){
 137                         notify(get_string('unknowncourseidnumber', 'error', $newgroup->idnumber));
 138                         unset($newgroup->courseid);//unset so 0 doesnt' get written to database
 139                     }
 140                     $newgroup->courseid = $mycourse->id;
 141                 }
 142                 //else use course short name to look up
 143                 //unset invalid coursename (if no id)
 144
 145                 else if (isset($newgroup->coursename)){
 146                     if (!$mycourse = get_record('course', 'shortname',$newgroup->coursename)){
 147                         notify(get_string('unknowncourse', 'error', $newgroup->coursename));
 148                         unset($newgroup->courseid);//unset so 0 doesnt' get written to database
 149                     }
 150                     $newgroup->courseid = $mycourse->id;
 151                 }
 152                 //else juse use current id
 153                 else{
 154                     $newgroup->courseid = $id;
 155                 }
 156
 157                 //if courseid is set
 158                 if (isset($newgroup->courseid)){
 159
 160                     $newgroup->timecreated = time();
 161                     $linenum++;
 162                     $groupname = $newgroup->name;
 163                     $newgrpcoursecontext = get_context_instance(CONTEXT_COURSE, $newgroup->courseid);
 164
 165                     ///Users cannot upload groups in courses they cannot update.
 166                     if (!has_capability('moodle/course:managegroups', $newgrpcoursecontext)){
 167                         notify( get_string('nopermissionforcreation','group',$newgroup->name) );
 168                     } else {
 169                         if ( $group = groups_group_name_exists($newgroup->courseid, $groupname) || !($newgroup->id = groups_create_group($newgroup->courseid, $newgroup)) ) {
 170
 171                             //Record not added - probably because group is already registered
 172                             //In this case, output groupname from previous registration
 173                             if ($group) {
 174                                 notify("$newgroup->name :".get_string('groupexistforcourse', 'error', $groupname));
 175                             } else {
 176                                 notify(get_string('groupnotaddederror', 'error', $groupname));
 177                             }
 178                         }
 179                         else {
 180                             notify( get_string('groupaddedsuccesfully', 'group', $newgroup->name) );
 181                         }
 182                     }
 183                 } //close courseid validity check
 184                 unset ($newgroup);
 185             }//close if ($record[$header[0]])
 186         }//close while($fp)
 187         fclose($fp);
 188
 189         echo '<hr />';
 190     }
 191
 192 /// Print the form
 193     require('mod.php');
 194
 195     print_footer($course);
 196
 197 function my_file_get_contents($filename, $use_include_path = 0) {
 198 /// Returns the file as one big long string
 199
 200     $data = "";
 201     $file = @fopen($filename, "rb", $use_include_path);
 202     if ($file) {
 203         while (!feof($file)) {
 204             $data .= fread($file, 1024);
 205         }
 206         fclose($file);
 207     }
 208     return $data;
 209 }
 210
 211 ?>
 212