<?php

/**

 * Main WordPress Formatting API.

 *

 * Handles many functions for formatting output.

 *

 * @package WordPress

 */

/**

 * Replaces common plain text characters with formatted entities.

 *

 * Returns given text with transformations of quotes into smart quotes, apostrophes,

 * dashes, ellipses, the trademark symbol, and the multiplication symbol.

 *

 * As an example,

 *

 *     'cause today's effort makes it worth tomorrow's "holiday" ...

 *

 * Becomes:

 *

 *     ’cause today’s effort makes it worth tomorrow’s “holiday” …

 *

 * Code within certain HTML blocks are skipped.

 *

 * Do not use this function before the {@see 'init'} action hook; everything will break.

 *

 * @since 0.71

 *

 * @global array $wp_cockneyreplace Array of formatted entities for certain common phrases.

 * @global array $shortcode_tags

 *

 * @param string $text  The text to be formatted.

 * @param bool   $reset Set to true for unit testing. Translated patterns will reset.

 * @return string The string replaced with HTML entities.

 */

function wptexturize( $text, $reset = false ) {

	global $wp_cockneyreplace, $shortcode_tags;

	static $static_characters            = null,

		$static_replacements             = null,

		$dynamic_characters              = null,

		$dynamic_replacements            = null,

		$default_no_texturize_tags       = null,

		$default_no_texturize_shortcodes = null,

		$run_texturize                   = true,

		$apos                            = null,

		$prime                           = null,

		$double_prime                    = null,

		$opening_quote                   = null,

		$closing_quote                   = null,

		$opening_single_quote            = null,

		$closing_single_quote            = null,

		$open_q_flag                     = '<!--oq-->',

		$open_sq_flag                    = '<!--osq-->',

		$apos_flag                       = '<!--apos-->';

	// If there's nothing to do, just stop.

	if ( empty( $text ) || false === $run_texturize ) {

		return $text;

	}

	// Set up static variables. Run once only.

	if ( $reset || ! isset( $static_characters ) ) {

		/**

		 * Filters whether to skip running wptexturize().

		 *

		 * Returning false from the filter will effectively short-circuit wptexturize()

		 * and return the original text passed to the function instead.

		 *

		 * The filter runs only once, the first time wptexturize() is called.

		 *

		 * @since 4.0.0

		 *

		 * @see wptexturize()

		 *

		 * @param bool $run_texturize Whether to short-circuit wptexturize().

		 */

		$run_texturize = apply_filters( 'run_wptexturize', $run_texturize );

		if ( false === $run_texturize ) {

			return $text;

		}

		/* translators: Opening curly double quote. */

		$opening_quote = _x( '“', 'opening curly double quote' );

		/* translators: Closing curly double quote. */

		$closing_quote = _x( '”', 'closing curly double quote' );

		/* translators: Apostrophe, for example in 'cause or can't. */

		$apos = _x( '’', 'apostrophe' );

		/* translators: Prime, for example in 9' (nine feet). */

		$prime = _x( '′', 'prime' );

		/* translators: Double prime, for example in 9" (nine inches). */

		$double_prime = _x( '″', 'double prime' );

		/* translators: Opening curly single quote. */

		$opening_single_quote = _x( '‘', 'opening curly single quote' );

		/* translators: Closing curly single quote. */

		$closing_single_quote = _x( '’', 'closing curly single quote' );

		/* translators: En dash. */

		$en_dash = _x( '–', 'en dash' );

		/* translators: Em dash. */

		$em_dash = _x( '—', 'em dash' );

		$default_no_texturize_tags       = array( 'pre', 'code', 'kbd', 'style', 'script', 'tt' );

		$default_no_texturize_shortcodes = array( 'code' );

		// If a plugin has provided an autocorrect array, use it.

		if ( isset( $wp_cockneyreplace ) ) {

			$cockney        = array_keys( $wp_cockneyreplace );

			$cockneyreplace = array_values( $wp_cockneyreplace );

		} else {

			/*

			 * translators: This is a comma-separated list of words that defy the syntax of quotations in normal use,

			 * for example... 'We do not have enough words yet'... is a typical quoted phrase. But when we write

			 * lines of code 'til we have enough of 'em, then we need to insert apostrophes instead of quotes.

			 */

			$cockney = explode(

				',',

				_x(

					"'tain't,'twere,'twas,'tis,'twill,'til,'bout,'nuff,'round,'cause,'em",

					'Comma-separated list of words to texturize in your language'

				)

			);

			$cockneyreplace = explode(

				',',

				_x(

					'’tain’t,’twere,’twas,’tis,’twill,’til,’bout,’nuff,’round,’cause,’em',

					'Comma-separated list of replacement words in your language'

				)

			);

		}

		$static_characters   = array_merge( array( '...', '``', '\'\'', ' (tm)' ), $cockney );

		$static_replacements = array_merge( array( '…', $opening_quote, $closing_quote, ' ™' ), $cockneyreplace );

		/*

		 * Pattern-based replacements of characters.

		 * Sort the remaining patterns into several arrays for performance tuning.

		 */

		$dynamic_characters   = array(

			'apos'  => array(),

			'quote' => array(),

			'dash'  => array(),

		);

		$dynamic_replacements = array(

			'apos'  => array(),

			'quote' => array(),

			'dash'  => array(),

		);

		$dynamic              = array();

		$spaces               = wp_spaces_regexp();

		// '99' and '99" are ambiguous among other patterns; assume it's an abbreviated year at the end of a quotation.

		if ( "'" !== $apos || "'" !== $closing_single_quote ) {

			$dynamic[ '/\'(\d\d)\'(?=\Z|[.,:;!?)}\-\]]|>|' . $spaces . ')/' ] = $apos_flag . '$1' . $closing_single_quote;

		}

		if ( "'" !== $apos || '"' !== $closing_quote ) {

			$dynamic[ '/\'(\d\d)"(?=\Z|[.,:;!?)}\-\]]|>|' . $spaces . ')/' ] = $apos_flag . '$1' . $closing_quote;

		}

		// '99 '99s '99's (apostrophe)  But never '9 or '99% or '999 or '99.0.

		if ( "'" !== $apos ) {

			$dynamic['/\'(?=\d\d(?:\Z|(?![%\d]|[.,]\d)))/'] = $apos_flag;

		}

		// Quoted numbers like '0.42'.

		if ( "'" !== $opening_single_quote && "'" !== $closing_single_quote ) {

			$dynamic[ '/(?<=\A|' . $spaces . ')\'(\d[.,\d]*)\'/' ] = $open_sq_flag . '$1' . $closing_single_quote;

		}

		// Single quote at start, or preceded by (, {, <, [, ", -, or spaces.

		if ( "'" !== $opening_single_quote ) {

			$dynamic[ '/(?<=\A|[([{"\-]|&lt;|' . $spaces . ')\'/' ] = $open_sq_flag;

		}

		// Apostrophe in a word. No spaces, double apostrophes, or other punctuation.

		if ( "'" !== $apos ) {

			$dynamic[ '/(?<!' . $spaces . ')\'(?!\Z|[.,:;!?"\'(){}[\]\-]|&[lg]t;|' . $spaces . ')/' ] = $apos_flag;

		}

		$dynamic_characters['apos']   = array_keys( $dynamic );

		$dynamic_replacements['apos'] = array_values( $dynamic );

		$dynamic                      = array();

		// Quoted numbers like "42".

		if ( '"' !== $opening_quote && '"' !== $closing_quote ) {

			$dynamic[ '/(?<=\A|' . $spaces . ')"(\d[.,\d]*)"/' ] = $open_q_flag . '$1' . $closing_quote;

		}

		// Double quote at start, or preceded by (, {, <, [, -, or spaces, and not followed by spaces.

		if ( '"' !== $opening_quote ) {

			$dynamic[ '/(?<=\A|[([{\-]|&lt;|' . $spaces . ')"(?!' . $spaces . ')/' ] = $open_q_flag;

		}

		$dynamic_characters['quote']   = array_keys( $dynamic );

		$dynamic_replacements['quote'] = array_values( $dynamic );

		$dynamic                       = array();

		// Dashes and spaces.

		$dynamic['/---/'] = $em_dash;

		$dynamic[ '/(?<=^|' . $spaces . ')--(?=$|' . $spaces . ')/' ] = $em_dash;

		$dynamic['/(?<!xn)--/']                                       = $en_dash;

		$dynamic[ '/(?<=^|' . $spaces . ')-(?=$|' . $spaces . ')/' ]  = $en_dash;

		$dynamic_characters['dash']   = array_keys( $dynamic );

		$dynamic_replacements['dash'] = array_values( $dynamic );

	}

	// Must do this every time in case plugins use these filters in a context sensitive manner.

	/**

	 * Filters the list of HTML elements not to texturize.

	 *

	 * @since 2.8.0

	 *

	 * @param string[] $default_no_texturize_tags An array of HTML element names.

	 */

	$no_texturize_tags = apply_filters( 'no_texturize_tags', $default_no_texturize_tags );

	/**

	 * Filters the list of shortcodes not to texturize.

	 *

	 * @since 2.8.0

	 *

	 * @param string[] $default_no_texturize_shortcodes An array of shortcode names.

	 */

	$no_texturize_shortcodes = apply_filters( 'no_texturize_shortcodes', $default_no_texturize_shortcodes );

	$no_texturize_tags_stack       = array();

	$no_texturize_shortcodes_stack = array();

	// Look for shortcodes and HTML elements.

	preg_match_all( '@\[/?([^<>&/\[\]\x00-\x20=]++)@', $text, $matches );

	$tagnames         = array_intersect( array_keys( $shortcode_tags ), $matches[1] );

	$found_shortcodes = ! empty( $tagnames );

	$shortcode_regex  = $found_shortcodes ? _get_wptexturize_shortcode_regex( $tagnames ) : '';

	$regex            = _get_wptexturize_split_regex( $shortcode_regex );

	$textarr = preg_split( $regex, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY );

	foreach ( $textarr as &$curl ) {

		// Only call _wptexturize_pushpop_element if $curl is a delimiter.

		$first = $curl[0];

		if ( '<' === $first ) {

			if ( str_starts_with( $curl, '<!--' ) ) {

				// This is an HTML comment delimiter.

				continue;

			} else {

				// This is an HTML element delimiter.

				// Replace each & with & unless it already looks like an entity.

				$curl = preg_replace( '/&(?!#(?:\d+|x[a-f0-9]+);|[a-z1-4]{1,8};)/i', '&', $curl );

				_wptexturize_pushpop_element( $curl, $no_texturize_tags_stack, $no_texturize_tags );

			}

		} elseif ( '' === trim( $curl ) ) {

			// This is a newline between delimiters. Performance improves when we check this.

			continue;

		} elseif ( '[' === $first && $found_shortcodes && 1 === preg_match( '/^' . $shortcode_regex . '$/', $curl ) ) {

			// This is a shortcode delimiter.

			if ( ! str_starts_with( $curl, '[[' ) && ! str_ends_with( $curl, ']]' ) ) {

				// Looks like a normal shortcode.

				_wptexturize_pushpop_element( $curl, $no_texturize_shortcodes_stack, $no_texturize_shortcodes );

			} else {

				// Looks like an escaped shortcode.

				continue;

			}

		} elseif ( empty( $no_texturize_shortcodes_stack ) && empty( $no_texturize_tags_stack ) ) {

			// This is neither a delimiter, nor is this content inside of no_texturize pairs. Do texturize.

			$curl = str_replace( $static_characters, $static_replacements, $curl );

			if ( str_contains( $curl, "'" ) ) {

				$curl = preg_replace( $dynamic_characters['apos'], $dynamic_replacements['apos'], $curl );

				$curl = wptexturize_primes( $curl, "'", $prime, $open_sq_flag, $closing_single_quote );

				$curl = str_replace( $apos_flag, $apos, $curl );

				$curl = str_replace( $open_sq_flag, $opening_single_quote, $curl );

			}

			if ( str_contains( $curl, '"' ) ) {

				$curl = preg_replace( $dynamic_characters['quote'], $dynamic_replacements['quote'], $curl );

				$curl = wptexturize_primes( $curl, '"', $double_prime, $open_q_flag, $closing_quote );

				$curl = str_replace( $open_q_flag, $opening_quote, $curl );

			}

			if ( str_contains( $curl, '-' ) ) {

				$curl = preg_replace( $dynamic_characters['dash'], $dynamic_replacements['dash'], $curl );

			}

			// 9x9 (times), but never 0x9999.

			if ( 1 === preg_match( '/(?<=\d)x\d/', $curl ) ) {

				// Searching for a digit is 10 times more expensive than for the x, so we avoid doing this one!

				$curl = preg_replace( '/\b(\d(?(?<=0)[\d\.,]+|[\d\.,]*))x(\d[\d\.,]*)\b/', '$1&#215;$2', $curl );

			}

			// Replace each & with & unless it already looks like an entity.

			$curl = preg_replace( '/&(?!#(?:\d+|x[a-f0-9]+);|[a-z1-4]{1,8};)/i', '&', $curl );

		}

	}

	return implode( '', $textarr );

}

