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.
  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     $dbman = $DB->get_manager();
  65
  66     if ($oldversion < 2016052301) {
  67
  68         // Changing type of field value on table lti_types_config to text.
  69         $table = new xmldb_table('lti_types_config');
  70         $field = new xmldb_field('value', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null, 'name');
  71
  72         // Launch change of type for field value.
  73         $dbman->change_field_type($table, $field);
  74
  75         // Lti savepoint reached.
  76         upgrade_mod_savepoint(true, 2016052301, 'lti');
  77     }
  78
  79     // Automatically generated Moodle v3.2.0 release upgrade line.
  80     // Put any upgrade step following this.
  81
  82     // Automatically generated Moodle v3.3.0 release upgrade line.
  83     // Put any upgrade step following this.
  84
  85     // Automatically generated Moodle v3.4.0 release upgrade line.
  86     // Put any upgrade step following this.
  87
  88     if ($oldversion < 2017111301) {
  89
  90         // A bug in the LTI plugin incorrectly inserted a grade item for
  91         // LTI instances which were set to not allow grading.
  92         // The change finds any LTI which does not have grading enabled,
  93         // and updates any grades to delete them.
  94
  95         $ltis = $DB->get_recordset_sql("
  96                 SELECT
  97                        l.id,
  98                        l.course,
  99                        l.instructorchoiceacceptgrades,
 100                        t.enabledcapability,
 101                        t.toolproxyid,
 102                        tc.value AS acceptgrades
 103                   FROM {lti} l
 104             INNER JOIN {grade_items} gt
 105                     ON l.id = gt.iteminstance
 106              LEFT JOIN {lti_types} t
 107                     ON t.id = l.typeid
 108              LEFT JOIN {lti_types_config} tc
 109                     ON tc.typeid = t.id AND tc.name = 'acceptgrades'
 110                  WHERE gt.itemmodule = 'lti'
 111                    AND gt.itemtype = 'mod'
 112         ");
 113
 114         foreach ($ltis as $lti) {
 115             $acceptgrades = true;
 116             if (empty($lti->toolproxyid)) {
 117                 $typeacceptgrades = isset($lti->acceptgrades) ? $lti->acceptgrades : 2;
 118                 if (!($typeacceptgrades == 1 ||
 119                         ($typeacceptgrades == 2 && $lti->instructorchoiceacceptgrades == 1))) {
 120                     $acceptgrades = false;
 121                 }
 122             } else {
 123                 $enabledcapabilities = explode("\n", $lti->enabledcapability);
 124                 $acceptgrades = in_array('Result.autocreate', $enabledcapabilities);
 125             }
 126
 127             if (!$acceptgrades) {
 128                 // Required when doing CLI upgrade.
 129                 require_once($CFG->libdir . '/gradelib.php');
 130                 grade_update('mod/lti', $lti->course, 'mod', 'lti', $lti->id, 0, null, array('deleted' => 1));
 131             }
 132
 133         }
 134
 135         $ltis->close();
 136
 137         upgrade_mod_savepoint(true, 2017111301, 'lti');
 138     }
 139
 140     // Automatically generated Moodle v3.5.0 release upgrade line.
 141     // Put any upgrade step following this.
 142
 143     return true;
 144
 145 }