generate-includes.php File Reference

Generates an include stub for users who do not want to use the autoloader. More...

Go to the source code of this file.

Functions
	get_dependency_lookup ($file)
	Returns a lookup array of dependencies for a file. More...
	dep_sort ($files)
	Sorts files based on dependencies. More...

Variables
	$FS = new FSTools()
	$exclude_dirs
	$exclude_files
	$raw_files = $FS->globr('.', '*.php')
	$files = array()
	foreach ( $raw_files as $file)
	$version = trim(file_get_contents('../VERSION'))
	$php

Detailed Description

Generates an include stub for users who do not want to use the autoloader.

When new files are added to HTML Purifier's main codebase, this file should be called.

Definition in file generate-includes.php.

Function Documentation

dep_sort()

dep_sort

(

$files

)

Sorts files based on dependencies.

This function is lazy and will not group files with dependencies together; it will merely ensure that a file is never included before its dependencies are.

Parameters

$files

Files array to sort.

Returns

Sorted array ($files is not modified by reference!)

Definition at line 112 of file generate-includes.php.

References $file, $files, $ret, array, and get_dependency_lookup().

{
    $ret = array();
    $cache = array();
    foreach ($files as $file) {
        if (isset($cache[$file])) continue;
        $deps = get_dependency_lookup($file);
        foreach (array_keys($deps) as $dep) {
            if (!isset($cache[$dep])) {
                $ret[] = $dep;
                $cache[$dep] = true;
            }
        }
        $cache[$file] = true;
        $ret[] = $file;
    }
    return $ret;
}

$files = dep_sort($files);

// Build the actual include stub:

$version = trim(file_get_contents('../VERSION'));

// stub
$php = "<?php

";

foreach ($files as $file) {
    $php .= "require '$file';" . PHP_EOL;
}

echo "Writing HTMLPurifier.includes.php... ";
file_put_contents('HTMLPurifier.includes.php', $php);
echo "done!\n";

$php = "<?php

\$__dir = dirname(__FILE__);

";

foreach ($files as $file) {
    $php .= "require_once \$__dir . '/$file';" . PHP_EOL;
}

Here is the call graph for this function:

get_dependency_lookup()

get_dependency_lookup

(

$file

)

Returns a lookup array of dependencies for a file.

Note

This function expects that format $name extends $parent on one line

Parameters

string

$file

File to check dependencies of.

Returns

array Lookup array of files the file is dependent on, sorted accordingly.

Definition at line 69 of file generate-includes.php.

References $fh, $file, array, and HTMLPurifier_Bootstrap\getPath().

Referenced by dep_sort().

{
    static $cache = array();
    if (isset($cache[$file])) return $cache[$file];
    if (!file_exists($file)) {
        echo "File doesn't exist: $file\n";
        return array();
    }
    $fh = fopen($file, 'r');
    $deps = array();
    while (!feof($fh)) {
        $line = fgets($fh);
        if (strncmp('class', $line, 5) === 0) {
            // The implementation here is fragile and will break if we attempt
            // to use interfaces. Beware!
            $arr = explode(' extends ', trim($line, ' {'."\n\r"), 2);
            if (count($arr) < 2) break;
            $parent = $arr[1];
            $dep_file = HTMLPurifier_Bootstrap::getPath($parent);
            if (!$dep_file) break;
            $deps[$dep_file] = true;
            break;
        }
    }
    fclose($fh);
    foreach (array_keys($deps) as $file) {
        // Extra dependencies must come *before* base dependencies
        $deps = get_dependency_lookup($file) + $deps;
    }
    $cache[$file] = $deps;
    return $deps;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

$exclude_dirs

$exclude_dirs

Initial value:

= array(
    'HTMLPurifier/Language/',
    'HTMLPurifier/ConfigSchema/',
    'HTMLPurifier/Filter/',
    'HTMLPurifier/Printer/',
    
)

Definition at line 20 of file generate-includes.php.

$exclude_files

$exclude_files

Initial value:

= array(
    'HTMLPurifier/Lexer/PEARSax3.php',
    'HTMLPurifier/Lexer/PH5P.php',
    'HTMLPurifier/Printer.php',
)

Definition at line 29 of file generate-includes.php.

$files

$files = array()

Definition at line 39 of file generate-includes.php.

Referenced by dep_sort().

$FS

$FS = new FSTools()

Definition at line 18 of file generate-includes.php.

$php

$php

Initial value:

= "<?php

"

Definition at line 138 of file generate-includes.php.

$raw_files

$raw_files = $FS->globr('.', '*.php')

Definition at line 37 of file generate-includes.php.

$version

$version = trim(file_get_contents('../VERSION'))

Definition at line 135 of file generate-includes.php.

Referenced by GuzzleHttp\Psr7\Request\__construct(), ilFileVersionTableGUI\__construct(), GuzzleHttp\Psr7\ServerRequest\__construct(), getID3_cached_mysqli\__construct(), getID3_cached_mysql\__construct(), GuzzleHttp\Psr7\Response\__construct(), ilvCard\__construct(), getID3_cached_sqlite3\__construct(), PHPExcel_Reader_Excel5\_readBof(), PHPExcel_Reader_Excel5\_readColor(), PHPExcel_Writer_Excel5_BIFFwriter\_storeBof(), ilLTIToolProvider\authenticate(), IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), sspmod_oauth_OAuthStore\authorize(), ilSetup\checkPHPVersion(), Monolog\Handler\HipChatHandlerTest\createHandler(), getid3_dts\dialogNormalization(), TCPDF_STATIC\get_mqr(), OAuthServer\get_version(), ilDataSet\getJsonRepresentation(), getid3_lyrics3\getLyrics3Data(), ilObjRemoteFileListGUI\getProperties(), ilObjFileListGUI\getProperties(), ilMDLifecycle\getVersion(), ilPlugin\getVersion(), TCPDF\ImageEps(), ilLDAPSettingsGUI\initForm(), ilUtil\isConvertVersionAtLeast(), ilDBMySQL\isMysql4_0OrHigher(), ilDBMySQL\isMysql4_1(), ilDBMySQL\isMysql4_1OrHigher(), ilDBMySQL\isMysql5_6OrHigher(), HTMLPurifier_DefinitionCache\isOld(), MDB2_Driver_Common\loadModule(), getid3_mp3\MPEGaudioFrameLength(), sspmod_oauth_OAuthStore\new_request_token(), GuzzleHttp\Psr7\parse_request(), ilPluginAdmin\parsePluginPhp(), ilUtil\processConvertVersion(), ilDBUpdate\readCustomUpdatesFileVersion(), ilDBUpdate\readFileVersion(), ilDBUpdate\readHotfixFileVersion(), ilLTIToolProvider\result(), IMSGlobal\LTI\ToolProvider\ToolProvider\result(), assFileUpload\savePreviewData(), SAML2\SOAPClient\send(), TCPDF_STATIC\set_mqr(), ilDBMySQL\setMaxAllowedPacket(), TCPDF\setPDFVersion(), ilTextAreaInputGUI\setRTESupport(), SimpleSAML\Store\SQL\setTableVersion(), ilTextAreaInputGUI\setUseRte(), ilvCard\setVersion(), ilWorkflowEngineDefinitionsGUI\showUploadForm(), IMSGlobal\LTI\ToolProvider\ToolConsumer\signParameters(), GuzzleHttp\Psr7\withProtocolVersion(), Slim\Http\Message\withProtocolVersion(), and getid3_mp3\XingVBRidOffset().

foreach

foreach($files as $file)

Definition at line 40 of file generate-includes.php.