ampproject · westonruter · Mar 19, 2021 · Feb 27, 2021 · Feb 27, 2021 · Feb 27, 2021
diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
     "ext-json": "*",
     "ext-libxml": "*",
     "ext-spl": "*",
-    "ampproject/amp-toolbox": "^0.1",
+    "ampproject/amp-toolbox": "^0.2",
     "cweagans/composer-patches": "1.7.0",
     "fasterimage/fasterimage": "1.5.0",
     "sabberworm/php-css-parser": "dev-master#bfdd976"

diff --git a/composer.lock b/composer.lock
diff --git a/includes/class-amp-theme-support.php b/includes/class-amp-theme-support.php
@@ -6,6 +6,7 @@
  */
 
 use AmpProject\Amp;
+use AmpProject\AmpWP\Dom\Options;
 use AmpProject\AmpWP\ExtraThemeAndPluginHeaders;
 use AmpProject\AmpWP\Option;
 use AmpProject\AmpWP\QueryVar;
@@ -1867,7 +1868,7 @@ public static function prepare_response( $response, $args = [] ) {
 		 */
 		do_action( 'amp_server_timing_start', 'amp_dom_parse', '', [], true );
 
-		$dom = Document::fromHtml( $response );
+		$dom = Document::fromHtml( $response, Options::DEFAULTS );
 
 		if ( AMP_Validation_Manager::$is_validate_request ) {
 			AMP_Validation_Manager::remove_illegal_source_stack_comments( $dom );
@@ -2117,8 +2118,6 @@ private static function get_optimizer_configuration( $args ) {
 					Optimizer\Transformer\TransformedIdentifier::class,
 				]
 			);
-		} else {
-			array_unshift( $transformers, Transformer\DetermineHeroImages::class );
 		}
 
 		array_unshift( $transformers, Transformer\AmpSchemaOrgMetadata::class );

diff --git a/includes/sanitizers/class-amp-meta-sanitizer.php b/includes/sanitizers/class-amp-meta-sanitizer.php
@@ -295,7 +295,7 @@ protected function create_charset_element() {
 			$this->dom,
 			Tag::META,
 			[
-				Attribute::CHARSET => Document::AMP_ENCODING,
+				Attribute::CHARSET => Document\Encoding::AMP,
 			]
 		);
 	}

diff --git a/includes/utils/class-amp-dom-utils.php b/includes/utils/class-amp-dom-utils.php
@@ -5,6 +5,7 @@
  * @package AMP
  */
 
+use AmpProject\AmpWP\Dom\Options;
 use AmpProject\Dom\Document;
 use AmpProject\Tag;
 
