[Summary view]

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

   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.
  34  
  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   */
  47  
  48   defined('MOODLE_INTERNAL') || die;
  49  
  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;
  63  
  64      $dbman = $DB->get_manager();
  65  
  66      // Automatically generated Moodle v3.6.0 release upgrade line.
  67      // Put any upgrade step following this.
  68  
  69      if ($oldversion < 2019031300) {
  70          // Define table lti_access_tokens to be updated.
  71          $table = new xmldb_table('lti_types');
  72  
  73          // Define field ltiversion to be added to lti_types.
  74          $field = new xmldb_field('ltiversion', XMLDB_TYPE_CHAR, 10, null, XMLDB_NOTNULL, null, null, 'coursevisible');
  75  
  76          // Conditionally launch add field ltiversion.
  77          if (!$dbman->field_exists($table, $field)) {
  78              $dbman->add_field($table, $field);
  79              $DB->set_field_select('lti_types', 'ltiversion', 'LTI-1p0', 'toolproxyid IS NULL');
  80              $DB->set_field_select('lti_types', 'ltiversion', 'LTI-2p0', 'toolproxyid IS NOT NULL');
  81          }
  82  
  83          // Define field clientid to be added to lti_types.
  84          $field = new xmldb_field('clientid', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'ltiversion');
  85  
  86          // Conditionally launch add field clientid.
  87          if (!$dbman->field_exists($table, $field)) {
  88              $dbman->add_field($table, $field);
  89          }
  90  
  91          // Define index clientid (unique) to be added to lti_types.
  92          $index = new xmldb_index('clientid', XMLDB_INDEX_UNIQUE, array('clientid'));
  93  
  94          // Conditionally launch add index clientid.
  95          if (!$dbman->index_exists($table, $index)) {
  96              $dbman->add_index($table, $index);
  97          }
  98  
  99          require_once($CFG->dirroot . '/mod/lti/upgradelib.php');
 100  
 101          $warning = mod_lti_verify_private_key();
 102          if (!empty($warning)) {
 103              echo $OUTPUT->notification($warning, 'notifyproblem');
 104          }
 105  
 106          // Lti savepoint reached.
 107          upgrade_mod_savepoint(true, 2019031300, 'lti');
 108      }
 109  
 110      if ($oldversion < 2019031301) {
 111          // Define table lti_access_tokens to be created.
 112          $table = new xmldb_table('lti_access_tokens');
 113  
 114          // Adding fields to table lti_access_tokens.
 115          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
 116          $table->add_field('typeid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 117          $table->add_field('scope', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
 118          $table->add_field('token', XMLDB_TYPE_CHAR, '128', null, XMLDB_NOTNULL, null, null);
 119          $table->add_field('validuntil', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 120          $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 121          $table->add_field('lastaccess', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
 122  
 123          // Adding keys to table lti_access_tokens.
 124          $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
 125          $table->add_key('typeid', XMLDB_KEY_FOREIGN, array('typeid'), 'lti_types', array('id'));
 126  
 127          // Add an index.
 128          $table->add_index('token', XMLDB_INDEX_UNIQUE, array('token'));
 129  
 130          // Conditionally launch create table for lti_access_tokens.
 131          if (!$dbman->table_exists($table)) {
 132              $dbman->create_table($table);
 133          }
 134  
 135          // Lti savepoint reached.
 136          upgrade_mod_savepoint(true, 2019031301, 'lti');
 137      }
 138  
 139      if ($oldversion < 2019031302) {
 140          // Define field typeid to be added to lti_tool_settings.
 141          $table = new xmldb_table('lti_tool_settings');
 142          $field = new xmldb_field('typeid', XMLDB_TYPE_INTEGER, '10', null, null, null, null, 'toolproxyid');
 143  
 144          // Conditionally launch add field typeid.
 145          if (!$dbman->field_exists($table, $field)) {
 146              $dbman->add_field($table, $field);
 147          }
 148  
 149          // Define key typeid (foreign) to be added to lti_tool_settings.
 150          $table = new xmldb_table('lti_tool_settings');
 151          $key = new xmldb_key('typeid', XMLDB_KEY_FOREIGN, ['typeid'], 'lti_types', ['id']);
 152  
 153          // Launch add key typeid.
 154          $dbman->add_key($table, $key);
 155  
 156          // Lti savepoint reached.
 157          upgrade_mod_savepoint(true, 2019031302, 'lti');
 158      }
 159  
 160      // Automatically generated Moodle v3.7.0 release upgrade line.
 161      // Put any upgrade step following this.
 162  
 163      // Automatically generated Moodle v3.8.0 release upgrade line.
 164      // Put any upgrade step following this.
 165  
 166      // Automatically generated Moodle v3.9.0 release upgrade line.
 167      // Put any upgrade step following this.
 168  
 169      if ($oldversion < 2021052501) {
 170  
 171          // Changing type of field instructorcustomparameters on table lti to text.
 172          $table = new xmldb_table('lti');
 173          $field = new xmldb_field('instructorcustomparameters', XMLDB_TYPE_TEXT, null, null, null, null, null,
 174                  'instructorchoiceallowsetting');
 175  
 176          // Launch change of type for field value.
 177          $dbman->change_field_type($table, $field);
 178  
 179          // Lti savepoint reached.
 180          upgrade_mod_savepoint(true, 2021052501, 'lti');
 181      }
 182  
 183      if ($oldversion < 2022032900) {
 184          // This option 'Public key type' was added in MDL-66920, but no value was set for existing 1.3 tools.
 185          // Set a default of 'RSA Key' for those LTI 1.3 tools without a value, representing the only key type they
 186          // could use at the time of their creation. Existing tools which have since been resaved will not be impacted.
 187          $sql = "SELECT t.id
 188                    FROM {lti_types} t
 189               LEFT JOIN {lti_types_config} tc
 190                      ON (tc.typeid = t.id AND tc.name = :typename)
 191                   WHERE t.ltiversion = :ltiversion
 192                     AND tc.value IS NULL";
 193          $params = ['typename' => 'keytype', 'ltiversion' => '1.3.0'];
 194          $recordset = $DB->get_recordset_sql($sql, $params);
 195          foreach ($recordset as $record) {
 196              $DB->insert_record('lti_types_config', (object) [
 197                  'typeid' => $record->id,
 198                  'name' => 'keytype',
 199                  'value' => 'RSA_KEY'
 200              ]);
 201          }
 202          $recordset->close();
 203  
 204          // Lti savepoint reached.
 205          upgrade_mod_savepoint(true, 2022032900, 'lti');
 206      }
 207  
 208      // Automatically generated Moodle v4.0.0 release upgrade line.
 209      // Put any upgrade step following this.
 210  
 211      return true;
 212  }