/**

 * Implements a logic tree to determine whether or not "7'." represents seven feet,

 * then converts the special char into either a prime char or a closing quote char.

 *

 * @since 4.3.0

 *

 * @param string $haystack    The plain text to be searched.

 * @param string $needle      The character to search for such as ' or ".

 * @param string $prime       The prime char to use for replacement.

 * @param string $open_quote  The opening quote char. Opening quote replacement must be

 *                            accomplished already.

 * @param string $close_quote The closing quote char to use for replacement.

 * @return string The $haystack value after primes and quotes replacements.

 */

function wptexturize_primes( $haystack, $needle, $prime, $open_quote, $close_quote ) {

	$spaces           = wp_spaces_regexp();

	$flag             = '<!--wp-prime-or-quote-->';

	$quote_pattern    = "/$needle(?=\\Z|[.,:;!?)}\\-\\]]|>|" . $spaces . ')/';

	$prime_pattern    = "/(?<=\\d)$needle/";

	$flag_after_digit = "/(?<=\\d)$flag/";

	$flag_no_digit    = "/(?<!\\d)$flag/";

	$sentences = explode( $open_quote, $haystack );

	foreach ( $sentences as $key => &$sentence ) {

		if ( ! str_contains( $sentence, $needle ) ) {

			continue;

		} elseif ( 0 !== $key && 0 === substr_count( $sentence, $close_quote ) ) {

			$sentence = preg_replace( $quote_pattern, $flag, $sentence, -1, $count );

			if ( $count > 1 ) {

				// This sentence appears to have multiple closing quotes. Attempt Vulcan logic.

				$sentence = preg_replace( $flag_no_digit, $close_quote, $sentence, -1, $count2 );

				if ( 0 === $count2 ) {

					// Try looking for a quote followed by a period.

					$count2 = substr_count( $sentence, "$flag." );

					if ( $count2 > 0 ) {

						// Assume the rightmost quote-period match is the end of quotation.

						$pos = strrpos( $sentence, "$flag." );

					} else {

						/*

						 * When all else fails, make the rightmost candidate a closing quote.

						 * This is most likely to be problematic in the context of bug #18549.

						 */

						$pos = strrpos( $sentence, $flag );

					}

					$sentence = substr_replace( $sentence, $close_quote, $pos, strlen( $flag ) );

				}

				// Use conventional replacement on any remaining primes and quotes.

				$sentence = preg_replace( $prime_pattern, $prime, $sentence );

				$sentence = preg_replace( $flag_after_digit, $prime, $sentence );

				$sentence = str_replace( $flag, $close_quote, $sentence );

			} elseif ( 1 === $count ) {

				// Found only one closing quote candidate, so give it priority over primes.

				$sentence = str_replace( $flag, $close_quote, $sentence );

				$sentence = preg_replace( $prime_pattern, $prime, $sentence );

			} else {

				// No closing quotes found. Just run primes pattern.

				$sentence = preg_replace( $prime_pattern, $prime, $sentence );

			}

		} else {

			$sentence = preg_replace( $prime_pattern, $prime, $sentence );

			$sentence = preg_replace( $quote_pattern, $close_quote, $sentence );

		}

		if ( '"' === $needle && str_contains( $sentence, '"' ) ) {

			$sentence = str_replace( '"', $close_quote, $sentence );

		}

	}

	return implode( $open_quote, $sentences );

}

