A modern, accurate HTML parser and serializer for PHP
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1422 lines
78 KiB

<?php
declare(strict_types=1);
namespace dW\HTML5;
class Parser {
/* Non-static properties */
// Context element for fragments
public $fragmentContext;
// The DOMDocument that is assembled by the tree builder
public $DOM;
// If a fragment a fragment is assembled instead
public $DOMFragment;
// Input data that's being parsed, uses DataStream
public $data;
// Instance of the Tokenizer class used for creating tokens
public $tokenizer;
// The form element pointer points to the last form element that was opened and
// whose end tag has not yet been seen. It is used to make form controls associate
// with forms in the face of dramatically bad markup, for historical reasons. It is
// ignored inside template elements
public $formElement;
// Flag for determining whether to use the foster parenting (badly nested table
// elements) algorithm.
public $fosterParenting = false;
// Flag that shows whether the content that's being parsed is a fragment or not
public $fragmentCase = false;
// Flag used to determine whether elements are okay to be used in framesets or not
public $framesetOk = true;
// Once a head element has been parsed (whether implicitly or explicitly) the head
// element pointer gets set to point to this node
public $headElement;
// The stack of open elements, uses Stack
public $stack;
// The list of active formatting elements, used when elements are improperly nested
public $activeFormattingElementsList;
// Treebuilder insertion mode
public $insertionMode;
// When the insertion mode is switched to "text" or "in table text", the
// original insertion mode is also set. This is the insertion mode to which the
// tree construction stage will return.
public $originalInsertionMode;
// Used to check if the document is in quirks mode
public $quirksMode;
/* Static properties */
// Property used as an instance for the non-static properties
public static $instance;
// For debugging
public static $debug = false;
/* Constants */
// Constants used for insertion modes
const INITIAL_MODE = 0;
const BEFORE_HTML_MODE = 1;
const BEFORE_HEAD_MODE = 2;
const IN_HEAD_MODE = 3;
const IN_HEAD_NOSCRIPT_MODE = 4;
const AFTER_HEAD_MODE = 5;
const IN_BODY_MODE = 6;
const TEXT_MODE = 7;
const IN_TABLE_MODE = 8;
const IN_TABLE_TEXT_MODE = 9;
const IN_CAPTION_MODE = 10;
const IN_COLUMN_GROUP_MODE = 11;
const IN_TABLE_BODY_MODE = 12;
const IN_ROW_MODE = 13;
const IN_CELL_MODE = 14;
const IN_SELECT_MODE = 15;
const IN_SELECT_IN_TABLE_MODE = 16;
const IN_TEMPLATE_MODE = 17;
const AFTER_BODY_MODE = 18;
const IN_FRAMESET_MODE = 19;
const AFTER_FRAMESET_MODE = 20;
const AFTER_AFTER_BODY_MODE = 21;
const AFTER_AFTER_FRAMESET_MODE = 22;
// Namespace constants
const HTML_NAMESPACE = 'http://www.w3.org/1999/xhtml';
const MATHML_NAMESPACE = 'http://www.w3.org/1998/Math/MathML';
const SVG_NAMESPACE = 'http://www.w3.org/2000/svg';
const XLINK_NAMESPACE = 'http://www.w3.org/1999/xlink';
const XML_NAMESPACE = 'http://www.w3.org/XML/1998/namespace';
const XMLNS_NAMESPACE = 'http://www.w3.org/2000/xmlns/';
// Quirks mode constants
const QUIRKS_MODE_OFF = 0;
const QUIRKS_MODE_ON = 1;
const QUIRKS_MODE_LIMITED = 2;
// Protected construct used for creating an instance to access properties which must
// be reset on every parse
protected function __construct() {
$this->insertionMode = static::INITIAL_MODE;
$this->quirksMode = static::QUIRKS_MODE_OFF;
$this->stack = new Stack();
$this->activeFormattingElementsList = new ActiveFormattingElementsList();
}
public static function parse(string $data, bool $file = false) {
// If parse() is called by parseFragment() then don't create an instance. It has
// already been created.
$c = __CLASS__;
if (!(static::$instance instanceof $c && !static::$instance->fragmentCase)) {
static::$instance = new $c;
}
// Create the document if it doesn't already exist. Will be overwritten if there is a DOCTYPE.
if (is_null(static::$instance->DOM)) {
$imp = new \DOMImplementation;
static::$instance->DOM = $imp->createDocument();
}
// Process the input stream.
static::$instance->data = new DataStream(($file === true) ? '' : $data, ($file === true) ? $data : 'STDIN');
// Set the locale for CTYPE to en_US.UTF8 so ctype functions and strtolower only
// work on basic latin characters. Used extensively when tokenizing.
setlocale(LC_CTYPE, 'en_US.UTF8');
// initialize the tokenizer
static::$instance->tokenizer = new Tokenizer(static::$instance->data, static::$instance->stack);
// Run the tokenizer. Tokenizer runs until after the EOF token is emitted.
do {
$token = static::$instance->tokenizer->createToken();
static::$instance->emitToken($token);
} while (!$token instanceof EOFToken);
return DOM::fixIdAttributes(static::$instance->DOM);
}
public static function parseFragment(string $data, \DOMDocument $dom = null, \DOMElement $context = null, bool $file = false): \DOMDocument {
// If a context is provided and either the DOM isn't provided or the DOM isn't
// the owner document of the provided context then the context is invalid and
// should be set to null.
if (!is_null($context) && (is_null($dom) || !$dom->isSameNode($context->ownerDocument))) {
$context = null;
}
// Create an instance of this class to use the non static properties.
$c = __CLASS__;
static::$instance = new $c;
if (!is_null($dom)) {
static::$instance->DOM = $dom;
} else {
$imp = new \DOMImplementation;
static::$instance->DOM = $imp->createDocument();
}
static::$instance->DOMFragment = static::$instance->DOM->createDocumentFragment();
// DEVIATION: The spec says to let the document be in quirks mode if the
// DOMDocument is in quirks mode. Cannot check whether the context element is in
// quirks mode, so going to assume it isn't.
// DEVIATION: The spec's version of parsing fragments isn't remotely useful in
// the context this library is intended for use in. This implementation uses a
// DOMDocumentFragment for inserting nodes into. There's no need to have a
// different process for when there isn't a context. There will always be one:
// the DOMDocumentFragment.
static::$instance->fragmentContext = (!is_null($context)) ? $context : static::$instance->DOMFragment;
$name = static::$instance->fragmentContext->nodeName;
# Set the state of the HTML parser's tokenization stage as follows:
if ($name === 'title' || $name === 'textarea') {
static::$instance->tokenizer->state = Tokenizer::RCDATA_STATE;
} elseif ($name === 'style' || $name === 'xmp' || $name === 'iframe' || $name === 'noembed' || $name === 'noframes') {
static::$instance->tokenizer->state = Tokenizer::RAWTEXT_STATE;
} elseif ($name === 'script') {
static::$instance->tokenizer->state = Tokenizer::SCRIPT_STATE;
} elseif ($name === 'noscript') {
static::$instance->tokenizer->state = Tokenizer::NOSCRIPT_STATE;
} elseif ($name === 'plaintext') {
static::$instance->tokenizer->state = Tokenizer::PLAINTEXT_STATE;
} else {
static::$instance->tokenizer->state = Tokenizer::DATA_STATE;
}
// DEVIATION: Since this implementation uses a DOMDocumentFragment for insertion
// there is no need to create an html element for inserting stuff into.
# If the context element is a template element, push "in template" onto the
# stack of template insertion modes so that it is the new current template
# insertion mode.
// DEVIATION: No scripting.
# Reset the parser's insertion mode appropriately.
// DEVIATION: The insertion mode will be always 'in body', not 'before head' if
// there isn't a context. There isn't a need to reconstruct a valid HTML
// document when using a DOMDocumentFragment.
static::$instance->resetInsertionMode();
# Set the parser's form element pointer to the nearest node to the context element
# that is a form element (going straight up the ancestor chain, and including the
# element itself, if it is a form element), if any. (If there is no such form
# element, the form element pointer keeps its initial value, null.)
static::$instance->formElement = ($name === 'form') ? $context : DOM::getAncestor('form', $context);
# Start the parser and let it run until it has consumed all the characters just
# inserted into the input stream.
static::$instance->fragmentCase = true;
static::parse($data, $file);
# If there is a context element, return the child nodes of root, in tree order.
# Otherwise, return the children of the Document object, in tree order.
// DEVIATION: This method will always return a DOMDocumentFragment.
return static::$instance->DOMFragment;
}
protected function emitToken(Token $token) {
// Loop used for reprocessing.
while (true) {
$adjustedCurrentNode = $this->stack->adjustedCurrentNode;
$adjustedCurrentNodeName = $this->stack->adjustedCurrentNodeName;
$adjustedCurrentNodeNamespace = $this->stack->adjustedCurrentNodeNamespace;
# 8.2.5 Tree construction
#
# As each token is emitted from the tokenizer, the user agent must follow the
# appropriate steps from the following list, known as the tree construction dispatcher:
#
# If the stack of open elements is empty
if ($this->stack->length === 0 ||
# If the adjusted current node is an element in the HTML namespace
$adjustedCurrentNodeNamespace === static::HTML_NAMESPACE || (
# If the adjusted current node is a MathML text integration point and the token is a
# start tag whose tag name is neither "mglyph" nor "malignmark"
# If the adjusted current node is a MathML text integration point and the token is a
# character token
DOM::isMathMLTextIntegrationPoint($adjustedCurrentNode) && ((
$token instanceof StartTagToken && (
$token->name !== 'mglyph' && $token->name !== 'malignmark'
) ||
$token instanceof CharacterToken
)
)
) || (
# If the adjusted current node is an annotation-xml element in the MathML namespace and
# the token is a start tag whose tag name is "svg"
$adjustedCurrentNodeNamespace === static::MATHML_NAMESPACE &&
$adjustedCurrentNodeName === 'annotation-xml' &&
$token instanceof StartTagToken &&
$token->name === 'svg'
) || (
# If the adjusted current node is an HTML integration point and the token is a start tag
# If the adjusted current node is an HTML integration point and the token is a character
# token
DOM::isHTMLIntegrationPoint($adjustedCurrentNode) && (
$token instanceof StartTagToken || $token instanceof CharacterToken
)
) ||
# If the token is an end-of-file token
$token instanceof EOFToken) {
# Process the token according to the rules given in the section corresponding to
# the current insertion mode in HTML content.
// Returns false when needing to reprocess.
if ($this->parseTokenInHTMLContent($token) === false) {
continue;
}
}
# Otherwise
else {
# Process the token according to the rules given in the section for parsing
# tokens in foreign content.
// Returns false when needing to reprocess.
if ($this->parseTokenInForeignContent($token) === false) {
continue;
}
}
# TEMPORARY
var_export($token);
echo "\n\n";
break;
}
}
protected function parseTokenInHTMLContent(Token $token, int $insertionMode = null) {
$insertionMode = (is_null($insertionMode)) ? $this->insertionMode : $insertionMode;
// Loop used when processing the token under different rules; always breaks.
while (true) {
# 8.2.5.4. The rules for parsing tokens in HTML content
switch ($insertionMode) {
# 8.2.5.4.1. The "initial" insertion mode
case static::INITIAL_MODE:
# A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED
# (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE
// OPTIMIZATION: Will check for multiple space characters at once as character
// tokens can contain more than one character.
if ($token instanceof CharacterToken && (strspn($token->data, "\t\n\x0c\x0d ") !== strlen($token->data))) {
# Ignore the token.
return;
}
# A comment token
elseif ($token instanceof CommentToken) {
# Insert a comment as the last child of the Document object.
// DEVIATION: PHP's DOM cannot have comments before the DOCTYPE, so just going
// to ignore them instead.
//$this->insertCommentToken($token, $this->$DOM);
return;
}
# A DOCTYPE token
elseif ($token instanceof DOCTYPEToken) {
# If the DOCTYPE token’s name is not a case-sensitive match for the string
# "html", or the token’s public identifier is not missing, or the token’s system
# identifier is neither missing nor a case-sensitive match for the string
# "about:legacy-compat", then there is a parse error.
6 years ago
if ($token->name !== 'html' || $token->public !== '' || ($token->system !== '' && $token->system !== 'about:legacy-compat')) {
ParseError::trigger(ParseError::INVALID_DOCTYPE);
}
# Append a DocumentType node to the Document node, with the name attribute set
# to the name given in the DOCTYPE token, or the empty string if the name was
# missing; the publicId attribute set to the public identifier given in the
# DOCTYPE token, or the empty string if the public identifier was missing; the
# systemId attribute set to the system identifier given in the DOCTYPE token, or
# the empty string if the system identifier was missing; and the other
# attributes specific to DocumentType objects set to null and empty lists as
# appropriate. Associate the DocumentType node with the Document object so that
# it is returned as the value of the doctype attribute of the Document object.
// PHP's DOM cannot just append a DOCTYPE node to the document, so a document is
// created with the specified DOCTYPE instead.
$imp = new \DOMImplementation();
// DEVIATION: PHP's DOMImplementation::createDocumentType() method cannot accept
// an empty name, so if it is missing it is replaced with 'html' instead.
$this->DOM = $imp->createDocument('', '', $imp->createDocumentType((!is_null($token->name)) ? $token->name : 'html', $token->public, $token->system));
6 years ago
$public = strtolower($token->public);
# Then, if the document is not an iframe srcdoc document, and the DOCTYPE token
# matches one of the conditions in the following list, then set the Document to
# quirks mode:
// DEVIATION: This implementation does not render, so there is no nested
// browsing contexts to consider.
if ($token->forceQuirks === true || $token->name !== 'html' ||
$public === '-//w3o//dtd w3 html strict 3.0//en//' ||
$public === '-/w3c/dtd html 4.0 transitional/en' ||
$public === 'html' ||
strtolower($token->system) === 'http://www.ibm.com/data/dtd/v11/ibmxhtml1-transitional.dtd' ||
strpos($public, '+//silmaril//dtd html pro v0r11 19970101//') === 0 ||
strpos($public, '-//as//dtd html 3.0 aswedit + extensions//') === 0 ||
strpos($public, '+//silmaril//dtd html pro v0r11 19970101//') === 0 ||
strpos($public, '-//as//dtd html 3.0 aswedit + extensions//') === 0 ||
strpos($public, '-//advasoft ltd//dtd html 3.0 aswedit + extensions//') === 0 ||
strpos($public, '-//ietf//dtd html 2.0 level 1//') === 0 ||
strpos($public, '-//ietf//dtd html 2.0 level 2//') === 0 ||
strpos($public, '-//ietf//dtd html 2.0 strict level 1//') === 0 ||
strpos($public, '-//ietf//dtd html 2.0 strict level 2//') === 0 ||
strpos($public, '-//ietf//dtd html 2.0 strict//') === 0 ||
strpos($public, '-//ietf//dtd html 2.0//') === 0 ||
strpos($public, '-//ietf//dtd html 2.1e//') === 0 ||
strpos($public, '-//ietf//dtd html 3.0//') === 0 ||
strpos($public, '-//ietf//dtd html 3.2 final//') === 0 ||
strpos($public, '-//ietf//dtd html 3.2//') === 0 ||
strpos($public, '-//ietf//dtd html 3//') === 0 ||
strpos($public, '-//ietf//dtd html level 0//') === 0 ||
strpos($public, '-//ietf//dtd html level 1//') === 0 ||
strpos($public, '-//ietf//dtd html level 2//') === 0 ||
strpos($public, '-//ietf//dtd html level 3//') === 0 ||
strpos($public, '-//ietf//dtd html strict level 0//') === 0 ||
strpos($public, '-//ietf//dtd html strict level 1//') === 0 ||
strpos($public, '-//ietf//dtd html strict level 2//') === 0 ||
strpos($public, '-//ietf//dtd html strict level 3//') === 0 ||
strpos($public, '-//ietf//dtd html strict//') === 0 ||
strpos($public, '-//ietf//dtd html//') === 0 ||
strpos($public, '-//metrius//dtd metrius presentational//') === 0 ||
strpos($public, '-//microsoft//dtd internet explorer 2.0 html strict//') === 0 ||
strpos($public, '-//microsoft//dtd internet explorer 2.0 html//') === 0 ||
strpos($public, '-//microsoft//dtd internet explorer 2.0 tables//') === 0 ||
strpos($public, '-//microsoft//dtd internet explorer 3.0 html strict//') === 0 ||
strpos($public, '-//microsoft//dtd internet explorer 3.0 html//') === 0 ||
strpos($public, '-//microsoft//dtd internet explorer 3.0 tables//') === 0 ||
strpos($public, '-//netscape comm. corp.//dtd html//') === 0 ||
strpos($public, '-//netscape comm. corp.//dtd strict html//') === 0 ||
strpos($public, '-//o\'reilly and associates//dtd html 2.0//') === 0 ||
strpos($public, '-//o\'reilly and associates//dtd html extended 1.0//') === 0 ||
strpos($public, '-//o\'reilly and associates//dtd html extended relaxed 1.0//') === 0 ||
strpos($public, '-//sq//dtd html 2.0 hotmetal + extensions//') === 0 ||
strpos($public, '-//softquad software//dtd hotmetal pro 6.0::19990601::extensions to html 4.0//') === 0 ||
strpos($public, '-//softquad//dtd hotmetal pro 4.0::19971010::extensions to html 4.0//') === 0 ||
strpos($public, '-//spyglass//dtd html 2.0 extended//') === 0 ||
strpos($public, '-//sun microsystems corp.//dtd hotjava html//') === 0 ||
strpos($public, '-//sun microsystems corp.//dtd hotjava strict html//') === 0 ||
strpos($public, '-//w3c//dtd html 3 1995-03-24//') === 0 ||
strpos($public, '-//w3c//dtd html 3.2 draft//') === 0 ||
strpos($public, '-//w3c//dtd html 3.2 final//') === 0 ||
strpos($public, '-//w3c//dtd html 3.2//') === 0 ||
strpos($public, '-//w3c//dtd html 3.2s draft//') === 0 ||
strpos($public, '-//w3c//dtd html 4.0 frameset//') === 0 ||
strpos($public, '-//w3c//dtd html 4.0 transitional//') === 0 ||
strpos($public, '-//w3c//dtd html experimental 19960712//') === 0 ||
strpos($public, '-//w3c//dtd html experimental 970421//') === 0 ||
strpos($public, '-//w3c//dtd w3 html//') === 0 ||
strpos($public, '-//w3o//dtd w3 html 3.0//') === 0 ||
strpos($public, '-//webtechs//dtd mozilla html 2.0//') === 0 ||
strpos($public, '-//webtechs//dtd mozilla html//') === 0 ||
(is_null($token->system) &&
(strpos($public, '-//w3c//dtd html 4.01 frameset//') === 0 ||
strpos($public, '-//w3c//dtd html 4.01 transitional//') === 0))) {
$this->quirksMode = static::QUIRKS_MODE_ON;
}
# Otherwise, if the document is not an iframe srcdoc document, and the DOCTYPE
# token matches one of the conditions in the following list, then set the
# Document to limited-quirks mode:
// DEVIATION: There is no iframe srcdoc document because there are no nested
// browsing contexts in this implementation.
else {
if (strpos($public, '-//w3c//dtd xhtml 1.0 frameset//') === 0 ||
strpos($public, '-//w3c//dtd xhtml 1.0 transitional//') === 0 ||
(!is_null($token->system) &&
(strpos($public, '-//w3c//dtd html 4.01 frameset//') === 0 ||
strpos($public, '-//w3c//dtd html 4.01 transitional//') === 0))) {
$this->quirksMode = static::QUIRKS_MODE_LIMITED;
}
}
# The system identifier and public identifier strings must be compared to the
# values given in the lists above in an ASCII case-insensitive manner. A system
# identifier whose value is the empty string is not considered missing for the
# purposes of the conditions above.
# Then, switch the insertion mode to "before html".
$this->insertionMode = static::BEFORE_HTML_MODE;
}
# Anything else
else {
# If the document is not an iframe srcdoc document, then this is a parse error;
# set the Document to quirks mode.
// DEVIATION: There is no iframe srcdoc document because there are no nested
// browsing contexts in this implementation.
$this->quirksMode = static::QUIRKS_MODE_ON;
# In any case, switch the insertion mode to "before html", then reprocess the
# token.
$this->insertionMode = static::BEFORE_HTML_MODE;
return false;
}
break;
# 8.2.5.4.2. The "before html" insertion mode
case static::BEFORE_HTML_MODE:
# A DOCTYPE token
if ($token instanceof DOCTYPEToken) {
ParseError::trigger(ParseError::UNEXPECTED_DOCTYPE, '');
}
# A comment token
elseif ($token instanceof CommentToken) {
# Insert a comment as the last child of the Document object.
$this->insertCommentToken($token, $this->$DOM);
}
# A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED
# (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE
// OPTIMIZATION: Will check for multiple space characters at once as character
// tokens can contain more than one character.
elseif ($token instanceof CharacterToken && (strspn($token->data, "\t\n\x0c\x0d ") !== strlen($token->data))) {
# Ignore the token.
return;
}
# A start tag whose tag name is "html"
elseif ($token instanceof StartTagToken && $token->name === 'html') {
# Create an element for the token in the HTML namespace, with the Document as
# the intended parent. Append it to the Document object. Put this element in the
# stack of open elements.
$element = $this->insertElement($token, $this->DOM);
# Switch the insertion mode to "before head".
$this->insertionMode = static::BEFORE_HEAD_MODE;
}
# Any other end tag
elseif ($token instanceof EndTagToken && $token->name !== 'head' && $token->name !== 'body' && $token->name !== 'html' && $token->name !== 'br') {
# Parse error.
ParseError::trigger(ParseError::UNEXPECTED_END_TAG, $token->name, 'head, body, html, or br tag');
}
# An end tag whose tag name is one of: "head", "body", "html", "br"
# Anything else
else {
# Create an html element whose node document is the Document object. Append it
# to the Document object. Put this element in the stack of open elements.
$element = $this->DOM->createElement('html');
$this->DOM->appendChild($element);
$this->stack[] = $element;
# Switch the insertion mode to "before head", then reprocess the token.
$this->insertionMode = static::BEFORE_HEAD_MODE;
return false;
}
# The document element can end up being removed from the Document object, e.g.,
# by scripts; nothing in particular happens in such cases, content continues
# being appended to the nodes as described in the next section.
// Good to know. There's no scripting in this implementation, though.
break;
# 8.2.5.4.3. The "before head" insertion mode
case static::BEFORE_HEAD_MODE:
# A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED
# (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE
if ($token instanceof CharacterToken && (strspn($token->data, "\t\n\x0c\x0d ") !== strlen($token->data))) {
# Ignore the token.
return;
}
# A comment token
elseif ($token instanceof CommentToken) {
$this->insertCommentToken($token);
}
# A DOCTYPE token
elseif ($token instanceof DOCTYPEToken) {
# Parse error.
ParseError::trigger(ParseError::UNEXPECTED_DOCTYPE, 'head tag');
}
elseif ($token instanceof StartTagToken) {
# A start tag whose tag name is "html"
if ($token->name === 'html') {
# Process the token using the rules for the "in body" insertion mode.
$insertionMode = static::IN_BODY_MODE;
continue 2;
}
# A start tag whose tag name is "head"
elseif ($token->name === 'head') {
# Insert an HTML element for the token.
$element = $this->insertElement($token);
# Set the head element pointer to the newly created head element.
$this->headElement = $element;
# Switch the insertion mode to "in head".
$this->insertionMode = static::IN_HEAD_MODE;
}
}
# Any other end tag
elseif ($token instanceof EndTagToken && $token->name !== 'head' && $token->name !== 'body' && $token->name !== 'html' && $token->name === 'br') {
# Parse error.
ParseError::trigger(ParseError::UNEXPECTED_END_TAG, $token->name, 'head, body, html, or br tag');
}
# An end tag whose tag name is one of: "head", "body", "html", "br"
# Anything else
else {
# Insert an HTML element for a "head" start tag token with no attributes.
$element = $this->insertElement(new StartTagToken('head'));
# Set the head element pointer to the newly created head element.
$this->headElement = $element;
# Switch the insertion mode to "in head".
$this->insertionMode = static::IN_HEAD_MODE;
# Reprocess the current token.
return false;
}
break;
# 8.2.5.4.4. The "in head" insertion mode
case static::IN_HEAD_MODE:
# A character token that is one of U+0009 CHARACTER TABULATION, U+000A LINE FEED
# (LF), U+000C FORM FEED (FF), U+000D CARRIAGE RETURN (CR), or U+0020 SPACE
if ($token instanceof CharacterToken && (strspn($token->data, "\t\n\x0c\x0d ") !== strlen($token->data))) {
# Insert the character.
$this->insertCharacterToken($token);
}
# A comment token
elseif ($token instanceof CommentToken) {
# Insert a comment.
$this->insertCommentToken($token);
}
# A DOCTYPE token
elseif ($token instanceof DOCTYPEToken) {
# Parse error.
ParseError::trigger(ParseError::UNEXPECTED_DOCTYPE, 'head data');
}
elseif ($token instanceof StartTagToken) {
# A start tag whose tag name is "html"
if ($token->name === 'html') {
# Process the token using the rules for the "in body" insertion mode.
$insertionMode = static::IN_BODY_MODE;
continue 2;
}
# A start tag whose tag name is one of: "base", "basefont", "bgsound", "link"
elseif ($token->name === 'base' || $token->name === 'basefont' || $token->name === 'bgsound' || $token->name === 'link') {
# Insert an HTML element for the token. Immediately pop the current node off the
# stack of open elements.
$this->createAndInsertElement($token);
$this->stack->pop();
# Acknowledge the token’s *self-closing flag*, if it is set.
// Acknowledged.
}
# A start tag whose tag name is "meta"
elseif ($token->name === 'meta') {
# Insert an HTML element for the token. Immediately pop the current node off the
# stack of open elements.
$this->createAndInsertElement($token);
$this->stack->pop();
# Acknowledge the token’s *self-closing flag*, if it is set.
// Acknowledged.
# If the element has a charset attribute, and getting an encoding from its value
# results in an encoding, and the confidence is currently tentative, then change
# the encoding to the resulting encoding.
#
# Otherwise, if the element has an http-equiv attribute whose value is an ASCII
# case-insensitive match for the string "Content-Type", and the element has a
# content attribute, and applying the algorithm for extracting a character
# encoding from a meta element to that attribute’s value returns an encoding,
# and the confidence is currently tentative, then change the encoding to the
# extracted encoding.
// DEVIATION: FIXME: This implementation currently only supports UTF-8.
}
# A start tag whose tag name is "title"
elseif ($token->name === 'title') {
# Follow the generic RCDATA element parsing algorithm.
$this->genericRCDATAParsingAlgorithm();
}
# A start tag whose tag name is "noscript", if the scripting flag is enabled
# A start tag whose tag name is one of: "noframes", "style"
// DEVIATION: There is no scripting in this implementation, so the scripting
// flag is always disabled.
elseif ($token->name === 'noframes' || $token->name === 'style') {
# Follow the generic raw text element parsing algorithm.
$this->genericRawTextParsingAlgorithm();
}
# A start tag whose tag name is "noscript", if the scripting flag is disabled
// DEVIATION: There is no scripting in this implementation, so the scripting
// flag is always disabled.
elseif ($token->name === 'noscript') {
# Insert an HTML element for the token.
$this->createAndInsertElement($token);
# Switch the insertion mode to "in head noscript".
$this->insertionMode = static::IN_HEAD_NOSCRIPT_MODE;
}
# A start tag whose tag name is "script"
elseif ($token->name === 'script') {
# Run these steps:
# 1. Let the adjusted insertion location be the appropriate place for inserting
# a node.
# 2. Create an element for the token in the HTML namespace, with the intended
# parent being the element in which the adjusted insertion location finds
# itself.
// DEVIATION: Because there is no scripting in this implementation, there is no
// need to get the adjusted insertion location as the intended parent as the
// intended parent isn't used when determining anything;
// Parser::createAndInsertElement will get the adjusted insertion location
// anyway.
$this->createAndInsertElement($token);
# 3. Mark the element as being "parser-inserted" and unset the element’s
# "non-blocking" flag.
# 4. Mark the element as being "parser-inserted" and unset the element’s
# "non-blocking" flag.
// DEVIATION: No scripting.
# 5. Insert the newly created element at the adjusted insertion location.
// Done.
# 6. Push the element onto the stack of open elements so that it is the new
# current node.
// The element insertion algorithm has it do this already...
# 7. Switch the tokenizer to the script data state.
$this->tokenizer->state = Tokenizer::SCRIPT_DATA_STATE;
# 8. Let the original insertion mode be the current insertion mode.
$this->originalInsertionMode = $this->currentInsertionMode;
# 9. Switch the insertion mode to "text".
$this->insertionMode = static::TEXT_MODE;
}
# A start tag whose tag name is "template"
elseif ($token->name === 'template') {
# Insert an HTML element for the token.
$this->createAndInsertElement($token);
# Insert a marker at the end of the list of active formatting elements.
$this->activeFormattingElementsList->insertMarker();
# Set the frameset-ok flag to "not ok".
$this->framesetOk = false;
# Switch the insertion mode to "in template".
$this->insertionMode = static::IN_TEMPLATE_MODE;
# Push "in template" onto the stack of template insertion modes so that it is
# the new current template insertion mode.
// DEVIATION: No scripting.
}
}
elseif ($token instanceof EndTagToken) {
# An end tag whose tag name is "head"
if ($token->name === 'head') {
# Pop the current node (which will be the head element) off the stack of open
# elements.
$this->stack->pop();
# Switch the insertion mode to "after head".
$this->insertionMode = static::AFTER_HEAD_MODE;
}
// ¡STOPPED HERE!
}
break;
}
break;
}
}
protected function parseTokenInForeignContent(Token $token) {
$currentNode = $this->stack->currentNode;
$currentNodeName = $this->stack->currentNodeName;
$currentNodeNamespace = $this->stack->currentNodeNamespace;
# 8.2.5.5 The rules for parsing tokens in foreign content
#
# When the user agent is to apply the rules for parsing tokens in foreign
# content, the user agent must handle the token as follows:
#
if ($token instanceof CharacterToken) {
# A character token that is one of U+0009 CHARACTER TABULATION, "LF" (U+000A),
# "FF" (U+000C), "CR" (U+000D), or U+0020 SPACE
# Any other character token
// OPTIMIZATION: Will check for multiple space characters at once as character
// tokens can contain more than one character.
if (strspn($token->data, "\t\n\x0c\x0d ") !== strlen($token->data)) {
# Set the frameset-ok flag to "not ok".
$this->$framesetOk = false;
}
# Insert the token's character.
$this->insertCharacterToken($token);
}
# A comment token
elseif ($token instanceof CommentToken) {
# Insert a comment.
$this->insertCommentToken($token);
}
# A DOCTYPE token
elseif ($token instanceof DOCTYPEToken) {
# Parse error.
ParseError::trigger(ParseError::UNEXPECTED_DOCTYPE, 'Character, Comment, Start Tag, or End Tag');
}
elseif ($token instanceof StartTagToken) {
# A start tag whose tag name is one of: "b", "big", "blockquote", "body", "br",
# "center", "code", "dd", "div", "dl", "dt", "em", "embed", "h1", "h2", "h3",
# "h4", "h5", "h6", "head", "hr", "i", "img", "li", "listing", "menu", "meta",
# "nobr", "ol", "p", "pre", "ruby", "s", "small", "span", "strong", "strike",
# "sub", "sup", "table", "tt", "u", "ul", "var"
# A start tag whose tag name is "font", if the token has any attributes named
# "color", "face", or "size"
if ($token->name === 'b' || $token->name === 'big' || $token->name === 'blockquote' || $token->name === 'body' || $token->name === 'br' || $token->name === 'center' || $token->name === 'code' || $token->name === 'dd' || $token->name === 'div' || $token->name === 'dl' || $token->name === 'dt' || $token->name === 'em' || $token->name === 'embed' || $token->name === 'h1' || $token->name === 'h2' || $token->name === 'h3' || $token->name === 'h4' || $token->name === 'h5' || $token->name === 'h6' || $token->name === 'head' || $token->name === 'hr' || $token->name === 'i' || $token->name === 'img' || $token->name === 'li' || $token->name === 'listing' || $token->name === 'menu' || $token->name === 'meta' || $token->name === 'nobr' || $token->name === 'ol' || $token->name === 'p' || $token->name === 'pre' || $token->name === 'ruby' || $token->name === 's' || $token->name === 'small' || $token->name === 'span' || $token->name === 'strong' || $token->name === 'strike' || $token->name === 'sub' || $token->name === 'sup' || $token->name === 'table' || $token->name === 'tt' || $token->name === 'u' || $token->name === 'var' || (
$token->name === 'font' && (
$token->hasAttribute('color') || $token->hasAttribute('face') || $token->hasAttribute('size')
)
)
) {
# Parse error.
ParseError::trigger(ParseError::UNEXPECTED_START_TAG, $token->name, 'Non-HTML start tag');
# If the parser was originally created for the HTML fragment parsing algorithm,
# then act as described in the "any other start tag" entry below. (fragment
# case)
if ($this->fragmentCase === true) {
// ¡TEMPORARY!
goto foreignContentAnyOtherStartTag;
}
# Otherwise:
#
# Pop an element from the stack of open elements, and then keep popping more
# elements from the stack of open elements until the current node is a MathML
# text integration point, an HTML integration point, or an element in the HTML
# namespace.
do {
$popped = $this->stack->pop();
} while (!is_null($popped) && (
!DOM::isMathMLTextIntegrationPoint($this->stack->currentNode) &&
!DOM::isHTMLIntegrationPoint($this->stack->currentNode) &&
$this->stack->currentNode->namespaceURI !== static::HTML_NAMESPACE
)
);
# Then, reprocess the token.
return false;
}
# Any other start tag
else {
foreignContentAnyOtherStartTag:
# If the adjusted current node is an element in the SVG namespace, and the
# token’s tag name is one of the ones in the first column of the following
# table, change the tag name to the name given in the corresponding cell in the
# second column. (This fixes the case of SVG elements that are not all
# lowercase.)
if ($currentNode->namespaceURI === static::SVG_NAMESPACE) {
switch ($token->name) {
case 'altglyph': $token->name = 'altGlyph';
break;
case 'altglyphdef': $token->name = 'altGlyphDef';
break;
case 'altglyphitem': $token->name = 'altGlyphItem';
break;
case 'animatecolor': $token->name = 'animateColor';
break;
case 'animatemotion': $token->name = 'animateMotion';
break;
case 'animatetransform': $token->name = 'animateTransform';
break;
case 'clippath': $token->name = 'clipPath';
break;
case 'feblend': $token->name = 'feBlend';
break;
case 'fecolormatrix': $token->name = 'feColorMatrix';
break;
case 'fecomponenttransfer': $token->name = 'feComponentTransfer';
break;
case 'fecomposite': $token->name = 'feComposite';
break;
case 'feconvolvematrix': $token->name = 'feConvolveMatrix';
break;
case 'fediffuselighting': $token->name = 'feDiffuseLighting';
break;
case 'fedisplacementmap': $token->name = 'feDisplacementMap';
break;
case 'fedistantlight': $token->name = 'feDistantLight';
break;
case 'feflood': $token->name = 'feFlood';
break;
case 'fefunca': $token->name = 'feFuncA';
break;
case 'fefuncb': $token->name = 'feFuncB';
break;
case 'fefuncg': $token->name = 'feFuncG';
break;
case 'fefuncr': $token->name = 'feFuncR';
break;
case 'fegaussianblur': $token->name = 'feGaussianBlur';
break;
case 'feimage': $token->name = 'feImage';
break;
case 'femerge': $token->name = 'feMerge';
break;
case 'femergenode': $token->name = 'feMergeNode';
break;
case 'femorphology': $token->name = 'feMorphology';
break;
case 'feoffset': $token->name = 'feOffset';
break;
case 'fepointlight': $token->name = 'fePointLight';
break;
case 'fespecularlighting': $token->name = 'feSpecularLighting';
break;
case 'fespotlight': $token->name = 'feSpotLight';
break;
case 'fetile': $token->name = 'feTile';
break;
case 'feturbulence': $token->name = 'feTurbulence';
break;
case 'foreignobject': $token->name = 'foreignObject';
break;
case 'glyphref': $token->name = 'glyphRef';
break;
case 'lineargradient': $token->name = 'linearGradient';
break;
case 'radialgradient': $token->name = 'radialGradient';
break;
case 'textpath': $token->name = 'textPath';
}
}
foreach ($token->attributes as &$a) {
# If the current node is an element in the MathML namespace, adjust MathML
# attributes for the token. (This fixes the case of MathML attributes that are
# not all lowercase.)
if ($currentNodeNamespace === static::MATHML_NAMESPACE && $a->name === 'definitionurl') {
$a->name = 'definitionURL';
}
# If the current node is an element in the SVG namespace, adjust SVG attributes
# for the token. (This fixes the case of SVG attributes that are not all
# lowercase.)
elseif ($currentNodeNamespace === static::SVG_NAMESPACE) {
switch ($a->name) {
case 'attributename': $a->name = 'attributeName';
break;
case 'attributetype': $a->name = 'attributeType';
break;
case 'basefrequency': $a->name = 'baseFrequency';
break;
case 'baseprofile': $a->name = 'baseProfile';
break;
case 'calcmode': $a->name = 'calcMode';
break;
case 'clippathunits': $a->name = 'clipPathUnits';
break;
case 'contentscripttype': $a->name = 'contentScriptType';
break;
case 'contentstyletype': $a->name = 'contentStyleType';
break;
case 'diffuseconstant': $a->name = 'diffuseConstant';
break;
case 'edgemode': $a->name = 'edgeMode';
break;
case 'externalresourcesrequired': $a->name = 'externalResourcesRequired';
break;
case 'filterres': $a->name = 'filterRes';
break;
case 'filterunits': $a->name = 'filterUnits';
break;
case 'glyphref': $a->name = 'glyphRef';
break;
case 'gradienttransform': $a->name = 'gradientTransform';
break;
case 'gradientunits': $a->name = 'gradientUnits';
break;
case 'kernelmatrix': $a->name = 'kernelMatrix';
break;
case 'kernelunitlength': $a->name = 'kernelUnitLength';
break;
case 'keypoints': $a->name = 'keyPoints';
break;
case 'keysplines': $a->name = 'keySplines';
break;
case 'keytimes': $a->name = 'keyTimes';
break;
case 'lengthadjust': $a->name = 'lengthAdjust';
break;
case 'limitingconeangle': $a->name = 'limitingConeAngle';
break;
case 'markerheight': $a->name = 'markerHeight';
break;
case 'markerunits': $a->name = 'markerUnits';
break;
case 'markerwidth': $a->name = 'markerWidth';
break;
case 'maskcontentunits': $a->name = 'maskContentUnits';
break;
case 'maskunits': $a->name = 'maskUnits';
break;
case 'numoctaves': $a->name = 'numOctaves';
break;
case 'pathlength': $a->name = 'pathLength';
break;
case 'patterncontentunits': $a->name = 'patternContentUnits';
break;
case 'patterntransform': $a->name = 'patternTransform';
break;
case 'patternunits': $a->name = 'patternUnits';
break;
case 'pointsatx': $a->name = 'pointsAtX';
break;
case 'pointsaty': $a->name = 'pointsAtY';
break;
case 'pointsatz': $a->name = 'pointsAtZ';
break;
case 'preservealpha': $a->name = 'preserveAlpha';
break;
case 'preserveaspectratio': $a->name = 'preserveAspectRatio';
break;
case 'primitiveunits': $a->name = 'primitiveUnits';
break;
case 'refx': $a->name = 'refX';
break;
case 'refy': $a->name = 'refY';
break;
case 'repeatcount': $a->name = 'repeatCount';
break;
case 'repeatdur': $a->name = 'repeatDur';
break;
case 'requiredextensions': $a->name = 'requiredExtensions';
break;
case 'requiredfeatures': $a->name = 'requiredFeatures';
break;
case 'specularconstant': $a->name = 'specularConstant';
break;
case 'specularexponent': $a->name = 'specularExponent';
break;
case 'spreadmethod': $a->name = 'spreadMethod';
break;
case 'startoffset': $a->name = 'startOffset';
break;
case 'stddeviation': $a->name = 'stdDeviation';
break;
case 'stitchtiles': $a->name = 'stitchTiles';
break;
case 'surfacescale': $a->name = 'surfaceScale';
break;
case 'systemlanguage': $a->name = 'systemLanguage';
break;
case 'tablevalues': $a->name = 'tableValues';
break;
case 'targetx': $a->name = 'targetX';
break;
case 'targety': $a->name = 'targetY';
break;
case 'textlength': $a->name = 'textLength';
break;
case 'viewbox': $a->name = 'viewBox';
break;
case 'viewtarget': $a->name = 'viewTarget';
break;
case 'xchannelselector': $a->name = 'xChannelSelector';
break;
case 'ychannelselector': $a->name = 'yChannelSelector';
break;
case 'zoomandpan': $a->name = 'zoomAndPan';
}
}
# Adjust foreign attributes for the token. (This fixes the use of namespaced
# attributes, in particular XLink in SVG.)
# When the steps below require the user agent to adjust foreign attributes for a
# token, then, if any of the attributes on the token match the strings given in
# the first column of the following table, let the attribute be a namespaced
# attribute, with the prefix being the string given in the corresponding cell in
# the second column, the local name being the string given in the corresponding
# cell in the third column, and the namespace being the namespace given in the
# corresponding cell in the fourth column. (This fixes the use of namespaced
# attributes, in particular lang attributes in the XML namespace.)
// DOMElement::setAttributeNS requires the prefix and local name be in one
// string, so there is no need to separate the prefix and the local name here.
switch($a->name) {
case 'xlink:actuate':
case 'xlink:arcrole':
case 'xlink:href':
case 'xlink:role':
case 'xlink:show':
case 'xlink:title':
case 'xlink:type': $a->namespace = static::XLINK_NAMESPACE;
break;
case 'xml:base':
case 'xml:lang':
case 'xml:space': $a->namespace = static::XML_NAMESPACE;
break;
case 'xmlns': $a->namespace = static::XMLNS_NAMESPACE;
break;
case 'xmlns:xlink': $a->namespace = static::XLINK_NAMESPACE;
break;
//default: $node->setAttribute($name, $value);
}
}
# Insert a foreign element for the token, in the same namespace as the adjusted
# current node.
$this->createAndInsertElement($token, null, $adjustedCurrentNode->namespaceURI);
# If the token has its self-closing flag set, then run the appropriate steps
# from the following list:
#
# If the token’s tag name is "script", and the new current node is in the SVG
# namespace
# Acknowledge the token’s *self-closing flag*, and then act as described in the
# steps for a "script" end tag below.
// DEVIATION: Unnecessary because there is no scripting in this implementation.
# Otherwise
# Pop the current node off the stack of open elements and acknowledge the
# token’s *self-closing flag*.
$this->stack->pop();
// Acknowledged.
}
}
# An end tag whose tag name is "script", if the current node is a script element
# in the SVG namespace
// DEVIATION: This implementation does not support scripting, so script elements
// aren't processed differently.
# Any other end tag
elseif ($token instanceof EndTagToken) {
# Run these steps:
#
# 1. Initialize node to be the current node (the bottommost node of the stack).
$node = $currentNode;
$nodeName = $currentNodeName;
# 2. If node is not an element with the same tag name as the token, then this is
# a parse error.
if ($nodeName !== $token->name) {
ParseError::trigger(ParseError::UNEXPECTED_END_TAG, $token->name, $nodeName);
}
# 3. Loop: If node's tag name, converted to ASCII lowercase, is the same as the
# tag name of the token, pop elements from the stack of open elements until node
# has been popped from the stack, and then abort these steps.
$count = $this->stack->length - 1;
while (true) {
if (strtolower($nodeName) === $token->name) {
do {
$popped = $this->stack->pop();
} while ($popped !== $node && !is_null($popped));
break;
}
# 4. Set node to the previous entry in the stack of open elements.
$node = $this->stack[--$count];
$nodeName = $node->nodeName;
# 5. If node is not an element in the HTML namespace, return to the step labeled
# loop.
if ($node->namespaceURI !== static::HTML_NAMESPACE) {
continue;
}
# 6. Otherwise, process the token according to the rules given in the section
# corresponding to the current insertion mode in HTML content.
$this->parseTokenInHTMLContent($token, $this->insertionMode);
break;
}
}
}
protected function appropriatePlaceForInsertingNode(\DOMNode $overrideTarget = null) {
$insertBefore = false;
# 8.2.5.1. Creating and inserting nodes
#
# While the parser is processing a token, it can enable or disable foster
# parenting. This affects the following algorithm.
#
# The appropriate place for inserting a node, optionally using a particular
# override target, is the position in an element returned by running the
# following steps:
# 1. If there was an override target specified, then let target be the override
# target.
$target = (!is_null($overrideTarget)) ? $overrideTarget : $this->stack->currentNode;
# 2. Determine the adjusted insertion location using the first matching steps
# from the following list: If foster parenting is enabled and target is a table,
# tbody, tfoot, thead, or tr element
$targetNodeName = $target->nodeName;
if ($this->fosterParenting && ($targetNodeName === 'table' || $targetNodeName === 'tbody' || $targetNodeName === 'tfoot' || $targetNodeName === 'thead' || $targetNodeName === 'tr')) {
# Run these substeps:
#
# 1. Let last template be the last template element in the stack of open
# elements, if any.
$lastTemplateKey = $this->stack->search('template');
$lastTemplate = $this->stack[$lastTemplateKey];
# 2. Let last table be the last table element in the stack of open elements, if
# any.
$lastTableKey = $this->stack->search('table');
$lastTable = $this->stack[$lastTableKey];
# 3. If there is a last template and either there is no last table, or there is
# one, but last template is lower (more recently added) than last table in the
# stack of open elements, then: let adjusted insertion location be inside last
# template’s template contents, after its last child (if any), and abort these
# substeps.
if ($lastTemplate && (!$lastTable || $lastTable && $lastTemplateKey > $lastTableKey)) {
$insertionLocation = $lastTemplate;
// Abort!
}
# 4. If there is no last table, then let adjusted insertion location be inside
# the first element in the stack of open elements (the html element), after its
# last child (if any), and abort these substeps. (fragment case)
elseif (!$lastTable) {
$insertionLocation = $this->stack[0];
// Abort!
}
# 5. If last table has a parent node, then let adjusted insertion location be
# inside last table’s parent node, immediately before last table, and abort
# these substeps.
elseif ($lastTable->parentNode) {
$insertionLocation = $lastTable;
$insertBefore = true;
// Abort!
}
else {
# 6. Let previous element be the element immediately above last table in the
# stack of open elements.
$previousElement = $this->stack[$lastTableKey - 1];
# 7. Let adjusted insertion location be inside previous element, after its last
# child (if any).
$insertionLocation = $previousElement;
}
}
# Otherwise let adjusted insertion location be inside target, after its last
# child (if any).
else {
$insertionLocation = $target;
}
# 3. If the adjusted insertion location is inside a template element, let it
# instead be inside the template element’s template contents, after its last
# child (if any).
if ($insertionLocation->nodeName === 'template') {
$insertionLocation = $insertionLocation->contents;
}
# 4. Return the adjusted insertion location.
return [
'node' => $insertionLocation,
'insert before' => $insertBefore
];
}
public function insertCharacterToken(CharacterToken $token) {
# 1. Let data be the characters passed to the algorithm, or, if no characters
# were explicitly specified, the character of the character token being
# processed.
// Already provided through the token object.
# 2. Let the adjusted insertion location be the appropriate place for inserting
# a node.
$location = $this->appropriatePlaceForInsertingNode();
$adjustedInsertionLocation = $location['node'];
$insertBefore = $location['insert before'];
# 3. If the adjusted insertion location is in a Document node, then abort these
# steps.
if ((($insertBefore === false) ? $adjustedInsertionLocation : $adjustedInsertionLocation->parentNode) instanceof DOMDocument) {
return;
}
# 4. If there is a Text node immediately before the adjusted insertion location,
# then append data to that Text node’s data.
$previousSibling = ($insertBefore === false) ? $adjustedInsertionLocation->lastChild : $adjustedInsertionLocation->previousSibling;
if ($previousSibling instanceof DOMText) {
$previousSibling->data .= $token->data;
return;
}
# Otherwise, create a new Text node whose data is data and whose node document
# is the same as that of the element in which the adjusted insertion location
# finds itself, and insert the newly created node at the adjusted insertion
# location.
$textNode = $adjustedInsertionLocation->ownerDocument->createTextNode($token->data);
if ($insertBefore === false) {
$adjustedInsertionLocation->appendChild($textNode);
} else {
$adjustedInsertionLocation->parentNode->insertBefore($textNode, $adjustedInsertionLocation);
}
}
public function insertCommentToken(CommentToken $token, \DOMNode $position = null) {
# When the steps below require the user agent to insert a comment while
# processing a comment token, optionally with an explicitly insertion position
# position, the user agent must run the following steps:
# 1. Let data be the data given in the comment token being processed.
// Already provided through the token object.
# 2. If position was specified, then let the adjusted insertion location be
# position. Otherwise, let adjusted insertion location be the appropriate place
# for inserting a node.
if (!is_null($position)) {
$adjustedInsertionLocation = $position;
$insertBefore = false;
} else {
$location = $this->appropriatePlaceForInsertingNode();
$adjustedInsertionLocation = $location['node'];
$insertBefore = $location['insert before'];
}
# 3. Create a Comment node whose data attribute is set to data and whose node
# document is the same as that of the node in which the adjusted insertion
# location finds itself.
$commentNode = $adjustedInsertionLocation->ownerDocument->createComment($data);
# 4. Insert the newly created node at the adjusted insertion location.
if ($insertBefore === false) {
$adjustedInsertionLocation->appendChild($commentNode);
} else {
$adjustedInsertionLocation->parentNode->insertBefore($commentNode, $adjustedInsertionLocation);
}
}
public function insertElement(StartTagToken $token, \DOMNode $intendedParent = null, string $namespace = null) {
if (!is_null($namespace)) {
$namespace = $token->namespace;
}
# When the steps below require the UA to create an element for a token in a
# particular given namespace and with a particular intended parent, the UA must
# run the following steps:
# 1. Let document be intended parent’s node document.
// DEVIATION: Unnecessary because there aren't any nested contexts to consider.
// The document will always be $this->DOM.
# 2. Let local name be the tag name of the token.
// Nope. Don't need it because when creating elements with
// DOMElement::createElementNS the prefix and local name are combined.
// DEVIATION: Steps three through six are unnecessary because there is no
// scripting in this implementation.
# 7. Let element be the result of creating an element given document, local
# name, given namespace, null, and is. If will execute script is true, set the
# synchronous custom elements flag; otherwise, leave it unset.
// DEVIATION: There is no point to setting the synchronous custom elements flag
// and custom element definition; there is no scripting in this implementation.
if ($namespace === static::HTML_NAMESPACE) {
$element = $this->DOM->createElement($token->name);
} else {
$element = $this->DOM->createElementNS($namespace, $token->name);
}
# 8. Append each attribute in the given token to element.
foreach ($token->attributes as $a) {
if ($namespace === static::HTML_NAMESPACE) {
$element->setAttribute($a->name, $a->value);
} else {
$element->setAttributeNS($namespace, $a->name, $a->value);
}
}
# 9. If will execute script is true, then:
# - 1. Let queue be the result of popping the current element queue from the
# custom element reactions stack. (This will be the same element queue as was
# pushed above.)
# - 2. Invoke custom element reactions in queue.
# - 3. Decrement document’s throw-on-dynamic-markup-insertion counter.
// DEVIATION: These steps are unnecessary because there is no scripting in this
// implementation.
# 10. If element has an xmlns attribute *in the XMLNS namespace* whose value is
# not exactly the same as the element’s namespace, that is a parse error.
# Similarly, if element has an xmlns:xlink attribute in the XMLNS namespace
# whose value is not the XLink namespace, that is a parse error.
$xmlns = $element->getAttributeNS(static::XMLNS_NAMESPACE, 'xmlns');
if ($xmlns !== '' && $xmlns !== $element->namespaceURI) {
ParseError::trigger(ParseError::UNEXPECTED_XMLNS_ATTRIBUTE_VALUE, $element->namespaceURI);
}
$xlink = $element->getAttributeNS(static::XMLNS_NAMESPACE, 'xlink');
if ($xlink !== '' && $xlink !== static::XLINK_NAMESPACE) {
ParseError::trigger(ParseError::UNEXPECTED_XMLNS_ATTRIBUTE_VALUE, static::XLINK_NAMESPACE);
}
# 11. If element is a resettable element, invoke its reset algorithm. (This
# initializes the element’s value and checkedness based on the element’s
# attributes.)
// DEVIATION: Unnecessary because there is no scripting in this implementation.
# 12. If element is a form-associated element, and the form element pointer is
# not null, and there is no template element on the stack of open elements, and
# element is either not listed or doesn’t have a form attribute, and the
# intended parent is in the same tree as the element pointed to by the form
# element pointer, associate element with the form element pointed to by the
# form element pointer, and suppress the running of the reset the form owner
# algorithm when the parser subsequently attempts to insert the element.
// DEVIATION: Unnecessary because there is no scripting in this implementation.
# 13. Return element.
// Nope. Going straight into element insertion.
# When the steps below require the user agent to insert an HTML element for a
# token, the user agent must insert a foreign element for the token, in the HTML
# namespace.
# When the steps below require the user agent to insert a foreign element for a
# token in a given namespace, the user agent must run these steps:
// Doing both foreign and HTML elements here because the only difference between
// the two is that foreign elements are inserted with a namespace and HTML
// elements are not.
# 1. Let the adjusted insertion location be the appropriate place for inserting
# a node.
$location = $this->appropriatePlaceForInsertingNode($intendedParent);
$adjustedInsertionLocation = $location['node'];
$insertBefore = $location['insert before'];
# 2. Let element be the result of creating an element for the token in the given
# namespace, with the intended parent being the element in which the adjusted
# insertion location finds itself.
// Element is supplied.
// Have that, too.
# 3. If it is possible to insert element at the adjusted insertion location,
# then:
# - 1. Push a new element queue onto the custom element reactions stack.
// DEVIATION: Unnecessary because there is no scripting in this implementation.
# - 2. Insert element at the adjusted insertion location.
if ($insertBefore === false) {
$adjustedInsertionLocation->appendChild($element);
} else {
$adjustedInsertionLocation->parentNode->insertBefore($element, $adjustedInsertionLocation);
}
# - 3. Pop the element queue from the custom element reactions stack, and
# invoke custom element reactions in that queue.
// DEVIATION: Unnecessary because there is no scripting in this implementation.
# 4. Push element onto the stack of open elements so that it is the new current node.
$this->stack[] = $element;
# Return element.
return $element;
}
protected function genericTextParsingAlgorithm(StartTagToken $token, bool $RAWTEXT = true) {
# The generic raw text element parsing algorithm and the generic RCDATA element
# parsing algorithm consist of the following steps. These algorithms are always
# invoked in response to a start tag token.
# 1. Insert an HTML element for the token.
$this->createandInsertElement($token);
# 2. If the algorithm that was invoked is the generic raw text element parsing
# algorithm, switch the tokenizer to the RAWTEXT state; otherwise the algorithm
# invoked was the generic RCDATA element parsing algorithm, switch the tokenizer
# to the RCDATA state.
$this->tokenizer->state = ($RAWTEXT === true) ? Tokenizer::RAWTEXT_STATE : Tokenizer::RCDATA_STATE;
# 3. Let the original insertion mode be the current insertion mode.
$this->originalInsertionMode = $this->insertionMode;
# 4. Then, switch the insertion mode to "text".
$this->insertionMode = static::TEXT_MODE;
}
protected function genericRawTextParsingAlgorithm(StartTagToken $token) {
$this->genericTextParsingAlgorithm($token, true);
}
protected function genericRCDATAParsingAlgorithm(StartTagToken $token) {
$this->genericTextParsingAlgorithm($token, false);
}
}