ae18f6a36e217f78b470d60e92d2384b6f77a9f8
[moodle.git] / lib / db / upgrade.php
1 <?PHP  //$Id$
3 // This file keeps track of upgrades to Moodle.
4 //
5 // Sometimes, changes between versions involve
6 // alterations to database structures and other
7 // major things that may break installations.
8 //
9 // The upgrade function in this file will attempt
10 // to perform all the necessary actions to upgrade
11 // your older installtion to the current version.
12 //
13 // If there's something it cannot do itself, it
14 // will tell you what you need to do.
15 //
16 // The commands in here will all be database-neutral,
17 // using the methods of database_manager class
20 function xmldb_main_upgrade($oldversion=0) {
21     global $CFG, $THEME, $USER, $DB;
23     $result = true;
25     $dbman = $DB->get_manager(); // loads ddl manager and xmldb classes
27     ////////////////////////////////////////
28     ///upgrade supported only from 1.9.x ///
29     ////////////////////////////////////////
31     if ($result && $oldversion < 2008030700) {
33     /// Define index contextid-lowerboundary (not unique) to be dropped form grade_letters
34         $table = new xmldb_table('grade_letters');
35         $index = new xmldb_index('contextid-lowerboundary', XMLDB_INDEX_NOTUNIQUE, array('contextid', 'lowerboundary'));
37     /// Launch drop index contextid-lowerboundary
38         $dbman->drop_index($table, $index);
40     /// Define index contextid-lowerboundary-letter (unique) to be added to grade_letters
41         $table = new xmldb_table('grade_letters');
42         $index = new xmldb_index('contextid-lowerboundary-letter', XMLDB_INDEX_UNIQUE, array('contextid', 'lowerboundary', 'letter'));
44     /// Launch add index contextid-lowerboundary-letter
45         $dbman->add_index($table, $index);
47     /// Main savepoint reached
48         upgrade_main_savepoint($result, 2008030700);
49     }
51     if ($result && $oldversion < 2008050100) {
52         // Update courses that used weekscss to weeks
53         $result = $DB->set_field('course', 'format', 'weeks', array('format' => 'weekscss'));
54         upgrade_main_savepoint($result, 2008050100);
55     }
57     if ($result && $oldversion < 2008050200) {
58         // remove unused config options
59         unset_config('statsrolesupgraded');
60         upgrade_main_savepoint($result, 2008050200);
61     }
63     if ($result && $oldversion < 2008050700) {
64     /// Fix minor problem caused by MDL-5482.
65         require_once($CFG->dirroot . '/question/upgrade.php');
66         $result = $result && question_fix_random_question_parents();
67         upgrade_main_savepoint($result, 2008050700);
68     }
70     if ($result && $oldversion < 2008051200) {
71         // if guest role used as default user role unset it and force admin to choose new setting
72         if (!empty($CFG->defaultuserroleid)) {
73             if ($role = $DB->get_record('role', array('id'=>$CFG->defaultuserroleid))) {
74                 if ($guestroles = get_roles_with_capability('moodle/legacy:guest', CAP_ALLOW)) {
75                     if (isset($guestroles[$role->id])) {
76                         set_config('defaultuserroleid', null);
77                         notify('Guest role removed from "Default role for all users" setting, please select another role.', 'notifysuccess');
78                     }
79                 }
80             } else {
81                 set_config('defaultuserroleid', null);
82             }
83         }
84     }
86     if ($result && $oldversion < 2008051201) {
87         notify('Increasing size of user idnumber field, this may take a while...', 'notifysuccess');
89     /// Under MySQL and Postgres... detect old NULL contents and change them by correct empty string. MDL-14859
90         if ($CFG->dbfamily == 'mysql' || $CFG->dbfamily == 'postgres') {
91             $DB->execute("UPDATE {user} SET idnumber = '' WHERE idnumber IS NULL");
92         }
94     /// Define index idnumber (not unique) to be dropped form user
95         $table = new xmldb_table('user');
96         $index = new xmldb_index('idnumber', XMLDB_INDEX_NOTUNIQUE, array('idnumber'));
98     /// Launch drop index idnumber
99         if ($dbman->index_exists($table, $index)) {
100             $dbman->drop_index($table, $index);
101         }
103     /// Changing precision of field idnumber on table user to (255)
104         $table = new xmldb_table('user');
105         $field = new xmldb_field('idnumber', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null, 'password');
107     /// Launch change of precision for field idnumber
108         $dbman->change_field_precision($table, $field);
110     /// Launch add index idnumber again
111         $index = new xmldb_index('idnumber', XMLDB_INDEX_NOTUNIQUE, array('idnumber'));
112         $dbman->add_index($table, $index);
114     /// Main savepoint reached
115         upgrade_main_savepoint($result, 2008051201);
116     }
118     if ($result && $oldversion < 2008051202) {
119         $log_action = new object();
120         $log_action->module = 'course';
121         $log_action->action = 'unenrol';
122         $log_action->mtable = 'course';
123         $log_action->field  = 'fullname';
124         if (!$DB->record_exists('log_display', array('action'=>'unenrol', 'module'=>'course'))) {
125             $result = $result && $DB->insert_record('log_display', $log_action);
126         }
127         upgrade_main_savepoint($result, 2008051202);
128     }
130     if ($result && $oldversion < 2008051203) {
131         $table = new xmldb_table('mnet_enrol_course');
132         $field = new xmldb_field('sortorder', XMLDB_TYPE_INTEGER, '10', true, true, null, false, false, 0);
133         $dbman->change_field_precision($table, $field);
134         upgrade_main_savepoint($result, 2008051203);
135     }
137     if ($result && $oldversion < 2008063001) {
138         // table to be modified
139         $table = new xmldb_table('tag_instance');
140         // add field
141         $field = new xmldb_field('tiuserid');
142         if (!$dbman->field_exists($table, $field)) {
143             $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, 0, 'itemid');
144             $dbman->add_field($table, $field);
145         }
146         // modify index
147         $index = new xmldb_index('itemtype-itemid-tagid');
148         $index->set_attributes(XMLDB_INDEX_UNIQUE, array('itemtype', 'itemid', 'tagid'));
149         $dbman->drop_index($table, $index);
150         $index = new xmldb_index('itemtype-itemid-tagid-tiuserid');
151         $index->set_attributes(XMLDB_INDEX_UNIQUE, array('itemtype', 'itemid', 'tagid', 'tiuserid'));
152         $dbman->add_index($table, $index);
154         /// Main savepoint reached
155         upgrade_main_savepoint($result, 2008063001);
156     }
157     if ($result && $oldversion < 2008063002) {
159     /// Define table repository to be created
160         $table = new xmldb_table('repository');
162     /// Adding fields to table repository
163         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
164         $table->add_field('repositoryname', XMLDB_TYPE_CHAR, '255', null, null, null, null, null, null);
165         $table->add_field('repositorytype', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
166         $table->add_field('userid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
167         $table->add_field('contextid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
168         $table->add_field('username', XMLDB_TYPE_CHAR, '255', null, null, null, null, null, null);
169         $table->add_field('password', XMLDB_TYPE_CHAR, '255', null, null, null, null, null, null);
170         $table->add_field('data1', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
171         $table->add_field('data2', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
172         $table->add_field('data3', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
173         $table->add_field('data4', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
174         $table->add_field('data5', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
175         $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
176         $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0');
178     /// Adding keys to table repository
179         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
181     /// Conditionally launch create table for repository
182         if (!$dbman->table_exists($table)) {
183             $dbman->create_table($table);
184         }
186     /// Main savepoint reached
187         upgrade_main_savepoint($result, 2008063002);
188     }
190     if ($result && $oldversion < 2008070300) {
191         $result = $DB->delete_records_select('role_names', $DB->sql_isempty('role_names', 'name', false, false));
192         upgrade_main_savepoint($result, 2008070300);
193     }
195     if ($result && $oldversion < 2008070700) {
196         if (isset($CFG->defaultuserroleid) and isset($CFG->guestroleid) and $CFG->defaultuserroleid == $CFG->guestroleid) {
197             // guest can not be selected in defaultuserroleid!
198             unset_config('defaultuserroleid');
199         }
200         upgrade_main_savepoint($result, 2008070700);
201     }
203     if ($result && $oldversion < 2008070701) {
205     /// Define table portfolio_instance to be created
206         $table = new xmldb_table('portfolio_instance');
208     /// Adding fields to table portfolio_instance
209         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
210         $table->add_field('plugin', XMLDB_TYPE_CHAR, '50', null, XMLDB_NOTNULL, null, null, null, null);
211         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
212         $table->add_field('visible', XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '1');
214     /// Adding keys to table portfolio_instance
215         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
217     /// Conditionally launch create table for portfolio_instance
218         if (!$dbman->table_exists($table)) {
219             $dbman->create_table($table);
220         }
221   /// Define table portfolio_instance_config to be created
222         $table = new xmldb_table('portfolio_instance_config');
224     /// Adding fields to table portfolio_instance_config
225         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
226         $table->add_field('instance', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
227         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
228         $table->add_field('value', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
230     /// Adding keys to table portfolio_instance_config
231         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
232         $table->add_key('instance', XMLDB_KEY_FOREIGN, array('instance'), 'portfolio_instance', array('id'));
234     /// Adding indexes to table portfolio_instance_config
235         $table->add_index('name', XMLDB_INDEX_NOTUNIQUE, array('name'));
237     /// Conditionally launch create table for portfolio_instance_config
238         if (!$dbman->table_exists($table)) {
239             $dbman->create_table($table);
240         }
242    /// Define table portfolio_instance_user to be created
243         $table = new xmldb_table('portfolio_instance_user');
245     /// Adding fields to table portfolio_instance_user
246         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
247         $table->add_field('instance', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
248         $table->add_field('userid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
249         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
250         $table->add_field('value', XMLDB_TYPE_TEXT, 'big', null, null, null, null, null, null);
252     /// Adding keys to table portfolio_instance_user
253         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
254         $table->add_key('instancefk', XMLDB_KEY_FOREIGN, array('instance'), 'portfolio_instance', array('id'));
255         $table->add_key('userfk', XMLDB_KEY_FOREIGN, array('userid'), 'user', array('id'));
257     /// Conditionally launch create table for portfolio_instance_user
258         if (!$dbman->table_exists($table)) {
259             $dbman->create_table($table);
260         }
262     /// Main savepoint reached
263         upgrade_main_savepoint($result, 2008070701);
264     }
265     
266     if ($result && $oldversion < 2008072400) {
267         /// Create the database tables for message_processors and message_providers
268         $table = new xmldb_table('message_providers');
269         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
270         $table->add_field('modulename', XMLDB_TYPE_CHAR, '166', null, XMLDB_NOTNULL, null, null, null, null);
271         $table->add_field('modulefile', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
272         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
273         $dbman->create_table($table);
275         $table = new xmldb_table('message_processors');
276         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
277         $table->add_field('name', XMLDB_TYPE_CHAR, '166', null, XMLDB_NOTNULL, null, null, null, null);
278         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
279         $dbman->create_table($table);
282         $provider = new object();
283         $provider->modulename  = 'moodle';
284         $provider->modulefile  = 'index.php';
285         $DB->insert_record('message_providers', $provider);
287     /// delete old and create new fields
288         $table = new xmldb_table('message');
289         $field = new xmldb_field('messagetype');
290         $dbman->drop_field($table, $field);
292     /// fields to rename
293         $field = new xmldb_field('message');
294         $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, null);
295         $dbman->rename_field($table, $field, 'fullmessage');
296         $field = new xmldb_field('format');
297         $field->set_attributes(XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED, null, null, null, null, '0', null);
298         $dbman->rename_field($table, $field, 'fullmessageformat');
300     /// new message fields
301         $field = new xmldb_field('subject');
302         $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, null);
303         $dbman->add_field($table, $field);
304         $field = new xmldb_field('fullmessagehtml');
305         $field->set_attributes(XMLDB_TYPE_TEXT, 'medium', null, null, null, null, null, null, null);
306         $dbman->add_field($table, $field);
307         $field = new xmldb_field('smallmessage');
308         $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, null);
309         $dbman->add_field($table, $field);
312         $table = new xmldb_table('message_read');
313         $field = new xmldb_field('messagetype');
314         $dbman->drop_field($table, $field);
315         $field = new xmldb_field('mailed');
316         $dbman->drop_field($table, $field);
318     /// fields to rename
319         $field = new xmldb_field('message');
320         $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, null);
321         $dbman->rename_field($table, $field, 'fullmessage');
322         $field = new xmldb_field('format');
323         $field->set_attributes(XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED, null, null, null, null, '0', null);
324         $dbman->rename_field($table, $field, 'fullmessageformat');
327     /// new message fields
328         $field = new xmldb_field('subject');
329         $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, null);
330         $dbman->add_field($table, $field);
331         $field = new xmldb_field('fullmessagehtml');
332         $field->set_attributes(XMLDB_TYPE_TEXT, 'medium', null, null, null, null, null, null, null);
333         $dbman->add_field($table, $field);
334         $field = new xmldb_field('smallmessage');
335         $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, null, null, null, null, null, null);
336         $dbman->add_field($table, $field);
338     /// new table
339         $table = new xmldb_table('message_working');
340         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
341         $table->add_field('unreadmessageid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
342         $table->add_field('processorid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
343         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
344         $dbman->create_table($table);
347         upgrade_main_savepoint($result, 2008072400);
348     }
350     if ($result && $oldversion < 2008072800) {
352     /// Define field enablecompletion to be added to course
353         $table = new xmldb_table('course');
354         $field = new xmldb_field('enablecompletion');
355         $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'defaultrole');
357     /// Launch add field enablecompletion
358         if(!$dbman->field_exists($table,$field)) {
359             $dbman->add_field($table, $field);
360         }
361         
362     /// Define field completion to be added to course_modules
363         $table = new xmldb_table('course_modules');
364         $field = new xmldb_field('completion');
365         $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'groupmembersonly');
367     /// Launch add field completion
368         if(!$dbman->field_exists($table,$field)) {
369             $dbman->add_field($table, $field);
370         }
372     /// Define field completiongradeitemnumber to be added to course_modules
373         $field = new xmldb_field('completiongradeitemnumber');
374         $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, null, null, null, 'completion');
376     /// Launch add field completiongradeitemnumber
377         if(!$dbman->field_exists($table,$field)) {
378             $dbman->add_field($table, $field);
379         }
381     /// Define field completionview to be added to course_modules
382         $field = new xmldb_field('completionview');
383         $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'completiongradeitemnumber');
385     /// Launch add field completionview
386         if(!$dbman->field_exists($table,$field)) {
387             $dbman->add_field($table, $field);
388         }
390     /// Define field completionexpected to be added to course_modules
391         $field = new xmldb_field('completionexpected');
392         $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'completionview');
394     /// Launch add field completionexpected
395         if(!$dbman->field_exists($table,$field)) {
396             $dbman->add_field($table, $field);
397         }
399    /// Define table course_modules_completion to be created
400         $table = new xmldb_table('course_modules_completion');
401         if(!$dbman->table_exists($table)) {
403         /// Adding fields to table course_modules_completion
404             $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
405             $table->add_field('coursemoduleid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
406             $table->add_field('userid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
407             $table->add_field('completionstate', XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
408             $table->add_field('viewed', XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, null, null, null, null, null);
409             $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
410     
411         /// Adding keys to table course_modules_completion
412             $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
413     
414         /// Adding indexes to table course_modules_completion
415             $table->add_index('coursemoduleid', XMLDB_INDEX_NOTUNIQUE, array('coursemoduleid'));
416             $table->add_index('userid', XMLDB_INDEX_NOTUNIQUE, array('userid'));
417     
418         /// Launch create table for course_modules_completion
419             $dbman->create_table($table);
420         }
422         /// Main savepoint reached
423         upgrade_main_savepoint($result, 2008072800);
424     }
425     
426     if ($result && $oldversion < 2008073000) {
428     /// Define table portfolio_log to be created
429         $table = new xmldb_table('portfolio_log');
431     /// Adding fields to table portfolio_log
432         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null, null, null);
433         $table->add_field('userid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
434         $table->add_field('time', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
435         $table->add_field('portfolio', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, null);
436         $table->add_field('caller_class', XMLDB_TYPE_CHAR, '150', null, XMLDB_NOTNULL, null, null, null, null);
437         $table->add_field('caller_file', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
438         $table->add_field('caller_sha1', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, null, null);
440     /// Adding keys to table portfolio_log
441         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
442         $table->add_key('userfk', XMLDB_KEY_FOREIGN, array('userid'), 'user', array('id'));
443         $table->add_key('portfoliofk', XMLDB_KEY_FOREIGN, array('portfolio'), 'portfolio_instance', array('id'));
445     /// Conditionally launch create table for portfolio_log
446         if (!$dbman->table_exists($table)) {
447             $dbman->create_table($table);
448         }
450     /// Main savepoint reached
451         upgrade_main_savepoint($result, 2008073000);
452     }
453  
454 /*
455  * TODO:
456  *   drop adodb_logsql table and create a new general sql log table
457  *
458  */
460     return $result;
464 ?>