@@ -65,7 +66,14 @@ class AMP_DOM_Utils {
 	 */
 	public static function get_dom( $document, $encoding = null ) {
 		_deprecated_function( __METHOD__, '1.5.0', 'AmpProject\Dom\Document::fromHtml()' );
-		return Document::fromHtml( $document, $encoding );
+
+		$options = Options::DEFAULTS;
+
+		if ( null !== $encoding ) {
+			$options[ Document\Option::ENCODING ] = $encoding;
+		}
+
+		return Document::fromHtml( $document, $options );
 	}
 
 	/**
@@ -172,7 +180,10 @@ public static function get_dom_from_content( $content, $encoding = null ) {
 		 */
 		$document = "<html><head></head><body>{$content}</body></html>";
 
-		return Document::fromHtml( $document, $encoding );
+		$options = Options::DEFAULTS;
+		$options[ Document\Option::ENCODING ] = $encoding;
+
+		return Document::fromHtml( $document, $options );
 	}
 
 	/**

diff --git a/src/Dom/Options.php b/src/Dom/Options.php
@@ -0,0 +1,22 @@
+<?php
+/**
+ * Class Options.
+ *
+ * @package AmpProject\AmpWP
+ */
+
+namespace AmpProject\AmpWP\Dom;
+
+use AmpProject\Dom\Document;
+
+interface Options {
+
+	/**
+	 * Default options to use for the Dom.
+	 *
+	 * @var array
+	 */
+	const DEFAULTS = [
+		Document\Option::AMP_BIND_SYNTAX => Document\Option::AMP_BIND_SYNTAX_DATA_ATTRIBUTE,
+	];
+}
diff --git a/src/Transformer/DetermineHeroImages.php b/src/Transformer/DetermineHeroImages.php
@@ -31,25 +31,25 @@
 final class DetermineHeroImages implements Transformer {
 
 	/**
-	 * XPath query to find the existing hero images (elements with data/hero attribute).
+	 * XPath query to find the custom logo.
 	 *
 	 * @var string
 	 */
-	const EXISTING_HERO_IMAGES_XPATH_QUERY = './/*[@data-hero]';
+	const CUSTOM_HEADER_XPATH_QUERY = ".//*[ @id = 'wp-custom-header' or @id = 'masthead' or @id = 'site-header' or contains( concat( ' ', normalize-space( @class ), ' ' ), ' wp-custom-header ' ) ]//*[ ( self::img or self::amp-img ) and not( @data-hero ) and not( contains( concat( ' ', normalize-space( @class ), ' ' ), ' custom-logo ' ) ) ]";
 
 	/**
 	 * XPath query to find the custom logo.
 	 *
 	 * @var string
 	 */
-	const CUSTOM_LOGO_XPATH_QUERY = ".//a[ contains( concat( ' ', normalize-space( @class ), ' ' ), ' custom-logo-link ' ) ]//*[ contains( concat( ' ', normalize-space( @class ), ' ' ), ' custom-logo ' ) ][ not( @data-hero ) ]";
+	const CUSTOM_LOGO_XPATH_QUERY = ".//a[ contains( concat( ' ', normalize-space( @class ), ' ' ), ' custom-logo-link ' ) ]//*[ ( self::img or self::amp-img ) and contains( concat( ' ', normalize-space( @class ), ' ' ), ' custom-logo ' ) ][ not( @data-hero ) ]";
 
 	/**
 	 * XPath query to find the featured image.
 	 *
 	 * @var string
 	 */
-	const FEATURED_IMAGE_XPATH_QUERY = ".//*[ contains( concat( ' ', normalize-space( @class ), ' ' ), ' wp-post-image ' ) ][ not( @data-hero ) ]";
+	const FEATURED_IMAGE_XPATH_QUERY = ".//*[ ( self::img or self::amp-img ) and contains( concat( ' ', normalize-space( @class ), ' ' ), ' wp-post-image ' ) ][ not( @data-hero ) ]";
 
 	/**
 	 * XPath query to find the cover blocks.
@@ -68,44 +68,60 @@ final class DetermineHeroImages implements Transformer {
 	 * @return void
 	 */
 	public function transform( Document $document, ErrorCollection $errors ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$existing_hero_images_count = $document->xpath->query(
-			self::EXISTING_HERO_IMAGES_XPATH_QUERY,
-			$document->body
-		)->length;
-
-		$available_hero_image_slots = max(
-			PreloadHeroImage::DATA_HERO_MAX - $existing_hero_images_count,
-			0
-		);
-
 		$hero_image_elements = [];
 
-		if ( count( $hero_image_elements ) < $available_hero_image_slots ) {
-			$custom_logo = $this->get_custom_logo( $document );
-			if ( null !== $custom_logo ) {
-				$hero_image_elements[] = $custom_logo;
+		foreach ( [ 'custom_header', 'custom_logo', 'featured_image', 'cover_blocks' ] as $hero_image_source ) {
+			if ( count( $hero_image_elements ) < PreloadHeroImage::DATA_HERO_MAX ) {
+				$candidates = [];
+
+				switch ( $hero_image_source ) {
+					case 'custom_header':
+						$candidates = $this->get_custom_header( $document );
+						break;
+					case 'custom_logo':
+						$candidates = $this->get_custom_logo( $document );
+						break;
+					case 'featured_image':
+						$candidates = $this->get_featured_image( $document );
+						break;
+					case 'cover_blocks':
+						$candidates = $this->get_cover_blocks( $document );
+						break;
+				}
+
+				if ( empty( $candidates ) ) {
+					continue;
+				}
+
+				if ( is_array( $candidates ) ) {
+					$hero_image_elements = array_merge( $hero_image_elements, array_filter( $candidates ) );
+				} else {
+					$hero_image_elements[] = $candidates;
+				}
 			}
 		}
 
-		if ( count( $hero_image_elements ) < $available_hero_image_slots ) {
-			$featured_image = $this->get_featured_image( $document );
-			if ( null !== $featured_image ) {
-				$hero_image_elements[] = $featured_image;
-			}
-		}
-
-		if ( count( $hero_image_elements ) < $available_hero_image_slots ) {
-			$hero_image_elements = array_merge(
-				$hero_image_elements,
-				array_filter(
-					$this->get_cover_blocks( $document )
-				)
-			);
-		}
+		$this->add_data_hero_candidate_attribute(
+			array_slice( $hero_image_elements, 0, PreloadHeroImage::DATA_HERO_MAX )
+		);
+	}
 
-		$this->add_data_hero_attribute(
-			array_slice( $hero_image_elements, 0, $available_hero_image_slots )
+	/**
+	 * Retrieve the element that represents the custom header.
+	 *
+	 * @param Document $document Document to retrieve the custom header from.
+	 * @return DOMElement|null Element that represents the custom header, or null
+	 *                         if not found.
+	 */
+	private function get_custom_header( Document $document ) {
+		$elements = $document->xpath->query(
+			self::CUSTOM_HEADER_XPATH_QUERY,
+			$document->body
 		);
-		$elements = $document->xpath->query(
-			self::CUSTOM_HEADER_XPATH_QUERY,
-			$document->body
-		);
+		$header_image = get_header_image();
+		if ( ! $header_image ) {
+			return null;
+		}
+
+		$elements = $document->xpath->query(
+			sprintf(
+				'//*[ ( self::img or self::amp-img ) and @src = "%s" ]',
+				addcslashes( $custom_header->url, '"\\' )
+			),
+			$document->body
+		);
-		$elements = $document->xpath->query(
-			self::CUSTOM_HEADER_XPATH_QUERY,
-			$document->body
-		);
+		$header_image = get_header_image();
+		if ( ! $header_image ) {
+			return null;
+		}
+
+		$elements = $document->xpath->query(
+			sprintf(
+				'//*[ ( self::img or self::amp-img ) and @src = "%s" ]',
+				addcslashes( $custom_header->url, '"\\' )
+			),
+			$document->body
+		);
+
+		$custom_header = $elements->item( 0 );
+
+		return $custom_header instanceof DOMElement ? $custom_header : null;
 	}
 
 	/**
@@ -165,9 +181,9 @@ private function get_cover_blocks( Document $document ) {
 	 * @param DOMElement[] $hero_image_elements Elements that are viable hero
 	 *                                          images.
 	 */
-	private function add_data_hero_attribute( $hero_image_elements ) {
+	private function add_data_hero_candidate_attribute( $hero_image_elements ) {
 		foreach ( $hero_image_elements as $hero_image_element ) {
-			$hero_image_element->setAttribute( Attribute::DATA_HERO, null );
+			$hero_image_element->setAttribute( Attribute::DATA_HERO_CANDIDATE, null );
 		}
 	}
 }