2ea3fa1b8eeb5ed104f69ccdeae486a9f0b4bf4f
[moodle.git] / mod / forum / 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/>.
17 /**
18  * This file keeps track of upgrades to
19  * the forum module
20  *
21  * Sometimes, changes between versions involve
22  * alterations to database structures and other
23  * major things that may break installations.
24  *
25  * The upgrade function in this file will attempt
26  * to perform all the necessary actions to upgrade
27  * your older installation to the current version.
28  *
29  * If there's something it cannot do itself, it
30  * will tell you what you need to do.
31  *
32  * The commands in here will all be database-neutral,
33  * using the methods of database_manager class
34  *
35  * Please do not forget to use upgrade_set_timeout()
36  * before any action that may take longer time to finish.
37  *
38  * @package   mod_forum
39  * @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
43 defined('MOODLE_INTERNAL') || die();
45 function xmldb_forum_upgrade($oldversion) {
46     global $DB;
48     $dbman = $DB->get_manager(); // Loads ddl manager and xmldb classes.
50     // Automatically generated Moodle v3.3.0 release upgrade line.
51     // Put any upgrade step following this.
53     if ($oldversion < 2017092200) {
55         // Remove duplicate entries from forum_subscriptions.
56         // Find records with multiple userid/forum combinations and find the highest ID.
57         // Later we will remove all those entries.
58         $sql = "
59             SELECT MIN(id) as minid, userid, forum
60             FROM {forum_subscriptions}
61             GROUP BY userid, forum
62             HAVING COUNT(id) > 1";
64         if ($duplicatedrows = $DB->get_recordset_sql($sql)) {
65             foreach ($duplicatedrows as $row) {
66                 $DB->delete_records_select('forum_subscriptions',
67                     'userid = :userid AND forum = :forum AND id <> :minid', (array)$row);
68             }
69         }
70         $duplicatedrows->close();
72         // Define key useridforum (primary) to be added to forum_subscriptions.
73         $table = new xmldb_table('forum_subscriptions');
74         $key = new xmldb_key('useridforum', XMLDB_KEY_UNIQUE, array('userid', 'forum'));
76         // Launch add key useridforum.
77         $dbman->add_key($table, $key);
79         // Forum savepoint reached.
80         upgrade_mod_savepoint(true, 2017092200, 'forum');
81     }
83     // Automatically generated Moodle v3.4.0 release upgrade line.
84     // Put any upgrade step following this.
86     if ($oldversion < 2018032900) {
88         // Define field deleted to be added to forum_posts.
89         $table = new xmldb_table('forum_posts');
90         $field = new xmldb_field('deleted', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '0', 'mailnow');
92         // Conditionally launch add field deleted.
93         if (!$dbman->field_exists($table, $field)) {
94             $dbman->add_field($table, $field);
95         }
97         // Forum savepoint reached.
98         upgrade_mod_savepoint(true, 2018032900, 'forum');
99     }
101     // Automatically generated Moodle v3.5.0 release upgrade line.
102     // Put any upgrade step following this.
104     // Automatically generated Moodle v3.6.0 release upgrade line.
105     // Put any upgrade step following this.
107     if ($oldversion < 2019031200) {
108         // Define field privatereplyto to be added to forum_posts.
109         $table = new xmldb_table('forum_posts');
110         $field = new xmldb_field('privatereplyto', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'mailnow');
112         // Conditionally launch add field privatereplyto.
113         if (!$dbman->field_exists($table, $field)) {
114             $dbman->add_field($table, $field);
115         }
117         upgrade_mod_savepoint(true, 2019031200, 'forum');
118     }
120     if ($oldversion < 2019040400) {
122         $table = new xmldb_table('forum');
124         // Define field duedate to be added to forum.
125         $field = new xmldb_field('duedate', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'introformat');
127         // Conditionally launch add field duedate.
128         if (!$dbman->field_exists($table, $field)) {
129             $dbman->add_field($table, $field);
130         }
132         // Define field cutoffdate to be added to forum.
133         $field = new xmldb_field('cutoffdate', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'duedate');
135         // Conditionally launch add field cutoffdate.
136         if (!$dbman->field_exists($table, $field)) {
137             $dbman->add_field($table, $field);
138         }
140         upgrade_mod_savepoint(true, 2019040400, 'forum');
141     }
143     if ($oldversion < 2019040401) {
144         // Define field deleted to be added to forum_posts.
145         $table = new xmldb_table('forum_discussions');
146         $field = new xmldb_field('timelocked', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'pinned');
148         // Conditionally launch add field deleted.
149         if (!$dbman->field_exists($table, $field)) {
150             $dbman->add_field($table, $field);
151         }
153         // Forum savepoint reached.
154         upgrade_mod_savepoint(true, 2019040401, 'forum');
155     }
157     return true;