#I LOVE YOU EVERDAY#

<?php
/**
 * @package The_SEO_Framework\Classes\Facade\Render
 * @subpackage The_SEO_Framework\Front
 */

namespace The_SEO_Framework;

\defined( 'THE_SEO_FRAMEWORK_PRESENT' ) or die;

/**
 * The SEO Framework plugin
 * Copyright (C) 2015 - 2023 Sybre Waaijer, CyberWire B.V. (https://cyberwire.nl/)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as published
 * by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Class The_SEO_Framework\Render
 *
 * Puts all data into HTML valid meta tags.
 *
 * @since 2.8.0
 */
class Render extends Admin_Init {

/**
	 * Returns the document title.
	 *
	 * This method serves as a callback for filter `pre_get_document_title`.
	 * Use tsf()->get_title() instead.
	 *
	 * @since 3.1.0
	 * @see $this->get_title()
	 *
	 * @param string $title The filterable title.
	 * @return string The document title
	 */
	public function get_document_title( $title = '' ) {

if ( ! $this->query_supports_seo() )
			return $title;

/**
		 * @since 3.1.0
		 * @param string $title The generated title.
		 * @param int    $id    The page or term ID.
		 */
		return \apply_filters_ref_array(
			'the_seo_framework_pre_get_document_title',
			[
				$this->get_title(),
				$this->get_the_real_ID(),
			]
		);
	}

/**
	 * Returns the document title.
	 *
	 * This method serves as a callback for filter `wp_title`.
	 * Use tsf()->get_title() instead.
	 *
	 * @since 3.1.0
	 * @since 4.0.0 Removed extraneous, unused parameters.
	 * @see $this->get_title()
	 *
	 * @param string $title The filterable title.
	 * @return string $title
	 */
	public function get_wp_title( $title = '' ) {

if ( ! $this->query_supports_seo() )
			return $title;

/**
		 * @since 3.1.0
		 * @param string $title The generated title.
		 * @param int    $id    The page or term ID.
		 */
		return \apply_filters_ref_array(
			'the_seo_framework_wp_title',
			[
				$this->get_title(),
				$this->get_the_real_ID(),
			]
		);
	}

/**
	 * Caches current Image URL in static variable.
	 * To be used on the front-end only.
	 *
	 * @since 2.2.2
	 * @since 2.7.0 $get_id parameter has been added.
	 * @since 4.0.0 Now uses the new image generator.
	 * @since 4.1.2 Now forwards the `multi_og_image` option to the generator. Although
	 *              it'll always use just one image, we read this option so we'll only
	 *              use a single cache instance internally with the generator.
	 *
	 * @return string The image URL.
	 */
	public function get_image_from_cache() {

foreach ( $this->get_image_details_from_cache( ! $this->get_option( 'multi_og_image' ) ) as $image ) {
			$url = $image['url'];
			if ( $url ) break;
		}

return $url ?? '';
	}

/**
	 * Returns the current Twitter card type.
	 * Memoizes the return value.
	 *
	 * @since 2.8.2
	 * @since 3.1.0 Filter has been moved to generate_twitter_card_type()
	 *
	 * @return string The cached Twitter card.
	 */
	public function get_current_twitter_card_type() {
		return memo() ?? memo( $this->generate_twitter_card_type() );
	}

/**
	 * Renders an XHTML element. Sane drop-in for DOMDocument and whatnot.
	 *
	 * Even though most (if not all) WordPress sites use HTML5, we expect some still use XHTML.
	 * We expect HTML5 fully on the back-end.
	 *
	 * This method should not be used by you. Eventually, it'll print or spawn demigods.
	 *
	 * @since 4.1.4
	 * @access protected
	 *         Not finished for 'public' use; method may (will) change unannounced.
	 * @internal
	 * @link <https://github.com/sybrew/the-seo-framework/commit/894d7d3a74e0ed6890b6e8851ef0866df15ea522>
	 *       Which is something we eventually want to go to, but that's not ready yet.
	 *
	 * @param array       $attributes Associative array of tag names and tag values : {
	 *    string $name => string $value
	 * }
	 * @param string      $tag      The element's tag-name.
	 * @param bool|string $text     The element's contents, if any.
	 * @param bool        $new_line Whether to add a new line to the end of the element.
	 */
	public function render_element( $attributes = [], $tag = 'meta', $text = false, $new_line = true ) {

$attr = '';

foreach ( $attributes as $_name => $_value ) {

switch ( $_name ) {
				case 'href':
				case 'xlink:href':
				case 'src':
					$_secure_attr_value = \esc_url_raw( $_value );
					break;
				default:
					$_secure_attr_value = \esc_attr( $_value );
					break;
			}

// phpcs:disable -- Security hint for later, left code intact; Redundant, internal... for now.
			// elseif ( \in_array(
			// 	$_name,
			// 	/** @link <https://www.w3.org/TR/2011/WD-html5-20110525/elements.html> */
			// 	[ 'onabort', 'onblur', 'oncanplay', 'oncanplaythrough', 'onchange', 'onclick', 'oncontextmenu', 'oncuechange', 'ondblclick', 'ondrag', 'ondragend', 'ondragenter', 'ondragleave', 'ondragover', 'ondragstart', 'ondrop', 'ondurationchange', 'onemptied', 'onended', 'onerror', 'onfocus', 'oninput', 'oninvalid', 'onkeydown', 'onkeypress', 'onkeyup', 'onload', 'onloadeddata', 'onloadedmetadata', 'onloadstart', 'onmousedown', 'onmousemove', 'onmouseout', 'onmouseover', 'onmouseup', 'onmousewheel', 'onpause', 'onplay', 'onplaying', 'onprogress', 'onratechange', 'onreadystatechange', 'onreset', 'onscroll', 'onseeked', 'onseeking', 'onselect', 'onshow', 'onstalled', 'onsubmit', 'onsuspend', 'ontimeupdate', 'onvolumechange', 'onwaiting' ],
			// 	true
			// ) ) {
			// 	// Nope. Not this function.
			// 	continue;
			// }
			// phpcs:enable

$attr .= sprintf(
				' %s="%s"',
				/**
				 * @link <https://www.w3.org/TR/2011/WD-html5-20110525/syntax.html#attributes-0>
				 * This will strip "safe" characters outside of the alphabet, 0-9, and :_-.
				 * I don't want angry parents ringing me at home for their site didn't
				 * support proper UTF. We can afford empty tags in rare situations -- not here.
				 */
				preg_replace( '/[^a-zA-Z0-9:_-]+/', '', $_name ),
				$_secure_attr_value
			);
		}

if ( $text ) {
			$el = vsprintf(
				'<%1$s%2$s>%3$s</%1$s>',
				[
					/** @link <https://www.w3.org/TR/2011/WD-html5-20110525/syntax.html#syntax-tag-name> */
					preg_replace( '/[^0-9a-zA-Z]+/', '', $tag ),
					$attr,
					\esc_html( $text ),
				]
			);
		} else {
			$el = sprintf(
				'<%s%s />',
				/** @link <https://www.w3.org/TR/2011/WD-html5-20110525/syntax.html#syntax-tag-name> */
				preg_replace( '/[^0-9a-zA-Z]+/', '', $tag ),
				$attr
			);
		}

return $el . ( $new_line ? "\n" : '' );
	}

/**
	 * Renders the 'tsf:aqp' meta tag. Useful for identifying when query-exploit detection
	 * is triggered.
	 *
	 * @since 4.1.4
	 *
	 * @return string The advanced query protection (aqp) identifier.
	 */
	public function advanced_query_protection() {
		return $this->render_element( [
			'name'  => 'tsf:aqp',
			'value' => '1',
		] );
	}

/**
	 * Renders the description meta tag.
	 *
	 * @since 1.3.0
	 * @since 3.0.6 No longer uses $this->description_from_cache()
	 * @since 3.1.0 No longer checks for SEO plugin presence.
	 * @uses $this->get_description()
	 *
	 * @return string The description meta tag.
	 */
	public function the_description() {

/**
		 * @since 2.3.0
		 * @since 2.7.0 Added output within filter.
		 * @param string $description The generated description.
		 * @param int    $id          The page or term ID.
		 */
		$description = (string) \apply_filters_ref_array(
			'the_seo_framework_description_output',
			[
				$this->get_description(),
				$this->get_the_real_ID(),
			]
		);

return $description ? $this->render_element( [
			'name'    => 'description',
			'content' => $description,
		] ) : '';
	}

/**
	 * Renders og:description meta tag
	 *
	 * @since 1.3.0
	 * @since 3.0.4 No longer uses $this->description_from_cache()
	 * @uses $this->get_open_graph_description()
	 *
	 * @return string The Open Graph description meta tag.
	 */
	public function og_description() {

if ( ! $this->use_og_tags() )
			return '';

/**
		 * @since 2.3.0
		 * @since 2.7.0 Added output within filter.
		 * @param string $description The generated Open Graph description.
		 * @param int    $id          The page or term ID.
		 */
		$description = (string) \apply_filters_ref_array(
			'the_seo_framework_ogdescription_output',
			[
				$this->get_open_graph_description(),
				$this->get_the_real_ID(),
			]
		);

return $description ? $this->render_element( [
			'property' => 'og:description',
			'content'  => $description,
		] ) : '';
	}

/**
	 * Renders the OG locale meta tag.
	 *
	 * @since 1.0.0
	 *
	 * @return string The Open Graph locale meta tag.
	 */
	public function og_locale() {

if ( ! $this->use_og_tags() )
			return '';

/**
		 * @since 2.3.0
		 * @since 2.7.0 Added output within filter.
		 * @param string $locale The generated locale field.
		 * @param int    $id     The page or term ID.
		 */
		$locale = (string) \apply_filters_ref_array(
			'the_seo_framework_oglocale_output',
			[
				$this->fetch_locale(),
				$this->get_the_real_ID(),
			]
		);

return $locale ? $this->render_element( [
			'property' => 'og:locale',
			'content'  => $locale,
		] ) : '';
	}

/**
	 * Renders the Open Graph title meta tag.
	 *
	 * @since 2.0.3
	 * @since 3.0.4 No longer uses $this->title_from_cache()
	 * @uses $this->get_open_graph_title()
	 *
	 * @return string The Open Graph title meta tag.
	 */
	public function og_title() {

if ( ! $this->use_og_tags() )
			return '';

/**
		 * @since 2.3.0
		 * @since 2.7.0 Added output within filter.
		 * @param string $title The generated Open Graph title.
		 * @param int    $id    The page or term ID.
		 */
		$title = (string) \apply_filters_ref_array(
			'the_seo_framework_ogtitle_output',
			[
				$this->get_open_graph_title(),
				$this->get_the_real_ID(),
			]
		);

return $title ? $this->render_element( [
			'property' => 'og:title',
			'content'  => $title,
		] ) : '';
	}

/**
	 * Renders the Open Graph type meta tag.
	 *
	 * @since 1.1.0
	 *
	 * @return string The Open Graph type meta tag.
	 */
	public function og_type() {

if ( ! $this->use_og_tags() )
			return '';

$type = $this->get_og_type();

return $type ? $this->render_element( [
			'property' => 'og:type',
			'content'  => $type,
		] ) : '';
	}

/**
	 * Renders Open Graph image meta tag.
	 *
	 * @since 1.3.0
	 * @since 2.6.0 Added WooCommerce gallery images.
	 * @since 2.7.0 Added image dimensions if found.
	 * @since 4.1.2 Now forwards the `multi_og_image` option to the generator to
	 *              reduce processing power.
	 *
	 * @return string The Open Graph image meta tag.
	 */
	public function og_image() {

if ( ! $this->use_og_tags() ) return '';

$output = '';

$multi = (bool) $this->get_option( 'multi_og_image' );

foreach ( $this->get_image_details_from_cache( ! $multi ) as $image ) {
			$output .= $this->render_element( [
				'property' => 'og:image',
				'content'  => $image['url'],
			] );

if ( $image['height'] && $image['width'] ) {
				$output .= $this->render_element( [
					'property' => 'og:image:width',
					'content'  => $image['width'],
				] );
				$output .= $this->render_element( [
					'property' => 'og:image:height',
					'content'  => $image['height'],
				] );
			}

if ( $image['alt'] ) {
				$output .= $this->render_element( [
					'property' => 'og:image:alt',
					'content'  => $image['alt'],
				] );
			}

// Redundant?
			if ( ! $multi ) break;
		}

return $output;
	}

/**
	 * Renders Open Graph sitename meta tag.
	 *
	 * @since 1.3.0
	 * @since 3.1.0 Now uses $this->get_blogname(), which trims the output.
	 *
	 * @return string The Open Graph sitename meta tag.
	 */
	public function og_sitename() {

if ( ! $this->use_og_tags() ) return '';

/**
		 * @since 2.3.0
		 * @since 2.7.0 Added output within filter.
		 * @param string $sitename The generated Open Graph site name.
		 * @param int    $id       The page or term ID.
		 */
		$sitename = (string) \apply_filters_ref_array(
			'the_seo_framework_ogsitename_output',
			[
				$this->get_blogname(),
				$this->get_the_real_ID(),
			]
		);

return $sitename ? $this->render_element( [
			'property' => 'og:site_name',
			'content'  => $sitename,
		] ) : '';
	}

/**
	 * Renders Open Graph URL meta tag.
	 *
	 * @since 1.3.0
	 * @since 2.9.3 Added filter
	 * @since 4.1.4 Now uses `render_element()`, which applies `esc_attr()` on the URL.
	 * @uses $this->get_current_canonical_url()
	 *
	 * @return string The Open Graph URL meta tag.
	 */
	public function og_url() {

if ( ! $this->use_og_tags() ) return '';

/**
		 * @since 2.9.3
		 * @param string $url The canonical/Open Graph URL. Must be escaped.
		 * @param int    $id  The current page or term ID.
		 */
		$url = (string) \apply_filters_ref_array(
			'the_seo_framework_ogurl_output',
			[
				$this->get_current_canonical_url(),
				$this->get_the_real_ID(),
			]
		);

return $url ? $this->render_element( [
			'property' => 'og:url',
			'content'  => $url,
		] ) : '';
	}

/**
	 * Renders the Twitter Card type meta tag.
	 *
	 * @since 2.2.2
	 *
	 * @return string The Twitter Card meta tag.
	 */
	public function twitter_card() {