[Summary view]

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  /**
  18   * Label module upgrade
  19   *
  20   * @package mod_label
  21   * @copyright  2006 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  // This file keeps track of upgrades to
  26  // the label module
  27  //
  28  // Sometimes, changes between versions involve
  29  // alterations to database structures and other
  30  // major things that may break installations.
  31  //
  32  // The upgrade function in this file will attempt
  33  // to perform all the necessary actions to upgrade
  34  // your older installation to the current version.
  35  //
  36  // If there's something it cannot do itself, it
  37  // will tell you what you need to do.
  38  //
  39  // The commands in here will all be database-neutral,
  40  // using the methods of database_manager class
  41  //
  42  // Please do not forget to use upgrade_set_timeout()
  43  // before any action that may take longer time to finish.
  44  
  45  defined('MOODLE_INTERNAL') || die;
  46  
  47  function xmldb_label_upgrade($oldversion) {
  48      global $CFG, $DB;
  49  
  50      // Automatically generated Moodle v3.9.0 release upgrade line.
  51      // Put any upgrade step following this.
  52  
  53      // Automatically generated Moodle v4.0.0 release upgrade line.
  54      // Put any upgrade step following this.
  55  
  56      if ($oldversion < 2022101300) {
  57          $module = $DB->get_field('modules', 'id', ['name' => 'label']);
  58          $DB->execute('
  59              UPDATE {course_modules}
  60                 SET visible = 0, visibleoncoursepage = 1
  61               WHERE module = :module
  62                     AND visible = 1
  63                     AND visibleoncoursepage = 0',
  64              ['module' => $module]
  65          );
  66          upgrade_mod_savepoint(true, 2022101300, 'label');
  67      }
  68  
  69      // Automatically generated Moodle v4.1.0 release upgrade line.
  70      // Put any upgrade step following this.
  71  
  72      if ($oldversion < 2022112801) {
  73          $prevlang = force_current_language($CFG->lang);
  74  
  75          $select = $DB->sql_like('name', ':tofind');
  76          $params = ['tofind' => '%@@PLUGINFILE@@%'];
  77          $total = $DB->count_records_select('label', $select, $params);
  78          if ($total > 0) {
  79              $labels = $DB->get_recordset_select('label', $select, $params, 'id, name, intro');
  80  
  81              // Show a progress bar.
  82              $pbar = new progress_bar('upgrademodlabelpluginfile', 500, true);
  83              $current = 0;
  84  
  85              $defaultname = get_string('modulename', 'label');
  86              foreach ($labels as $label) {
  87                  $originalname = $label->name;
  88                  // Make sure that all labels have now the same name according to the new convention.
  89                  // Note this is the same (and duplicated) code as in get_label_name as we cannot call any API function
  90                  // during upgrade.
  91                  $name = html_to_text(format_string($label->intro, true));
  92                  $name = preg_replace('/@@PLUGINFILE@@\/[[:^space:]]+/i', '', $name);
  93                  // Remove double space and also nbsp; characters.
  94                  $name = preg_replace('/\s+/u', ' ', $name);
  95                  $name = trim($name);
  96                  if (core_text::strlen($name) > LABEL_MAX_NAME_LENGTH) {
  97                      $name = core_text::substr($name, 0, LABEL_MAX_NAME_LENGTH) . "...";
  98                  }
  99                  if (empty($name)) {
 100                      $name = $defaultname;
 101                  }
 102                  $label->name = $name;
 103                  if ($originalname !== $name) {
 104                      $DB->update_record('label', $label);
 105                  }
 106                  $current++;
 107                  $pbar->update($current, $total, "Upgrading label activity names - $current/$total.");
 108              }
 109              $labels->close();
 110          }
 111          force_current_language($prevlang);
 112          upgrade_mod_savepoint(true, 2022112801, 'label');
 113      }
 114  
 115      return true;
 116  }