remove autoload section in composer.json

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

<?php\r
\r
/**\r
 * Injects tokens into the document while parsing for well-formedness.\r
 * This enables "formatter-like" functionality such as auto-paragraphing,\r
 * smiley-ification and linkification to take place.\r
 *\r
 * A note on how handlers create changes; this is done by assigning a new\r
 * value to the $token reference. These values can take a variety of forms and\r
 * are best described HTMLPurifier_Strategy_MakeWellFormed->processToken()\r
 * documentation.\r
 *\r
 * @todo Allow injectors to request a re-run on their output. This\r
 *       would help if an operation is recursive.\r
 */\r
abstract class HTMLPurifier_Injector\r
{\r
\r
    /**\r
     * Advisory name of injector, this is for friendly error messages.\r
     * @type string\r
     */\r
    public $name;\r
\r
    /**\r
     * @type HTMLPurifier_HTMLDefinition\r
     */\r
    protected $htmlDefinition;\r
\r
    /**\r
     * Reference to CurrentNesting variable in Context. This is an array\r
     * list of tokens that we are currently "inside"\r
     * @type array\r
     */\r
    protected $currentNesting;\r
\r
    /**\r
     * Reference to current token.\r
     * @type HTMLPurifier_Token\r
     */\r
    protected $currentToken;\r
\r
    /**\r
     * Reference to InputZipper variable in Context.\r
     * @type HTMLPurifier_Zipper\r
     */\r
    protected $inputZipper;\r
\r
    /**\r
     * Array of elements and attributes this injector creates and therefore\r
     * need to be allowed by the definition. Takes form of\r
     * array('element' => array('attr', 'attr2'), 'element2')\r
     * @type array\r
     */\r
    public $needed = array();\r
\r
    /**\r
     * Number of elements to rewind backwards (relative).\r
     * @type bool|int\r
     */\r
    protected $rewindOffset = false;\r
\r
    /**\r
     * Rewind to a spot to re-perform processing. This is useful if you\r
     * deleted a node, and now need to see if this change affected any\r
     * earlier nodes. Rewinding does not affect other injectors, and can\r
     * result in infinite loops if not used carefully.\r
     * @param bool|int $offset\r
     * @warning HTML Purifier will prevent you from fast-forwarding with this\r
     *          function.\r
     */\r
    public function rewindOffset($offset)\r
    {\r
        $this->rewindOffset = $offset;\r
    }\r
\r
    /**\r
     * Retrieves rewind offset, and then unsets it.\r
     * @return bool|int\r
     */\r
    public function getRewindOffset()\r
    {\r
        $r = $this->rewindOffset;\r
        $this->rewindOffset = false;\r
        return $r;\r
    }\r
\r
    /**\r
     * Prepares the injector by giving it the config and context objects:\r
     * this allows references to important variables to be made within\r
     * the injector. This function also checks if the HTML environment\r
     * will work with the Injector (see checkNeeded()).\r
     * @param HTMLPurifier_Config $config\r
     * @param HTMLPurifier_Context $context\r
     * @return bool|string Boolean false if success, string of missing needed element/attribute if failure\r
     */\r
    public function prepare($config, $context)\r
    {\r
        $this->htmlDefinition = $config->getHTMLDefinition();\r
        // Even though this might fail, some unit tests ignore this and\r
        // still test checkNeeded, so be careful. Maybe get rid of that\r
        // dependency.\r
        $result = $this->checkNeeded($config);\r
        if ($result !== false) {\r
            return $result;\r
        }\r
        $this->currentNesting =& $context->get('CurrentNesting');\r
        $this->currentToken   =& $context->get('CurrentToken');\r
        $this->inputZipper    =& $context->get('InputZipper');\r
        return false;\r
    }\r
\r
    /**\r
     * This function checks if the HTML environment\r
     * will work with the Injector: if p tags are not allowed, the\r
     * Auto-Paragraphing injector should not be enabled.\r
     * @param HTMLPurifier_Config $config\r
     * @return bool|string Boolean false if success, string of missing needed element/attribute if failure\r
     */\r
    public function checkNeeded($config)\r
    {\r
        $def = $config->getHTMLDefinition();\r
        foreach ($this->needed as $element => $attributes) {\r
            if (is_int($element)) {\r
                $element = $attributes;\r
            }\r
            if (!isset($def->info[$element])) {\r
                return $element;\r
            }\r
            if (!is_array($attributes)) {\r
                continue;\r
            }\r
            foreach ($attributes as $name) {\r
                if (!isset($def->info[$element]->attr[$name])) {\r
                    return "$element.$name";\r
                }\r
            }\r
        }\r
        return false;\r
    }\r
\r
    /**\r
     * Tests if the context node allows a certain element\r
     * @param string $name Name of element to test for\r
     * @return bool True if element is allowed, false if it is not\r
     */\r
    public function allowsElement($name)\r
    {\r
        if (!empty($this->currentNesting)) {\r
            $parent_token = array_pop($this->currentNesting);\r
            $this->currentNesting[] = $parent_token;\r
            $parent = $this->htmlDefinition->info[$parent_token->name];\r
        } else {\r
            $parent = $this->htmlDefinition->info_parent_def;\r
        }\r
        if (!isset($parent->child->elements[$name]) || isset($parent->excludes[$name])) {\r
            return false;\r
        }\r
        // check for exclusion\r
        for ($i = count($this->currentNesting) - 2; $i >= 0; $i--) {\r
            $node = $this->currentNesting[$i];\r
            $def  = $this->htmlDefinition->info[$node->name];\r
            if (isset($def->excludes[$name])) {\r
                return false;\r
            }\r
        }\r
        return true;\r
    }\r
\r
    /**\r
     * Iterator function, which starts with the next token and continues until\r
     * you reach the end of the input tokens.\r
     * @warning Please prevent previous references from interfering with this\r
     *          functions by setting $i = null beforehand!\r
     * @param int $i Current integer index variable for inputTokens\r
     * @param HTMLPurifier_Token $current Current token variable.\r
     *          Do NOT use $token, as that variable is also a reference\r
     * @return bool\r
     */\r
    protected function forward(&$i, &$current)\r
    {\r
        if ($i === null) {\r
            $i = count($this->inputZipper->back) - 1;\r
        } else {\r
            $i--;\r
        }\r
        if ($i < 0) {\r
            return false;\r
        }\r
        $current = $this->inputZipper->back[$i];\r
        return true;\r
    }\r
\r
    /**\r
     * Similar to _forward, but accepts a third parameter $nesting (which\r
     * should be initialized at 0) and stops when we hit the end tag\r
     * for the node $this->inputIndex starts in.\r
     * @param int $i Current integer index variable for inputTokens\r
     * @param HTMLPurifier_Token $current Current token variable.\r
     *          Do NOT use $token, as that variable is also a reference\r
     * @param int $nesting\r
     * @return bool\r
     */\r
    protected function forwardUntilEndToken(&$i, &$current, &$nesting)\r
    {\r
        $result = $this->forward($i, $current);\r
        if (!$result) {\r
            return false;\r
        }\r
        if ($nesting === null) {\r
            $nesting = 0;\r
        }\r
        if ($current instanceof HTMLPurifier_Token_Start) {\r
            $nesting++;\r
        } elseif ($current instanceof HTMLPurifier_Token_End) {\r
            if ($nesting <= 0) {\r
                return false;\r
            }\r
            $nesting--;\r
        }\r
        return true;\r
    }\r
\r
    /**\r
     * Iterator function, starts with the previous token and continues until\r
     * you reach the beginning of input tokens.\r
     * @warning Please prevent previous references from interfering with this\r
     *          functions by setting $i = null beforehand!\r
     * @param int $i Current integer index variable for inputTokens\r
     * @param HTMLPurifier_Token $current Current token variable.\r
     *          Do NOT use $token, as that variable is also a reference\r
     * @return bool\r
     */\r
    protected function backward(&$i, &$current)\r
    {\r
        if ($i === null) {\r
            $i = count($this->inputZipper->front) - 1;\r
        } else {\r
            $i--;\r
        }\r
        if ($i < 0) {\r
            return false;\r
        }\r
        $current = $this->inputZipper->front[$i];\r
        return true;\r
    }\r
\r
    /**\r
     * Handler that is called when a text token is processed\r
     */\r
    public function handleText(&$token)\r
    {\r
    }\r
\r
    /**\r
     * Handler that is called when a start or empty token is processed\r
     */\r
    public function handleElement(&$token)\r
    {\r
    }\r
\r
    /**\r
     * Handler that is called when an end token is processed\r
     */\r
    public function handleEnd(&$token)\r
    {\r
        $this->notifyEnd($token);\r
    }\r
\r
    /**\r
     * Notifier that is called when an end token is processed\r
     * @param HTMLPurifier_Token $token Current token variable.\r
     * @note This differs from handlers in that the token is read-only\r
     * @deprecated\r
     */\r
    public function notifyEnd($token)\r
    {\r
    }\r
}\r
\r
// vim: et sw=4 sts=4\r