mirrored from git://git.moodle.org/moodle.git
/
upgrade.php
262 lines (213 loc) · 13.4 KB
/
upgrade.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
<?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/>.
//
/**
* This file keeps track of upgrades to the lti enrolment plugin
*
* @package enrol_lti
* @copyright 2016 John Okely <john@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
/**
* xmldb_lti_upgrade is the function that upgrades
* the lti module database when is needed
*
* This function is automaticly called when version number in
* version.php changes.
*
* @param int $oldversion New old version number.
*
* @return boolean
*/
function xmldb_enrol_lti_upgrade($oldversion) {
global $DB;
$dbman = $DB->get_manager();
if ($oldversion < 2016052303) {
// Define table enrol_lti_lti2_consumer to be created.
$table = new xmldb_table('enrol_lti_lti2_consumer');
// Adding fields to table enrol_lti_lti2_consumer.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('name', XMLDB_TYPE_CHAR, '50', null, XMLDB_NOTNULL, null, null);
$table->add_field('consumerkey256', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
$table->add_field('consumerkey', XMLDB_TYPE_TEXT, null, null, null, null, null);
$table->add_field('secret', XMLDB_TYPE_CHAR, '1024', null, XMLDB_NOTNULL, null, null);
$table->add_field('ltiversion', XMLDB_TYPE_CHAR, '10', null, null, null, null);
$table->add_field('consumername', XMLDB_TYPE_CHAR, '255', null, null, null, null);
$table->add_field('consumerversion', XMLDB_TYPE_CHAR, '255', null, null, null, null);
$table->add_field('consumerguid', XMLDB_TYPE_CHAR, '1024', null, null, null, null);
$table->add_field('profile', XMLDB_TYPE_TEXT, null, null, null, null, null);
$table->add_field('toolproxy', XMLDB_TYPE_TEXT, null, null, null, null, null);
$table->add_field('settings', XMLDB_TYPE_TEXT, null, null, null, null, null);
$table->add_field('protected', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, null);
$table->add_field('enabled', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, null);
$table->add_field('enablefrom', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
$table->add_field('enableuntil', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
$table->add_field('lastaccess', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
$table->add_field('created', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
$table->add_field('updated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_consumer.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
// Adding indexes to table enrol_lti_lti2_consumer.
$table->add_index('consumerkey256_uniq', XMLDB_INDEX_UNIQUE, array('consumerkey256'));
// Conditionally launch create table for enrol_lti_lti2_consumer.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_lti2_tool_proxy to be created.
$table = new xmldb_table('enrol_lti_lti2_tool_proxy');
// Adding fields to table enrol_lti_lti2_tool_proxy.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('toolproxykey', XMLDB_TYPE_CHAR, '32', null, XMLDB_NOTNULL, null, null);
$table->add_field('consumerid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
$table->add_field('toolproxy', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
$table->add_field('created', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
$table->add_field('updated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_tool_proxy.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('toolproxykey_uniq', XMLDB_KEY_UNIQUE, array('toolproxykey'));
$table->add_key('consumerid', XMLDB_KEY_FOREIGN, array('consumerid'), 'enrol_lti_lti2_consumer', array('id'));
// Conditionally launch create table for enrol_lti_lti2_tool_proxy.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_lti2_context to be created.
$table = new xmldb_table('enrol_lti_lti2_context');
// Adding fields to table enrol_lti_lti2_context.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('consumerid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
$table->add_field('lticontextkey', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
$table->add_field('settings', XMLDB_TYPE_TEXT, null, null, null, null, null);
$table->add_field('created', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
$table->add_field('updated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_context.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('consumerid', XMLDB_KEY_FOREIGN, array('consumerid'), 'enrol_lti_lti2_consumer', array('id'));
// Conditionally launch create table for enrol_lti_lti2_context.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_lti2_nonce to be created.
$table = new xmldb_table('enrol_lti_lti2_nonce');
// Adding fields to table enrol_lti_lti2_nonce.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('consumerid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
$table->add_field('value', XMLDB_TYPE_CHAR, '32', null, XMLDB_NOTNULL, null, null);
$table->add_field('expires', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_nonce.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('consumerid', XMLDB_KEY_FOREIGN, array('consumerid'), 'enrol_lti_lti2_consumer', array('id'));
// Conditionally launch create table for enrol_lti_lti2_nonce.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_lti2_resource_link to be created.
$table = new xmldb_table('enrol_lti_lti2_resource_link');
// Adding fields to table enrol_lti_lti2_resource_link.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('contextid', XMLDB_TYPE_INTEGER, '11', null, null, null, null);
$table->add_field('consumerid', XMLDB_TYPE_INTEGER, '11', null, null, null, null);
$table->add_field('ltiresourcelinkkey', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
$table->add_field('settings', XMLDB_TYPE_TEXT, null, null, null, null, null);
$table->add_field('primaryresourcelinkid', XMLDB_TYPE_INTEGER, '11', null, null, null, null);
$table->add_field('shareapproved', XMLDB_TYPE_INTEGER, '1', null, null, null, null);
$table->add_field('created', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
$table->add_field('updated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_resource_link.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('contextid', XMLDB_KEY_FOREIGN, array('contextid'), 'enrol_lti_lti2_context', array('id'));
$table->add_key('primaryresourcelinkid', XMLDB_KEY_FOREIGN, array('primaryresourcelinkid'),
'enrol_lti_lti2_resource_link', array('id'));
$table->add_key('consumerid', XMLDB_KEY_FOREIGN, array('consumerid'), 'enrol_lti_lti2_consumer', array('id'));
// Conditionally launch create table for enrol_lti_lti2_resource_link.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_lti2_share_key to be created.
$table = new xmldb_table('enrol_lti_lti2_share_key');
// Adding fields to table enrol_lti_lti2_share_key.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('sharekey', XMLDB_TYPE_CHAR, '32', null, XMLDB_NOTNULL, null, null);
$table->add_field('resourcelinkid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
$table->add_field('autoapprove', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, null);
$table->add_field('expires', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_share_key.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('sharekey', XMLDB_KEY_UNIQUE, array('sharekey'));
$table->add_key('resourcelinkid', XMLDB_KEY_FOREIGN_UNIQUE, array('resourcelinkid'),
'enrol_lti_lti2_resource_link', array('id'));
// Conditionally launch create table for enrol_lti_lti2_share_key.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_lti2_user_result to be created.
$table = new xmldb_table('enrol_lti_lti2_user_result');
// Adding fields to table enrol_lti_lti2_user_result.
$table->add_field('id', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('resourcelinkid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
$table->add_field('ltiuserkey', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
$table->add_field('ltiresultsourcedid', XMLDB_TYPE_CHAR, '1024', null, XMLDB_NOTNULL, null, null);
$table->add_field('created', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
$table->add_field('updated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_lti2_user_result.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('resourcelinkid', XMLDB_KEY_FOREIGN, array('resourcelinkid'),
'enrol_lti_lti2_resource_link', array('id'));
// Conditionally launch create table for enrol_lti_lti2_user_result.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Define table enrol_lti_tool_consumer_map to be created.
$table = new xmldb_table('enrol_lti_tool_consumer_map');
// Adding fields to table enrol_lti_tool_consumer_map.
$table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('toolid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
$table->add_field('consumerid', XMLDB_TYPE_INTEGER, '11', null, XMLDB_NOTNULL, null, null);
// Adding keys to table enrol_lti_tool_consumer_map.
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('toolid', XMLDB_KEY_FOREIGN, array('toolid'), 'enrol_lti_tools', array('id'));
$table->add_key('consumerid', XMLDB_KEY_FOREIGN, array('consumerid'), 'enrol_lti_lti2_consumer', array('id'));
// Conditionally launch create table for enrol_lti_tool_consumer_map.
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// Lti savepoint reached.
upgrade_plugin_savepoint(true, 2016052303, 'enrol', 'lti');
}
if ($oldversion < 2016052304) {
// Define field type to be added to enrol_lti_lti2_context.
$table = new xmldb_table('enrol_lti_lti2_context');
$field = new xmldb_field('type', XMLDB_TYPE_CHAR, '100', null, null, null, null, 'lticontextkey');
// Conditionally launch add field type.
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Lti savepoint reached.
upgrade_plugin_savepoint(true, 2016052304, 'enrol', 'lti');
}
// Automatically generated Moodle v3.2.0 release upgrade line.
// Put any upgrade step following this.
if ($oldversion < 2016120501) {
// Changing precision of field value on table enrol_lti_lti2_nonce to (64).
$table = new xmldb_table('enrol_lti_lti2_nonce');
$field = new xmldb_field('value', XMLDB_TYPE_CHAR, '64', null, XMLDB_NOTNULL, null, null, 'consumerid');
// Launch change of precision for field value.
$dbman->change_field_precision($table, $field);
// Lti savepoint reached.
upgrade_plugin_savepoint(true, 2016120501, 'enrol', 'lti');
}
return true;
}