mirrored from git://git.moodle.org/moodle.git
/
load_data.php
640 lines (581 loc) · 25.1 KB
/
load_data.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* A class for loading and preparing grade data from import.
*
* @package gradeimport_csv
* @copyright 2014 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* A class for loading and preparing grade data from import.
*
* @package gradeimport_csv
* @copyright 2014 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class gradeimport_csv_load_data {
/** @var string $error csv import error. */
protected $error;
/** @var int $iid Unique identifier for these csv records. */
protected $iid;
/** @var array $headers Column names for the data. */
protected $headers;
/** @var array $previewdata A subsection of the csv imported data. */
protected $previewdata;
// The map_user_data_with_value variables.
/** @var array $newgrades Grades to be inserted into the gradebook. */
protected $newgrades;
/** @var array $newfeedbacks Feedback to be inserted into the gradebook. */
protected $newfeedbacks;
/** @var int $studentid Student ID*/
protected $studentid;
// The prepare_import_grade_data() variables.
/** @var bool $status The current status of the import. True = okay, False = errors. */
protected $status;
/** @var int $importcode The code for this batch insert. */
protected $importcode;
/** @var array $gradebookerrors An array of errors from trying to import into the gradebook. */
protected $gradebookerrors;
/** @var array $newgradeitems An array of new grade items to be inserted into the gradebook. */
protected $newgradeitems;
/**
* Load CSV content for previewing.
*
* @param string $text The grade data being imported.
* @param string $encoding The type of encoding the file uses.
* @param string $separator The separator being used to define each field.
* @param int $previewrows How many rows are being previewed.
*/
public function load_csv_content($text, $encoding, $separator, $previewrows) {
$this->raise_limits();
$this->iid = csv_import_reader::get_new_iid('grade');
$csvimport = new csv_import_reader($this->iid, 'grade');
$csvimport->load_csv_content($text, $encoding, $separator);
$this->error = $csvimport->get_error();
// If there are no import errors then proceed.
if (empty($this->error)) {
// Get header (field names).
$this->headers = $csvimport->get_columns();
$this->trim_headers();
$csvimport->init();
$this->previewdata = array();
for ($numlines = 0; $numlines <= $previewrows; $numlines++) {
$lines = $csvimport->next();
if ($lines) {
$this->previewdata[] = $lines;
}
}
}
}
/**
* Gets all of the grade items in this course.
*
* @param int $courseid Course id;
* @return array An array of grade items for the course.
*/
public static function fetch_grade_items($courseid) {
$gradeitems = null;
if ($allgradeitems = grade_item::fetch_all(array('courseid' => $courseid))) {
foreach ($allgradeitems as $gradeitem) {
// Skip course type and category type.
if ($gradeitem->itemtype == 'course' || $gradeitem->itemtype == 'category') {
continue;
}
$displaystring = null;
if (!empty($gradeitem->itemmodule)) {
$displaystring = get_string('modulename', $gradeitem->itemmodule).get_string('labelsep', 'langconfig')
.$gradeitem->get_name();
} else {
$displaystring = $gradeitem->get_name();
}
$gradeitems[$gradeitem->id] = $displaystring;
}
}
return $gradeitems;
}
/**
* Cleans the column headers from the CSV file.
*/
protected function trim_headers() {
foreach ($this->headers as $i => $h) {
$h = trim($h); // Remove whitespace.
$h = clean_param($h, PARAM_RAW); // Clean the header.
$this->headers[$i] = $h;
}
}
/**
* Raises the php execution time and memory limits for importing the CSV file.
*/
protected function raise_limits() {
// Large files are likely to take their time and memory. Let PHP know
// that we'll take longer, and that the process should be recycled soon
// to free up memory.
core_php_time_limit::raise();
raise_memory_limit(MEMORY_EXTRA);
}
/**
* Inserts a record into the grade_import_values table. This also adds common record information.
*
* @param object $record The grade record being inserted into the database.
* @param int $studentid The student ID.
* @return bool|int true or insert id on success. Null if the grade value is too high.
*/
protected function insert_grade_record($record, $studentid) {
global $DB, $USER, $CFG;
$record->importcode = $this->importcode;
$record->userid = $studentid;
$record->importer = $USER->id;
// By default the maximum grade is 100.
$gradepointmaximum = 100;
// If the grade limit has been increased then use the gradepointmax setting.
if ($CFG->unlimitedgrades) {
$gradepointmaximum = $CFG->gradepointmax;
}
// If the record final grade is set then check that the grade value isn't too high.
// Final grade will not be set if we are inserting feedback.
if (!isset($record->finalgrade) || $record->finalgrade <= $gradepointmaximum) {
return $DB->insert_record('grade_import_values', $record);
} else {
$this->cleanup_import(get_string('gradevaluetoobig', 'grades', $gradepointmaximum));
return null;
}
}
/**
* Insert the new grade into the grade item buffer table.
*
* @param array $header The column headers from the CSV file.
* @param int $key Current row identifier.
* @param string $value The value for this row (final grade).
* @return stdClass new grade that is ready for commiting to the gradebook.
*/
protected function import_new_grade_item($header, $key, $value) {
global $DB, $USER;
// First check if header is already in temp database.
if (empty($this->newgradeitems[$key])) {
$newgradeitem = new stdClass();
$newgradeitem->itemname = $header[$key];
$newgradeitem->importcode = $this->importcode;
$newgradeitem->importer = $USER->id;
// Insert into new grade item buffer.
$this->newgradeitems[$key] = $DB->insert_record('grade_import_newitem', $newgradeitem);
}
$newgrade = new stdClass();
$newgrade->newgradeitem = $this->newgradeitems[$key];
$trimmed = trim($value);
if ($trimmed === '' or $trimmed == '-') {
// Blank or dash grade means null, ie "no grade".
$newgrade->finalgrade = null;
} else {
// We have an actual grade.
$newgrade->finalgrade = $value;
}
$this->newgrades[] = $newgrade;
return $newgrade;
}
/**
* Check that the user is in the system.
*
* @param string $value The value, from the csv file, being mapped to identify the user.
* @param array $userfields Contains the field and label being mapped from.
* @return int Returns the user ID if it exists, otherwise null.
*/
protected function check_user_exists($value, $userfields) {
global $DB;
$user = null;
$errorkey = false;
// The user may use the incorrect field to match the user. This could result in an exception.
try {
// Make sure the record exists and that there's only one matching record found.
$user = $DB->get_record('user', array($userfields['field'] => $value), '*', MUST_EXIST);
} catch (dml_missing_record_exception $missingex) {
$errorkey = 'usermappingerror';
} catch (dml_multiple_records_exception $multiex) {
$errorkey = 'usermappingerrormultipleusersfound';
}
// Field may be fine, but no records were returned.
if ($errorkey) {
$usermappingerrorobj = new stdClass();
$usermappingerrorobj->field = $userfields['label'];
$usermappingerrorobj->value = $value;
$this->cleanup_import(get_string($errorkey, 'grades', $usermappingerrorobj));
unset($usermappingerrorobj);
return null;
}
return $user->id;
}
/**
* Check to see if the feedback matches a grade item.
*
* @param int $courseid The course ID.
* @param int $itemid The ID of the grade item that the feedback relates to.
* @param string $value The actual feedback being imported.
* @return object Creates a feedback object with the item ID and the feedback value.
*/
protected function create_feedback($courseid, $itemid, $value) {
// Case of an id, only maps id of a grade_item.
// This was idnumber.
if (!new grade_item(array('id' => $itemid, 'courseid' => $courseid))) {
// Supplied bad mapping, should not be possible since user
// had to pick mapping.
$this->cleanup_import(get_string('importfailed', 'grades'));
return null;
}
// The itemid is the id of the grade item.
$feedback = new stdClass();
$feedback->itemid = $itemid;
$feedback->feedback = $value;
return $feedback;
}
/**
* This updates existing grade items.
*
* @param int $courseid The course ID.
* @param array $map Mapping information provided by the user.
* @param int $key The line that we are currently working on.
* @param bool $verbosescales Form setting for grading with scales.
* @param string $value The grade value.
* @return array grades to be updated.
*/
protected function update_grade_item($courseid, $map, $key, $verbosescales, $value) {
// Case of an id, only maps id of a grade_item.
// This was idnumber.
if (!$gradeitem = new grade_item(array('id' => $map[$key], 'courseid' => $courseid))) {
// Supplied bad mapping, should not be possible since user
// had to pick mapping.
$this->cleanup_import(get_string('importfailed', 'grades'));
return null;
}
// Check if grade item is locked if so, abort.
if ($gradeitem->is_locked()) {
$this->cleanup_import(get_string('gradeitemlocked', 'grades'));
return null;
}
$newgrade = new stdClass();
$newgrade->itemid = $gradeitem->id;
if ($gradeitem->gradetype == GRADE_TYPE_SCALE and $verbosescales) {
if ($value === '' or $value == '-') {
$value = null; // No grade.
} else {
$scale = $gradeitem->load_scale();
$scales = explode(',', $scale->scale);
$scales = array_map('trim', $scales); // Hack - trim whitespace around scale options.
array_unshift($scales, '-'); // Scales start at key 1.
$key = array_search($value, $scales);
if ($key === false) {
$this->cleanup_import(get_string('badgrade', 'grades'));
return null;
}
$value = $key;
}
$newgrade->finalgrade = $value;
} else {
if ($value === '' or $value == '-') {
$value = null; // No grade.
} else {
// If the value has a local decimal or can correctly be unformatted, do it.
$validvalue = unformat_float($value, true);
if ($validvalue !== false) {
$value = $validvalue;
} else {
// Non numeric grade value supplied, possibly mapped wrong column.
$this->cleanup_import(get_string('badgrade', 'grades'));
return null;
}
}
$newgrade->finalgrade = $value;
}
$this->newgrades[] = $newgrade;
return $this->newgrades;
}
/**
* Clean up failed CSV grade import. Clears the temp table for inserting grades.
*
* @param string $notification The error message to display from the unsuccessful grade import.
*/
protected function cleanup_import($notification) {
$this->status = false;
import_cleanup($this->importcode);
$this->gradebookerrors[] = $notification;
}
/**
* Check user mapping.
*
* @param string $mappingidentifier The user field that we are matching together.
* @param string $value The value we are checking / importing.
* @param array $header The column headers of the csv file.
* @param array $map Mapping information provided by the user.
* @param int $key Current row identifier.
* @param int $courseid The course ID.
* @param int $feedbackgradeid The ID of the grade item that the feedback relates to.
* @param bool $verbosescales Form setting for grading with scales.
*/
protected function map_user_data_with_value($mappingidentifier, $value, $header, $map, $key, $courseid, $feedbackgradeid,
$verbosescales) {
// Fields that the user can be mapped from.
$userfields = array(
'userid' => array(
'field' => 'id',
'label' => 'id',
),
'useridnumber' => array(
'field' => 'idnumber',
'label' => 'idnumber',
),
'useremail' => array(
'field' => 'email',
'label' => 'email address',
),
'username' => array(
'field' => 'username',
'label' => 'username',
),
);
switch ($mappingidentifier) {
case 'userid':
case 'useridnumber':
case 'useremail':
case 'username':
// Skip invalid row with blank user field.
if (!empty($value)) {
$this->studentid = $this->check_user_exists($value, $userfields[$mappingidentifier]);
}
break;
case 'new':
$this->import_new_grade_item($header, $key, $value);
break;
case 'feedback':
if ($feedbackgradeid) {
$feedback = $this->create_feedback($courseid, $feedbackgradeid, $value);
if (isset($feedback)) {
$this->newfeedbacks[] = $feedback;
}
}
break;
default:
// Existing grade items.
if (!empty($map[$key])) {
$this->newgrades = $this->update_grade_item($courseid, $map, $key, $verbosescales, $value,
$mappingidentifier);
}
// Otherwise, we ignore this column altogether because user has chosen
// to ignore them (e.g. institution, address etc).
break;
}
}
/**
* Checks and prepares grade data for inserting into the gradebook.
*
* @param array $header Column headers of the CSV file.
* @param object $formdata Mapping information from the preview page.
* @param object $csvimport csv import reader object for iterating over the imported CSV file.
* @param int $courseid The course ID.
* @param bool $separatemode If we have groups are they separate?
* @param mixed $currentgroup current group information.
* @param bool $verbosescales Form setting for grading with scales.
* @return bool True if the status for importing is okay, false if there are errors.
*/
public function prepare_import_grade_data($header, $formdata, $csvimport, $courseid, $separatemode, $currentgroup,
$verbosescales) {
global $DB, $USER;
// The import code is used for inserting data into the grade tables.
$this->importcode = $formdata->importcode;
$this->status = true;
$this->headers = $header;
$this->studentid = null;
$this->gradebookerrors = null;
$forceimport = $formdata->forceimport;
// Temporary array to keep track of what new headers are processed.
$this->newgradeitems = array();
$this->trim_headers();
$timeexportkey = null;
$map = array();
// Loops mapping_0, mapping_1 .. mapping_n and construct $map array.
foreach ($header as $i => $head) {
if (isset($formdata->{'mapping_'.$i})) {
$map[$i] = $formdata->{'mapping_'.$i};
}
if ($head == get_string('timeexported', 'gradeexport_txt')) {
$timeexportkey = $i;
}
}
// If mapping information is supplied.
$map[clean_param($formdata->mapfrom, PARAM_RAW)] = clean_param($formdata->mapto, PARAM_RAW);
// Check for mapto collisions.
$maperrors = array();
foreach ($map as $i => $j) {
if ($j == 0) {
// You can have multiple ignores.
continue;
} else {
if (!isset($maperrors[$j])) {
$maperrors[$j] = true;
} else {
// Collision.
print_error('cannotmapfield', '', '', $j);
}
}
}
$this->raise_limits();
$csvimport->init();
while ($line = $csvimport->next()) {
if (count($line) <= 1) {
// There is no data on this line, move on.
continue;
}
// Array to hold all grades to be inserted.
$this->newgrades = array();
// Array to hold all feedback.
$this->newfeedbacks = array();
// Each line is a student record.
foreach ($line as $key => $value) {
$value = clean_param($value, PARAM_RAW);
$value = trim($value);
/*
* the options are
* 1) userid, useridnumber, usermail, username - used to identify user row
* 2) new - new grade item
* 3) id - id of the old grade item to map onto
* 3) feedback_id - feedback for grade item id
*/
// Explode the mapping for feedback into a label 'feedback' and the identifying number.
$mappingbase = explode("_", $map[$key]);
$mappingidentifier = $mappingbase[0];
// Set the feedback identifier if it exists.
if (isset($mappingbase[1])) {
$feedbackgradeid = (int)$mappingbase[1];
} else {
$feedbackgradeid = '';
}
$this->map_user_data_with_value($mappingidentifier, $value, $header, $map, $key, $courseid, $feedbackgradeid,
$verbosescales);
if ($this->status === false) {
return $this->status;
}
}
// No user mapping supplied at all, or user mapping failed.
if (empty($this->studentid) || !is_numeric($this->studentid)) {
// User not found, abort whole import.
$this->cleanup_import(get_string('usermappingerrorusernotfound', 'grades'));
break;
}
if ($separatemode and !groups_is_member($currentgroup, $this->studentid)) {
// Not allowed to import into this group, abort.
$this->cleanup_import(get_string('usermappingerrorcurrentgroup', 'grades'));
break;
}
// Insert results of this students into buffer.
if ($this->status and !empty($this->newgrades)) {
foreach ($this->newgrades as $newgrade) {
// Check if grade_grade is locked and if so, abort.
if (!empty($newgrade->itemid) and $gradegrade = new grade_grade(array('itemid' => $newgrade->itemid,
'userid' => $this->studentid))) {
if ($gradegrade->is_locked()) {
// Individual grade locked.
$this->cleanup_import(get_string('gradelocked', 'grades'));
return $this->status;
}
// Check if the force import option is disabled and the last exported date column is present.
if (!$forceimport && !empty($timeexportkey)) {
$exportedtime = $line[$timeexportkey];
if (clean_param($exportedtime, PARAM_INT) != $exportedtime || $exportedtime > time() ||
$exportedtime < strtotime("-1 year", time())) {
// The date is invalid, or in the future, or more than a year old.
$this->cleanup_import(get_string('invalidgradeexporteddate', 'grades'));
return $this->status;
}
$timemodified = $gradegrade->get_dategraded();
if (!empty($timemodified) && ($exportedtime < $timemodified)) {
// The item was graded after we exported it, we return here not to override it.
$user = core_user::get_user($this->studentid);
$this->cleanup_import(get_string('gradealreadyupdated', 'grades', fullname($user)));
return $this->status;
}
}
}
$insertid = self::insert_grade_record($newgrade, $this->studentid);
// Check to see if the insert was successful.
if (empty($insertid)) {
return null;
}
}
}
// Updating/inserting all comments here.
if ($this->status and !empty($this->newfeedbacks)) {
foreach ($this->newfeedbacks as $newfeedback) {
$sql = "SELECT *
FROM {grade_import_values}
WHERE importcode=? AND userid=? AND itemid=? AND importer=?";
if ($feedback = $DB->get_record_sql($sql, array($this->importcode, $this->studentid, $newfeedback->itemid,
$USER->id))) {
$newfeedback->id = $feedback->id;
$DB->update_record('grade_import_values', $newfeedback);
} else {
// The grade item for this is not updated.
$newfeedback->importonlyfeedback = true;
$insertid = self::insert_grade_record($newfeedback, $this->studentid);
// Check to see if the insert was successful.
if (empty($insertid)) {
return null;
}
}
}
}
}
return $this->status;
}
/**
* Returns the headers parameter for this class.
*
* @return array returns headers parameter for this class.
*/
public function get_headers() {
return $this->headers;
}
/**
* Returns the error parameter for this class.
*
* @return string returns error parameter for this class.
*/
public function get_error() {
return $this->error;
}
/**
* Returns the iid parameter for this class.
*
* @return int returns iid parameter for this class.
*/
public function get_iid() {
return $this->iid;
}
/**
* Returns the preview_data parameter for this class.
*
* @return array returns previewdata parameter for this class.
*/
public function get_previewdata() {
return $this->previewdata;
}
/**
* Returns the gradebookerrors parameter for this class.
*
* @return array returns gradebookerrors parameter for this class.
*/
public function get_gradebookerrors() {
return $this->gradebookerrors;
}
}