FileMaster

Edit File: html-formatter.php

<?php

/**
 * Contact Form 7's class used for formatting HTML fragments.
 */
class WPCF7_HTMLFormatter {

// HTML component types.
	const text = 0;
	const start_tag = 1;
	const end_tag = 2;
	const comment = 3;

/**
	 * Tag name reserved for a custom HTML element used as a block placeholder.
	 */
	const placeholder_block = 'placeholder:block';

/**
	 * Tag name reserved for a custom HTML element used as an inline placeholder.
	 */
	const placeholder_inline = 'placeholder:inline';

/**
	 * The void elements in HTML.
	 *
	 * @link https://developer.mozilla.org/en-US/docs/Glossary/Void_element
	 */
	const void_elements = array(
		'area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input',
		'keygen', 'link', 'meta', 'param', 'source', 'track', 'wbr',
		self::placeholder_block, self::placeholder_inline,
	);

/**
	 * HTML elements that can be a direct child of the same element.
	 */
	const nestable_elements = array(
		'article', 'aside', 'blockquote', 'div', 'fieldset', 'section', 'span',
	);

/**
	 * HTML elements that can contain flow content.
	 */
	const p_parent_elements = array(
		'address', 'article', 'aside', 'blockquote', 'body', 'caption',
		'dd', 'details', 'dialog', 'div', 'dt', 'fieldset', 'figcaption',
		'figure', 'footer', 'form', 'header', 'li', 'main', 'nav',
		'section', 'td', 'th',
	);

/**
	 * HTML elements that can be neither the parent nor a child of
	 * a paragraph element.
	 */
	const p_nonparent_elements = array(
		'colgroup', 'dl', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'head',
		'hgroup', 'html', 'legend', 'menu', 'ol', 'pre', 'style', 'summary',
		'table', 'tbody', 'template', 'tfoot', 'thead', 'title', 'tr', 'ul',
	);

/**
	 * HTML elements in the phrasing content category, plus non-phrasing
	 * content elements that can be grandchildren of a paragraph element.
	 */
	const p_child_elements = array(
		'a', 'abbr', 'area', 'audio', 'b', 'bdi', 'bdo', 'br', 'button',
		'canvas', 'cite', 'code', 'data', 'datalist', 'del', 'dfn',
		'em', 'embed', 'i', 'iframe', 'img', 'input', 'ins', 'kbd',
		'keygen', 'label', 'link', 'map', 'mark', 'meta',
		'meter', 'noscript', 'object', 'output', 'picture', 'progress',
		'q', 'ruby', 's', 'samp', 'script', 'select', 'slot', 'small',
		'span', 'strong', 'sub', 'sup', 'textarea',
		'time', 'u', 'var', 'video', 'wbr',
		'optgroup', 'option', 'rp', 'rt', // non-phrasing grandchildren
		self::placeholder_inline,
	);

/**
	 * HTML elements that can contain phrasing content.
	 */
	const br_parent_elements = array(
		'a', 'abbr', 'address', 'article', 'aside', 'audio', 'b', 'bdi',
		'bdo', 'blockquote', 'button', 'canvas', 'caption', 'cite', 'code',
		'data', 'datalist', 'dd', 'del', 'details', 'dfn', 'dialog', 'div',
		'dt', 'em', 'fieldset', 'figcaption', 'figure', 'footer', 'form',
		'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header', 'i', 'ins', 'kbd',
		'label', 'legend', 'li', 'main', 'map', 'mark', 'meter', 'nav',
		'noscript', 'object', 'output', 'p', 'progress', 'q', 'rt',
		'ruby', 's', 'samp', 'section', 'slot', 'small', 'span', 'strong',
		'sub', 'summary', 'sup', 'td', 'th', 'time', 'u', 'var',
		'video',
	);

// Properties.
	private $options = array();
	private $stacked_elements = array();
	private $output = '';

/**
	 * Constructor.
	 */
	public function __construct( $options = '' ) {
		$this->options = wp_parse_args( $options, array(
			'auto_br' => true,
			'auto_indent' => true,
			'allowed_html' => wpcf7_kses_allowed_html(),
		) );
	}

/**
	 * Separates the given text into chunks of HTML. Each chunk must be an
	 * associative array that includes 'position', 'type', and 'content' keys.
	 *
	 * @param string $input Text to be separated into chunks.
	 * @return iterable Iterable of chunks.
	 */
	public function separate_into_chunks( $input ) {
		$input_bytelength = strlen( $input );
		$position = 0;

while ( $position < $input_bytelength ) {
			$next_tag = preg_match(
				'/(?:|<(?:\/?)[a-z].*?>)/is',
				$input,
				$matches,
				PREG_OFFSET_CAPTURE,
				$position
			);

if ( ! $next_tag ) {
				yield array(
					'position' => $position,
					'type' => self::text,
					'content' => substr( $input, $position ),
				);

break;
			}

$next_tag = $matches[0][0];
			$next_tag_position = $matches[0][1];

if ( $position < $next_tag_position ) {
				yield array(
					'position' => $position,
					'type' => self::text,
					'content' => substr(
						$input,
						$position,
						$next_tag_position - $position
					),
				);
			}

if ( '<!' === substr( $next_tag, 0, 2 ) ) {
				$next_tag_type = self::comment;
			} elseif ( '</' === substr( $next_tag, 0, 2 ) ) {
				$next_tag_type = self::end_tag;
			} else {
				$next_tag_type = self::start_tag;
			}

yield array(
				'position' => $next_tag_position,
				'type' => $next_tag_type,
				'content' => substr(
					$input,
					$next_tag_position,
					strlen( $next_tag )
				),
			);

$position = $next_tag_position + strlen( $next_tag );
		}
	}

/**
	 * Normalizes content in each chunk. This may change the type and position
	 * of the chunk.
	 *
	 * @param iterable $chunks The original chunks.
	 * @return iterable Normalized chunks.
	 */
	public function pre_format( $chunks ) {
		$position = 0;

foreach ( $chunks as $chunk ) {
			$chunk['position'] = $position;

// Standardize newline characters to "\n".
			$chunk['content'] = str_replace(
				array( "\r\n", "\r" ), "\n", $chunk['content']
			);

if ( self::start_tag === $chunk['type'] ) {
				list( $chunk['content'] ) =
					self::normalize_start_tag( $chunk['content'] );

// Replace by a line break.
				if (
					$this->options['auto_br'] and
					preg_match( '/^<br\s*\/?>$/i', $chunk['content'] )
				) {
					$chunk['type'] = self::text;
					$chunk['content'] = "\n";
				}
			}

yield $chunk;
			$position = self::calc_next_position( $chunk );
		}
	}

/**
	 * Concatenates neighboring text chunks to create a single chunk.
	 *
	 * @param iterable $chunks The original chunks.
	 * @return iterable Processed chunks.
	 */
	public function concatenate_texts( $chunks ) {
		$position = 0;
		$text_left = null;

foreach ( $chunks as $chunk ) {
			$chunk['position'] = $position;

if ( self::text === $chunk['type'] ) {
				if ( isset( $text_left ) ) {
					$text_left['content'] .= $chunk['content'];
				} else {
					$text_left = $chunk;
				}

continue;
			}

if ( isset( $text_left ) ) {
				yield $text_left;
				$chunk['position'] = self::calc_next_position( $text_left );
				$text_left = null;
			}

yield $chunk;
			$position = self::calc_next_position( $chunk );
		}

if ( isset( $text_left ) ) {
			yield $text_left;
		}
	}

/**
	 * Outputs formatted HTML based on the given chunks.
	 *
	 * @param iterable $chunks The original chunks.
	 * @return string Formatted HTML.
	 */
	public function format( $chunks ) {
		$chunks = $this->pre_format( $chunks );
		$chunks = $this->concatenate_texts( $chunks );

$this->output = '';
		$this->stacked_elements = array();

foreach ( $chunks as $chunk ) {

if ( self::text === $chunk['type'] ) {
				$this->append_text( $chunk['content'] );
			}

if ( self::start_tag === $chunk['type'] ) {
				$this->start_tag( $chunk['content'] );
			}

if ( self::end_tag === $chunk['type'] ) {
				$this->end_tag( $chunk['content'] );
			}

if ( self::comment === $chunk['type'] ) {
				$this->append_comment( $chunk['content'] );
			}
		}

return $this->output();
	}

/**
	 * Appends preformatted text to the output property.
	 */
	public function append_preformatted( $content ) {
		$this->output .= $content;
	}

/**
	 * Appends whitespace to the output property.
	 */
	public function append_whitespace() {
		$this->append_preformatted( ' ' );
	}

/**
	 * Appends a text node content to the output property.
	 *
	 * @param string $content Text node content.
	 */
	public function append_text( $content ) {
		if ( $this->is_inside( array( 'pre', 'template' ) ) ) {
			$this->append_preformatted( $content );
			return;
		}

if (
			empty( $this->stacked_elements ) or
			$this->has_parent( 'p' ) or
			$this->has_parent( self::p_parent_elements )
		) {
			// Close if the content starts with multiple line breaks.
			if ( preg_match( '/^\s*\n\s*\n\s*/', $content ) ) {
				$this->end_tag( 'p' );
			}

// Split up the contents into paragraphs, separated by double line breaks.
			$paragraphs = preg_split( '/\s*\n\s*\n\s*/', $content );

$paragraphs = array_filter( $paragraphs, static function ( $paragraph ) {
				return '' !== wpcf7_strip_whitespaces( $paragraph );
			} );

$paragraphs = array_values( $paragraphs );

if ( $paragraphs ) {
				if ( $this->is_inside( 'p' ) ) {
					$paragraph = array_shift( $paragraphs );

$paragraph = self::normalize_paragraph(
						$paragraph,
						$this->options['auto_br']
					);

$this->append_preformatted( $paragraph );
				}

foreach ( $paragraphs as $paragraph ) {
					$this->start_tag( 'p' );

$paragraph = wpcf7_strip_whitespaces( $paragraph, 'start' );

$paragraph = self::normalize_paragraph(
						$paragraph,
						$this->options['auto_br']
					);

$this->append_preformatted( $paragraph );
				}
			}

// Close if the content ends with multiple line breaks.
			if ( preg_match( '/\s*\n\s*\n\s*$/', $content ) ) {
				$this->end_tag( 'p' );
			}

// Cases where the content is a single line break.
			if ( preg_match( '/^\s*\n\s*$/', $content ) ) {
				$auto_br = $this->options['auto_br'] && $this->is_inside( 'p' );

$content = self::normalize_paragraph( $content, $auto_br );

$this->append_preformatted( $content );
			}
		} else {
			$auto_br = $this->options['auto_br'] &&
				$this->has_parent( self::br_parent_elements );

$content = self::normalize_paragraph( $content, $auto_br );

$this->append_preformatted( $content );
		}
	}

/**
	 * Appends a start tag to the output property.
	 *
	 * @param string $tag A start tag.
	 */
	public function start_tag( $tag ) {
		list( $tag, $tag_name ) = self::normalize_start_tag( $tag );

if (
			in_array( $tag_name, self::p_child_elements, true ) and
			! $this->is_inside( 'p' ) and
			! $this->is_inside( self::p_child_elements ) and
			! $this->has_parent( self::p_nonparent_elements )
		) {
			// Open if it does not exist.
			$this->start_tag( 'p' );
		}

$this->append_start_tag( $tag_name, array(), $tag );
	}

/**
	 * Appends a start tag to the output property.
	 *
	 * @param string $tag_name Tag name.
	 * @param array $atts Associative array of attribute name and value pairs.
	 * @param string $tag A start tag.
	 */
	public function append_start_tag( $tag_name, $atts = array(), $tag = '' ) {
		if ( ! self::validate_tag_name( $tag_name ) ) {
			wp_trigger_error(
				__METHOD__,
				sprintf(
					/* translators: %s: Invalid HTML tag name */
					__( 'Invalid tag name (%s) is specified.', 'contact-form-7' ),
					$tag_name
				),
				E_USER_WARNING
			);

return false;
		}

if ( WP_DEBUG and ! empty( $this->options['allowed_html'] ) ) {
			$html_disallowance = array();

if ( ! isset( $this->options['allowed_html'][$tag_name] ) ) {
				$html_disallowance = array(
					'element' => $tag_name,
				);
			} else {
				$atts_allowed = $this->options['allowed_html'][$tag_name];

$atts_disallowed = array_diff_ukey( $atts, $atts_allowed,
					static function ( $key_1, $key_2 ) use ( $atts_allowed ) {
						if (
							str_starts_with( $key_1, 'data-' ) and
							! empty( $atts_allowed['data-*'] ) and
							preg_match( '/^data-[a-z0-9_-]+$/', $key_1 )
						) {
							return 0;
						} else {
							return $key_1 === $key_2 ? 0 : 1;
						}
					}
				);

if ( ! empty( $atts_disallowed ) ) {
					$html_disallowance = array(
						'element' => $tag_name,
						'attributes' => array_keys( $atts_disallowed ),
					);
				}
			}

if ( $html_disallowance ) {
				$notice = sprintf(
					/* translators: %s: JSON-formatted array of disallowed HTML */
					__( 'HTML Disallowance: %s', 'contact-form-7' ),
					wp_json_encode( $html_disallowance, JSON_PRETTY_PRINT )
				);

wp_trigger_error( __METHOD__, $notice, E_USER_NOTICE );
			}
		}

if (
			'p' === $tag_name or
			in_array( $tag_name, self::p_parent_elements, true ) or
			in_array( $tag_name, self::p_nonparent_elements, true )
		) {
			// Close if it exists.
			$this->end_tag( 'p' );
		}

if ( 'dd' === $tag_name or 'dt' === $tag_name ) {
			// Close <dd> and <dt> if closing tag is omitted.
			$this->end_tag( 'dd' );
			$this->end_tag( 'dt' );
		}

if ( 'li' === $tag_name ) {
			// Close <li> if closing tag is omitted.
			$this->end_tag( 'li' );
		}

if ( 'optgroup' === $tag_name ) {
			// Close <option> and <optgroup> if closing tag is omitted.
			$this->end_tag( 'option' );
			$this->end_tag( 'optgroup' );
		}

if ( 'option' === $tag_name ) {
			// Close <option> if closing tag is omitted.
			$this->end_tag( 'option' );
		}

if ( 'rp' === $tag_name or 'rt' === $tag_name ) {
			// Close <rp> and <rt> if closing tag is omitted.
			$this->end_tag( 'rp' );
			$this->end_tag( 'rt' );
		}

if ( 'td' === $tag_name or 'th' === $tag_name ) {
			// Close <td> and <th> if closing tag is omitted.
			$this->end_tag( 'td' );
			$this->end_tag( 'th' );
		}

if ( 'tr' === $tag_name ) {
			// Close <tr> if closing tag is omitted.
			$this->end_tag( 'tr' );
		}

if ( 'tbody' === $tag_name or 'tfoot' === $tag_name ) {
			// Close <thead> if closing tag is omitted.
			$this->end_tag( 'thead' );
		}

if ( 'tfoot' === $tag_name ) {
			// Close <tbody> if closing tag is omitted.
			$this->end_tag( 'tbody' );
		}

if (
			$this->has_parent( $tag_name ) and
			! in_array( $tag_name, self::nestable_elements, true )
		) {
			$this->end_tag( $tag_name );
		}

if ( ! in_array( $tag_name, self::void_elements, true ) ) {
			array_unshift( $this->stacked_elements, $tag_name );
		}

if ( ! in_array( $tag_name, self::p_child_elements, true ) ) {
			if ( '' !== $this->output ) {
				$this->output = wpcf7_strip_whitespaces( $this->output, 'end' ) . "\n";
			}

if ( $this->options['auto_indent'] ) {
				$this->append_preformatted(
					self::indent( count( $this->stacked_elements ) - 1 )
				);
			}
		}

if ( $tag ) {
			$this->append_preformatted( $tag );
		} elseif ( $atts ) {
			if ( in_array( $tag_name, self::void_elements, true ) ) {
				$this->append_preformatted(
					sprintf(
						'<%1$s %2$s />',
						$tag_name,
						wpcf7_format_atts( $atts )
					)
				);
			} else {
				$this->append_preformatted(
					sprintf(
						'<%1$s %2$s>',
						$tag_name,
						wpcf7_format_atts( $atts )
					)
				);
			}
		} else {
			if ( in_array( $tag_name, self::void_elements, true ) ) {
				$this->append_preformatted(
					sprintf(
						'<%s />',
						$tag_name
					)
				);
			} else {
				$this->append_preformatted(
					sprintf(
						'<%s>',
						$tag_name
					)
				);
			}
		}
	}

/**
	 * Closes an element and its open descendants at a time.
	 *
	 * @param string $tag An end tag.
	 */
	public function end_tag( $tag ) {
		if ( preg_match( '/<\/(.+?)(?:\s|>)/', $tag, $matches ) ) {
			$tag_name = strtolower( $matches[1] );
		} else {
			$tag_name = strtolower( $tag );
		}

$stacked_elements = array_values( $this->stacked_elements );

$tag_position = array_search( $tag_name, $stacked_elements, true );

if ( false === $tag_position ) {
			return;
		}

// Element groups that make up an indirect nesting structure.
		// Descendant can contain ancestors.
		static $nesting_families = array(
			array(
				'ancestors' => array( 'dl' ),
				'descendants' => array( 'dd', 'dt' ),
			),
			array(
				'ancestors' => array( 'ol', 'ul', 'menu' ),
				'descendants' => array( 'li' ),
			),
			array(
				'ancestors' => array( 'table' ),
				'descendants' => array( 'td', 'th', 'tr', 'thead', 'tbody', 'tfoot' ),
			),
		);

foreach ( $nesting_families as $family ) {
			$ancestors = (array) $family['ancestors'];
			$descendants = (array) $family['descendants'];

if ( in_array( $tag_name, $descendants, true ) ) {
				$intersect = array_intersect(
					$ancestors,
					array_slice( $stacked_elements, 0, $tag_position )
				);

if ( $intersect ) { // Ancestor appears after descendant.
					return;
				}
			}
		}

while ( $element = array_shift( $this->stacked_elements ) ) {
			$this->append_end_tag( $element );

if ( $element === $tag_name ) {
				break;
			}
		}
	}

/**
	 * Appends an end tag to the output property.
	 *
	 * @param string $tag_name Tag name.
	 */
	public function append_end_tag( $tag_name ) {
		if ( ! in_array( $tag_name, self::p_child_elements, true ) ) {
			// Remove unnecessary .
			$this->output = preg_replace( '/\s* \s*$/', '', $this->output );

$this->output = wpcf7_strip_whitespaces( $this->output, 'end' ) . "\n";

if ( $this->options['auto_indent'] ) {
				$this->append_preformatted(
					self::indent( count( $this->stacked_elements ) )
				);
			}
		}

$this->append_preformatted(
			sprintf( '</%s>', $tag_name )
		);

// Remove trailing .
		$this->output = preg_replace( '/\s*<\/p>$/', '', $this->output );
	}

/**
	 * Closes all open tags.
	 */
	public function close_all_tags() {
		while ( $element = array_shift( $this->stacked_elements ) ) {
			$this->append_end_tag( $element );
		}
	}

/**
	 * Appends an HTML comment to the output property.
	 *
	 * @param string $tag An HTML comment.
	 */
	public function append_comment( $tag ) {
		$this->append_preformatted( $tag );
	}

/**
	 * Returns true if it is currently inside one of HTML elements specified
	 * by tag names.
	 *
	 * @param string|array $tag_names A tag name or an array of tag names.
	 */
	public function is_inside( $tag_names ) {
		$tag_names = (array) $tag_names;

foreach ( $this->stacked_elements as $element ) {
			if ( in_array( $element, $tag_names, true ) ) {
				return true;
			}
		}

return false;
	}

/**
	 * Returns true if the parent node is one of HTML elements specified
	 * by tag names.
	 *
	 * @param string|array $tag_names A tag name or an array of tag names.
	 */
	public function has_parent( $tag_names ) {
		$tag_names = (array) $tag_names;

$parent = reset( $this->stacked_elements );

if ( false === $parent ) {
			return false;
		}

return in_array( $parent, $tag_names, true );
	}

/**
	 * Calls the callback given by the first parameter. The buffered output
	 * will be appended to the output property.
	 */
	public function call_user_func( $callback, ...$args ) {
		ob_start();
		$result = call_user_func( $callback, ...$args );
		$output = ob_get_clean();

if ( false !== $output ) {
			$this->append_preformatted( "\n" . $output . "\n" );
		}

return $result;
	}

/**
	 * Closes all remaining tags, returns and resets the output.
	 */
	public function output() {
		$this->close_all_tags();

$output = $this->output;
		$this->output = '';

return $output;
	}

/**
	 * Prints the output. Returns false if the allowed_html option is empty.
	 */
	public function print() {
		if ( empty( $this->options['allowed_html'] ) ) {
			return false;
		}

echo wp_kses( $this->output(), $this->options['allowed_html'] );
	}

/**
	 * Calculates the position of the next chunk based on the position and
	 * length of the current chunk.
	 *
	 * @param array $chunk An associative array of the current chunk.
	 * @return int The position of the next chunk.
	 */
	public static function calc_next_position( $chunk ) {
		return $chunk['position'] + strlen( $chunk['content'] );
	}

/**
	 * Outputs a set of tabs to indent.
	 *
	 * @param int $level Indentation level.
	 * @return string A series of tabs.
	 */
	public static function indent( $level ) {
		$level = (int) $level;

if ( 0 < $level ) {
			return str_repeat( "\t", $level );
		}

return '';
	}

/**
	 * Normalizes a start tag.
	 *
	 * @param string $tag A start tag or a tag name.
	 * @return array An array includes the normalized start tag and tag name.
	 */
	public static function normalize_start_tag( $tag ) {
		if ( preg_match( '/<(.+?)[\s\/>]/', $tag, $matches ) ) {
			$tag_name = strtolower( $matches[1] );
		} else {
			$tag_name = strtolower( $tag );
			$tag = sprintf( '<%s>', $tag_name );
		}

if ( in_array( $tag_name, self::void_elements, true ) ) {
			// Normalize void element.
			$tag = preg_replace( '/\s*\/?>/', ' />', $tag );
		}

return array( $tag, $tag_name );
	}

/**
	 * Normalizes a paragraph of text.
	 *
	 * @param string $paragraph A paragraph of text.
	 * @param bool $auto_br Optional. If true, line breaks will be replaced
	 * by a br element.
	 * @return string The normalized paragraph.
	 */
	public static function normalize_paragraph( $paragraph, $auto_br = false ) {
		if ( $auto_br ) {
			$paragraph = preg_replace( '/\s*\n\s*/', " \n", $paragraph );
		}

$paragraph = preg_replace( '/[ ]+/', ' ', $paragraph );

return $paragraph;
	}

/**
	 * Returns true if the specified tag name is valid.
	 */
	public static function validate_tag_name( $tag_name ) {
		return preg_match( '/^[a-z][0-9a-z]*(?:[:][a-z][0-9a-z]*)?$/', $tag_name );
	}

}

Back