Merge branch 'MDL-57756-text-customparams' of https://github.com/cengage/moodle into...
[moodle.git] / mod / lti / db / upgrade.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
8 //
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.
13 //
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 // This file is part of BasicLTI4Moodle
18 //
19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
23 // are already supporting or going to support BasicLTI. This project Implements the consumer
24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
26 // at the GESSI research group at UPC.
27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
30 //
31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
35 /**
36  * This file keeps track of upgrades to the lti module
37  *
38  * @package mod_lti
39  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
40  *  marc.alier@upc.edu
41  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
42  * @author     Marc Alier
43  * @author     Jordi Piguillem
44  * @author     Nikolas Galanis
45  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
48  defined('MOODLE_INTERNAL') || die;
50 /**
51  * xmldb_lti_upgrade is the function that upgrades
52  * the lti module database when is needed
53  *
54  * This function is automaticly called when version number in
55  * version.php changes.
56  *
57  * @param int $oldversion New old version number.
58  *
59  * @return boolean
60  */
61 function xmldb_lti_upgrade($oldversion) {
62     global $CFG, $DB, $OUTPUT;
64     $dbman = $DB->get_manager();
66     // Automatically generated Moodle v3.5.0 release upgrade line.
67     // Put any upgrade step following this.
69     // Automatically generated Moodle v3.6.0 release upgrade line.
70     // Put any upgrade step following this.
72     if ($oldversion < 2019031300) {
73         // Define table lti_access_tokens to be updated.
74         $table = new xmldb_table('lti_types');
76         // Define field ltiversion to be added to lti_types.
77         $field = new xmldb_field('ltiversion', XMLDB_TYPE_CHAR, 10, null, XMLDB_NOTNULL, null, null, 'coursevisible');
79         // Conditionally launch add field ltiversion.
80         if (!$dbman->field_exists($table, $field)) {
81             $dbman->add_field($table, $field);
82             $DB->set_field_select('lti_types', 'ltiversion', 'LTI-1p0', 'toolproxyid IS NULL');
83             $DB->set_field_select('lti_types', 'ltiversion', 'LTI-2p0', 'toolproxyid IS NOT NULL');
84         }
86         // Define field clientid to be added to lti_types.
87         $field = new xmldb_field('clientid', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'ltiversion');
89         // Conditionally launch add field clientid.
90         if (!$dbman->field_exists($table, $field)) {
91             $dbman->add_field($table, $field);
92         }
94         // Define index clientid (unique) to be added to lti_types.
95         $index = new xmldb_index('clientid', XMLDB_INDEX_UNIQUE, array('clientid'));
97         // Conditionally launch add index clientid.
98         if (!$dbman->index_exists($table, $index)) {
99             $dbman->add_index($table, $index);
100         }
102         require_once($CFG->dirroot . '/mod/lti/upgradelib.php');
104         $warning = mod_lti_verify_private_key();
105         if (!empty($warning)) {
106             echo $OUTPUT->notification($warning, 'notifyproblem');
107         }
109         // Lti savepoint reached.
110         upgrade_mod_savepoint(true, 2019031300, 'lti');
111     }
113     if ($oldversion < 2019031301) {
114         // Define table lti_access_tokens to be created.
115         $table = new xmldb_table('lti_access_tokens');
117         // Adding fields to table lti_access_tokens.
118         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
119         $table->add_field('typeid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
120         $table->add_field('scope', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
121         $table->add_field('token', XMLDB_TYPE_CHAR, '128', null, XMLDB_NOTNULL, null, null);
122         $table->add_field('validuntil', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
123         $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
124         $table->add_field('lastaccess', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
126         // Adding keys to table lti_access_tokens.
127         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
128         $table->add_key('typeid', XMLDB_KEY_FOREIGN, array('typeid'), 'lti_types', array('id'));
130         // Add an index.
131         $table->add_index('token', XMLDB_INDEX_UNIQUE, array('token'));
133         // Conditionally launch create table for lti_access_tokens.
134         if (!$dbman->table_exists($table)) {
135             $dbman->create_table($table);
136         }
138         // Lti savepoint reached.
139         upgrade_mod_savepoint(true, 2019031301, 'lti');
140     }
142     if ($oldversion < 2019031302) {
143         // Define field typeid to be added to lti_tool_settings.
144         $table = new xmldb_table('lti_tool_settings');
145         $field = new xmldb_field('typeid', XMLDB_TYPE_INTEGER, '10', null, null, null, null, 'toolproxyid');
147         // Conditionally launch add field typeid.
148         if (!$dbman->field_exists($table, $field)) {
149             $dbman->add_field($table, $field);
150         }
152         // Define key typeid (foreign) to be added to lti_tool_settings.
153         $table = new xmldb_table('lti_tool_settings');
154         $key = new xmldb_key('typeid', XMLDB_KEY_FOREIGN, ['typeid'], 'lti_types', ['id']);
156         // Launch add key typeid.
157         $dbman->add_key($table, $key);
159         // Lti savepoint reached.
160         upgrade_mod_savepoint(true, 2019031302, 'lti');
161     }
163     // Automatically generated Moodle v3.7.0 release upgrade line.
164     // Put any upgrade step following this.
166     // Automatically generated Moodle v3.8.0 release upgrade line.
167     // Put any upgrade step following this.
169     // Automatically generated Moodle v3.9.0 release upgrade line.
170     // Put any upgrade step following this.
172     if ($oldversion < 2021052501) {
174         // Changing type of field instructorcustomparameters on table lti to text.
175         $table = new xmldb_table('lti');
176         $field = new xmldb_field('instructorcustomparameters', XMLDB_TYPE_TEXT, null, null, null, null, null,
177                 'instructorchoiceallowsetting');
179         // Launch change of type for field value.
180         $dbman->change_field_type($table, $field);
182         // Lti savepoint reached.
183         upgrade_mod_savepoint(true, 2021052501, 'lti');
184     }
186     return true;