[Summary view] [Print] [Text view]

   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;
  63  
  64      require_once (__DIR__ . '/upgradelib.php');
  65  
  66      $dbman = $DB->get_manager();
  67  
  68      if ($oldversion < 2014060201) {
  69  
  70          // Changing type of field grade on table lti to int.
  71          $table = new xmldb_table('lti');
  72          $field = new xmldb_field('grade', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '100',
  73                  'instructorchoiceacceptgrades');
  74  
  75          // Launch change of type for field grade.
  76          $dbman->change_field_type($table, $field);
  77  
  78          // Lti savepoint reached.
  79          upgrade_mod_savepoint(true, 2014060201, 'lti');
  80      }
  81  
  82      if ($oldversion < 2014061200) {
  83  
  84          // Define table lti_tool_proxies to be created.
  85          $table = new xmldb_table('lti_tool_proxies');
  86  
  87          // Adding fields to table lti_tool_proxies.
  88          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
  89          $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, 'Tool Provider');
  90          $table->add_field('regurl', XMLDB_TYPE_TEXT, null, null, null, null, null);
  91          $table->add_field('state', XMLDB_TYPE_INTEGER, '2', null, XMLDB_NOTNULL, null, '1');
  92          $table->add_field('guid', XMLDB_TYPE_CHAR, '255', null, null, null, null);
  93          $table->add_field('secret', XMLDB_TYPE_CHAR, '255', null, null, null, null);
  94          $table->add_field('vendorcode', XMLDB_TYPE_CHAR, '255', null, null, null, null);
  95          $table->add_field('capabilityoffered', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
  96          $table->add_field('serviceoffered', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
  97          $table->add_field('toolproxy', XMLDB_TYPE_TEXT, null, null, null, null, null);
  98          $table->add_field('createdby', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
  99          $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 100          $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 101  
 102          // Adding keys to table lti_tool_proxies.
 103          $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
 104  
 105          // Adding indexes to table lti_tool_proxies.
 106          $table->add_index('guid', XMLDB_INDEX_UNIQUE, array('guid'));
 107  
 108          // Conditionally launch create table for lti_tool_proxies.
 109          if (!$dbman->table_exists($table)) {
 110              $dbman->create_table($table);
 111          }
 112  
 113          // Define table lti_tool_settings to be created.
 114          $table = new xmldb_table('lti_tool_settings');
 115  
 116          // Adding fields to table lti_tool_settings.
 117          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
 118          $table->add_field('toolproxyid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 119          $table->add_field('course', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
 120          $table->add_field('coursemoduleid', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
 121          $table->add_field('settings', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
 122          $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 123          $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 124  
 125          // Adding keys to table lti_tool_settings.
 126          $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
 127          $table->add_key('toolproxy', XMLDB_KEY_FOREIGN, array('toolproxyid'), 'lti_tool_proxies', array('id'));
 128          $table->add_key('course', XMLDB_KEY_FOREIGN, array('course'), 'course', array('id'));
 129          $table->add_key('coursemodule', XMLDB_KEY_FOREIGN, array('coursemoduleid'), 'lti', array('id'));
 130  
 131          // Conditionally launch create table for lti_tool_settings.
 132          if (!$dbman->table_exists($table)) {
 133              $dbman->create_table($table);
 134          }
 135  
 136          // Define table lti_types to be updated.
 137          $table = new xmldb_table('lti_types');
 138  
 139          // Adding fields to table lti_types.
 140          $field = new xmldb_field('toolproxyid', XMLDB_TYPE_INTEGER, '10', null, null, null, null);
 141          if (!$dbman->field_exists($table, $field)) {
 142              $dbman->add_field($table, $field);
 143          }
 144          $field = new xmldb_field('enabledcapability', XMLDB_TYPE_TEXT, null, null, null, null, null);
 145          if (!$dbman->field_exists($table, $field)) {
 146              $dbman->add_field($table, $field);
 147          }
 148          $field = new xmldb_field('parameter', XMLDB_TYPE_TEXT, null, null, null, null, null);
 149          if (!$dbman->field_exists($table, $field)) {
 150              $dbman->add_field($table, $field);
 151          }
 152          $field = new xmldb_field('icon', XMLDB_TYPE_TEXT, null, null, null, null, null);
 153          if (!$dbman->field_exists($table, $field)) {
 154              $dbman->add_field($table, $field);
 155          }
 156          $field = new xmldb_field('secureicon', XMLDB_TYPE_TEXT, null, null, null, null, null);
 157          if (!$dbman->field_exists($table, $field)) {
 158              $dbman->add_field($table, $field);
 159          }
 160  
 161          // Lti savepoint reached.
 162          upgrade_mod_savepoint(true, 2014061200, 'lti');
 163      }
 164  
 165      if ($oldversion < 2014100300) {
 166  
 167          mod_lti_upgrade_custom_separator();
 168  
 169          // Lti savepoint reached.
 170          upgrade_mod_savepoint(true, 2014100300, 'lti');
 171      }
 172  
 173      // Moodle v2.8.0 release upgrade line.
 174      // Put any upgrade step following this.
 175  
 176      // Moodle v2.9.0 release upgrade line.
 177      // Put any upgrade step following this.
 178  
 179      // Moodle v3.0.0 release upgrade line.
 180      // Put any upgrade step following this.
 181  
 182      if ($oldversion < 2016041800) {
 183  
 184          // Define field description to be added to lti_types.
 185          $table = new xmldb_table('lti_types');
 186          $field = new xmldb_field('description', XMLDB_TYPE_TEXT, null, null, null, null, null, 'timemodified');
 187  
 188          // Conditionally launch add field description.
 189          if (!$dbman->field_exists($table, $field)) {
 190              $dbman->add_field($table, $field);
 191          }
 192  
 193          // Lti savepoint reached.
 194          upgrade_mod_savepoint(true, 2016041800, 'lti');
 195      }
 196  
 197      // Moodle v3.1.0 release upgrade line.
 198      // Put any upgrade step following this.
 199  
 200      return true;
 201  }