Commit f9c20cfd authored by Aaron Wells's avatar Aaron Wells Committed by Robert Lyon
Browse files

Use $CFG->cacheversion for HTMLPurifier cache version 

Bug 1558387

With this, we don't have to remember to bump HTML.DefinitionRev in
html_clean(), or clear the htmlpurifier directory in dataroot.

behatnotneeded: API change only

Change-Id: I15cd291fd8e5d7d5c357f1595a89f34f44236e7d
parent 176c48c2

htdocs/lib/db/upgrade.php

+0 −6
Original line number Diff line number Diff line
@@ -4212,12 +4212,6 @@ function xmldb_core_upgrade($oldversion=0) { 
        }

    }



    if ($oldversion < 2015092914) {

        log_debug('Clear the HTMLPurifier cache');

        require_once(get_config('docroot') . 'lib/file.php');

        rmdirr(get_config('dataroot') . 'htmlpurifier');

    }



    if ($oldversion < 2015092915) {

        log_debug('Sorting out block_instance sort order drift');

        // There was an issue with the sorting of blocks (Bug #1523719) that existed since

htdocs/lib/web.php

+21 −10
Original line number Diff line number Diff line
@@ -3565,6 +3565,9 @@ function get_htmlpurifier_custom_filters() { 
 * Given raw html (eg typed in by a user), this function cleans it up

 * and removes any nasty tags that could mess up pages.

 *

 * NOTE: The HTMLPurifier config is cached. You'll need to bump $CFG->cacheversion

 * to clear the cache. (The easiest way to do that is to bump htdocs/lib/version.php)

 *

 * @param string $text The text to be cleaned

 * @param boolean $xhtml HTML 4.01 will be used for all of mahara, except very special cases (eg leap2a exports)

 * @return string The cleaned up text
@@ -3572,6 +3575,13 @@ function get_htmlpurifier_custom_filters() { 
function clean_html($text, $xhtml=false) {

    require_once('htmlpurifier/HTMLPurifier.auto.php');

    $config = HTMLPurifier_Config::createDefault();



    // Uncomment this line to disable the cache during debugging

    // $config->set('Cache.DefinitionImpl', null);



    $config->set('HTML.DefinitionID', 'Mahara customisations to default config');

    $config->set('HTML.DefinitionRev', get_config('cacheversion'));



    $config->set('Cache.SerializerPermissions', get_config('directorypermissions'));

    $config->set('Cache.SerializerPath', get_config('dataroot') . 'htmlpurifier');

    if (empty($xhtml)) {
@@ -3605,13 +3615,6 @@ function clean_html($text, $xhtml=false) { 
        $config->set('Filter.Custom', $customfilters);

    }



    // These settings help identify the configuration definition. If the

    // definition (the $def object below) is changed (e.g. new method calls

    // made on it), the DefinitionRev needs to be increased. See

    // http://htmlpurifier.org/live/configdoc/plain.html#HTML.DefinitionID

    $config->set('HTML.DefinitionID', 'Mahara customisations to default config');

    $config->set('HTML.DefinitionRev', 1);



    if ($def = $config->maybeGetRawHTMLDefinition()) {

        $def->addAttribute('a', 'target', 'Enum#_blank,_self,_target,_top');

        # Allow iframes with custom attributes such as fullscreen
@@ -3682,6 +3685,9 @@ function clean_html($text, $xhtml=false) { 
 * Much of the code in this function was taken from the sample code in this post:

 * http://stackoverflow.com/questions/3241616/sanitize-user-defined-css-in-php#5209050

 *

 * NOTE: The HTMLPurifier config is cached. You'll need to bump $CFG->cacheversion

 * to clear the cache. (The easiest way to do that is to bump htdocs/lib/version.php)

 *

 * @param string $input_css

 * @param string $preserve_css, if turns on the CSS comments will be preserved

 * @return string The cleaned CSS
@@ -3692,6 +3698,14 @@ function clean_css($input_css, $preserve_css=false) { 


    // Create a new configuration object

    $config = HTMLPurifier_Config::createDefault();



    // Uncomment this line to disable the cache during debugging

    // $config->set('Cache.DefinitionImpl', null);



    $config->set('HTML.DefinitionID', 'Mahara customisations to default config for CSS');

    $config->set('HTML.DefinitionRev', get_config('cacheversion'));

    $config->set('CSS.DefinitionRev', get_config('cacheversion'));



    $config->set('Cache.SerializerPermissions', get_config('directorypermissions'));

    $config->set('Cache.SerializerPath', get_config('dataroot') . 'htmlpurifier');
@@ -3707,9 +3721,6 @@ function clean_css($input_css, $preserve_css=false) { 
        $config->set('Filter.Custom', $customfilters);

    }



    $config->set('HTML.DefinitionID', 'Mahara customisations to default config for CSS');

    $config->set('HTML.DefinitionRev', 1);



    // Create a new purifier instance

    $purifier = new HTMLPurifier($config);