Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 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 defines tasks performed by the plugin.
  37   *
  38   * @package    ltiservice_gradebookservices
  39   * @copyright  2020 Cengage Learning http://www.cengage.com
  40   * @author     Claude Vervoort
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  
  44   defined('MOODLE_INTERNAL') || die;
  45  
  46  /**
  47   * xmldb_ltiservice_gradebookservices_upgrade is the function that upgrades
  48   * the gradebook lti service subplugin database when is needed.
  49   *
  50   * This function is automatically called when version number in
  51   * version.php changes.
  52   *
  53   * @param int $oldversion New old version number.
  54   *
  55   * @return boolean
  56   */
  57  function xmldb_ltiservice_gradebookservices_upgrade($oldversion) {
  58      global $CFG, $DB, $OUTPUT;
  59  
  60      $dbman = $DB->get_manager();
  61  
  62      if ($oldversion < 2020042401) {
  63          // Define field typeid to be added to lti_tool_settings.
  64          $table = new xmldb_table('ltiservice_gradebookservices');
  65          $field = new xmldb_field('resourceid', XMLDB_TYPE_CHAR, "512", null, null, null, null);
  66  
  67          // Conditionally launch add field typeid.
  68          if (!$dbman->field_exists($table, $field)) {
  69              $dbman->add_field($table, $field);
  70          }
  71  
  72          // Lti savepoint reached.
  73          upgrade_plugin_savepoint(true, 2020042401, 'ltiservice', 'gradebookservices');
  74      }
  75  
  76      if ($oldversion < 2020042402) {
  77          // Now that we have added the new column let's migrate it'
  78          // Prior implementation was storing the resourceid under the grade item idnumber, so moving it to lti_gradebookservices.
  79          // We only care for mod/lti grade items as manual columns would already have a matching gradebookservices record.
  80  
  81          $DB->execute("INSERT INTO {ltiservice_gradebookservices}
  82                  (gradeitemid, courseid, typeid, ltilinkid, resourceid, baseurl, toolproxyid)
  83           SELECT gi.id, courseid, lti.typeid, lti.id, gi.idnumber, t.baseurl, t.toolproxyid
  84             FROM {grade_items} gi
  85             JOIN {lti} lti ON lti.id=gi.iteminstance AND gi.itemtype='mod' AND gi.itemmodule='lti'
  86             JOIN {lti_types} t ON t.id = lti.typeid
  87            WHERE gi.id NOT IN ( SELECT gradeitemid
  88                                   FROM {ltiservice_gradebookservices} )
  89               AND gi.idnumber IS NOT NULL
  90               AND gi.idnumber <> ''");
  91  
  92          // Lti savepoint reached.
  93          upgrade_plugin_savepoint(true, 2020042402, 'ltiservice', 'gradebookservices');
  94      }
  95  
  96      if ($oldversion < 2020042403) {
  97          // Here updating the resourceid of pre-existing lti_gradebookservices.
  98          $DB->execute("UPDATE {ltiservice_gradebookservices}
  99                           SET resourceid = (SELECT idnumber FROM {grade_items} WHERE id=gradeitemid)
 100                         WHERE gradeitemid in (SELECT id FROM {grade_items}
 101                                               WHERE ((itemtype='mod' AND itemmodule='lti') OR itemtype='manual')
 102                                                 AND idnumber IS NOT NULL
 103                                                 AND idnumber <> '')
 104                           AND (resourceid is null OR resourceid = '')");
 105  
 106          // Lti savepoint reached.
 107          upgrade_plugin_savepoint(true, 2020042403, 'ltiservice', 'gradebookservices');
 108      }
 109  
 110      // Automatically generated Moodle v3.9.0 release upgrade line.
 111      // Put any upgrade step following this.
 112  
 113      // Automatically generated Moodle v4.0.0 release upgrade line.
 114      // Put any upgrade step following this.
 115  
 116      if ($oldversion < 2022051900) {
 117          $table = new xmldb_table('ltiservice_gradebookservices');
 118          $field = new xmldb_field('subreviewurl', XMLDB_TYPE_TEXT, null, null, null, null, null);
 119          if (!$dbman->field_exists($table, $field)) {
 120              $dbman->add_field($table, $field);
 121          }
 122          $field = new xmldb_field('subreviewparams', XMLDB_TYPE_TEXT, null, null, null, null, null);
 123          if (!$dbman->field_exists($table, $field)) {
 124              $dbman->add_field($table, $field);
 125          }
 126  
 127          // Lti savepoint reached.
 128          upgrade_plugin_savepoint(true, 2022051900, 'ltiservice', 'gradebookservices');
 129      }
 130  
 131      // Automatically generated Moodle v4.1.0 release upgrade line.
 132      // Put any upgrade step following this.
 133  
 134      return true;
 135  }