Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace AmpProject;

[2] Fix | Delete

[3] Fix | Delete

use AmpProject\Dom\Document;

[4] Fix | Delete

use AmpProject\Dom\Element;

[5] Fix | Delete

use DOMNode;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Central helper functionality for all Amp-related PHP code.

[9] Fix | Delete

[10] Fix | Delete

* @package ampproject/amp-toolbox

[11] Fix | Delete

[12] Fix | Delete

final class Amp

[13] Fix | Delete

{

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* List of AMP attribute tags that can be appended to the <html> element.

[17] Fix | Delete

[18] Fix | Delete

* The *_ALT version represent a Unicode variation of the lightning emoji.

[19] Fix | Delete

* @see https://github.com/ampproject/amphtml/issues/25990

[20] Fix | Delete

[21] Fix | Delete

* @var string[]

[22] Fix | Delete

[23] Fix | Delete

const TAGS = [

[24] Fix | Delete

Attribute::AMP,

[25] Fix | Delete

Attribute::AMP_EMOJI,

[26] Fix | Delete

Attribute::AMP_EMOJI_ALT,

[27] Fix | Delete

Attribute::AMP4ADS,

[28] Fix | Delete

Attribute::AMP4ADS_EMOJI,

[29] Fix | Delete

Attribute::AMP4ADS_EMOJI_ALT,

[30] Fix | Delete

Attribute::AMP4EMAIL,

[31] Fix | Delete

Attribute::AMP4EMAIL_EMOJI,

[32] Fix | Delete

Attribute::AMP4EMAIL_EMOJI_ALT,

[33] Fix | Delete

];

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Host and scheme of the AMP cache.

[37] Fix | Delete

[38] Fix | Delete

* @var string

[39] Fix | Delete

[40] Fix | Delete

const CACHE_HOST = 'https://cdn.ampproject.org';

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* URL of the AMP cache.

[44] Fix | Delete

[45] Fix | Delete

* @var string

[46] Fix | Delete

[47] Fix | Delete

const CACHE_ROOT_URL = self::CACHE_HOST . '/';

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* List of valid AMP formats.

[51] Fix | Delete

[52] Fix | Delete

* @var string[]

[53] Fix | Delete

[54] Fix | Delete

const FORMATS = ['AMP', 'AMP4EMAIL', 'AMP4ADS'];

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* List of dynamic components

[58] Fix | Delete

[59] Fix | Delete

* This list should be kept in sync with the list of dynamic components at:

[60] Fix | Delete

[61] Fix | Delete

* @see https://github.com/ampproject/amphtml/blob/292dc66b8c0bb078bbe3a1bca960e8f494f7fc8f/spec/amp-cache-guidelines.md#guidelines-adding-a-new-cache-to-the-amp-ecosystem

[62] Fix | Delete

[63] Fix | Delete

* @var array[]

[64] Fix | Delete

[65] Fix | Delete

const DYNAMIC_COMPONENTS = [

[66] Fix | Delete

Attribute::CUSTOM_ELEMENT => [Extension::GEO],

[67] Fix | Delete

Attribute::CUSTOM_TEMPLATE => [],

[68] Fix | Delete

];

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Array of custom element names that delay rendering.

[72] Fix | Delete

[73] Fix | Delete

* @var string[]

[74] Fix | Delete

[75] Fix | Delete

const RENDER_DELAYING_EXTENSIONS = [

[76] Fix | Delete

Extension::DYNAMIC_CSS_CLASSES,

[77] Fix | Delete

Extension::EXPERIMENT,

[78] Fix | Delete

Extension::STORY,

[79] Fix | Delete

];

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Standard boilerplate CSS stylesheet.

[83] Fix | Delete

[84] Fix | Delete

* @var string

[85] Fix | Delete

[86] Fix | Delete

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Boilerplate CSS stylesheet for the <noscript> tag.

[90] Fix | Delete

[91] Fix | Delete

* @var string

[92] Fix | Delete

[93] Fix | Delete

const BOILERPLATE_NOSCRIPT_CSS = 'body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}'; // phpcs:ignore Generic.Files.LineLength.TooLong

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Boilerplate CSS stylesheet for Amp4Ads & Amp4Email.

[97] Fix | Delete

[98] Fix | Delete

* @var string

[99] Fix | Delete

[100] Fix | Delete

const AMP4ADS_AND_AMP4EMAIL_BOILERPLATE_CSS = 'body{visibility:hidden}';

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* AMP runtime tag name.

[104] Fix | Delete

[105] Fix | Delete

* @var string

[106] Fix | Delete

[107] Fix | Delete

const RUNTIME = 'amp-runtime';

[108] Fix | Delete

[109] Fix | Delete

// AMP classes reserved for internal use.

[110] Fix | Delete

const LAYOUT_ATTRIBUTE = 'i-amphtml-layout';

[111] Fix | Delete

const NO_BOILERPLATE_ATTRIBUTE = 'i-amphtml-no-boilerplate';

[112] Fix | Delete

const LAYOUT_CLASS_PREFIX = 'i-amphtml-layout-';

[113] Fix | Delete

const LAYOUT_SIZE_DEFINED_CLASS = 'i-amphtml-layout-size-defined';

[114] Fix | Delete

const SIZER_ELEMENT = 'i-amphtml-sizer';

[115] Fix | Delete

const INTRINSIC_SIZER_ELEMENT = 'i-amphtml-intrinsic-sizer';

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Maximum size of the CSS styles in bytes.

[119] Fix | Delete

[120] Fix | Delete

* @todo Max size is hard-coded for now until we ported over the generated spec into a reusable package.

[121] Fix | Delete

[122] Fix | Delete

* @var int

[123] Fix | Delete

[124] Fix | Delete

const MAX_CSS_BYTE_COUNT = 75000;

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Check if a given node is the AMP runtime script.

[128] Fix | Delete

[129] Fix | Delete

* The AMP runtime script node is of the form '<script async src="https://cdn.ampproject.org...v0.js"></script>'.

[130] Fix | Delete

[131] Fix | Delete

* @param DOMNode $node Node to check.

[132] Fix | Delete

* @return bool Whether the given node is the AMP runtime script.

[133] Fix | Delete

[134] Fix | Delete

public static function isRuntimeScript(DOMNode $node)

[135] Fix | Delete

{

[136] Fix | Delete

if (

[137] Fix | Delete

! $node instanceof Element

[138] Fix | Delete

|| ! self::isAsyncScript($node)

[139] Fix | Delete

|| self::isExtension($node)

[140] Fix | Delete

) {

[141] Fix | Delete

return false;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

$src = $node->getAttribute(Attribute::SRC);

[145] Fix | Delete

[146] Fix | Delete

if (strpos($src, self::CACHE_ROOT_URL) !== 0) {

[147] Fix | Delete

return false;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

if (

[151] Fix | Delete

// @TODO Compare performance against single regex.

[152] Fix | Delete

substr($src, -6) !== '/v0.js'

[153] Fix | Delete

&& substr($src, -7) !== '/v0.mjs'

[154] Fix | Delete

&& substr($src, -14) !== '/amp4ads-v0.js'

[155] Fix | Delete

&& substr($src, -15) !== '/amp4ads-v0.mjs'

[156] Fix | Delete

) {

[157] Fix | Delete

return false;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

return true;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* Check if a given node is the AMP viewer script.

[165] Fix | Delete

[166] Fix | Delete

* The AMP viewer script node is of the form '<script async

[167] Fix | Delete

* src="https://cdn.ampproject.org/v0/amp-viewer-integration-...js>"</script>'.

[168] Fix | Delete

[169] Fix | Delete

* @param DOMNode $node Node to check.

[170] Fix | Delete

* @return bool Whether the given node is the AMP runtime script.

[171] Fix | Delete

[172] Fix | Delete

public static function isViewerScript(DOMNode $node)

[173] Fix | Delete

{

[174] Fix | Delete

if (

[175] Fix | Delete

! $node instanceof Element

[176] Fix | Delete

|| ! self::isAsyncScript($node)

[177] Fix | Delete

|| self::isExtension($node)

[178] Fix | Delete

) {

[179] Fix | Delete

return false;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

$src = $node->getAttribute(Attribute::SRC);

[183] Fix | Delete

[184] Fix | Delete

if (strpos($src, self::CACHE_HOST . '/v0/amp-viewer-integration-') !== 0) {

[185] Fix | Delete

return false;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

if (substr($src, -3) !== '.js') {

[189] Fix | Delete

return false;

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

return true;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* Check if a given node is an AMP extension.

[197] Fix | Delete

[198] Fix | Delete

* @param DOMNode $node Node to check.

[199] Fix | Delete

* @return bool Whether the given node is the AMP runtime script.

[200] Fix | Delete

[201] Fix | Delete

public static function isExtension(DOMNode $node)

[202] Fix | Delete

{

[203] Fix | Delete

return ! empty(self::getExtensionName($node));

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

/**

[207] Fix | Delete

* Get the name of the extension.

[208] Fix | Delete

[209] Fix | Delete

* Returns an empty string if the name of the extension could not be retrieved.

[210] Fix | Delete

[211] Fix | Delete

* @param DOMNode $node Node to get the name of.

[212] Fix | Delete

* @return string Name of the custom node or template. Empty string if none found.

[213] Fix | Delete

[214] Fix | Delete

public static function getExtensionName(DOMNode $node)

[215] Fix | Delete

{

[216] Fix | Delete

if (! $node instanceof Element || $node->tagName !== Tag::SCRIPT) {

[217] Fix | Delete

return '';

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

if ($node->hasAttribute(Attribute::CUSTOM_ELEMENT)) {

[221] Fix | Delete

return $node->getAttribute(Attribute::CUSTOM_ELEMENT);

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

if ($node->hasAttribute(Attribute::CUSTOM_TEMPLATE)) {

[225] Fix | Delete

return $node->getAttribute(Attribute::CUSTOM_TEMPLATE);

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

if ($node->hasAttribute(Attribute::HOST_SERVICE)) {

[229] Fix | Delete

return $node->getAttribute(Attribute::HOST_SERVICE);

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

return '';

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

/**

[236] Fix | Delete

* Check whether a given node is a script for a render-delaying extension.

[237] Fix | Delete

[238] Fix | Delete

* @param DOMNode $node Node to check.

[239] Fix | Delete

* @return bool Whether the node is a script for a render-delaying extension.

[240] Fix | Delete

[241] Fix | Delete

public static function isRenderDelayingExtension(DOMNode $node)

[242] Fix | Delete

{

[243] Fix | Delete

$extensionName = self::getExtensionName($node);

[244] Fix | Delete

[245] Fix | Delete

if (empty($extensionName)) {

[246] Fix | Delete

return false;

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

return in_array($extensionName, self::RENDER_DELAYING_EXTENSIONS, true);

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Check whether a given DOM node is an AMP custom element.

[254] Fix | Delete

[255] Fix | Delete

* @param DOMNode $node DOM node to check.

[256] Fix | Delete

* @return bool Whether the checked DOM node is an AMP custom element.

[257] Fix | Delete

[258] Fix | Delete

public static function isCustomElement(DOMNode $node)

[259] Fix | Delete

{

[260] Fix | Delete

return $node instanceof Element && strpos($node->tagName, Extension::PREFIX) === 0;

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Check whether the given document is an AMP story.

[265] Fix | Delete

[266] Fix | Delete

* @param Document $document Document of the page to check within.

[267] Fix | Delete

* @return bool Whether the provided document is an AMP story.

[268] Fix | Delete

[269] Fix | Delete

public static function isAmpStory(Document $document)

[270] Fix | Delete

{

[271] Fix | Delete

foreach ($document->head->childNodes as $node) {

[272] Fix | Delete

if (

[273] Fix | Delete

$node instanceof Element

[274] Fix | Delete

[275] Fix | Delete

$node->tagName === Tag::SCRIPT

[276] Fix | Delete

[277] Fix | Delete

$node->getAttribute(Attribute::CUSTOM_ELEMENT) === Extension::STORY

[278] Fix | Delete

) {

[279] Fix | Delete

return true;

[280] Fix | Delete

}

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

return false;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Check whether a given node is an AMP template.

[288] Fix | Delete

[289] Fix | Delete

* @param DOMNode $node Node to check.

[290] Fix | Delete

* @return bool Whether the node is an AMP template.

[291] Fix | Delete

[292] Fix | Delete

public static function isTemplate(DOMNode $node)

[293] Fix | Delete

{

[294] Fix | Delete

if (! $node instanceof Element) {

[295] Fix | Delete

return false;

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

if ($node->tagName === Tag::TEMPLATE) {

[299] Fix | Delete

return true;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

if (

[303] Fix | Delete

$node->tagName === Tag::SCRIPT

[304] Fix | Delete

&& $node->hasAttribute(Attribute::TEMPLATE)

[305] Fix | Delete

&& $node->getAttribute(Attribute::TEMPLATE) === Extension::MUSTACHE

[306] Fix | Delete

) {

[307] Fix | Delete

return true;

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

return false;

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

/**

[314] Fix | Delete

* Check whether a given node is an async <script> element.

[315] Fix | Delete

[316] Fix | Delete

* @param DOMNode $node Node to check.

[317] Fix | Delete

* @return bool Whether the given node is an async <script> element.

[318] Fix | Delete

[319] Fix | Delete

private static function isAsyncScript(DOMNode $node)

[320] Fix | Delete

{

[321] Fix | Delete

if (

[322] Fix | Delete

! $node instanceof Element

[323] Fix | Delete

|| $node->tagName !== Tag::SCRIPT

[324] Fix | Delete

) {

[325] Fix | Delete

return false;

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

if (

[329] Fix | Delete

! $node->hasAttribute(Attribute::SRC)

[330] Fix | Delete

|| ! $node->hasAttribute(Attribute::ASYNC)

[331] Fix | Delete

) {

[332] Fix | Delete

return false;

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

return true;

[336] Fix | Delete

}

[337] Fix | Delete

[338] Fix | Delete

/**

[339] Fix | Delete

* Check whether a given node is an AMP iframe.

[340] Fix | Delete

[341] Fix | Delete

* @param DOMNode $node Node to check.

[342] Fix | Delete

* @return bool Whether the node is an AMP iframe.

[343] Fix | Delete

[344] Fix | Delete

public static function isAmpIframe(DOMNode $node)

[345] Fix | Delete

{

[346] Fix | Delete

if (! $node instanceof Element) {

[347] Fix | Delete

return false;

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

return $node->tagName === Extension::IFRAME

[351] Fix | Delete

|| $node->tagName === Extension::VIDEO_IFRAME;

[352] Fix | Delete

}

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete