forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
upgradelib.php
513 lines (420 loc) · 21 KB
/
upgradelib.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
<?php //$Id$
/*
* This file is used for special upgrade functions - for example groups and gradebook.
* These functions must use SQL and database related functions only- no other Moodle API,
* because it might depend on db structures that are not yet present during upgrade.
* (Do not use functions from accesslib.php, grades classes or group functions at all!)
*/
/**
* Migrates the grade_letter data to grade_letters
*/
function upgrade_18_letters() {
global $CFG;
$table = new XMLDBTable('grade_letters');
if (table_exists($table)) {
// already converted or development site
return true;
}
$result = true;
/// Rename field grade_low on table grade_letter to lowerboundary
$table = new XMLDBTable('grade_letter');
$field = new XMLDBField('grade_low');
$field->setAttributes(XMLDB_TYPE_NUMBER, '5, 2', null, XMLDB_NOTNULL, null, null, null, '0.00', 'grade_high');
/// Launch rename field grade_low
$result = $result && rename_field($table, $field, 'lowerboundary');
/// Define field grade_high to be dropped from grade_letter
$table = new XMLDBTable('grade_letter');
$field = new XMLDBField('grade_high');
/// Launch drop field grade_high
$result = $result && drop_field($table, $field);
/// Define index courseid (not unique) to be dropped form grade_letter
$table = new XMLDBTable('grade_letter');
$index = new XMLDBIndex('courseid');
$index->setAttributes(XMLDB_INDEX_NOTUNIQUE, array('courseid'));
/// Launch drop index courseid
$result = $result && drop_index($table, $index);
/// Rename field courseid on table grade_letter to contextid
$table = new XMLDBTable('grade_letter');
$field = new XMLDBField('courseid');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'id');
/// Launch rename field courseid
$result = $result && rename_field($table, $field, 'contextid');
$sql = "UPDATE {$CFG->prefix}grade_letter
SET contextid=COALESCE((SELECT c.id
FROM {$CFG->prefix}context c
WHERE c.instanceid={$CFG->prefix}grade_letter.contextid AND c.contextlevel=".CONTEXT_COURSE."), 0)";
execute_sql($sql);
/// remove broken records
execute_sql("DELETE FROM {$CFG->prefix}grade_letter WHERE contextid=0");
/// Define table grade_letter to be renamed to grade_letters
$table = new XMLDBTable('grade_letter');
/// Launch rename table for grade_letter
$result = $result && rename_table($table, 'grade_letters');
/// Changing type of field lowerboundary on table grade_letters to number
$table = new XMLDBTable('grade_letters');
$field = new XMLDBField('lowerboundary');
$field->setAttributes(XMLDB_TYPE_NUMBER, '10, 5', null, XMLDB_NOTNULL, null, null, null, null, 'contextid');
/// Launch change of type for field lowerboundary
$result = $result && change_field_precision($table, $field);
$result = $result && change_field_default($table, $field);
/// Changing the default of field letter on table grade_letters to drop it
$table = new XMLDBTable('grade_letters');
$field = new XMLDBField('letter');
$field->setAttributes(XMLDB_TYPE_CHAR, '255', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null, 'lowerboundary');
/// Launch change of default for field letter
$result = $result && change_field_precision($table, $field);
$result = $result && change_field_default($table, $field);
/// Define index contextidlowerboundary (not unique) to be added to grade_letters
$table = new XMLDBTable('grade_letters');
$index = new XMLDBIndex('contextid-lowerboundary');
$index->setAttributes(XMLDB_INDEX_NOTUNIQUE, array('contextid', 'lowerboundary'));
/// Launch add index contextidlowerboundary
$result = $result && add_index($table, $index);
return $result;
}
/**
* This function is used to migrade old data and settings from old gradebook into new grading system.
* It is executed only once for each course during upgrade to 1.9, all grade tables must be empty initially.
* @param int $courseid
*/
function upgrade_18_gradebook($courseid) {
global $CFG;
require_once($CFG->libdir.'/gradelib.php'); // we need constants only
// get all grade items with mod details and categories
$sql = "SELECT gi.*, cm.idnumber as cmidnumber, m.name as modname
FROM {$CFG->prefix}grade_item gi, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m
WHERE gi.courseid=$courseid AND m.id=gi.modid AND cm.instance=gi.cminstance
ORDER BY gi.sort_order ASC";
if (!$olditems = get_records_sql($sql)) {
//nothing to do - no items present in old gradebook
return true;
}
if (!$oldcats = get_records('grade_category', 'courseid', $courseid, 'id')) {
//there should be at least uncategorised category - hmm, nothing to do
return true;
}
$order = 1;
// create course category
$course_category = new object();
$course_category->courseid = $courseid;
$course_category->fullname = get_string('coursegradecategory', 'grades');
$course_category->parent = null;
$course_category->aggregation = GRADE_AGGREGATE_MEAN;
$course_category->timemodified = $course_category->timecreated = time();
if (!$course_category->id = insert_record('grade_categories', $course_category)) {
return false;
}
$course_category->depth = 1;
$course_category->path = '/'.$course_category->id;
if (!update_record('grade_categories', $course_category)) {
return false;
}
// create course item
$course_item = new object();
$course_item->courseid = $courseid;
$course_item->itemtype = 'course';
$course_item->iteminstance = $course_category->id;
$course_item->gradetype = GRADE_TYPE_VALUE;
$course_item->sortorder = $order++;
$course_item->timemodified = $course_item->timecreated = $course_category->timemodified;
$course_item->needsupdate = 1;
if (!insert_record('grade_items', $course_item)) {
return false;
}
// existing categories
$categories = array();
$hiddenoldcats = array();
if (count($oldcats) == 1) {
$oldcat = reset($oldcats);
if ($oldcat->drop_x_lowest) {
$course_category->droplow = $oldcat->drop_x_lowest;
update_record('grade_categories', $course_category);
}
$categories[$oldcat->id] = $course_category;
} else {
foreach ($oldcats as $oldcat) {
$category = new object();
$category->courseid = $courseid;
$category->fullname = addslashes($oldcat->name);
$category->parent = $course_category->id;
$category->droplow = $oldcat->drop_x_lowest;
$category->aggregation = GRADE_AGGREGATE_MEAN;
$category->timemodified = $category->timecreated = time();
if (!$category->id = insert_record('grade_categories', $category)) {
return false;
}
$category->depth = 2;
$category->path = '/'.$course_category->id.'/'.$category->id;
if (!update_record('grade_categories', $category)) {
return false;
}
$categories[$oldcat->id] = $category;
$item = new object();
$item->courseid = $courseid;
$item->itemtype = 'category';
$item->iteminstance = $category->id;
$item->gradetype = GRADE_TYPE_VALUE;
$item->plusfactor = $oldcat->bonus_points;
$item->hidden = $oldcat->hidden;
$item->aggregationcoef = $oldcat->weight;
$item->sortorder = $order++;
$item->timemodified = $item->timecreated = $category->timemodified;
$item->needsupdate = 1;
if (!insert_record('grade_items', $item)) {
return false;
}
if ($item->hidden) {
$hiddenoldcats[] = $oldcat->id;
}
}
$course_category->aggregation = GRADE_AGGREGATE_WEIGHTED_MEAN;
update_record('grade_categories', $course_category);
}
unset($oldcats);
// existing items
$newitems = array();
foreach ($olditems as $olditem) {
if (empty($categories[$olditem->category])) {
continue; // faulty record
}
// proper data are set during activity upgrade or legacy grade fetching
$item = new object();
$item->courseid = $courseid;
$item->itemtype = 'mod';
$item->itemmodule = $olditem->modname;
$item->iteminstance = $olditem->cminstance;
$item->idnumber = $olditem->cmidnumber;
$item->itemname = NULL;
$item->itemnumber = 0;
$item->gradetype = GRADE_TYPE_VALUE;
$item->multfactor = $olditem->scale_grade;
$item->hidden = (int)in_array($olditem->category, $hiddenoldcats);
$item->aggregationcoef = $olditem->extra_credit;
$item->sortorder = $order++;
$item->timemodified = $item->timecreated = time();
$item->needsupdate = 1;
$item->categoryid = $categories[$olditem->category]->id;
if (!$item->id = insert_record('grade_items', $item)) {
return false;
}
$newitems[$olditem->id] = $item;
if ($olditem->extra_credit and $categories[$olditem->category]->aggregation != GRADE_AGGREGATE_EXTRACREDIT_MEAN) {
$categories[$olditem->category]->aggregation = GRADE_AGGREGATE_EXTRACREDIT_MEAN;
update_record('grade_categories', $categories[$olditem->category]);
}
}
unset($olditems);
// setup up exception handling - exclude grade from aggregation
if ($exceptions = get_records('grade_exceptions', 'courseid', $courseid)) {
foreach ($exceptions as $exception) {
if (!array_key_exists($exception->grade_itemid, $newitems)) {
continue; // broken record
}
$grade = new object();
$grade->excluded = time();
$grade->itemid = $newitems[$exception->grade_itemid]->id;
$grade->userid = $exception->userid;
$grade->timemodified = $grade->timecreated = $grade->excluded;
insert_record('grade_grades', $grade);
}
}
return true;
}
/**
* Create new groupings tables for upgrade from 1.7.*|1.6.* and so on.
*/
function upgrade_17_groups() {
global $CFG;
$result = true;
/// Define table groupings to be created
$table = new XMLDBTable('groupings');
/// Adding fields to table groupings
$table->addFieldInfo('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
$table->addFieldInfo('courseid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
$table->addFieldInfo('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
$table->addFieldInfo('description', XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null);
$table->addFieldInfo('configdata', XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null);
$table->addFieldInfo('timecreated', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
$table->addFieldInfo('timemodified', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
/// Adding keys to table groupings
$table->addKeyInfo('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->addKeyInfo('courseid', XMLDB_KEY_FOREIGN, array('courseid'), 'course', array('id'));
/// Launch create table for groupings
$result = $result && create_table($table);
// ==========================================
/// Define table groupings_groups to be created
$table = new XMLDBTable('groupings_groups');
/// Adding fields to table groupings_groups
$table->addFieldInfo('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
$table->addFieldInfo('groupingid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
$table->addFieldInfo('groupid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
$table->addFieldInfo('timeadded', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
/// Adding keys to table groupings_groups
$table->addKeyInfo('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->addKeyInfo('groupingid', XMLDB_KEY_FOREIGN, array('groupingid'), 'groupings', array('id'));
$table->addKeyInfo('groupid', XMLDB_KEY_FOREIGN, array('groupid'), 'groups', array('id'));
/// Launch create table for groupings_groups
$result = $result && create_table($table);
/// fix not null constrain
$table = new XMLDBTable('groups');
$field = new XMLDBField('password');
$field->setAttributes(XMLDB_TYPE_CHAR, '50', null, null, null, null, null, null, 'description');
$result = $result && change_field_notnull($table, $field);
/// Rename field password in table groups to enrolmentkey
$table = new XMLDBTable('groups');
$field = new XMLDBField('password');
$field->setAttributes(XMLDB_TYPE_CHAR, '50', null, null, null, null, null, null, 'description');
$result = $result && rename_field($table, $field, 'enrolmentkey');
return $result;
}
/**
* Drop, add fields and rename tables for groups upgrade from 1.8.*
* @param XMLDBTable $table 'groups_groupings' table object.
*/
function upgrade_18_groups() {
global $CFG, $db;
$result = upgrade_18_groups_drop_keys_indexes();
/// Delete not used columns
$fields_r = array('viewowngroup', 'viewallgroupsmembers', 'viewallgroupsactivities',
'teachersgroupmark', 'teachersgroupview', 'teachersoverride', 'teacherdeletable');
foreach ($fields_r as $fname) {
$table = new XMLDBTable('groups_groupings');
$field = new XMLDBField($fname);
if (field_exists($table, $field)) {
$result = $result && drop_field($table, $field);
}
}
/// Rename 'groups_groupings' to 'groupings'
$table = new XMLDBTable('groups_groupings');
$result = $result && rename_table($table, 'groupings');
/// Add columns/key 'courseid', exclusivegroups, maxgroupsize, timemodified.
$table = new XMLDBTable('groupings');
$field = new XMLDBField('courseid');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'id');
$result = $result && add_field($table, $field);
$table = new XMLDBTable('groupings');
$key = new XMLDBKey('courseid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('courseid'), 'course', array('id'));
$result = $result && add_key($table, $key);
$table = new XMLDBTable('groupings');
$field = new XMLDBField('configdata');
$field->setAttributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, 'description');
$result = $result && add_field($table, $field);
$table = new XMLDBTable('groupings');
$field = new XMLDBField('timemodified');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'timecreated');
$result = $result && add_field($table, $field);
//==================
/// Add columns/key 'courseid' into groups table
$table = new XMLDBTable('groups');
$field = new XMLDBField('courseid');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'id');
$result = $result && add_field($table, $field);
$table = new XMLDBTable('groups');
$key = new XMLDBKey('courseid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('courseid'), 'course', array('id'));
$result = $result && add_key($table, $key);
/// Changing nullability of field enrolmentkey on table groups to null
$table = new XMLDBTable('groups');
$field = new XMLDBField('enrolmentkey');
$field->setAttributes(XMLDB_TYPE_CHAR, '50', null, null, null, null, null, null, 'description');
$result = $result && change_field_notnull($table, $field);
//==================
/// Now, rename 'groups_groupings_groups' to 'groupings_groups' and add keys
$table = new XMLDBTable('groups_groupings_groups');
$result = $result && rename_table($table, 'groupings_groups');
$table = new XMLDBTable('groupings_groups');
$key = new XMLDBKey('groupingid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('groupingid'), 'groupings', array('id'));
$result = $result && add_key($table, $key);
$table = new XMLDBTable('groupings_groups');
$key = new XMLDBKey('groupid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('groupid'), 'groups', array('id'));
$result = $result && add_key($table, $key);
///=================
/// Transfer courseid from 'mdl_groups_courses_groups' to 'mdl_groups'.
if ($result) {
$sql = "UPDATE {$CFG->prefix}groups
SET courseid = (
SELECT MAX(courseid)
FROM {$CFG->prefix}groups_courses_groups gcg
WHERE gcg.groupid = {$CFG->prefix}groups.id)";
execute_sql($sql);
}
/// Transfer courseid from 'groups_courses_groupings' to 'mdl_groupings'.
if ($result) {
$sql = "UPDATE {$CFG->prefix}groupings
SET courseid = (
SELECT MAX(courseid)
FROM {$CFG->prefix}groups_courses_groupings gcg
WHERE gcg.groupingid = {$CFG->prefix}groupings.id)";
execute_sql($sql);
}
/// Drop the old tables
if ($result) {
drop_table(new XMLDBTable('groups_courses_groups'));
drop_table(new XMLDBTable('groups_courses_groupings'));
drop_table(new XMLDBTable('groups_temp'));
drop_table(new XMLDBTable('groups_members_temp'));
unset_config('group_version');
}
return $result;
}
/**
* Drop keys & indexes for groups upgrade from 1.8.*
*/
function upgrade_18_groups_drop_keys_indexes() {
$result = true;
/// Define index groupid-courseid (unique) to be added to groups_members
$table = new XMLDBTable('groups_members');
$index = new XMLDBIndex('groupid-courseid');
$index->setAttributes(XMLDB_INDEX_UNIQUE, array('groupid', 'userid'));
$result = $result && drop_index($table, $index);
/// Define key courseid (foreign) to be added to groups_courses_groups
$table = new XMLDBTable('groups_courses_groups');
$key = new XMLDBKey('courseid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('courseid'), 'course', array('id'));
$result = $result && drop_key($table, $key);
/// Define key groupid (foreign) to be added to groups_courses_groups
$table = new XMLDBTable('groups_courses_groups');
$key = new XMLDBKey('groupid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('groupid'), 'groups', array('id'));
$result = $result && drop_key($table, $key);
/// Define index courseid-groupid (unique) to be added to groups_courses_groups
$table = new XMLDBTable('groups_courses_groups');
$index = new XMLDBIndex('courseid-groupid');
$index->setAttributes(XMLDB_INDEX_UNIQUE, array('courseid', 'groupid'));
$result = $result && drop_index($table, $index);
/// Define key courseid (foreign) to be added to groups_courses_groupings
$table = new XMLDBTable('groups_courses_groupings');
$key = new XMLDBKey('courseid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('courseid'), 'course', array('id'));
$result = $result && drop_key($table, $key);
/// Define key groupingid (foreign) to be added to groups_courses_groupings
$table = new XMLDBTable('groups_courses_groupings');
$key = new XMLDBKey('groupingid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('groupingid'), 'groups_groupings', array('id'));
$result = $result && drop_key($table, $key);
/// Define index courseid-groupingid (unique) to be added to groups_courses_groupings
$table = new XMLDBTable('groups_courses_groupings');
$index = new XMLDBIndex('courseid-groupingid');
$index->setAttributes(XMLDB_INDEX_UNIQUE, array('courseid', 'groupingid'));
$result = $result && drop_index($table, $index);
/// Define key groupingid (foreign) to be added to groups_groupings_groups
$table = new XMLDBTable('groups_groupings_groups');
$key = new XMLDBKey('groupingid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('groupingid'), 'groups_groupings', array('id'));
$result = $result && drop_key($table, $key);
/// Define key groupid (foreign) to be added to groups_groupings_groups
$table = new XMLDBTable('groups_groupings_groups');
$key = new XMLDBKey('groupid');
$key->setAttributes(XMLDB_KEY_FOREIGN, array('groupid'), 'groups', array('id'));
$result = $result && drop_key($table, $key);
/// Define index groupingid-groupid (unique) to be added to groups_groupings_groups
$table = new XMLDBTable('groups_groupings_groups');
$index = new XMLDBIndex('groupingid-groupid');
$index->setAttributes(XMLDB_INDEX_UNIQUE, array('groupingid', 'groupid'));
$result = $result && drop_index($table, $index);
return $result;
}
?>