MDL-53572 mathjax: always load mathjax using https
[moodle.git] / filter / mathjaxloader / 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  * MathJAX filter upgrade code.
19  *
20  * @package    filter_mathjaxloader
21  * @copyright  2014 Damyon Wiese (damyon@moodle.com)
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * @param int $oldversion the version we are upgrading from
29  * @return bool result
30  */
31 function xmldb_filter_mathjaxloader_upgrade($oldversion) {
32     global $CFG, $DB;
34     $dbman = $DB->get_manager();
36     if ($oldversion < 2014081100) {
38         $sslcdnurl = get_config('filter_mathjaxloader', 'httpsurl');
39         if ($sslcdnurl === "https://c328740.ssl.cf1.rackcdn.com/mathjax/2.3-latest/MathJax.js") {
40             set_config('httpsurl', 'https://cdn.mathjax.org/mathjax/2.3-latest/MathJax.js', 'filter_mathjaxloader');
41         }
43         upgrade_plugin_savepoint(true, 2014081100, 'filter', 'mathjaxloader');
44     }
46     // Moodle v2.8.0 release upgrade line.
47     // Put any upgrade step following this.
49     if ($oldversion < 2015021200) {
51         $httpurl = get_config('filter_mathjaxloader', 'httpurl');
52         // Don't change the config if it has been manually changed to something besides the default setting value.
53         if ($httpurl === "http://cdn.mathjax.org/mathjax/2.3-latest/MathJax.js") {
54             set_config('httpurl', 'http://cdn.mathjax.org/mathjax/2.5-latest/MathJax.js', 'filter_mathjaxloader');
55         }
57         $httpsurl = get_config('filter_mathjaxloader', 'httpsurl');
58         // Don't change the config if it has been manually changed to something besides the default setting value.
59         if ($httpsurl === "https://cdn.mathjax.org/mathjax/2.3-latest/MathJax.js") {
60             set_config('httpsurl', 'https://cdn.mathjax.org/mathjax/2.5-latest/MathJax.js', 'filter_mathjaxloader');
61         }
63         upgrade_plugin_savepoint(true, 2015021200, 'filter', 'mathjaxloader');
64     }
66     if ($oldversion < 2015021700) {
68         $oldconfig = get_config('filter_mathjaxloader', 'mathjaxconfig');
69         $olddefault = 'MathJax.Hub.Config({
70     config: ["MMLorHTML.js", "Safe.js"],
71     jax: ["input/TeX","input/MathML","output/HTML-CSS","output/NativeMML"],
72     extensions: ["tex2jax.js","mml2jax.js","MathMenu.js","MathZoom.js"],
73     TeX: {
74         extensions: ["AMSmath.js","AMSsymbols.js","noErrors.js","noUndefined.js"]
75     },
76     menuSettings: {
77         zoom: "Double-Click",
78         mpContext: true,
79         mpMouse: true
80     },
81     errorSettings: { message: ["!"] },
82     skipStartupTypeset: true,
83     messageStyle: "none"
84 });
85 ';
86         $newdefault = '
87 MathJax.Hub.Config({
88     config: ["Accessible.js", "Safe.js"],
89     errorSettings: { message: ["!"] },
90     skipStartupTypeset: true,
91     messageStyle: "none"
92 });
93 ';
95         // Ignore white space changes.
96         $oldconfig = trim(preg_replace('/\s+/', ' ', $oldconfig));
97         $olddefault = trim(preg_replace('/\s+/', ' ', $olddefault));
99         // Update the default config for mathjax only if it has not been customised.
101         if ($oldconfig == $olddefault) {
102             set_config('mathjaxconfig', $newdefault, 'filter_mathjaxloader');
103         }
105         upgrade_plugin_savepoint(true, 2015021700, 'filter', 'mathjaxloader');
106     }
108     // Moodle v2.9.0 release upgrade line.
109     // Put any upgrade step following this.
111     // Moodle v3.0.0 release upgrade line.
112     // Put any upgrade step following this.
114     if ($oldversion < 2016032200) {
116         $httpurl = get_config('filter_mathjaxloader', 'httpurl');
117         // Don't change the config if it has been manually changed to something besides the default setting value.
118         if ($httpurl === "http://cdn.mathjax.org/mathjax/2.5-latest/MathJax.js") {
119             set_config('httpurl', 'http://cdn.mathjax.org/mathjax/2.6-latest/MathJax.js', 'filter_mathjaxloader');
120         }
122         $httpsurl = get_config('filter_mathjaxloader', 'httpsurl');
123         // Don't change the config if it has been manually changed to something besides the default setting value.
124         if ($httpsurl === "https://cdn.mathjax.org/mathjax/2.5-latest/MathJax.js") {
125             set_config('httpsurl', 'https://cdn.mathjax.org/mathjax/2.6-latest/MathJax.js', 'filter_mathjaxloader');
126         }
128         upgrade_plugin_savepoint(true, 2016032200, 'filter', 'mathjaxloader');
129     }
131     // Moodle v3.1.0 release upgrade line.
132     // Put any upgrade step following this.
134     if ($oldversion < 2016080200) {
135         // We are consolodating the two settings for http and https url into only the https
136         // setting. Since it is preferably to always load the secure resource.
138         $httpurl = get_config('filter_mathjaxloader', 'httpurl');
139         if ($httpurl !== 'http://cdn.mathjax.org/mathjax/2.6-latest/MathJax.js') {
140             // If the http setting has been changed, we make the admin choose the https setting because
141             // it indicates some sort of custom setup. This will be supported by the release notes.
142             unset_config('httpsurl', 'filter_mathjaxloader');
143         }
145         // The seperate http setting has been removed. We always use the secure resource.
146         unset_config('httpurl', 'filter_mathjaxloader');
148         upgrade_plugin_savepoint(true, 2016080200, 'filter', 'mathjaxloader');
149     }
151     return true;