MDL-46269 tool_httpsreplace: Add tool_httpsreplace to core

This commit is contained in:
John Okely
2017-08-25 09:38:36 +08:00
committed by Marina Glancy
parent 9a316f3367
commit eca2b34cb0
10 changed files with 672 additions and 0 deletions
+47
View File
@@ -0,0 +1,47 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Site wide http -> https search-replace form.
*
* @package tool_httpsreplace
* @copyright Copyright (c) 2016 Blackboard Inc. (http://www.blackboard.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace tool_httpsreplace;
defined('MOODLE_INTERNAL') || die();
require_once("$CFG->libdir/formslib.php");
/**
* Site wide http -> https search-replace form.
*/
class form extends \moodleform {
public function definition() {
$mform = $this->_form;
$mform->addElement('header', 'confirmhdr', get_string('confirm'));
$mform->setExpanded('confirmhdr', true);
$mform->addElement('checkbox', 'sure', get_string('disclaimer', 'tool_httpsreplace'));
$mform->addRule('sure', get_string('required'), 'required', null, 'client');
$this->add_action_buttons(false, get_string('doit', 'tool_httpsreplace'));
}
}
@@ -0,0 +1,227 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace tool_httpsreplace;
defined('MOODLE_INTERNAL') || die();
/**
* Examines DB for non-https src or data links that will cause trouble
* when embedded in HTTPS sites.
*
* @package tool_httpsreplace
* @copyright Copyright (c) 2016 Blackboard Inc. (http://www.blackboard.com)
*/
class url_finder {
/**
* Domains that need replaced when using https links.
*
* @var array
* @access private
*/
private $exceptions = [
'cdnapi.kaltura.com' => 'cdnapisec.kaltura.com',
];
public function http_link_stats() {
return $this->process(false);
}
public function upgrade_http_links() {
return $this->process(true);
}
/**
* Replace http domains with https equivalent, with two types of exceptions
* for less straightforward swaps.
*
* @param string $table
* @param string $column
* @param string $domain
* @access private
* @return void
*/
private function domain_swap($table, $column, $domain) {
global $DB;
$search = "http://$domain";
$replace = "https://$domain";
if (isset($this->exceptions[$domain])) {
$replace = 'https://' . $this->exceptions[$domain];
}
if (preg_match('/rackcdn.com$/', $domain)) {
// Regexes adapted from
// https://www.eff.org/https-everywhere/atlas/domains/rackcdn.com.html ruleset.
$pattern = '/^([\w-]+)\.(?:r\d+|ssl)\.cf(\d)\.rackcdn\.com$/';
$replacement = 'https://$1.ssl.cf$2.rackcdn.com';
$replace = preg_replace($pattern, $replacement, $domain);
}
$DB->set_debug(true);
// Note, this search is case sensitive.
$DB->replace_all_text($table, $column, $search, $replace);
$DB->set_debug(false);
}
/**
* Originally forked from core function db_search().
*/
private function process($replacing = false) {
global $DB, $CFG;
require_once($CFG->libdir.'/filelib.php');
$httpurls = "(src|data)\ *=\ *[\\\"\']http://";
// TODO: block_instances have HTML content as base64, need to decode then
// search, currently just skipped.
$skiptables = array(
'block_instances',
'config',
'config_log',
'config_plugins',
'events_queue',
'files',
'filter_config',
'grade_grades_history',
'grade_items_history',
'log',
'logstore_standard_log',
'repository_instance_config',
'sessions',
'upgrade_log',
'grade_categories_history',
'',
);
// Turn off time limits.
\core_php_time_limit::raise();
if (!$tables = $DB->get_tables() ) { // No tables yet at all.
return false;
}
$urls = array();
$texttypes = array (
'text',
'mediumtext',
'longtext',
'varchar',
);
foreach ($tables as $table) {
if (in_array($table, $skiptables)) {
continue;
}
if ($columns = $DB->get_columns($table)) {
$regexp = $DB->sql_regex();
foreach ($columns as $column) {
if (in_array($column->type, $texttypes)) {
$columnname = $column->name;
$select = "$columnname $regexp ?";
$rs = $DB->get_recordset_select($table, $select, [$httpurls]);
$found = array();
foreach ($rs as $record) {
// Regex to match src=http://etc. and data=http://etc.urls.
// Standard warning on expecting regex to perfectly parse HTML
// read http://stackoverflow.com/a/1732454 for more info.
$regex = '#(src|data)\ *=\ *[\'\"]http://[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|/))[\'\"]#';
preg_match_all($regex, $record->$columnname, $match);
foreach ($match[0] as $url) {
if (strpos($url, $CFG->wwwroot) !== false) {
continue;
}
if ($replacing) {
$url = substr($url, strpos($url, 'http'), -1);
$host = parse_url($url, PHP_URL_HOST);
$found[] = $host;
} else {
$entry["table"] = $table;
$entry["columnname"] = $columnname;
$entry["url"] = str_replace(array("'", '"'), "", substr($url, ((int) strpos($url, "=") + 1) ));
$entry["host"] = parse_url($entry["url"], PHP_URL_HOST);
$entry["raw"] = $record->$columnname;
$entry["ssl"] = '';
$urls[] = $entry;
}
}
}
$rs->close();
if ($replacing) {
$found = array_unique($found);
foreach ($found as $domain) {
$this->domain_swap($table, $column, $domain);
}
}
}
}
}
}
if ($replacing) {
rebuild_course_cache(0, true);
purge_all_caches();
return true;
}
$domains = array_map(function ($i) {
return $i['host'];
}, $urls);
$uniquedomains = array_unique($domains);
$sslfailures = array();
$knownsupported = array(
'amazon.com',
'www.amazon.com',
'dropbox.com',
'www.dropbox.com',
'cdnapi.kaltura.com',
'fe8be92ac963979368eca.r38.cf1.rackcdn.com', // Not actually a real domain, but used for testing.
);
foreach ($uniquedomains as $domain) {
if (in_array($domain, $knownsupported)) {
continue;
}
$url = "https://$domain/";
$curl = new \curl();
$curl->head($url);
$info = $curl->get_info();
if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
$sslfailures[] = $domain;
}
}
$results = array();
foreach ($urls as $url) {
$host = $url['host'];
foreach ($sslfailures as $badhost) {
if ($host == $badhost) {
if (!isset($results[$host])) {
$results[$host] = 1;
} else {
$results[$host]++;
}
}
}
}
return $results;
}
}