Merge branch 'MDL-32670' of git://github.com/rlorenzo/moodle
[moodle.git] / lib / db / upgrade.php
CommitLineData
5b4a78e2 1<?php
5b4a78e2 2// This file is part of Moodle - http://moodle.org/
4e423cbf 3//
5b4a78e2
PS
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
4e423cbf 8//
5b4a78e2
PS
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
4e423cbf 13//
5b4a78e2
PS
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * This file keeps track of upgrades to Moodle.
19 *
20 * Sometimes, changes between versions involve
21 * alterations to database structures and other
22 * major things that may break installations.
23 *
24 * The upgrade function in this file will attempt
25 * to perform all the necessary actions to upgrade
26 * your older installation to the current version.
27 *
28 * If there's something it cannot do itself, it
29 * will tell you what you need to do.
30 *
31 * The commands in here will all be database-neutral,
32 * using the methods of database_manager class
33 *
34 * Please do not forget to use upgrade_set_timeout()
35 * before any action that may take longer time to finish.
36 *
39b90b51
EL
37 * @package core_install
38 * @category upgrade
39 * @copyright 2006 onwards Martin Dougiamas http://dougiamas.com
40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5b4a78e2
PS
41 */
42
43defined('MOODLE_INTERNAL') || die();
4e423cbf 44
3406acde 45/**
39b90b51
EL
46 * Main upgrade tasks to be executed on Moodle version bump
47 *
48 * This function is automatically executed after one bump in the Moodle core
f9488a6f 49 * version is detected. It's in charge of performing the required tasks
39b90b51
EL
50 * to raise core from the previous version to the next one.
51 *
52 * It's a collection of ordered blocks of code, named "upgrade steps",
f9488a6f 53 * each one performing one isolated (from the rest of steps) task. Usually
39b90b51
EL
54 * tasks involve creating new DB objects or performing manipulation of the
55 * information for cleanup/fixup purposes.
56 *
57 * Each upgrade step has a fixed structure, that can be summarised as follows:
58 *
59 * if ($oldversion < XXXXXXXXXX.XX) {
f9488a6f 60 * // Explanation of the update step, linking to issue in the Tracker if necessary
39b90b51
EL
61 * upgrade_set_timeout(XX); // Optional for big tasks
62 * // Code to execute goes here, usually the XMLDB Editor will
63 * // help you here. See {@link http://docs.moodle.org/dev/XMLDB_editor}.
64 * upgrade_main_savepoint(true, XXXXXXXXXX.XX);
65 * }
66 *
67 * All plugins within Moodle (modules, blocks, reports...) support the existence of
68 * their own upgrade.php file, using the "Frankenstyle" component name as
69 * defined at {@link http://docs.moodle.org/dev/Frankenstyle}, for example:
70 * - {@link xmldb_page_upgrade($oldversion)}. (modules don't require the plugintype ("mod_") to be used.
71 * - {@link xmldb_auth_manual_upgrade($oldversion)}.
72 * - {@link xmldb_workshopform_accumulative_upgrade($oldversion)}.
73 * - ....
74 *
75 * In order to keep the contents of this file reduced, it's allowed to create some helper
76 * functions to be used here in the {@link upgradelib.php} file at the same directory. Note
f9488a6f 77 * that such a file must be manually included from upgrade.php, and there are some restrictions
39b90b51
EL
78 * about what can be used within it.
79 *
80 * For more information, take a look to the documentation available:
81 * - Data definition API: {@link http://docs.moodle.org/dev/Data_definition_API}
82 * - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
3406acde 83 *
3406acde 84 * @param int $oldversion
5b4a78e2 85 * @return bool always true
3406acde 86 */
775f811a 87function xmldb_main_upgrade($oldversion) {
78946b9b 88 global $CFG, $USER, $DB, $OUTPUT;
4e423cbf 89
4f12838e 90 require_once($CFG->libdir.'/db/upgradelib.php'); // Core Upgrade-related functions
13a0d3d3 91
46d318bc 92 $dbman = $DB->get_manager(); // loads ddl manager and xmldb classes
f33e1ed4 93
5c79b8ed
PS
94 if ($oldversion < 2011120500) {
95 // just in case somebody hacks upgrade scripts or env, we really can not continue
96 echo("You need to upgrade to 2.2.x first!\n");
97 exit(1);
ae95489d
EL
98 // Note this savepoint is 100% unreachable, but needed to pass the upgrade checks
99 upgrade_main_savepoint(true, 2011120500);
5c79b8ed
PS
100 }
101
39b90b51
EL
102 // Moodle v2.2.0 release upgrade line
103 // Put any upgrade step following this
da4aa3e4 104
43cf3165
EL
105 if ($oldversion < 2011120500.02) {
106
107 upgrade_set_timeout(60*20); // This may take a while
108 // MDL-28180. Some missing restrictions in certain backup & restore operations
109 // were causing incorrect duplicates in the course_completion_aggr_methd table.
110 // This upgrade step takes rid of them.
111 $sql = 'SELECT course, criteriatype, MIN(id) AS minid
112 FROM {course_completion_aggr_methd}
113 GROUP BY course, criteriatype
114 HAVING COUNT(*) > 1';
115 $duprs = $DB->get_recordset_sql($sql);
116 foreach ($duprs as $duprec) {
117 // We need to handle NULLs in criteriatype diferently
118 if (is_null($duprec->criteriatype)) {
119 $where = 'course = ? AND criteriatype IS NULL AND id > ?';
120 $params = array($duprec->course, $duprec->minid);
121 } else {
122 $where = 'course = ? AND criteriatype = ? AND id > ?';
123 $params = array($duprec->course, $duprec->criteriatype, $duprec->minid);
124 }
125 $DB->delete_records_select('course_completion_aggr_methd', $where, $params);
126 }
127 $duprs->close();
128
129 // Main savepoint reached
130 upgrade_main_savepoint(true, 2011120500.02);
131 }
132
52a23063 133 if ($oldversion < 2011120500.03) {
8e54ce97
AD
134
135 // Changing precision of field value on table user_preferences to (1333)
136 $table = new xmldb_table('user_preferences');
137 $field = new xmldb_field('value', XMLDB_TYPE_CHAR, '1333', null, XMLDB_NOTNULL, null, null, 'name');
138
139 // Launch change of precision for field value
140 $dbman->change_field_precision($table, $field);
141
142 // Main savepoint reached
52a23063 143 upgrade_main_savepoint(true, 2011120500.03);
8e54ce97
AD
144 }
145
91331b6b
MG
146 if ($oldversion < 2012020200.03) {
147
148 // Define index rolecontext (not unique) to be added to role_assignments
149 $table = new xmldb_table('role_assignments');
150 $index = new xmldb_index('rolecontext', XMLDB_INDEX_NOTUNIQUE, array('roleid', 'contextid'));
151
152 // Conditionally launch add index rolecontext
153 if (!$dbman->index_exists($table, $index)) {
154 $dbman->add_index($table, $index);
155 }
156
157 // Define index usercontextrole (not unique) to be added to role_assignments
158 $index = new xmldb_index('usercontextrole', XMLDB_INDEX_NOTUNIQUE, array('userid', 'contextid', 'roleid'));
159
160 // Conditionally launch add index usercontextrole
161 if (!$dbman->index_exists($table, $index)) {
162 $dbman->add_index($table, $index);
163 }
164
165 // Main savepoint reached
166 upgrade_main_savepoint(true, 2012020200.03);
167 }
168
8900213b
AD
169 if ($oldversion < 2012020200.06) {
170 // Previously we always allowed users to override their email address via the messaging system
171 // We have now added a setting to allow admins to turn this this ability on and off
172 // While this setting defaults to 0 (off) we're setting it to 1 (on) to maintain the behaviour for upgrading sites
173 set_config('messagingallowemailoverride', 1);
174
175 // Main savepoint reached
176 upgrade_main_savepoint(true, 2012020200.06);
177 }
178
bc5fbbb3 179 if ($oldversion < 2012021700.01) {
669bdcab
RT
180 // Changing precision of field uniquehash on table post to 255
181 $table = new xmldb_table('post');
182 $field = new xmldb_field('uniquehash', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, 'content');
183
184 // Launch change of precision for field uniquehash
185 $dbman->change_field_precision($table, $field);
186
187 // Main savepoint reached
bc5fbbb3 188 upgrade_main_savepoint(true, 2012021700.01);
669bdcab
RT
189 }
190
aa803ceb
RT
191 if ($oldversion < 2012021700.02) {
192 // Somewhere before 1.9 summary and content column in post table were not null. In 1.9+
193 // not null became false.
194 $columns = $DB->get_columns('post');
195
196 // Fix discrepancies in summary field after upgrade from 1.9
197 if (array_key_exists('summary', $columns) && $columns['summary']->not_null != false) {
198 $table = new xmldb_table('post');
199 $summaryfield = new xmldb_field('summary', XMLDB_TYPE_TEXT, 'big', null, null, null, null, 'subject');
5f5ee191 200
aa803ceb
RT
201 if ($dbman->field_exists($table, $summaryfield)) {
202 $dbman->change_field_notnull($table, $summaryfield);
203 }
204
205 }
206
207 // Fix discrepancies in content field after upgrade from 1.9
208 if (array_key_exists('content', $columns) && $columns['content']->not_null != false) {
209 $table = new xmldb_table('post');
210 $contentfield = new xmldb_field('content', XMLDB_TYPE_TEXT, 'big', null, null, null, null, 'summary');
211
212 if ($dbman->field_exists($table, $contentfield)) {
213 $dbman->change_field_notnull($table, $contentfield);
214 }
215
216 }
217
218 upgrade_main_savepoint(true, 2012021700.02);
219 }
220
f8822462
EL
221 // The ability to backup user (private) files is out completely - MDL-29248
222 if ($oldversion < 2012030100.01) {
223 unset_config('backup_general_user_files', 'backup');
224 unset_config('backup_general_user_files_locked', 'backup');
225 unset_config('backup_auto_user_files', 'backup');
226
227 upgrade_main_savepoint(true, 2012030100.01);
228 }
229
e9e4a4a6
PS
230 if ($oldversion < 2012030100.02) {
231 // migrate all numbers to signed - it should be safe to interrupt this and continue later
232 upgrade_mysql_fix_unsigned_columns();
233
234 // Main savepoint reached
235 upgrade_main_savepoint(true, 2012030100.02);
236 }
237
436650b0
PS
238 if ($oldversion < 2012030900.01) {
239 // migrate all texts and binaries to big size - it should be safe to interrupt this and continue later
240 upgrade_mysql_fix_lob_columns();
241
242 // Main savepoint reached
243 upgrade_main_savepoint(true, 2012030900.01);
244 }
245
9665ecd2
TH
246 if ($oldversion < 2012031500.01) {
247 // Upgrade old course_allowed_modules data to be permission overrides.
6f3570ff 248 if ($CFG->restrictmodulesfor === 'all') {
9665ecd2 249 $courses = $DB->get_records_menu('course', array(), 'id', 'id, 1');
6f3570ff 250 } else if ($CFG->restrictmodulesfor === 'requested') {
9665ecd2
TH
251 $courses = $DB->get_records_menu('course', array('retrictmodules' => 1), 'id', 'id, 1');
252 } else {
253 $courses = array();
254 }
255
256 if (!$dbman->table_exists('course_allowed_modules')) {
257 // Upgrade must already have been run on this server. This might happen,
258 // for example, during development of these changes.
259 $courses = array();
260 }
261
262 $modidtoname = $DB->get_records_menu('modules', array(), 'id', 'id, name');
263
264 $coursecount = count($courses);
265 if ($coursecount) {
266 $pbar = new progress_bar('allowedmods', 500, true);
267 $transaction = $DB->start_delegated_transaction();
268 }
269
270 $i = 0;
271 foreach ($courses as $courseid => $notused) {
272 $i += 1;
273 upgrade_set_timeout(60); // 1 minute per course should be fine.
274
275 $allowedmoduleids = $DB->get_records_menu('course_allowed_modules',
276 array('course' => $courseid), 'module', 'module, 1');
277 if (empty($allowedmoduleids)) {
278 // This seems to be the best match for backwards compatibility,
8149d624 279 // not necessarily with the old code in course_allowed_module function,
9665ecd2
TH
280 // but with the code that used to be in the coures settings form.
281 $allowedmoduleids = explode(',', $CFG->defaultallowedmodules);
282 $allowedmoduleids = array_combine($allowedmoduleids, $allowedmoduleids);
283 }
284
285 $context = context_course::instance($courseid);
286
287 list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
288 list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
289 foreach ($managerroleids as $roleid) {
290 unset($roleids[$roleid]);
291 }
292
293 foreach ($modidtoname as $modid => $modname) {
294 if (isset($allowedmoduleids[$modid])) {
295 // Module is allowed, no worries.
296 continue;
297 }
298
299 $capability = 'mod/' . $modname . ':addinstance';
300 foreach ($roleids as $roleid) {
301 assign_capability($capability, CAP_PREVENT, $roleid, $context);
302 }
303 }
304
305 $pbar->update($i, $coursecount, "Upgrading legacy course_allowed_modules data - $i/$coursecount.");
306 }
307
308 if ($coursecount) {
309 $transaction->allow_commit();
310 }
311
312 upgrade_main_savepoint(true, 2012031500.01);
313 }
314
315 if ($oldversion < 2012031500.02) {
316
317 // Define field retrictmodules to be dropped from course
318 $table = new xmldb_table('course');
4354486d 319 $field = new xmldb_field('restrictmodules');
9665ecd2
TH
320
321 // Conditionally launch drop field requested
322 if ($dbman->field_exists($table, $field)) {
323 $dbman->drop_field($table, $field);
324 }
325
326 upgrade_main_savepoint(true, 2012031500.02);
327 }
328
329 if ($oldversion < 2012031500.03) {
330
331 // Define table course_allowed_modules to be dropped
332 $table = new xmldb_table('course_allowed_modules');
333
334 // Conditionally launch drop table for course_allowed_modules
335 if ($dbman->table_exists($table)) {
336 $dbman->drop_table($table);
337 }
338
339 upgrade_main_savepoint(true, 2012031500.03);
340 }
341
342 if ($oldversion < 2012031500.04) {
343 // Clean up the old admin settings.
344 unset_config('restrictmodulesfor');
345 unset_config('restrictbydefault');
346 unset_config('defaultallowedmodules');
347
348 upgrade_main_savepoint(true, 2012031500.04);
349 }
e9e4a4a6 350
e63f95d7
PS
351 if ($oldversion < 2012032300.02) {
352 // Migrate the old admin debug setting.
353 if ($CFG->debug == 38911) {
354 set_config('debug', DEBUG_DEVELOPER);
355 } else if ($CFG->debug == 6143) {
356 set_config('debug', DEBUG_ALL);
357 }
358 upgrade_main_savepoint(true, 2012032300.02);
359 }
360
e7e0f8d2
DP
361 if ($oldversion < 2012042300.00) {
362 // This change makes the course_section index unique.
363
cf76b335 364 // xmldb does not allow changing index uniqueness - instead we must drop
e7e0f8d2
DP
365 // index then add it again
366 $table = new xmldb_table('course_sections');
cf76b335 367 $index = new xmldb_index('course_section', XMLDB_INDEX_NOTUNIQUE, array('course', 'section'));
e7e0f8d2
DP
368
369 // Conditionally launch drop index course_section
370 if ($dbman->index_exists($table, $index)) {
371 $dbman->drop_index($table, $index);
372 }
cf76b335 373
374 // Look for any duplicate course_sections entries. There should not be
375 // any but on some busy systems we found a few, maybe due to previous
376 // bugs.
377 $transaction = $DB->start_delegated_transaction();
378 $rs = $DB->get_recordset_sql('
379 SELECT DISTINCT
380 cs.id, cs.course
381 FROM
382 {course_sections} cs
383 INNER JOIN {course_sections} older
384 ON cs.course = older.course AND cs.section = older.section
385 AND older.id < cs.id');
386 foreach ($rs as $rec) {
387 $DB->delete_records('course_sections', array('id' => $rec->id));
388 rebuild_course_cache($rec->course, true);
389 }
390 $rs->close();
391 $transaction->allow_commit();
392
393 // Define index course_section (unique) to be added to course_sections
394 $index = new xmldb_index('course_section', XMLDB_INDEX_UNIQUE, array('course', 'section'));
395
396 // Conditionally launch add index course_section
397 if (!$dbman->index_exists($table, $index)) {
398 $dbman->add_index($table, $index);
399 }
400
401 // Main savepoint reached
e7e0f8d2 402 upgrade_main_savepoint(true, 2012042300.00);
cf76b335 403 }
296c0247 404
ede323e2
ARN
405 if ($oldversion < 2012042300.02) {
406 require_once($CFG->libdir . '/completion/completion_criteria.php');
407 // Delete orphaned criteria which were left when modules were removed
408 if ($DB->get_dbfamily() === 'mysql') {
409 $sql = "DELETE cc FROM {course_completion_criteria} cc
410 LEFT JOIN {course_modules} cm ON cm.id = cc.moduleinstance
411 WHERE cm.id IS NULL AND cc.criteriatype = ".COMPLETION_CRITERIA_TYPE_ACTIVITY;
412 } else {
413 $sql = "DELETE FROM {course_completion_criteria}
414 WHERE NOT EXISTS (
415 SELECT 'x' FROM {course_modules}
416 WHERE {course_modules}.id = {course_completion_criteria}.moduleinstance)
2ea2549e 417 AND {course_completion_criteria}.criteriatype = ".COMPLETION_CRITERIA_TYPE_ACTIVITY;
ede323e2
ARN
418 }
419 $DB->execute($sql);
420
421 // Main savepoint reached
422 upgrade_main_savepoint(true, 2012042300.02);
423 }
424
0dda790c 425 if ($oldversion < 2012050300.01) {
fa530687
PS
426 // Make sure deleted users do not have picture flag.
427 $DB->set_field('user', 'picture', 0, array('deleted'=>1, 'picture'=>1));
0dda790c 428 upgrade_main_savepoint(true, 2012050300.01);
fa530687
PS
429 }
430
0dda790c 431 if ($oldversion < 2012050300.02) {
4d254790
PS
432
433 // Changing precision of field picture on table user to (10)
434 $table = new xmldb_table('user');
435 $field = new xmldb_field('picture', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'secret');
436
437 // Launch change of precision for field picture
438 $dbman->change_field_precision($table, $field);
439
440 // Main savepoint reached
0dda790c 441 upgrade_main_savepoint(true, 2012050300.02);
4d254790
PS
442 }
443
1156d38d
DP
444 if ($oldversion < 2012050300.03) {
445
446 // Define field coursedisplay to be added to course
447 $table = new xmldb_table('course');
448 $field = new xmldb_field('coursedisplay', XMLDB_TYPE_INTEGER, '2', null, XMLDB_NOTNULL, null, '0', 'completionnotify');
449
450 // Conditionally launch add field coursedisplay
451 if (!$dbman->field_exists($table, $field)) {
452 $dbman->add_field($table, $field);
453 }
454
455 // Main savepoint reached
456 upgrade_main_savepoint(true, 2012050300.03);
457 }
458
b9bcdb54
DP
459 if ($oldversion < 2012050300.04) {
460
461 // Define table course_display to be dropped
462 $table = new xmldb_table('course_display');
463
464 // Conditionally launch drop table for course_display
465 if ($dbman->table_exists($table)) {
466 $dbman->drop_table($table);
467 }
468
469 // Main savepoint reached
470 upgrade_main_savepoint(true, 2012050300.04);
471 }
472
473 if ($oldversion < 2012050300.05) {
474
475 // Clean up removed admin setting.
476 unset_config('navlinkcoursesections');
477
478 upgrade_main_savepoint(true, 2012050300.05);
479 }
480
c119a2ee
PS
481 if ($oldversion < 2012050400.01) {
482
483 // Define index sortorder (not unique) to be added to course
484 $table = new xmldb_table('course');
485 $index = new xmldb_index('sortorder', XMLDB_INDEX_NOTUNIQUE, array('sortorder'));
486
487 // Conditionally launch add index sortorder
488 if (!$dbman->index_exists($table, $index)) {
489 $dbman->add_index($table, $index);
490 }
491
492 // Main savepoint reached
493 upgrade_main_savepoint(true, 2012050400.01);
494 }
495
a4cdd6d2 496 return true;
4e423cbf 497}