[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 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.9.0 release upgrade line.
  67      // Put any upgrade step following this.
  68  
  69      if ($oldversion < 2021052501) {
  70  
  71          // Changing type of field instructorcustomparameters on table lti to text.
  72          $table = new xmldb_table('lti');
  73          $field = new xmldb_field('instructorcustomparameters', XMLDB_TYPE_TEXT, null, null, null, null, null,
  74                  'instructorchoiceallowsetting');
  75  
  76          // Launch change of type for field value.
  77          $dbman->change_field_type($table, $field);
  78  
  79          // Lti savepoint reached.
  80          upgrade_mod_savepoint(true, 2021052501, 'lti');
  81      }
  82  
  83      if ($oldversion < 2022032900) {
  84          // This option 'Public key type' was added in MDL-66920, but no value was set for existing 1.3 tools.
  85          // Set a default of 'RSA Key' for those LTI 1.3 tools without a value, representing the only key type they
  86          // could use at the time of their creation. Existing tools which have since been resaved will not be impacted.
  87          $sql = "SELECT t.id
  88                    FROM {lti_types} t
  89               LEFT JOIN {lti_types_config} tc
  90                      ON (tc.typeid = t.id AND tc.name = :typename)
  91                   WHERE t.ltiversion = :ltiversion
  92                     AND tc.value IS NULL";
  93          $params = ['typename' => 'keytype', 'ltiversion' => '1.3.0'];
  94          $recordset = $DB->get_recordset_sql($sql, $params);
  95          foreach ($recordset as $record) {
  96              $DB->insert_record('lti_types_config', (object) [
  97                  'typeid' => $record->id,
  98                  'name' => 'keytype',
  99                  'value' => 'RSA_KEY'
 100              ]);
 101          }
 102          $recordset->close();
 103  
 104          // Lti savepoint reached.
 105          upgrade_mod_savepoint(true, 2022032900, 'lti');
 106      }
 107  
 108      // Automatically generated Moodle v4.0.0 release upgrade line.
 109      // Put any upgrade step following this.
 110  
 111      // Automatically generated Moodle v4.1.0 release upgrade line.
 112      // Put any upgrade step following this.
 113  
 114      // Automatically generated Moodle v4.2.0 release upgrade line.
 115      // Put any upgrade step following this.
 116  
 117      if ($oldversion < 2023070501) {
 118  
 119          // Define table lti_types_categories to be created.
 120          $table = new xmldb_table('lti_types_categories');
 121  
 122          // Adding fields to table lti_types_categories.
 123          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
 124          $table->add_field('typeid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 125          $table->add_field('categoryid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 126  
 127          // Adding keys to table lti_types_categories.
 128          $table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
 129          $table->add_key('typeid', XMLDB_KEY_FOREIGN, ['typeid'], 'lti_types', ['id']);
 130          $table->add_key('categoryid', XMLDB_KEY_FOREIGN, ['categoryid'], 'course_categories', ['id']);
 131  
 132          // Conditionally launch create table for lti_types_categories.
 133          if (!$dbman->table_exists($table)) {
 134              $dbman->create_table($table);
 135          }
 136          // Lti savepoint reached.
 137          upgrade_mod_savepoint(true, 2023070501, 'lti');
 138      }
 139  
 140      if ($oldversion < 2023081101) {
 141          // Define table to override coursevisible for a tool on course level.
 142          $table = new xmldb_table('lti_coursevisible');
 143  
 144          // Adding fields to table lti_coursevisible.
 145          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE);
 146          $table->add_field('typeid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null, 'id');
 147          $table->add_field('courseid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null, 'typeid');
 148          $table->add_field('coursevisible', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, null, 'courseid');
 149  
 150          // Add key.
 151          $table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
 152  
 153          // Define index courseid (not unique) to be added to lti_coursevisible.
 154          $table->add_index('courseid', XMLDB_INDEX_NOTUNIQUE, ['courseid']);
 155          // Define index typeid (not unique) to be added to lti_coursevisible.
 156          $table->add_index('typeid', XMLDB_INDEX_NOTUNIQUE, ['typeid']);
 157  
 158          // Conditionally launch create table for overriding coursevisible.
 159          if (!$dbman->table_exists($table)) {
 160              $dbman->create_table($table);
 161          }
 162  
 163          // Lti savepoint reached.
 164          upgrade_mod_savepoint(true, 2023081101, 'lti');
 165      }
 166  
 167      // Automatically generated Moodle v4.3.0 release upgrade line.
 168      // Put any upgrade step following this.
 169  
 170      return true;
 171  }