d93284b1aa3846fe62062f7ec4bc0493f6c8f383
[moodle.git] / mod / data / 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  * This file is part of the Database module for Moodle
20  *
21  * @copyright 2005 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package mod-data
24  */
26 require_once('../../config.php');
27 require_once('lib.php');
28 require_once($CFG->libdir.'/csvlib.class.php');
29 require_once('import_form.php');
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
37 $url = new moodle_url('/mod/data/import.php');
38 if ($rid !== 0) {
39     $url->param('rid', $rid);
40 }
41 if ($fielddelimiter !== '') {
42     $url->param('fielddelimiter', $fielddelimiter);
43 }
44 if ($fieldenclosure !== '') {
45     $url->param('fieldenclosure', $fieldenclosure);
46 }
48 if ($id) {
49     $url->param('id', $id);
50     $PAGE->set_url($url);
51     if (! $cm = get_coursemodule_from_id('data', $id)) {
52         print_error('invalidcoursemodule');
53     }
54     if (! $course = $DB->get_record('course', array('id'=>$cm->course))) {
55         print_error('coursemisconf');
56     }
57     if (! $data = $DB->get_record('data', array('id'=>$cm->instance))) {
58         print_error('invalidcoursemodule');
59     }
61 } else {
62     $url->param('d', $d);
63     $PAGE->set_url($url);
64     if (! $data = $DB->get_record('data', array('id'=>$d))) {
65         print_error('invalidid', 'data');
66     }
67     if (! $course = $DB->get_record('course', array('id'=>$data->course))) {
68         print_error('coursemisconf');
69     }
70     if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
71         print_error('coursemisconf');
72     }
73 }
75 require_login($course, false, $cm);
77 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
78 require_capability('mod/data:manageentries', $context);
79 $form = new mod_data_import_form(new moodle_url('/mod/data/import.php'));
81 /// Print the page header
82 $PAGE->navbar->add(get_string('add', 'data'));
83 $PAGE->set_title($data->name);
84 $PAGE->set_heading($course->fullname);
85 echo $OUTPUT->header();
86 echo $OUTPUT->heading(format_string($data->name));
88 /// Groups needed for Add entry tab
89 $currentgroup = groups_get_activity_group($cm);
90 $groupmode = groups_get_activity_groupmode($cm);
92 if (!$formdata = $form->get_data()) {
93     /// Upload records section. Only for teachers and the admin.
94     echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
95     require_once('import_form.php');
96     echo $OUTPUT->heading(get_string('uploadrecords', 'data'), 3);
97     $form = new mod_data_import_form(new moodle_url('/mod/data/import.php'));
98     $formdata = new stdClass();
99     $formdata->d = $data->id;
100     $form->set_data($formdata);
101     $form->display();
102     echo $OUTPUT->box_end();
103     echo $OUTPUT->footer();
104     die;
105 } else {
106     // Large files are likely to take their time and memory. Let PHP know
107     // that we'll take longer, and that the process should be recycled soon
108     // to free up memory.
109     @set_time_limit(0);
110     @raise_memory_limit("96M");
111     if (function_exists('apache_child_terminate')) {
112         @apache_child_terminate();
113     }
115     $iid = csv_import_reader::get_new_iid('moddata');
116     $cir = new csv_import_reader($iid, 'moddata');
118     $readcount = $cir->load_csv_content($form->get_file_content('recordsfile'), $formdata->encoding, $formdata->fielddelimiter);
119     if (empty($readcount)) {
120         print_error('csvfailed','data',"{$CFG->wwwroot}/mod/data/edit.php?d={$data->id}");
121     } else {
122         if (!$fieldnames = $cir->get_columns()) {
123             print_error('cannotreadtmpfile', 'error');
124         }
125         // check the fieldnames are valid
126         $fields = $DB->get_records('data_fields', array('dataid'=>$data->id), '', 'name, id, type');
127         $errorfield = '';
128         foreach ($fieldnames as $name) {
129             if (!isset($fields[$name])) {
130                 $errorfield .= "'$name' ";
131             }
132         }
134         if (!empty($errorfield)) {
135             print_error('fieldnotmatched','data',"{$CFG->wwwroot}/mod/data/edit.php?d={$data->id}",$errorfield);
136         }
138         $cir->init();
139         $recordsadded = 0;
140         while ($record = $cir->next()) {
141             if ($recordid = data_add_record($data, 0)) {  // add instance to data_record
142                 $fields = $DB->get_records('data_fields', array('dataid'=>$data->id), '', 'name, id, type');
144                 // Insert new data_content fields with NULL contents:
145                 foreach ($fields as $field) {
146                     $content = new stdClass();
147                     $content->recordid = $recordid;
148                     $content->fieldid = $field->id;
149                     $DB->insert_record('data_content', $content);
150                 }
151                 // Fill data_content with the values imported from the CSV file:
152                 foreach ($record as $key => $value) {
153                     $name = $fieldnames[$key];
154                     $field = $fields[$name];
155                     $content = new stdClass();
156                     $content->fieldid = $field->id;
157                     $content->recordid = $recordid;
158                     if ($field->type == 'textarea') {
159                         // the only field type where HTML is possible
160                         $value = clean_param($value, PARAM_CLEANHTML);
161                     } else {
162                         // remove potential HTML:
163                         $patterns[] = '/</';
164                         $replacements[] = '&lt;';
165                         $patterns[] = '/>/';
166                         $replacements[] = '&gt;';
167                         $value = preg_replace($patterns, $replacements, $value);
168                     }
169                     // for now, only for "latlong" and "url" fields, but that should better be looked up from
170                     // $CFG->dirroot . '/mod/data/field/' . $field->type . '/field.class.php'
171                     // once there is stored how many contents the field can have.
172                     if (preg_match("/^(latlong|url)$/", $field->type)) {
173                         $values = explode(" ", $value, 2);
174                         $content->content  = $values[0];
175                         $content->content1 = $values[1];
176                     } else {
177                         $content->content = $value;
178                     }
179                     $oldcontent = $DB->get_record('data_content', array('fieldid'=>$field->id, 'recordid'=>$recordid));
180                     $content->id = $oldcontent->id;
181                     $DB->update_record('data_content', $content);
182                 }
183                 $recordsadded++;
184                 print get_string('added', 'moodle', $recordsadded) . ". " . get_string('entry', 'data') . " (ID $recordid)<br />\n";
185             }
186         }
187         $cir->close();
188         $cir->cleanup(true);
189     }
192 if ($recordsadded > 0) {
193     echo $OUTPUT->notification($recordsadded. ' '. get_string('recordssaved', 'data'), '');
194 } else {
195     echo $OUTPUT->notification(get_string('recordsnotsaved', 'data'), 'notifysuccess');
198 echo $OUTPUT->continue_button('import.php?d='.$data->id);
200 /// Finish the page
201 echo $OUTPUT->footer();