remove autoload section in composer.json

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

<?php\r
\r
class HTMLPurifier_HTMLModuleManager\r
{\r
\r
    /**\r
     * @type HTMLPurifier_DoctypeRegistry\r
     */\r
    public $doctypes;\r
\r
    /**\r
     * Instance of current doctype.\r
     * @type string\r
     */\r
    public $doctype;\r
\r
    /**\r
     * @type HTMLPurifier_AttrTypes\r
     */\r
    public $attrTypes;\r
\r
    /**\r
     * Active instances of modules for the specified doctype are\r
     * indexed, by name, in this array.\r
     * @type HTMLPurifier_HTMLModule[]\r
     */\r
    public $modules = array();\r
\r
    /**\r
     * Array of recognized HTMLPurifier_HTMLModule instances,\r
     * indexed by module's class name. This array is usually lazy loaded, but a\r
     * user can overload a module by pre-emptively registering it.\r
     * @type HTMLPurifier_HTMLModule[]\r
     */\r
    public $registeredModules = array();\r
\r
    /**\r
     * List of extra modules that were added by the user\r
     * using addModule(). These get unconditionally merged into the current doctype, whatever\r
     * it may be.\r
     * @type HTMLPurifier_HTMLModule[]\r
     */\r
    public $userModules = array();\r
\r
    /**\r
     * Associative array of element name to list of modules that have\r
     * definitions for the element; this array is dynamically filled.\r
     * @type array\r
     */\r
    public $elementLookup = array();\r
\r
    /**\r
     * List of prefixes we should use for registering small names.\r
     * @type array\r
     */\r
    public $prefixes = array('HTMLPurifier_HTMLModule_');\r
\r
    /**\r
     * @type HTMLPurifier_ContentSets\r
     */\r
    public $contentSets;\r
\r
    /**\r
     * @type HTMLPurifier_AttrCollections\r
     */\r
    public $attrCollections;\r
\r
    /**\r
     * If set to true, unsafe elements and attributes will be allowed.\r
     * @type bool\r
     */\r
    public $trusted = false;\r
\r
    public function __construct()\r
    {\r
        // editable internal objects\r
        $this->attrTypes = new HTMLPurifier_AttrTypes();\r
        $this->doctypes  = new HTMLPurifier_DoctypeRegistry();\r
\r
        // setup basic modules\r
        $common = array(\r
            'CommonAttributes', 'Text', 'Hypertext', 'List',\r
            'Presentation', 'Edit', 'Bdo', 'Tables', 'Image',\r
            'StyleAttribute',\r
            // Unsafe:\r
            'Scripting', 'Object', 'Forms',\r
            // Sorta legacy, but present in strict:\r
            'Name',\r
        );\r
        $transitional = array('Legacy', 'Target', 'Iframe');\r
        $xml = array('XMLCommonAttributes');\r
        $non_xml = array('NonXMLCommonAttributes');\r
\r
        // setup basic doctypes\r
        $this->doctypes->register(\r
            'HTML 4.01 Transitional',\r
            false,\r
            array_merge($common, $transitional, $non_xml),\r
            array('Tidy_Transitional', 'Tidy_Proprietary'),\r
            array(),\r
            '-//W3C//DTD HTML 4.01 Transitional//EN',\r
            'http://www.w3.org/TR/html4/loose.dtd'\r
        );\r
\r
        $this->doctypes->register(\r
            'HTML 4.01 Strict',\r
            false,\r
            array_merge($common, $non_xml),\r
            array('Tidy_Strict', 'Tidy_Proprietary', 'Tidy_Name'),\r
            array(),\r
            '-//W3C//DTD HTML 4.01//EN',\r
            'http://www.w3.org/TR/html4/strict.dtd'\r
        );\r
\r
        $this->doctypes->register(\r
            'XHTML 1.0 Transitional',\r
            true,\r
            array_merge($common, $transitional, $xml, $non_xml),\r
            array('Tidy_Transitional', 'Tidy_XHTML', 'Tidy_Proprietary', 'Tidy_Name'),\r
            array(),\r
            '-//W3C//DTD XHTML 1.0 Transitional//EN',\r
            'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'\r
        );\r
\r
        $this->doctypes->register(\r
            'XHTML 1.0 Strict',\r
            true,\r
            array_merge($common, $xml, $non_xml),\r
            array('Tidy_Strict', 'Tidy_XHTML', 'Tidy_Strict', 'Tidy_Proprietary', 'Tidy_Name'),\r
            array(),\r
            '-//W3C//DTD XHTML 1.0 Strict//EN',\r
            'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'\r
        );\r
\r
        $this->doctypes->register(\r
            'XHTML 1.1',\r
            true,\r
            // Iframe is a real XHTML 1.1 module, despite being\r
            // "transitional"!\r
            array_merge($common, $xml, array('Ruby', 'Iframe')),\r
            array('Tidy_Strict', 'Tidy_XHTML', 'Tidy_Proprietary', 'Tidy_Strict', 'Tidy_Name'), // Tidy_XHTML1_1\r
            array(),\r
            '-//W3C//DTD XHTML 1.1//EN',\r
            'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd'\r
        );\r
\r
    }\r
\r
    /**\r
     * Registers a module to the recognized module list, useful for\r
     * overloading pre-existing modules.\r
     * @param $module Mixed: string module name, with or without\r
     *                HTMLPurifier_HTMLModule prefix, or instance of\r
     *                subclass of HTMLPurifier_HTMLModule.\r
     * @param $overload Boolean whether or not to overload previous modules.\r
     *                  If this is not set, and you do overload a module,\r
     *                  HTML Purifier will complain with a warning.\r
     * @note This function will not call autoload, you must instantiate\r
     *       (and thus invoke) autoload outside the method.\r
     * @note If a string is passed as a module name, different variants\r
     *       will be tested in this order:\r
     *          - Check for HTMLPurifier_HTMLModule_$name\r
     *          - Check all prefixes with $name in order they were added\r
     *          - Check for literal object name\r
     *          - Throw fatal error\r
     *       If your object name collides with an internal class, specify\r
     *       your module manually. All modules must have been included\r
     *       externally: registerModule will not perform inclusions for you!\r
     */\r
    public function registerModule($module, $overload = false)\r
    {\r
        if (is_string($module)) {\r
            // attempt to load the module\r
            $original_module = $module;\r
            $ok = false;\r
            foreach ($this->prefixes as $prefix) {\r
                $module = $prefix . $original_module;\r
                if (class_exists($module)) {\r
                    $ok = true;\r
                    break;\r
                }\r
            }\r
            if (!$ok) {\r
                $module = $original_module;\r
                if (!class_exists($module)) {\r
                    trigger_error(\r
                        $original_module . ' module does not exist',\r
                        E_USER_ERROR\r
                    );\r
                    return;\r
                }\r
            }\r
            $module = new $module();\r
        }\r
        if (empty($module->name)) {\r
            trigger_error('Module instance of ' . get_class($module) . ' must have name');\r
            return;\r
        }\r
        if (!$overload && isset($this->registeredModules[$module->name])) {\r
            trigger_error('Overloading ' . $module->name . ' without explicit overload parameter', E_USER_WARNING);\r
        }\r
        $this->registeredModules[$module->name] = $module;\r
    }\r
\r
    /**\r
     * Adds a module to the current doctype by first registering it,\r
     * and then tacking it on to the active doctype\r
     */\r
    public function addModule($module)\r
    {\r
        $this->registerModule($module);\r
        if (is_object($module)) {\r
            $module = $module->name;\r
        }\r
        $this->userModules[] = $module;\r
    }\r
\r
    /**\r
     * Adds a class prefix that registerModule() will use to resolve a\r
     * string name to a concrete class\r
     */\r
    public function addPrefix($prefix)\r
    {\r
        $this->prefixes[] = $prefix;\r
    }\r
\r
    /**\r
     * Performs processing on modules, after being called you may\r
     * use getElement() and getElements()\r
     * @param HTMLPurifier_Config $config\r
     */\r
    public function setup($config)\r
    {\r
        $this->trusted = $config->get('HTML.Trusted');\r
\r
        // generate\r
        $this->doctype = $this->doctypes->make($config);\r
        $modules = $this->doctype->modules;\r
\r
        // take out the default modules that aren't allowed\r
        $lookup = $config->get('HTML.AllowedModules');\r
        $special_cases = $config->get('HTML.CoreModules');\r
\r
        if (is_array($lookup)) {\r
            foreach ($modules as $k => $m) {\r
                if (isset($special_cases[$m])) {\r
                    continue;\r
                }\r
                if (!isset($lookup[$m])) {\r
                    unset($modules[$k]);\r
                }\r
            }\r
        }\r
\r
        // custom modules\r
        if ($config->get('HTML.Proprietary')) {\r
            $modules[] = 'Proprietary';\r
        }\r
        if ($config->get('HTML.SafeObject')) {\r
            $modules[] = 'SafeObject';\r
        }\r
        if ($config->get('HTML.SafeEmbed')) {\r
            $modules[] = 'SafeEmbed';\r
        }\r
        if ($config->get('HTML.SafeScripting') !== array()) {\r
            $modules[] = 'SafeScripting';\r
        }\r
        if ($config->get('HTML.Nofollow')) {\r
            $modules[] = 'Nofollow';\r
        }\r
        if ($config->get('HTML.TargetBlank')) {\r
            $modules[] = 'TargetBlank';\r
        }\r
\r
        // merge in custom modules\r
        $modules = array_merge($modules, $this->userModules);\r
\r
        foreach ($modules as $module) {\r
            $this->processModule($module);\r
            $this->modules[$module]->setup($config);\r
        }\r
\r
        foreach ($this->doctype->tidyModules as $module) {\r
            $this->processModule($module);\r
            $this->modules[$module]->setup($config);\r
        }\r
\r
        // prepare any injectors\r
        foreach ($this->modules as $module) {\r
            $n = array();\r
            foreach ($module->info_injector as $injector) {\r
                if (!is_object($injector)) {\r
                    $class = "HTMLPurifier_Injector_$injector";\r
                    $injector = new $class;\r
                }\r
                $n[$injector->name] = $injector;\r
            }\r
            $module->info_injector = $n;\r
        }\r
\r
        // setup lookup table based on all valid modules\r
        foreach ($this->modules as $module) {\r
            foreach ($module->info as $name => $def) {\r
                if (!isset($this->elementLookup[$name])) {\r
                    $this->elementLookup[$name] = array();\r
                }\r
                $this->elementLookup[$name][] = $module->name;\r
            }\r
        }\r
\r
        // note the different choice\r
        $this->contentSets = new HTMLPurifier_ContentSets(\r
            // content set assembly deals with all possible modules,\r
            // not just ones deemed to be "safe"\r
            $this->modules\r
        );\r
        $this->attrCollections = new HTMLPurifier_AttrCollections(\r
            $this->attrTypes,\r
            // there is no way to directly disable a global attribute,\r
            // but using AllowedAttributes or simply not including\r
            // the module in your custom doctype should be sufficient\r
            $this->modules\r
        );\r
    }\r
\r
    /**\r
     * Takes a module and adds it to the active module collection,\r
     * registering it if necessary.\r
     */\r
    public function processModule($module)\r
    {\r
        if (!isset($this->registeredModules[$module]) || is_object($module)) {\r
            $this->registerModule($module);\r
        }\r
        $this->modules[$module] = $this->registeredModules[$module];\r
    }\r
\r
    /**\r
     * Retrieves merged element definitions.\r
     * @return Array of HTMLPurifier_ElementDef\r
     */\r
    public function getElements()\r
    {\r
        $elements = array();\r
        foreach ($this->modules as $module) {\r
            if (!$this->trusted && !$module->safe) {\r
                continue;\r
            }\r
            foreach ($module->info as $name => $v) {\r
                if (isset($elements[$name])) {\r
                    continue;\r
                }\r
                $elements[$name] = $this->getElement($name);\r
            }\r
        }\r
\r
        // remove dud elements, this happens when an element that\r
        // appeared to be safe actually wasn't\r
        foreach ($elements as $n => $v) {\r
            if ($v === false) {\r
                unset($elements[$n]);\r
            }\r
        }\r
\r
        return $elements;\r
\r
    }\r
\r
    /**\r
     * Retrieves a single merged element definition\r
     * @param string $name Name of element\r
     * @param bool $trusted Boolean trusted overriding parameter: set to true\r
     *                 if you want the full version of an element\r
     * @return HTMLPurifier_ElementDef Merged HTMLPurifier_ElementDef\r
     * @note You may notice that modules are getting iterated over twice (once\r
     *       in getElements() and once here). This\r
     *       is because\r
     */\r
    public function getElement($name, $trusted = null)\r
    {\r
        if (!isset($this->elementLookup[$name])) {\r
            return false;\r
        }\r
\r
        // setup global state variables\r
        $def = false;\r
        if ($trusted === null) {\r
            $trusted = $this->trusted;\r
        }\r
\r
        // iterate through each module that has registered itself to this\r
        // element\r
        foreach ($this->elementLookup[$name] as $module_name) {\r
            $module = $this->modules[$module_name];\r
\r
            // refuse to create/merge from a module that is deemed unsafe--\r
            // pretend the module doesn't exist--when trusted mode is not on.\r
            if (!$trusted && !$module->safe) {\r
                continue;\r
            }\r
\r
            // clone is used because, ideally speaking, the original\r
            // definition should not be modified. Usually, this will\r
            // make no difference, but for consistency's sake\r
            $new_def = clone $module->info[$name];\r
\r
            if (!$def && $new_def->standalone) {\r
                $def = $new_def;\r
            } elseif ($def) {\r
                // This will occur even if $new_def is standalone. In practice,\r
                // this will usually result in a full replacement.\r
                $def->mergeIn($new_def);\r
            } else {\r
                // :TODO:\r
                // non-standalone definitions that don't have a standalone\r
                // to merge into could be deferred to the end\r
                // HOWEVER, it is perfectly valid for a non-standalone\r
                // definition to lack a standalone definition, even\r
                // after all processing: this allows us to safely\r
                // specify extra attributes for elements that may not be\r
                // enabled all in one place.  In particular, this might\r
                // be the case for trusted elements.  WARNING: care must\r
                // be taken that the /extra/ definitions are all safe.\r
                continue;\r
            }\r
\r
            // attribute value expansions\r
            $this->attrCollections->performInclusions($def->attr);\r
            $this->attrCollections->expandIdentifiers($def->attr, $this->attrTypes);\r
\r
            // descendants_are_inline, for ChildDef_Chameleon\r
            if (is_string($def->content_model) &&\r
                strpos($def->content_model, 'Inline') !== false) {\r
                if ($name != 'del' && $name != 'ins') {\r
                    // this is for you, ins/del\r
                    $def->descendants_are_inline = true;\r
                }\r
            }\r
\r
            $this->contentSets->generateChildDef($def, $module);\r
        }\r
\r
        // This can occur if there is a blank definition, but no base to\r
        // mix it in with\r
        if (!$def) {\r
            return false;\r
        }\r
\r
        // add information on required attributes\r
        foreach ($def->attr as $attr_name => $attr_def) {\r
            if ($attr_def->required) {\r
                $def->required_attr[] = $attr_name;\r
            }\r
        }\r
        return $def;\r
    }\r
}\r
\r
// vim: et sw=4 sts=4\r