/**

 * Searches for disabled element tags. Pushes element to stack on tag open

 * and pops on tag close.

 *

 * Assumes first char of `$text` is tag opening and last char is tag closing.

 * Assumes second char of `$text` is optionally `/` to indicate closing as in `</html>`.

 *

 * @since 2.9.0

 * @access private

 *

 * @param string   $text              Text to check. Must be a tag like `<html>` or `[shortcode]`.

 * @param string[] $stack             Array of open tag elements.

 * @param string[] $disabled_elements Array of tag names to match against. Spaces are not allowed in tag names.

 */

function _wptexturize_pushpop_element( $text, &$stack, $disabled_elements ) {

	// Is it an opening tag or closing tag?

	if ( isset( $text[1] ) && '/' !== $text[1] ) {

		$opening_tag = true;

		$name_offset = 1;

	} elseif ( 0 === count( $stack ) ) {

		// Stack is empty. Just stop.

		return;

	} else {

		$opening_tag = false;

		$name_offset = 2;

	}

	// Parse out the tag name.

	$space = strpos( $text, ' ' );

	if ( false === $space ) {

		$space = -1;

	} else {

		$space -= $name_offset;

	}

	$tag = substr( $text, $name_offset, $space );

	// Handle disabled tags.

	if ( in_array( $tag, $disabled_elements, true ) ) {

		if ( $opening_tag ) {

			/*

			 * This disables texturize until we find a closing tag of our type

			 * (e.g. <pre>) even if there was invalid nesting before that.

			 *

			 * Example: in the case <pre>sadsadasd</code>"baba"</pre>

			 *          "baba" won't be texturized.

			 */

			array_push( $stack, $tag );

		} elseif ( end( $stack ) === $tag ) {

			array_pop( $stack );

		}

	}

}

