Add sanitizer to disable auto lightbox (#6936)

Co-authored-by: Dhaval Parekh <[email protected]>
ampproject · Mar 9, 2022 · 3ba9db9 · 3ba9db9
1 parent bc74cd7
commit 3ba9db9
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 0 deletions.
diff --git a/includes/amp-helper-functions.php b/includes/amp-helper-functions.php
@@ -1609,6 +1609,22 @@ function amp_get_content_sanitizers( $post = null ) {
 		);
 	}
 
+	/**
+	 * Filters whether AMP auto-lightbox is disabled.
+	 *
+	 * When disabled, the data-amp-auto-lightbox-disable attribute is added to the body.
+	 *
+	 * @since 2.2.2
+	 * @link https://github.com/ampproject/amphtml/blob/420bc3987f69f6d9cd36e31c013fc9eea4f1b245/docs/spec/auto-lightbox.md#disabling-treatment-explicitly
+	 *
+	 * @param bool $disabled Whether disabled.
+	 */
+	$is_auto_lightbox_disabled = apply_filters( 'amp_auto_lightbox_disabled', true );
+
+	if ( $is_auto_lightbox_disabled ) {
+		$sanitizers[ AMP_Auto_Lightbox_Disable_Sanitizer::class ] = [];
+	}
+
 	/**
 	 * Filters the content sanitizers.
 	 *
@@ -1688,6 +1704,7 @@ function amp_get_content_sanitizers( $post = null ) {
 
 	// Force core essential sanitizers to appear at the end at the end, with non-essential and third-party sanitizers appearing before.
 	$expected_final_sanitizer_order = [
+		AMP_Auto_Lightbox_Disable_Sanitizer::class,
 		AMP_Core_Theme_Sanitizer::class, // Must come before script sanitizer since onclick attributes are removed.
 		AMP_Bento_Sanitizer::class, // Bento scripts may be preserved here.
 		AMP_Script_Sanitizer::class, // Must come before sanitizers for images, videos, audios, comments, forms, and styles.

diff --git a/includes/sanitizers/class-amp-auto-lightbox-disable-sanitizer.php b/includes/sanitizers/class-amp-auto-lightbox-disable-sanitizer.php
@@ -0,0 +1,24 @@
+<?php
+/**
+ * Class AMP_Auto_Lightbox_Disable_Sanitizer
+ *
+ * @package AmpProject\AmpWP
+ */
+
+/**
+ * Disable auto lightbox for images.
+ *
+ * @since 2.2.2
+ * @internal
+ */
+class AMP_Auto_Lightbox_Disable_Sanitizer extends AMP_Base_Sanitizer {
+
+	/**
+	 * Add "data-amp-auto-lightbox-disable" attribute to body tag.
+	 *
+	 * @return void
+	 */
+	public function sanitize() {
+		$this->dom->body->setAttributeNode( $this->dom->createAttribute( 'data-amp-auto-lightbox-disable' ) );
+	}
+}
diff --git a/tests/php/test-amp-helper-functions.php b/tests/php/test-amp-helper-functions.php
@@ -1907,6 +1907,21 @@ static function( $classes ) {
 		$this->assertEquals( AMP_Tag_And_Attribute_Sanitizer::class, $ordered_sanitizers[ count( $ordered_sanitizers ) - 1 ] );
 	}
 
+	/**
+	 * @covers ::amp_get_content_sanitizers()
+	 */
+	public function test_amp_get_content_sanitizers_for_lightbox_sanitizer() {
+		$this->assertArrayHasKey( AMP_Auto_Lightbox_Disable_Sanitizer::class, amp_get_content_sanitizers() );
+
+		add_filter( 'amp_auto_lightbox_disabled', '__return_false', 10 );
+
+		$this->assertArrayNotHasKey( AMP_Auto_Lightbox_Disable_Sanitizer::class, amp_get_content_sanitizers() );
+
+		add_filter( 'amp_auto_lightbox_disabled', '__return_true', 20 );
+
+		$this->assertArrayHasKey( AMP_Auto_Lightbox_Disable_Sanitizer::class, amp_get_content_sanitizers() );
+	}
+
 	/**
 	 * Test amp_get_content_sanitizers().
 	 *

diff --git a/tests/php/test-class-amp-auto-lightbox-disable-sanitizer.php b/tests/php/test-class-amp-auto-lightbox-disable-sanitizer.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * Class AMP_Auto_Lightbox_Disable_Sanitizer_Test.
+ *
+ * @package AmpProject\AmpWP
+ */
+
+use AmpProject\AmpWP\Tests\TestCase;
+
+/**
+ * Tests the auto lightbox disable sanitizer class.
+ *
+ * @coversDefaultClass AMP_Auto_Lightbox_Disable_Sanitizer
+ */
+class AMP_Auto_Lightbox_Disable_Sanitizer_Test extends TestCase {
+
+	/**
+	 * @covers ::sanitize()
+	 */
+	public function test_sanitize() {
+
+		$source = '<html><body class="body-class"><span>Hello World!</span></body></html>';
+		$dom    = AMP_DOM_Utils::get_dom_from_content( $source );
+
+		$sanitizer = new AMP_Auto_Lightbox_Disable_Sanitizer( $dom );
+		$sanitizer->sanitize();
+
+		$this->assertTrue( $dom->body->hasAttribute( 'data-amp-auto-lightbox-disable' ) );
+	}
+}