mod/assign/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 /**
  18  * Upgrade code for install
  19  *
  20  * @package   mod_assign
  21  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 /**
  26  * upgrade this assignment instance - this function could be skipped but it will be needed later
  27  * @param int $oldversion The old version of the assign module
  28  * @return bool
  29  */
  30 function xmldb_assign_upgrade($oldversion) {
  31     global $DB;
  32
  33     // Automatically generated Moodle v4.1.0 release upgrade line.
  34     // Put any upgrade step following this.
  35
  36     // Automatically generated Moodle v4.2.0 release upgrade line.
  37     // Put any upgrade step following this.
  38
  39     // Automatically generated Moodle v4.3.0 release upgrade line.
  40     // Put any upgrade step following this.
  41
  42     $dbman = $DB->get_manager(); // Loads ddl manager and xmldb classes.
  43
  44     if ($oldversion < 2023103000) {
  45         // Define field activity to be added to assign.
  46         $table = new xmldb_table('assign');
  47         $field = new xmldb_field(
  48             'markinganonymous',
  49             XMLDB_TYPE_INTEGER,
  50             '2',
  51             null,
  52             XMLDB_NOTNULL,
  53             null,
  54             '0',
  55             'markingallocation'
  56         );
  57         // Conditionally launch add field activity.
  58         if (!$dbman->field_exists($table, $field)) {
  59             $dbman->add_field($table, $field);
  60         }
  61
  62         // Assign savepoint reached.
  63         upgrade_mod_savepoint(true, 2023103000, 'assign');
  64     }
  65
  66     // Automatically generated Moodle v4.4.0 release upgrade line.
  67     // Put any upgrade step following this.
  68
  69     if ($oldversion < 2024042201) {
  70         // The 'Never' ('none') option for the additional attempts (attemptreopenmethod) setting is no longer supported
  71         // and needs to be updated in all relevant instances.
  72
  73         // The default value for the 'attemptreopenmethod' field in the 'assign' database table is currently set to 'none',
  74         // This needs to be updated to 'untilpass' to ensure the system functions correctly. Additionally, the default
  75         // value for the 'maxattempts' field needs to be changed to '1' to prevent multiple attempts and maintain the
  76         // original behavior.
  77         $table = new xmldb_table('assign');
  78         $attemptreopenmethodfield = new xmldb_field('attemptreopenmethod', XMLDB_TYPE_CHAR, '10', null, XMLDB_NOTNULL,
  79             null, 'untilpass');
  80         $maxattemptsfield = new xmldb_field('maxattempts', XMLDB_TYPE_INTEGER, '6', null, XMLDB_NOTNULL,
  81             null, '1');
  82         $dbman->change_field_default($table, $attemptreopenmethodfield);
  83         $dbman->change_field_default($table, $maxattemptsfield);
  84
  85         // If the current value for the 'attemptreopenmethod' global configuration in the assignment is set to 'none'.
  86         if (get_config('assign', 'attemptreopenmethod') == 'none') {
  87             // Reset the value to 'untilpass'.
  88             set_config('attemptreopenmethod', 'untilpass', 'assign');
  89             // Also, setting the value for the 'maxattempts' global config in the assignment to '1' ensures that the
  90             // original behaviour is preserved by disallowing any additional attempts by default.
  91             set_config('maxattempts', 1, 'assign');
  92         }
  93
  94         // Update all the current assignment instances that have their 'attemptreopenmethod' set to 'none'.
  95         // By setting 'maxattempts' to 1, additional attempts are disallowed, preserving the original behavior.
  96         $DB->execute(
  97             'UPDATE {assign}
  98                     SET attemptreopenmethod = :newattemptreopenmethod,
  99                         maxattempts = :maxattempts
 100                   WHERE attemptreopenmethod = :oldattemptreopenmethod',
 101             [
 102                 'newattemptreopenmethod' => 'untilpass',
 103                 'maxattempts' => 1,
 104                 'oldattemptreopenmethod' => 'none',
 105             ]
 106         );
 107
 108         // Assign savepoint reached.
 109         upgrade_mod_savepoint(true, 2024042201, 'assign');
 110     }
 111
 112     return true;
 113 }