mod/data/import.php

   1 <?php  // $Id$
   2 ///////////////////////////////////////////////////////////////////////////
   3 //                                                                       //
   4 // NOTICE OF COPYRIGHT                                                   //
   5 //                                                                       //
   6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   7 //          http://moodle.org                                            //
   8 //                                                                       //
   9 // Copyright (C) 2005 Martin Dougiamas  http://dougiamas.com             //
  10 //                                                                       //
  11 // This program is free software; you can redistribute it and/or modify  //
  12 // it under the terms of the GNU General Public License as published by  //
  13 // the Free Software Foundation; either version 2 of the License, or     //
  14 // (at your option) any later version.                                   //
  15 //                                                                       //
  16 // This program is distributed in the hope that it will be useful,       //
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  19 // GNU General Public License for more details:                          //
  20 //                                                                       //
  21 //          http://www.gnu.org/copyleft/gpl.html                         //
  22 //                                                                       //
  23 ///////////////////////////////////////////////////////////////////////////
  24
  25     require_once('../../config.php');
  26     require_once('lib.php');
  27     require_once($CFG->libdir.'/uploadlib.php');
  28
  29     require_login();
  30
  31     $id              = optional_param('id', 0, PARAM_INT);  // course module id
  32     $d               = optional_param('d', 0, PARAM_INT);   // database id
  33     $rid             = optional_param('rid', 0, PARAM_INT); // record id
  34     $fielddelimiter  = optional_param('fielddelimiter', ',', PARAM_CLEANHTML); // characters used as field delimiters for csv file import
  35     $fieldenclosure = optional_param('fieldenclosure', '', PARAM_CLEANHTML);   // characters used as record delimiters for csv file import
  36
  37     if ($id) {
  38         if (! $cm = get_coursemodule_from_id('data', $id)) {
  39             error('Course Module ID was incorrect');
  40         }
  41         if (! $course = get_record('course', 'id', $cm->course)) {
  42             error('Course is misconfigured');
  43         }
  44         if (! $data = get_record('data', 'id', $cm->instance)) {
  45             error('Course module is incorrect');
  46         }
  47
  48     } else {
  49         if (! $data = get_record('data', 'id', $d)) {
  50             error('Data ID is incorrect');
  51         }
  52         if (! $course = get_record('course', 'id', $data->course)) {
  53             error('Course is misconfigured');
  54         }
  55         if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
  56             error('Course Module ID was incorrect');
  57         }
  58     }
  59
  60     require_login($course, false, $cm);
  61
  62     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
  63     require_capability('mod/data:manageentries', $context);
  64
  65 /// Print the page header
  66     $strdata = get_string('modulenameplural','data');
  67
  68     $navigation = build_navigation('', $cm);
  69     print_header_simple($data->name, "", $navigation, "", "", true, "", navmenu($course));
  70     print_heading(format_string($data->name));
  71
  72 /// Groups needed for Add entry tab
  73     $currentgroup = groups_get_activity_group($cm);
  74     $groupmode = groups_get_activity_groupmode($cm);
  75
  76 /// Print the tabs
  77     $currenttab = 'add';
  78     include('tabs.php');
  79
  80
  81     $um = new upload_manager('recordsfile', false, false, null, false, 0);
  82
  83     if ($um->preprocess_files() && confirm_sesskey()) {
  84         $filename = $um->files['recordsfile']['tmp_name'];
  85
  86         // Large files are likely to take their time and memory. Let PHP know
  87         // that we'll take longer, and that the process should be recycled soon
  88         // to free up memory.
  89         @set_time_limit(0);
  90         @raise_memory_limit("96M");
  91         if (function_exists('apache_child_terminate')) {
  92             @apache_child_terminate();
  93         }
  94
  95         //Fix mac/dos newlines
  96         $text = my_file_get_contents($filename);
  97         $text = preg_replace('!\r\n?!',"\n",$text);
  98         $fp = fopen($filename, "w");
  99         fwrite($fp, $text);
 100         fclose($fp);
 101
 102         $recordsadded = 0;
 103
 104         if (!$records = data_get_records_csv($filename, $fielddelimiter, $fieldenclosure)) {
 105             error('get_records_csv failed to read data from the uploaded file. Please check file for field name typos and formatting errors.');
 106         } else {
 107             //$db->debug = true;
 108             $fieldnames = array_shift($records);
 109
 110             foreach ($records as $record) {
 111                 if ($recordid = data_add_record($data, 0)) {  // add instance to data_record
 112                     $fields = get_records('data_fields', 'dataid', $data->id, '', 'name, id, type');
 113
 114                     // Insert new data_content fields with NULL contents:
 115                     foreach ($fields as $field) {
 116                         $content = new object();
 117                         $content->recordid = $recordid;
 118                         $content->fieldid = $field->id;
 119                         if (! insert_record('data_content', $content)) {
 120                             print_error('cannotinsertrecord', '', '', $recordid);
 121                         }
 122                     }
 123                     // Fill data_content with the values imported from the CSV file:
 124                     foreach ($record as $key => $value) {
 125                         $name = $fieldnames[$key];
 126                         $field = $fields[$name];
 127                         $content = new object();
 128                         $content->fieldid = $field->id;
 129                         $content->recordid = $recordid;
 130                         if ($field->type == 'textarea') {
 131                             // the only field type where HTML is possible
 132                             $value = clean_param($value, PARAM_CLEANHTML);
 133                         } else {
 134                             // remove potential HTML:
 135                             $patterns[] = '/</';
 136                             $replacements[] = '&lt;';
 137                             $patterns[] = '/>/';
 138                             $replacements[] = '&gt;';
 139                             $value = preg_replace($patterns, $replacements, $value);
 140                         }
 141                         $value = addslashes($value);
 142                         // for now, only for "latlong" and "url" fields, but that should better be looked up from
 143                         // $CFG->dirroot . '/mod/data/field/' . $field->type . '/field.class.php'
 144                         // once there is stored how many contents the field can have.
 145                         if (preg_match("/^(latlong|url)$/", $field->type)) {
 146                             $values = explode(" ", $value, 2);
 147                             $content->content  = $values[0];
 148                             $content->content1 = $values[1];
 149                         } else {
 150                             $content->content = $value;
 151                         }
 152                         $oldcontent = get_record('data_content', 'fieldid', $field->id, 'recordid', $recordid);
 153                         $content->id = $oldcontent->id;
 154                         if (! update_record('data_content', $content)) {
 155                             print_error('cannotupdaterecord', '', '', $recordid);
 156                         }
 157                     }
 158                     $recordsadded++;
 159                     print get_string('added', 'moodle', $recordsadded) . ". " . get_string('entry', 'data') . " (ID $recordid)<br />\n";
 160                 }
 161             }
 162         }
 163     }
 164
 165     if ($recordsadded > 0) {
 166         notify($recordsadded. ' '. get_string('recordssaved', 'data'));
 167     } else {
 168         notify(get_string('recordsnotsaved', 'data'));
 169     }
 170     echo '<p />';
 171
 172
 173 /// Finish the page
 174     print_footer($course);
 175
 176
 177
 178
 179 function my_file_get_contents($filename, $use_include_path = 0) {
 180 /// Returns the file as one big long string
 181
 182     $data = "";
 183     $file = @fopen($filename, "rb", $use_include_path);
 184     if ($file) {
 185         while (!feof($file)) {
 186             $data .= fread($file, 1024);
 187         }
 188         fclose($file);
 189     }
 190     return $data;
 191 }
 192
 193
 194
 195 // Read the records from the given file.
 196 // Perform a simple field count check for each record.
 197 function data_get_records_csv($filename, $fielddelimiter=',', $fieldenclosure="\n") {
 198     global $db;
 199
 200     if (empty($fielddelimiter)) {
 201         $fielddelimiter = ',';
 202     }
 203     if (empty($fieldenclosure)) {
 204         $fieldenclosure = "\n";
 205     }
 206
 207     if (!$fp = fopen($filename, "r")) {
 208         error('get_records_csv failed to open '.$filename);
 209     }
 210     $fieldnames = array();
 211     $rows = array();
 212
 213     $fieldnames = fgetcsv($fp, 4096, $fielddelimiter, $fieldenclosure);
 214
 215     if (empty($fieldnames)) {
 216         fclose($fp);
 217         return false;
 218     }
 219     $rows[] = $fieldnames;
 220
 221     while (($data = fgetcsv($fp, 4096, $fielddelimiter, $fieldenclosure)) !== false) {
 222         if (count($data) > count($fieldnames)) {
 223             // For any given record, we can't have more data entities than the number of fields.
 224             fclose($fp);
 225             return false;
 226         }
 227         $rows[] = $data;
 228     }
 229
 230     fclose($fp);
 231     return $rows;
 232 }
 233
 234 ?>