ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / letacommog / letaweb / admin / classes / htmlpurifier / library / HTMLPurifier

<?php

/**
 * Parses string hash files. File format is as such:.
 *
 *      DefaultKeyValue
 *      KEY: Value
 *      KEY2: Value2
 *      --MULTILINE-KEY--
 *      Multiline
 *      value.
 *
 * Which would output something similar to:
 *
 *      array(
 *          'ID' => 'DefaultKeyValue',
 *          'KEY' => 'Value',
 *          'KEY2' => 'Value2',
 *          'MULTILINE-KEY' => "Multiline\nvalue.\n",
 *      )
 *
 * We use this as an easy to use file-format for configuration schema
 * files, but the class itself is usage agnostic.
 *
 * You can use ---- to forcibly terminate parsing of a single string-hash;
 * this marker is used in multi string-hashes to delimit boundaries.
 */
class HTMLPurifier_StringHashParser
{
    public $default = 'ID';

/**
     * Parses a file that contains a single string-hash.
     */
    public function parseFile($file)
    {
        if (!file_exists($file)) {
            return false;
        }
        $fh = fopen($file, 'r');
        if (!$fh) {
            return false;
        }
        $ret = $this->parseHandle($fh);
        fclose($fh);

return $ret;
    }

/**
     * Parses a file that contains multiple string-hashes delimited by '----'.
     */
    public function parseMultiFile($file)
    {
        if (!file_exists($file)) {
            return false;
        }
        $ret = array();
        $fh = fopen($file, 'r');
        if (!$fh) {
            return false;
        }
        while (!feof($fh)) {
            $ret[] = $this->parseHandle($fh);
        }
        fclose($fh);

return $ret;
    }

/**
     * Internal parser that acepts a file handle.
     *
     * @note While it's possible to simulate in-memory parsing by using
     *       custom stream wrappers, if such a use-case arises we should
     *       factor out the file handle into its own class.
     *
     * @param $fh File handle with pointer at start of valid string-hash
     *            block.
     */
    protected function parseHandle($fh)
    {
        $state = false;
        $single = false;
        $ret = array();
        do {
            $line = fgets($fh);
            if ($line === false) {
                break;
            }
            $line = rtrim($line, "\n\r");
            if (!$state && $line === '') {
                continue;
            }
            if ($line === '----') {
                break;
            }
            if (strncmp('--#', $line, 3) === 0) {
                // Comment
                continue;
            } elseif (strncmp('--', $line, 2) === 0) {
                // Multiline declaration
                $state = trim($line, '- ');
                if (!isset($ret[$state])) {
                    $ret[$state] = '';
                }
                continue;
            } elseif (!$state) {
                $single = true;
                if (strpos($line, ':') !== false) {
                    // Single-line declaration
                    list($state, $line) = explode(':', $line, 2);
                    $line = trim($line);
                } else {
                    // Use default declaration
                    $state = $this->default;
                }
            }
            if ($single) {
                $ret[$state] = $line;
                $single = false;
                $state = false;
            } else {
                $ret[$state] .= "$line\n";
            }
        } while (!feof($fh));

return $ret;
    }
}

// vim: et sw=4 sts=4

[+] ..
[+] ConfigSchema
[-] CSSDefinition.php [edit]
[-] Generator.php [edit]
[-] ElementDef.php [edit]
[-] AttrTypes.php [edit]
[+] ChildDef
[+] AttrDef
[-] ChildDef.php [edit]
[+] Printer
[-] Exception.php [edit]
[-] PercentEncoder.php [edit]
[+] Lexer
[-] IDAccumulator.php [edit]
[-] Token.php [edit]
[+] TagTransform
[-] AttrTransform.php [edit]
[-] Language.php [edit]
[-] Filter.php [edit]
[-] Printer.php [edit]
[-] DefinitionCache.php [edit]
[-] Injector.php [edit]
[-] TokenFactory.php [edit]
[-] URISchemeRegistry.php [edit]
[-] Length.php [edit]
[-] URIParser.php [edit]
[-] AttrCollections.php [edit]
[-] Lexer.php [edit]
[-] HTMLDefinition.php [edit]
[-] Context.php [edit]
[-] DefinitionCacheFactory.php [edit]
[-] Doctype.php [edit]
[+] Strategy
[-] LanguageFactory.php [edit]
[+] Token
[-] TagTransform.php [edit]
[-] AttrValidator.php [edit]
[+] Filter
[-] ErrorCollector.php [edit]
[-] DoctypeRegistry.php [edit]
[-] UnitConverter.php [edit]
[-] EntityParser.php [edit]
[-] URIScheme.php [edit]
[-] Bootstrap.php [edit]
[-] StringHashParser.php [edit]
[+] VarParser
[-] VarParserException.php [edit]
[-] EntityLookup.php [edit]
[-] ErrorStruct.php [edit]
[-] HTMLModule.php [edit]
[-] Definition.php [edit]
[-] PropertyList.php [edit]
[+] URIFilter
[-] Strategy.php [edit]
[-] AttrDef.php [edit]
[+] HTMLModule
[+] URIScheme
[-] Config.php [edit]
[-] HTMLModuleManager.php [edit]
[-] Encoder.php [edit]
[+] AttrTransform
[-] URI.php [edit]
[-] ContentSets.php [edit]
[-] ConfigSchema.php [edit]
[+] EntityLookup
[-] VarParser.php [edit]
[+] Language
[-] PropertyListIterator.php [edit]
[+] DefinitionCache
[-] StringHash.php [edit]
[+] Injector
[-] URIDefinition.php [edit]
[-] URIFilter.php [edit]