moodle/admin/tool/httpsreplace/classes/url_finder.php

<?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/>.

/**
 * url_finder class definition.
 *
 * @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();

/**
 * Examines DB for non-https src or data links
 *
 * @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
 */
class url_finder {


    /**
     * Returns a hash of what hosts are referred to over http and would need to be changed.
     *
     * @param progress_bar $progress Progress bar keeping track of this process.
     * @return array Hash of domains with number of references as the value.
     */
    public function http_link_stats($progress = null) {
        return $this->process(false, $progress);
    }

    /**
     * Changes all resources referred to over http to https.
     *
     * @param progress_bar $progress Progress bar keeping track of this process.
     * @return bool True upon success
     */
    public function upgrade_http_links($progress = null) {
        return $this->process(true, $progress);
    }

    /**
     * Replace http domains with https equivalent, with two types of exceptions
     * for less straightforward swaps.
     *
     * @param string $table
     * @param string $column
     * @param string $domain
     * @return void
     */
    private function domain_swap($table, $column, $domain) {
        global $DB;

        $renames = (array)json_decode(get_config('tool_httpsreplace', 'renames'));

        $search = "http://$domain";
        $replace = "https://$domain";
        if (isset($renames[$domain])) {
            $replace = 'https://' . $renames[$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().
     * @param bool $replacing Whether or not to replace the found urls.
     * @param progress_bar $progress Progress bar keeping track of this process.
     * @return bool|array If $replacing, return true on success. If not, return hash of http urls to number of times used.
     */
    private function process($replacing = false, $progress = null) {
        global $DB, $CFG;

        require_once($CFG->libdir.'/filelib.php');

        if ($DB->sql_regex_supported()) {
            $regexp = $DB->sql_regex();
            $httpurls  = "(src|data)\ *=\ *[\\\"\']http://";
        } else {
            // Simpler query for DBs without regex support.
            $regexp = "like";
            $httpurls  = "%=%http://%";
        }

        // TODO: block_instances have HTML content as base64, need to decode then
        // search, currently just skipped. See MDL-60024.
        $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',
            'nvarchar',
            'CLOB',
        );

        $numberoftables = count($tables);
        $tablenumber = 0;
        foreach ($tables as $table) {
            if ($progress) {
                $progress->update($tablenumber, $numberoftables, get_string('searching', 'tool_httpsreplace', $table));
                $tablenumber++;
            }
            if (in_array($table, $skiptables)) {
                continue;
            }
            if ($columns = $DB->get_columns($table)) {
                foreach ($columns as $column) {

                    if (in_array($column->type, $texttypes)) {
                        $columnname = $column->name;
                        $select = "LOWER($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]|/))[\'\"]#i';
                            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();

        foreach ($uniquedomains as $domain) {
            $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;
    }

}