/**

 * Replaces double line breaks with paragraph elements.

 *

 * A group of regex replaces used to identify text formatted with newlines and

 * replace double line breaks with HTML paragraph tags. The remaining line breaks

 * after conversion become `<br />` tags, unless `$br` is set to '0' or 'false'.

 *

 * @since 0.71

 *

 * @param string $text The text which has to be formatted.

 * @param bool   $br   Optional. If set, this will convert all remaining line breaks

 *                     after paragraphing. Line breaks within `<script>`, `<style>`,

 *                     and `<svg>` tags are not affected. Default true.

 * @return string Text which has been converted into correct paragraph tags.

 */

function wpautop( $text, $br = true ) {

	$pre_tags = array();

	if ( trim( $text ) === '' ) {

		return '';

	}

	// Just to make things a little easier, pad the end.

	$text = $text . "\n";

	/*

	 * Pre tags shouldn't be touched by autop.

	 * Replace pre tags with placeholders and bring them back after autop.

	 */

	if ( str_contains( $text, '<pre' ) ) {

		$text_parts = explode( '</pre>', $text );

		$last_part  = array_pop( $text_parts );

		$text       = '';

		$i          = 0;

		foreach ( $text_parts as $text_part ) {

			$start = strpos( $text_part, '<pre' );

			// Malformed HTML?

			if ( false === $start ) {

				$text .= $text_part;

				continue;

			}

			$name              = "<pre wp-pre-tag-$i></pre>";

			$pre_tags[ $name ] = substr( $text_part, $start ) . '</pre>';

			$text .= substr( $text_part, 0, $start ) . $name;

			++$i;

		}

		$text .= $last_part;

	}

	// Change multiple <br>'s into two line breaks, which will turn into paragraphs.

	$text = preg_replace( '|<br\s*/?>\s*<br\s*/?>|', "\n\n", $text );

	$allblocks = '(?:table|thead|tfoot|caption|col|colgroup|tbody|tr|td|th|div|dl|dd|dt|ul|ol|li|pre|form|map|area|blockquote|address|style|p|h[1-6]|hr|fieldset|legend|section|article|aside|hgroup|header|footer|nav|figure|figcaption|details|menu|summary)';