[add] HTML Purifier added to clean code

[github/wallabag/wallabag.git] / inc / 3rdparty / htmlpurifier / HTMLPurifier / ConfigSchema.php

<?php\r
\r
/**\r
 * Configuration definition, defines directives and their defaults.\r
 */\r
class HTMLPurifier_ConfigSchema\r
{\r
    /**\r
     * Defaults of the directives and namespaces.\r
     * @type array\r
     * @note This shares the exact same structure as HTMLPurifier_Config::$conf\r
     */\r
    public $defaults = array();\r
\r
    /**\r
     * The default property list. Do not edit this property list.\r
     * @type array\r
     */\r
    public $defaultPlist;\r
\r
    /**\r
     * Definition of the directives.\r
     * The structure of this is:\r
     *\r
     *  array(\r
     *      'Namespace' => array(\r
     *          'Directive' => new stdclass(),\r
     *      )\r
     *  )\r
     *\r
     * The stdclass may have the following properties:\r
     *\r
     *  - If isAlias isn't set:\r
     *      - type: Integer type of directive, see HTMLPurifier_VarParser for definitions\r
     *      - allow_null: If set, this directive allows null values\r
     *      - aliases: If set, an associative array of value aliases to real values\r
     *      - allowed: If set, a lookup array of allowed (string) values\r
     *  - If isAlias is set:\r
     *      - namespace: Namespace this directive aliases to\r
     *      - name: Directive name this directive aliases to\r
     *\r
     * In certain degenerate cases, stdclass will actually be an integer. In\r
     * that case, the value is equivalent to an stdclass with the type\r
     * property set to the integer. If the integer is negative, type is\r
     * equal to the absolute value of integer, and allow_null is true.\r
     *\r
     * This class is friendly with HTMLPurifier_Config. If you need introspection\r
     * about the schema, you're better of using the ConfigSchema_Interchange,\r
     * which uses more memory but has much richer information.\r
     * @type array\r
     */\r
    public $info = array();\r
\r
    /**\r
     * Application-wide singleton\r
     * @type HTMLPurifier_ConfigSchema\r
     */\r
    protected static $singleton;\r
\r
    public function __construct()\r
    {\r
        $this->defaultPlist = new HTMLPurifier_PropertyList();\r
    }\r
\r
    /**\r
     * Unserializes the default ConfigSchema.\r
     * @return HTMLPurifier_ConfigSchema\r
     */\r
    public static function makeFromSerial()\r
    {\r
        $contents = file_get_contents(HTMLPURIFIER_PREFIX . '/HTMLPurifier/ConfigSchema/schema.ser');\r
        $r = unserialize($contents);\r
        if (!$r) {\r
            $hash = sha1($contents);\r
            trigger_error("Unserialization of configuration schema failed, sha1 of file was $hash", E_USER_ERROR);\r
        }\r
        return $r;\r
    }\r
\r
    /**\r
     * Retrieves an instance of the application-wide configuration definition.\r
     * @param HTMLPurifier_ConfigSchema $prototype\r
     * @return HTMLPurifier_ConfigSchema\r
     */\r
    public static function instance($prototype = null)\r
    {\r
        if ($prototype !== null) {\r
            HTMLPurifier_ConfigSchema::$singleton = $prototype;\r
        } elseif (HTMLPurifier_ConfigSchema::$singleton === null || $prototype === true) {\r
            HTMLPurifier_ConfigSchema::$singleton = HTMLPurifier_ConfigSchema::makeFromSerial();\r
        }\r
        return HTMLPurifier_ConfigSchema::$singleton;\r
    }\r
\r
    /**\r
     * Defines a directive for configuration\r
     * @warning Will fail of directive's namespace is defined.\r
     * @warning This method's signature is slightly different from the legacy\r
     *          define() static method! Beware!\r
     * @param string $key Name of directive\r
     * @param mixed $default Default value of directive\r
     * @param string $type Allowed type of the directive. See\r
     *      HTMLPurifier_DirectiveDef::$type for allowed values\r
     * @param bool $allow_null Whether or not to allow null values\r
     */\r
    public function add($key, $default, $type, $allow_null)\r
    {\r
        $obj = new stdclass();\r
        $obj->type = is_int($type) ? $type : HTMLPurifier_VarParser::$types[$type];\r
        if ($allow_null) {\r
            $obj->allow_null = true;\r
        }\r
        $this->info[$key] = $obj;\r
        $this->defaults[$key] = $default;\r
        $this->defaultPlist->set($key, $default);\r
    }\r
\r
    /**\r
     * Defines a directive value alias.\r
     *\r
     * Directive value aliases are convenient for developers because it lets\r
     * them set a directive to several values and get the same result.\r
     * @param string $key Name of Directive\r
     * @param array $aliases Hash of aliased values to the real alias\r
     */\r
    public function addValueAliases($key, $aliases)\r
    {\r
        if (!isset($this->info[$key]->aliases)) {\r
            $this->info[$key]->aliases = array();\r
        }\r
        foreach ($aliases as $alias => $real) {\r
            $this->info[$key]->aliases[$alias] = $real;\r
        }\r
    }\r
\r
    /**\r
     * Defines a set of allowed values for a directive.\r
     * @warning This is slightly different from the corresponding static\r
     *          method definition.\r
     * @param string $key Name of directive\r
     * @param array $allowed Lookup array of allowed values\r
     */\r
    public function addAllowedValues($key, $allowed)\r
    {\r
        $this->info[$key]->allowed = $allowed;\r
    }\r
\r
    /**\r
     * Defines a directive alias for backwards compatibility\r
     * @param string $key Directive that will be aliased\r
     * @param string $new_key Directive that the alias will be to\r
     */\r
    public function addAlias($key, $new_key)\r
    {\r
        $obj = new stdclass;\r
        $obj->key = $new_key;\r
        $obj->isAlias = true;\r
        $this->info[$key] = $obj;\r
    }\r
\r
    /**\r
     * Replaces any stdclass that only has the type property with type integer.\r
     */\r
    public function postProcess()\r
    {\r
        foreach ($this->info as $key => $v) {\r
            if (count((array) $v) == 1) {\r
                $this->info[$key] = $v->type;\r
            } elseif (count((array) $v) == 2 && isset($v->allow_null)) {\r
                $this->info[$key] = -$v->type;\r
            }\r
        }\r
    }\r
}\r
\r
// vim: et sw=4 sts=4\r